Class WakuPeerExchange

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

Hierarchy

  • BaseProtocol
    • WakuPeerExchange

Implements

Constructors

constructor

Properties

addLibp2pEventListener multicodec removeLibp2pEventListener streamManager

Accessors

peerStore

Methods

getPeer getPeers getStream peers query

Constructors

constructor

Properties

Readonly addLibp2pEventListener

addLibp2pEventListener: (<K>(type: K, listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>, options?: boolean | AddEventListenerOptions) => void)

Type declaration

    • <K>(type: K, listener: null | EventHandler<Libp2pEvents<ServiceMap>[K]>, options?: boolean | AddEventListenerOptions): 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 removeLibp2pEventListener

removeLibp2pEventListener: (<K>(type: K, listener?: null | EventHandler<Libp2pEvents<ServiceMap>[K]>, options?: boolean | EventListenerOptions) => void)

Type declaration

    • <K>(type: K, listener?: null | EventHandler<Libp2pEvents<ServiceMap>[K]>, options?: boolean | EventListenerOptions): void

    • Type Parameters

      • K extends keyof Libp2pEvents<ServiceMap>

      Parameters

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

      Returns void

Protected streamManager

streamManager: StreamManager

Accessors

peerStore

  • get peerStore(): PeerStore

  • Returns PeerStore

Methods

Protected getPeer

  • Parameters

    • Optional peerId: PeerId

    Returns Promise<Peer>

Protected getPeers

  • Retrieves a list of peers based on the specified criteria.

    Returns

    A Promise that resolves to an array of peers based on the specified criteria.

    Parameters

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

    Returns Promise<Peer[]>

Protected getStream

  • Parameters

    • peer: Peer

    Returns Promise<Stream>

peers

  • 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[]>

query

Settings

Member Visibility

Theme

Generated using TypeDoc