Class PeerRouting

Hierarchy

  • PeerRouting

Index

References

Constructors

Properties

Methods

References

Multiaddr

Re-exports Multiaddr

Constructors

constructor

Properties

_peerId

_peerId: PeerId

_peerStore

_peerStore: PeerStore

_refreshManagerOptions

_refreshManagerOptions: any

_routers

_routers: any

_timeoutId

_timeoutId: any

Methods

_findClosestPeersTask

  • _findClosestPeersTask(): Promise<void>

  • Recurrent task to find closest peers and add their addresses to the Address Book.

    Returns Promise<void>

findPeer

  • findPeer(id: PeerId, options?: { timeout?: number | undefined } | undefined): Promise<{ id: PeerId; multiaddrs: Multiaddr[] }>

  • Iterates over all peer routers in parallel to find the given peer.

    Parameters

    • id: PeerId

      The id of the peer to find

    • Optional options: { timeout?: number | undefined } | undefined

    Returns Promise<{ id: PeerId; multiaddrs: Multiaddr[] }>

    }

getClosestPeers

  • getClosestPeers(key: Uint8Array, options?: { timeout?: number | undefined } | undefined): AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

  • Attempt to find the closest peers on the network to the given key.

    Parameters

    • key: Uint8Array

      A CID like key

    • Optional options: { timeout?: number | undefined } | undefined

    Returns AsyncIterable<{ id: PeerId; multiaddrs: Multiaddr[] }>

    }

start

  • start(): void

  • Start peer routing service.

    Returns void

stop

  • stop(): void

  • Stop peer routing service.

    Returns void