Class WakuPeerExchange

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

Hierarchy

  • BaseProtocol
    • WakuPeerExchange

Implements

Constructors

constructor

Properties

addLibp2pEventListener multicodec numPeersToUse pubsubTopics removeLibp2pEventListener streamManager

Accessors

peerStore

Methods

allPeers connectedPeers getPeers getStream query

Constructors

constructor

Properties

Readonly addLibp2pEventListener

addLibp2pEventListener: (<K>(type, listener, options?) => void)

Type declaration

    • <K>(type, listener, options?): void

    • Type Parameters

      • K extends keyof Libp2pEvents<ServiceMap>

      Parameters

      • type: K
      • listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
      • Optional options: boolean | AddEventListenerOptions

      Returns void

multicodec

multicodec: string

Readonly numPeersToUse

numPeersToUse: number

Protected pubsubTopics

pubsubTopics: string[]

Readonly removeLibp2pEventListener

removeLibp2pEventListener: {
    <K>(type, listener?, options?): void;
    (type, listener?, options?): void;
}

Type declaration

    • <K>(type, listener?, options?): void

    • Type Parameters

      • K extends keyof Libp2pEvents<ServiceMap>

      Parameters

      • type: K
      • Optional listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>
      • Optional options: boolean | EventListenerOptions

      Returns void

    • (type, listener?, options?): void

    • Parameters

      • type: string
      • Optional listener: EventHandler<Event>
      • Optional options: boolean | EventListenerOptions

      Returns void

Protected streamManager

streamManager: StreamManager

Accessors

peerStore

  • get peerStore(): PeerStore

  • Returns PeerStore

Methods

allPeers

  • allPeers(): 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[]>

connectedPeers

  • connectedPeers(): Promise<Peer[]>

  • Returns Promise<Peer[]>

Protected getPeers

  • getPeers(__namedParameters?): Promise<Peer[]>

  • Retrieves a list of connected peers that support the protocol. The list is sorted by latency.

    Parameters

    • Optional __namedParameters: {
          maxBootstrapPeers: number;
          numPeers: number;
      }
      • maxBootstrapPeers: number
      • numPeers: number

    Returns Promise<Peer[]>

    A list of peers that support the protocol sorted by latency.

Protected getStream

  • getStream(peer): Promise<Stream>

  • Parameters

    • peer: Peer

    Returns Promise<Stream>

query

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc