Interface CreateOptions

Hierarchy

  • CreateOptions

Properties

defaultBootstrap?: boolean

Use recommended bootstrap method to discovery and connect to new nodes.

libp2p?: Partial<RecursivePartial<Libp2pInit>>

You can pass options to the Libp2p instance used by @waku/core.WakuNode using the libp2p property. This property is the same type as the one passed to Libp2p.create 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/core.WakuNode to ensure it implements the Waku protocol.

pubSubTopic?: string

The PubSub Topic to use.

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 Waku v2 Topic Usage Recommendations for details.

staticNoiseKey?: Uint8Array

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

Generated using TypeDoc