Interface Routing

name

cancelReprovide

• cancelReprovide(key: CID, options?: AbortOptions): Promise<void>

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

  Parameters

  • key: CID
  • Optionaloptions: AbortOptions

  Returns Promise<void>

  Example

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

findPeer

• findPeer(
      peerId: PeerId,
      options?: RoutingOptions<RoutingFindPeerProgressEvents>,
  ): Promise<PeerInfo>

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

  Parameters

  • peerId: PeerId
  • Optionaloptions: RoutingOptions<RoutingFindPeerProgressEvents>

  Returns Promise<PeerInfo>

  Example

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

findProviders

• findProviders(
      cid: CID,
      options?: RoutingOptions<RoutingFindProvidersProgressEvents>,
  ): AsyncIterable<Provider>

  Find the providers of the passed CID.

  Parameters

  • cid: CID
  • Optionaloptions: RoutingOptions<RoutingFindProvidersProgressEvents>

  Returns AsyncIterable<Provider>

  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

get

• get(
      key: Uint8Array,
      options?: RoutingOptions<RoutingGetProgressEvents>,
  ): Promise<Uint8Array<ArrayBufferLike>>

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

  Parameters

  • key: Uint8Array
  • Optionaloptions: RoutingOptions<RoutingGetProgressEvents>

  Returns Promise<Uint8Array<ArrayBufferLike>>

  Example

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

getClosestPeers

• getClosestPeers(
      key: Uint8Array,
      options?: RoutingOptions<RoutingGetClosestPeersProgressEvents>,
  ): 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<RoutingGetClosestPeersProgressEvents>

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

provide

• provide(
      cid: CID,
      options?: RoutingOptions<RoutingProvideProgressEvents>,
  ): Promise<void>

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

  Parameters

  • cid: CID
  • Optionaloptions: RoutingOptions<RoutingProvideProgressEvents>

  Returns Promise<void>

  Example

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

put

• put(
      key: Uint8Array,
      value: Uint8Array,
      options?: RoutingOptions<RoutingPutProgressEvents>,
  ): Promise<void>

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

  Parameters

  • key: Uint8Array
  • value: Uint8Array
  • Optionaloptions: RoutingOptions<RoutingPutProgressEvents>

  Returns Promise<void>

  Example

  // ...
  const key = '/key'
  const value = uint8ArrayFromString('oh hello there')
  
  await contentRouting.put(key, value)
  Copy