Class WakuPeerExchange

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

Hierarchy

WakuPeerExchange

Implements

IPeerExchange

Index

Constructors

Properties

callback components createOptions?

Accessors

Methods

getPeer handler newStream peers query

Constructors

constructor

new WakuPeerExchange(components: PeerExchangeComponents, createOptions?: ProtocolOptions): WakuPeerExchange
Parameters
- components: PeerExchangeComponents
  
  libp2p components
- Optional createOptions: ProtocolOptions
  
  Options for the protocol
Returns WakuPeerExchange
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:41

Properties

`Private` callback

callback: undefined | ((response: PeerExchangeResponse) => Promise<void>)

components

components: PeerExchangeComponents

libp2p components

`Optional` createOptions

createOptions?: ProtocolOptions

Options for the protocol

Accessors

peerStore

get peerStore(): PeerStore
Returns
The libp2p peer store

Returns PeerStore
Implementation of IPeerExchange.peerStore
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:153

Methods

`Private` getPeer

getPeer(peerId?: PeerId): Promise<Peer>
Returns
A peer to query
Parameters
- Optional peerId: PeerId
  
  Optional peer ID to select a peer
Returns Promise<Peer>
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:115

`Private` handler

handler(streamData: IncomingStreamData): void
Handle a peer exchange query response
Parameters
- streamData: IncomingStreamData
Returns void
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:81

`Private` newStream

newStream(peer: Peer): Promise<Stream>
Returns
A new stream
Parameters
- peer: Peer
  
  Peer to open a stream with
Returns Promise<Stream>
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:131

peers

peers(): Promise<Peer[]>
Returns
All peers that support the peer exchange protocol

Returns Promise<Peer[]>
Implementation of IPeerExchange.peers
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:146

query

query(params: PeerExchangeQueryParams, callback: ((response: PeerExchangeResponse) => Promise<void>)): Promise<void>
Make a peer exchange query to a peer
Parameters
- params: PeerExchangeQueryParams
- callback: ((response: PeerExchangeResponse) => Promise<void>)
  - - (response: PeerExchangeResponse): Promise<void>
    - Parameters
      
      response: PeerExchangeResponse
      
      Returns Promise<void>
Returns Promise<void>
Implementation of IPeerExchange.query
- Defined in packages/peer-exchange/src/waku_peer_exchange.ts:53

Generated using TypeDoc