Class BaseProtocol

A class with predefined helpers, to be used as a base to implement Waku Protocols.

Hierarchy

BaseProtocol
- WakuPeerExchange

Index

Constructors

Properties

getConnections multicodec peerStore

Methods

getPeer newStream peers

Constructors

constructor

new BaseProtocol(multicodec: string, peerStore: PeerStore, getConnections: ((peerId?: PeerId) => Connection[])): BaseProtocol
Parameters
- multicodec: string
- peerStore: PeerStore
- getConnections: ((peerId?: PeerId) => Connection[])
  - - (peerId?: PeerId): Connection[]
    - Parameters
      
      Optional peerId: PeerId
      
      Returns Connection[]
Returns BaseProtocol
- Defined in packages/core/dist/lib/base_protocol.d.ts:12

Properties

`Protected` getConnections

getConnections: ((peerId?: PeerId) => Connection[])

Type declaration

- (peerId?: PeerId): Connection[]
- Parameters
  - Optional peerId: PeerId
  Returns Connection[]

multicodec

multicodec: string

peerStore

peerStore: PeerStore

Methods

`Protected` getPeer

getPeer(peerId?: PeerId): Promise<Peer>
Parameters
- Optional peerId: PeerId
Returns Promise<Peer>
- Defined in packages/core/dist/lib/base_protocol.d.ts:19

`Protected` newStream

newStream(peer: Peer): Promise<Stream>
Parameters
- peer: Peer
Returns Promise<Stream>
- Defined in packages/core/dist/lib/base_protocol.d.ts:20

peers

peers(): Promise<Peer[]>
Returns known peers from the address book (libp2p.peerStore) that support the class protocol. Waku may or may not be currently connected to these peers.

Returns Promise<Peer[]>
- Defined in packages/core/dist/lib/base_protocol.d.ts:18

Generated using TypeDoc