Interface Routing

interface Routing {
    cancelReprovide(key: CID, options?: AbortOptions): Promise<void>;
    findPeer(peerId: PeerId, options?: RoutingOptions): Promise<PeerInfo>;
    findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>;
    get(
        key: Uint8Array,
        options?: RoutingOptions,
    ): Promise<Uint8Array<ArrayBufferLike>>;
    getClosestPeers(
        key: Uint8Array,
        options?: RoutingOptions,
    ): AsyncIterable<PeerInfo>;
    provide(cid: CID, options?: RoutingOptions): Promise<void>;
    put(
        key: Uint8Array,
        value: Uint8Array,
        options?: RoutingOptions,
    ): Promise<void>;
}

Index

Methods

cancelReprovide findPeer findProviders get getClosestPeers provide put

Methods

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)
```
- Defined in packages/interface/src/routing.ts:78

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/routing.ts:134

findProviders

findProviders(cid: CID, options?: RoutingOptions): AsyncIterable<Provider>
Find the providers of the passed CID.
Parameters
- cid: CID
- Optionaloptions: RoutingOptions
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)
}
```
- Defined in packages/interface/src/routing.ts:92

get

get(
key: Uint8Array,
options?: RoutingOptions,
): Promise<Uint8Array<ArrayBufferLike>>
Retrieves a value from the network corresponding to the passed key.
Parameters
- key: Uint8Array
- Optionaloptions: RoutingOptions
Returns Promise<Uint8Array<ArrayBufferLike>>
Example
```
// ...

const key = '/key'
const value = await contentRouting.get(key)
```
- Defined in packages/interface/src/routing.ts:122

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/routing.ts:149

provide

provide(cid: CID, options?: RoutingOptions): 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
Returns Promise<void>
Example
```
// ...
await contentRouting.provide(cid)
```
- Defined in packages/interface/src/routing.ts:65

put

put(key: Uint8Array, value: Uint8Array, options?: RoutingOptions): 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
Returns Promise<void>
Example
```
// ...
const key = '/key'
const value = uint8ArrayFromString('oh hello there')

await contentRouting.put(key, value)
```
- Defined in packages/interface/src/routing.ts:108