Interface DelegatedRoutingV1HttpApiClient

interface DelegatedRoutingV1HttpApiClient {
    getIPNS(
        libp2pKey: CID<unknown, 114, 0 | 18, 1>,
        options?: GetIPNSOptions,
    ): Promise<IPNSRecord>;
    getPeers(
        peerId: PeerId,
        options?: GetPeersOptions,
    ): AsyncGenerator<PeerRecord>;
    getProviders(
        cid: CID,
        options?: GetProvidersOptions,
    ): AsyncGenerator<PeerRecord>;
    putIPNS(
        libp2pKey: CID<unknown, 114, 0 | 18, 1>,
        record: IPNSRecord,
        options?: AbortOptions,
    ): Promise<void>;
    start(): Promise<void>;
    stop(): Promise<void>;
}

Index

Methods

getIPNS getPeers getProviders putIPNS start stop

Methods

getIPNS

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

getPeers

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

getProviders

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

putIPNS

putIPNS(
    libp2pKey: CID<unknown, 114, 0 | 18, 1>,
    record: IPNSRecord,
    options?: AbortOptions,
): Promise<void>
Publishes the given IPNSRecord for the provided MultihashDigest
Parameters
- libp2pKey: CID<unknown, 114, 0 | 18, 1>
- record: IPNSRecord
- Optionaloptions: 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