Class WakuNode

Hierarchy

  • WakuNode

Implements

Constructors

constructor

Properties

filter? libp2p lightPush? pingKeepAliveTimers relay? relayKeepAliveTimers store?

Methods

addPeerToAddressBook dial getLocalMultiaddrWithID isStarted start startKeepAlive stop stopAllKeepAlives stopKeepAlive

Constructors

constructor

Properties

Optional filter

filter?: WakuFilter

libp2p

libp2p: Libp2p

Optional lightPush

lightPush?: WakuLightPush

Private pingKeepAliveTimers

pingKeepAliveTimers: { [peer: string]: ReturnType<typeof setInterval> }

Type declaration

  • [peer: string]: ReturnType<typeof setInterval>

Optional relay

relay?: WakuRelay

Private relayKeepAliveTimers

relayKeepAliveTimers: { [peer: string]: ReturnType<typeof setInterval> }

Type declaration

  • [peer: string]: ReturnType<typeof setInterval>

Optional store

store?: WakuStore

Methods

addPeerToAddressBook

  • Add peer to address book, it will be auto-dialed in the background.

    Parameters

    • peerId: string | PeerId
    • multiaddrs: Multiaddr[] | string[]

    Returns Promise<void>

dial

  • Dials to the provided peer.

    Parameters

    • peer: PeerId | Multiaddr

      The peer to dial

    • Optional protocols: Protocols[]

      Waku protocols we expect from the peer; Default to Relay

    Returns Promise<Stream>

getLocalMultiaddrWithID

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

    Throws

    if libp2p is not listening on localhost.

    Returns string

isStarted

start

Private startKeepAlive

  • Parameters

    • peerId: PeerId
    • pingPeriodSecs: number
    • relayPeriodSecs: number

    Returns void

stop

Private stopAllKeepAlives

Private stopKeepAlive

  • Parameters

    • peerId: PeerId

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc