Class WakuNode

Hierarchy

WakuNode

Implements

Waku

Index

Constructors

Properties

filter? libp2p lightPush? peerExchange? pingKeepAliveTimers relay? relayKeepAliveTimers store?

Methods

dial getLocalMultiaddrWithID isStarted start startKeepAlive stop stopAllKeepAlives stopKeepAlive

Constructors

constructor

new WakuNode(options: waku.WakuOptions, libp2p: Libp2p, store?: ((libp2p: Libp2p) => IStore), lightPush?: ((libp2p: Libp2p) => ILightPush), filter?: ((libp2p: Libp2p) => IFilter), peerExchange?: ((components: PeerExchangeComponents) => IPeerExchange)): WakuNode
Parameters
- options: waku.WakuOptions
- libp2p: Libp2p
- Optional store: ((libp2p: Libp2p) => IStore)
  - - (libp2p: Libp2p): IStore
    - Parameters
      
      libp2p: Libp2p
      
      Returns IStore
- Optional lightPush: ((libp2p: Libp2p) => ILightPush)
  - - (libp2p: Libp2p): ILightPush
    - Parameters
      
      libp2p: Libp2p
      
      Returns ILightPush
- Optional filter: ((libp2p: Libp2p) => IFilter)
  - - (libp2p: Libp2p): IFilter
    - Parameters
      
      libp2p: Libp2p
      
      Returns IFilter
- Optional peerExchange: ((components: PeerExchangeComponents) => IPeerExchange)
  - - (components: PeerExchangeComponents): IPeerExchange
    - Parameters
      
      components: PeerExchangeComponents
      
      Returns IPeerExchange
Returns WakuNode
- Defined in packages/core/src/lib/waku.ts:65

Properties

`Optional` filter

filter?: IFilter

libp2p

libp2p: Libp2p

`Optional` lightPush

lightPush?: ILightPush

`Optional` peerExchange

peerExchange?: IPeerExchange

`Private` pingKeepAliveTimers

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

Type declaration

[peer: string]: ReturnType<typeof setInterval>

`Optional` relay

relay?: IRelay

`Private` relayKeepAliveTimers

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

Type declaration

[peer: string]: ReturnType<typeof setInterval>

`Optional` store

store?: IStore

Methods

dial

dial(peer: PeerId | Multiaddr, protocols?: Protocols[]): Promise<Stream>
Dials to the provided peer.
Parameters
- peer: PeerId | Multiaddr
  
  The peer to dial
- Optional protocols: Protocols[]
  
  Waku protocols we expect from the peer; Defaults to mounted protocols
Returns Promise<Stream>
Implementation of Waku.dial
- Defined in packages/core/src/lib/waku.ts:148

getLocalMultiaddrWithID

getLocalMultiaddrWithID(): string
Return the local multiaddr with peer id on which libp2p is listening.

Throws
if libp2p is not listening on localhost.

Returns string
- Defined in packages/core/src/lib/waku.ts:233

isStarted

isStarted(): boolean
Returns boolean
Implementation of Waku.isStarted
- Defined in packages/core/src/lib/waku.ts:224

start

start(): Promise<void>
Returns Promise<void>
Implementation of Waku.start
- Defined in packages/core/src/lib/waku.ts:215

`Private` startKeepAlive

startKeepAlive(peerId: PeerId, pingPeriodSecs: number, relayPeriodSecs: number): void
Parameters
- peerId: PeerId
- pingPeriodSecs: number
- relayPeriodSecs: number
Returns void
- Defined in packages/core/src/lib/waku.ts:243

stop

stop(): Promise<void>
Returns Promise<void>
Implementation of Waku.stop
- Defined in packages/core/src/lib/waku.ts:219

`Private` stopAllKeepAlives

stopAllKeepAlives(): void
Returns void
- Defined in packages/core/src/lib/waku.ts:290

`Private` stopKeepAlive

stopKeepAlive(peerId: PeerId): void
Parameters
- peerId: PeerId
Returns void
- Defined in packages/core/src/lib/waku.ts:276

Generated using TypeDoc