Class WakuPeerExchange

Implementation of the Peer Exchange protocol (https://rfc.vac.dev/spec/34/)

Hierarchy

BaseProtocol
- WakuPeerExchange

Implements

IPeerExchange

Index

Constructors

Properties

components getConnections multicodec peerStore

Methods

getPeer newStream peers query

Constructors

constructor

new WakuPeerExchange(components: PeerExchangeComponents): WakuPeerExchange
Parameters
- components: PeerExchangeComponents
  
  libp2p components
Returns WakuPeerExchange
Overrides BaseProtocol.constructor
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:37

Properties

components

components: PeerExchangeComponents

libp2p components

`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>
Inherited from BaseProtocol.getPeer
- Defined in packages/core/dist/lib/base_protocol.d.ts:19

`Protected` newStream

newStream(peer: Peer): Promise<Stream>
Parameters
- peer: Peer
Returns Promise<Stream>
Inherited from BaseProtocol.newStream
- 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[]>
Implementation of IPeerExchange.peers

Inherited from BaseProtocol.peers
- Defined in packages/core/dist/lib/base_protocol.d.ts:18

query

query(params: PeerExchangeQueryParams): Promise<undefined | PeerInfo[]>
Make a peer exchange query to a peer
Parameters
- params: PeerExchangeQueryParams
Returns Promise<undefined | PeerInfo[]>
Implementation of IPeerExchange.query
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:51

Generated using TypeDoc