Interface DelegatedRoutingV1HttpApiClient

interface DelegatedRoutingV1HttpApiClient {
    getIPNS(libp2pKey, options?): Promise<IPNSRecord>;
    getPeers(peerId, options?): AsyncGenerator<PeerRecord, any, unknown>;
    getProviders(cid, options?): AsyncGenerator<PeerRecord, any, unknown>;
    putIPNS(libp2pKey, record, options?): Promise<void>;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Index

Methods

getIPNS getPeers getProviders putIPNS start stop

Methods

getIPNS

getIPNS(libp2pKey, options?): Promise<IPNSRecord>
Returns a promise of a IPNSRecord for the given MultihashDigest
Parameters
- libp2pKey: CID<unknown, 114, 0 | 18, 1>
- Optional options: GetIPNSOptions
Returns Promise<IPNSRecord>
- Defined in packages/client/src/index.ts:187

getPeers

getPeers(peerId, options?): AsyncGenerator<PeerRecord, any, unknown>
Returns an async generator of PeerRecords for the provided PeerId
Parameters
- peerId: PeerId
- Optional options: GetPeersOptions
Returns AsyncGenerator<PeerRecord, any, unknown>
- Defined in packages/client/src/index.ts:182

getProviders

getProviders(cid, options?): AsyncGenerator<PeerRecord, any, unknown>
Returns an async generator of PeerRecords that can provide the content for the passed CID
Parameters
- cid: CID<unknown, number, number, Version>
- Optional options: GetProvidersOptions
Returns AsyncGenerator<PeerRecord, any, unknown>
- Defined in packages/client/src/index.ts:176

putIPNS

putIPNS(libp2pKey, record, options?): Promise<void>
Publishes the given IPNSRecord for the provided MultihashDigest
Parameters
- libp2pKey: CID<unknown, 114, 0 | 18, 1>
- record: IPNSRecord
- Optional options: AbortOptions
Returns Promise<void>
- Defined in packages/client/src/index.ts:192

start

start(): Promise<void>
Create the request/response cache used to ensure duplicate requests aren't made for the same data

Returns Promise<void>
- Defined in packages/client/src/index.ts:198

stop

stop(): Promise<void>
Shut down any currently running HTTP requests and clear up any resources that are in use

Returns Promise<void>
- Defined in packages/client/src/index.ts:204