Class WakuNode

constructor

• new WakuNode(options, libp2p, store?, lightPush?, filter?, relay?): WakuNode

• Parameters

  • options: WakuOptions
  • libp2p: Libp2p
  • Optional store: ((libp2p) => IStoreSDK)
    • • (libp2p): IStoreSDK

      • Parameters

        • libp2p: Libp2p

        Returns IStoreSDK

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

      • Parameters

        • libp2p: Libp2p

        Returns ILightPushSDK

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

      • Parameters

        • libp2p: Libp2p

        Returns IFilterSDK

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

      • Parameters

        • libp2p: Libp2p

        Returns IRelay

  Returns 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>

subscribeToContentTopic

• subscribeToContentTopic(contentTopic, peer, callback): Promise<IFilterSubscription>

• Parameters

  • contentTopic: string
  • peer: Multiaddr
  • callback: Callback<DecodedMessage>

  Returns Promise<IFilterSubscription>