CreateOptions | js-waku
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateOptions

Hierarchy

  • CreateOptions

Index

Properties

bootstrap?: BootstrapOptions

Use libp2p-bootstrap to discover and connect to new nodes.

See BootstrapOptions for available parameters.

Note: It overrides any other peerDiscovery modules that may have been set via CreateOptions.libp2p.

decryptionKeys?: (string | Uint8Array)[]
libp2p?: Omit<Libp2pOptions & CreateOptions, "modules"> & { modules?: Partial<Libp2pModules> }

You can pass options to the Libp2p instance used by Waku using the CreateOptions.libp2p property. This property is the same type than the one passed to apart that we made the modules property optional and partial, allowing its omission and letting Waku set good defaults. Notes that some values are overridden by Waku to ensure it implements the Waku protocol.

pingKeepAlive?: number

Set keep alive frequency in seconds: Waku will send a /ipfs/ping/1.0.0 request to each peer after the set number of seconds. Set to 0 to disable.

default

DefaultPingKeepAliveValueSecs

pubSubTopic?: string

The PubSub Topic to use. Defaults to DefaultPubSubTopic.

One and only one pubsub topic is used by Waku. This is used by:

  • WakuRelay to receive, route and send messages,
  • WakuLightPush to send messages,
  • WakuStore to retrieve messages.

The usage of the default pubsub topic is recommended. See for details.

default

DefaultPubSubTopic

relayKeepAlive?: number

Set keep alive frequency in seconds: Waku will send a ping message over relay to each peer after the set number of seconds. Set to 0 to disable.

default

DefaultRelayKeepAliveValueSecs

staticNoiseKey?: Uint8Array

Byte array used as key for the noise protocol used for connection encryption by This is only used for test purposes to not run out of entropy during CI runs.

Generated using