Class BaseProtocol

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

Hierarchy

Implements

Constructors

constructor

Properties

addLibp2pEventListener components multicodec removeLibp2pEventListener

Accessors

peerStore

Methods

getPeer newStream peers

Constructors

constructor

  • Parameters

    • multicodec: string
    • components: Components

    Returns BaseProtocol

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

Private components

components: any

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

Accessors

peerStore

  • get peerStore(): PeerStore

  • Returns PeerStore

Methods

Protected getPeer

  • Parameters

    • Optional peerId: PeerId

    Returns Promise<Peer>

Protected newStream

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

Settings

Member Visibility

Theme

Generated using TypeDoc