Class WakuNode

constructor

• new WakuNode(options, pubsubTopics?, libp2p, pubsubShardInfo?, store?, lightPush?, filter?, relay?): waku.WakuNode

• Parameters

  • options: waku.WakuOptions

  • pubsubTopics: string[] = []

  • libp2p: Libp2p

  • Optional pubsubShardInfo: ShardingParams

  • Optional store: ((libp2p) => IStore)

    • • (libp2p): IStore

      • Parameters

        • libp2p: Libp2p

        Returns IStore

  • Optional lightPush: ((libp2p) => ILightPush)

    • • (libp2p): ILightPush

      • Parameters

        • libp2p: Libp2p

        Returns ILightPush

  • Optional filter: ((libp2p) => IFilter)

    • • (libp2p): IFilter

      • Parameters

        • libp2p: Libp2p

        Returns IFilter

  • Optional relay: ((libp2p) => IRelay)

    • • (libp2p): IRelay

      • Parameters

        • libp2p: Libp2p

        Returns IRelay

  Returns waku.WakuNode

connectionManager

Optional filter

libp2p

Optional lightPush

Readonly pubsubTopics

Optional relay

Optional store

dial

• dial(peer, protocols?): Promise<Stream>

• Dials to the provided peer.

  Parameters

  • peer: PeerId | MultiaddrInput

    The peer to dial

  • Optional protocols: Protocols[]

    Waku protocols we expect from the peer; Defaults to mounted protocols

  Returns Promise<Stream>

getLocalMultiaddrWithID

• getLocalMultiaddrWithID(): string

• Return the local multiaddr with peer id on which libp2p is listening.

  Returns string

  Throws

  if libp2p is not listening on localhost.

isConnected

• isConnected(): boolean

• Returns boolean

isStarted

• isStarted(): boolean

• Returns boolean

start

• start(): Promise<void>

• Returns Promise<void>

stop

• stop(): Promise<void>

• Returns Promise<void>