Interface Routing

Helia will periodically re-provide every previously provided CID. Use this method to no longer re-provide the passed CID.

Example

// ...
await contentRouting.cancelReprovide(cid)
Copy

Searches the network for peer info corresponding to the passed peer id.

Example

// ...
const peer = await peerRouting.findPeer(peerId, options)
Copy

Find the providers of the passed CID.

Example

// Iterate over the providers found for the given cid
for await (const provider of contentRouting.findProviders(cid)) {
 console.log(provider.id, provider.multiaddrs)
}
Copy

Retrieves a value from the network corresponding to the passed key.

Example

// ...

const key = '/key'
const value = await contentRouting.get(key)
Copy

Search the network for peers that are closer to the passed key. Peer info should be yielded in ever-increasing closeness to the key.

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)
}
Copy

The implementation of this method should ensure that network peers know the caller can provide content that corresponds to the passed CID.

Example

// ...
await contentRouting.provide(cid)
Copy

Puts a value corresponding to the passed key in a way that can later be retrieved by another network peer using the get method.

Example

// ...
const key = '/key'
const value = uint8ArrayFromString('oh hello there')

await contentRouting.put(key, value)
Copy