Type alias ProtocolCreateOptions

ProtocolCreateOptions: {
    defaultBootstrap?: boolean;
    libp2p?: Partial<Libp2pOptions>;
    pubSubTopic?: string;
    staticNoiseKey?: Uint8Array;
    useFilterV1?: boolean;
}

Type declaration

  • Optional defaultBootstrap?: boolean

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

  • Optional libp2p?: Partial<Libp2pOptions>

    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.

  • Optional pubSubTopic?: string

    The PubSub Topic to use. Defaults to @waku/core.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 Waku v2 Topic Usage Recommendations for details.

  • Optional 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.

  • Optional useFilterV1?: boolean

    FilterV2 has been set to default Use this flag to enable the previous version of the filter protocol See Improved Filter protocol specifications

Settings

Member Visibility

Theme

Generated using TypeDoc