Interface PeerRouting

interface PeerRouting {
    findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>;
    getClosestPeers(
        key: Uint8Array,
        options?: RoutingOptions,
    ): AsyncIterable<PeerInfo>;
}

Index

Methods

findPeer getClosestPeers

Methods

findPeer

findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>
Searches the network for peer info corresponding to the passed peer id.
Parameters
- peerId: PeerId
- Optionaloptions: RoutingOptions
Returns Promise<PeerInfo>
Example
```
// ...
const peer = await peerRouting.findPeer(peerId, options)
```
- Defined in packages/interface/src/peer-routing.ts:45

getClosestPeers

getClosestPeers(
key: Uint8Array,
options?: RoutingOptions,
): AsyncIterable<PeerInfo>
Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.
Parameters
- key: Uint8Array
- Optionaloptions: RoutingOptions
Returns AsyncIterable<PeerInfo>
Example
```
// Iterate over the closest peers found for the given key
for await (const peer of peerRouting.getClosestPeers(key)) {
  console.log(peer.id, peer.multiaddrs)
}
```
- Defined in packages/interface/src/peer-routing.ts:60