Interface KadDHT

interface KadDHT {
    a: number;
    d: number;
    k: number;
    cancelReprovide(key: CID): Promise<void>;
    findPeer(id: PeerId, options?: RoutingOptions): AsyncIterable<QueryEvent>;
    findProviders(
        key: CID,
        options?: RoutingOptions,
    ): AsyncIterable<QueryEvent>;
    get(key: Uint8Array, options?: RoutingOptions): AsyncIterable<QueryEvent>;
    getClosestPeers(
        key: Uint8Array,
        options?: RoutingOptions,
    ): AsyncIterable<QueryEvent>;
    getMode(): "client" | "server";
    provide(key: CID, options?: RoutingOptions): AsyncIterable<QueryEvent>;
    put(
        key: Uint8Array,
        value: Uint8Array,
        options?: RoutingOptions,
    ): AsyncIterable<QueryEvent>;
    refreshRoutingTable(): Promise<void>;
    setMode(mode: "client" | "server"): Promise<void>;
}

Hierarchy (View Summary)

KadDHT
- SingleKadDHT

Index

Properties

a d k

Methods

cancelReprovide findPeer findProviders get getClosestPeers getMode provide put refreshRoutingTable setMode

Properties

`Readonly`a

a: number

Query concurrency factor - this controls how many peers we contact in parallel during a query.

`Readonly`d

d: number

From section 4.4 of the S/Kademlia paper - this is how many disjoint paths are used during a query.

`Readonly`k

k: number

This is the maximum size of the k-buckets and how many peers are looked up when searching for peers close to a key.

Methods

cancelReprovide

cancelReprovide(key: CID): Promise<void>
Provider records must be re-published every 24 hours - pass a previously provided CID here to not re-publish a record for it any more
Parameters
- key: CID
Returns Promise<void>
- Defined in kad-dht/src/index.ts:353

findPeer

findPeer(id: PeerId, options?: RoutingOptions): AsyncIterable<QueryEvent>
Find a peer on the DHT
Parameters
- id: PeerId
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:337

findProviders

findProviders(key: CID, options?: RoutingOptions): AsyncIterable<QueryEvent>
Find providers of a given CID
Parameters
- key: CID
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:332

get

get(key: Uint8Array, options?: RoutingOptions): AsyncIterable<QueryEvent>
Get a value from the DHT, the final ValueEvent will be the best value
Parameters
- key: Uint8Array
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:327

getClosestPeers

getClosestPeers(
key: Uint8Array,
options?: RoutingOptions,
): AsyncIterable<QueryEvent>
Find the closest peers to the passed key
Parameters
- key: Uint8Array
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:342

getMode

getMode(): "client" | "server"
Returns the mode this node is in

Returns "client" | "server"
- Defined in kad-dht/src/index.ts:363

provide

provide(key: CID, options?: RoutingOptions): AsyncIterable<QueryEvent>
Store provider records for the passed CID on the DHT pointing to us
Parameters
- key: CID
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:347

put

put(
    key: Uint8Array,
    value: Uint8Array,
    options?: RoutingOptions,
): AsyncIterable<QueryEvent>
Store the passed value under the passed key on the DHT
Parameters
- key: Uint8Array
- value: Uint8Array
- Optionaloptions: RoutingOptions
Returns AsyncIterable<QueryEvent>
- Defined in kad-dht/src/index.ts:358

refreshRoutingTable

refreshRoutingTable(): Promise<void>
Force a routing table refresh

Returns Promise<void>
- Defined in kad-dht/src/index.ts:374

setMode

setMode(mode: "client" | "server"): Promise<void>
If 'server' this node will respond to DHT queries, if 'client' this node will not.
Parameters
- mode: "client" | "server"
Returns Promise<void>
- Defined in kad-dht/src/index.ts:369