@libp2p/kad-dht 0.28.6

package/dist/src/routing-table/index.d.ts

@@ -0,0 +1,91 @@
+import Queue from 'p-queue';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Dialer, Startable } from '@libp2p/interfaces';
+import type { ComponentMetricsTracker } from '@libp2p/interfaces/metrics';
+export interface KBucketPeer {
+    id: Uint8Array;
+    peer: PeerId;
+}
+export interface KBucket {
+    id: Uint8Array;
+    contacts: KBucketPeer[];
+    dontSplit: boolean;
+    left: KBucket;
+    right: KBucket;
+}
+export interface KBucketTree {
+    root: KBucket;
+    localNodeId: Uint8Array;
+    on: (event: 'ping', callback: (oldContacts: KBucketPeer[], newContact: KBucketPeer) => void) => void;
+    closest: (key: Uint8Array, count: number) => KBucketPeer[];
+    closestPeer: (key: Uint8Array) => KBucketPeer;
+    remove: (key: Uint8Array) => void;
+    add: (peer: KBucketPeer) => void;
+    get: (key: Uint8Array) => Uint8Array;
+    count: () => number;
+    toIterable: () => Iterable<KBucket>;
+}
+export interface RoutingTableOptions {
+    peerId: PeerId;
+    dialer: Dialer;
+    lan: boolean;
+    metrics?: ComponentMetricsTracker;
+    kBucketSize?: number;
+    pingTimeout?: number;
+}
+/**
+ * A wrapper around `k-bucket`, to provide easy store and
+ * retrieval for peers.
+ */
+export declare class RoutingTable implements Startable {
+    private readonly log;
+    private readonly peerId;
+    dialer: Dialer;
+    private readonly lan;
+    private readonly metrics?;
+    kBucketSize: number;
+    private readonly pingTimeout;
+    kb?: KBucketTree;
+    private running;
+    pingQueue: Queue;
+    constructor(options: RoutingTableOptions);
+    isStarted(): boolean;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * Called on the `ping` event from `k-bucket` when a bucket is full
+     * and cannot split.
+     *
+     * `oldContacts.length` is defined by the `numberOfNodesToPing` param
+     * passed to the `k-bucket` constructor.
+     *
+     * `oldContacts` will not be empty and is the list of contacts that
+     * have not been contacted for the longest.
+     */
+    _onPing(oldContacts: KBucketPeer[], newContact: KBucketPeer): void;
+    /**
+     * Amount of currently stored peers
+     */
+    get size(): number;
+    /**
+     * Find a specific peer by id
+     */
+    find(peer: PeerId): Promise<PeerId | undefined>;
+    /**
+     * Retrieve the closest peers to the given key
+     */
+    closestPeer(key: Uint8Array): PeerId | undefined;
+    /**
+     * Retrieve the `count`-closest peers to the given key
+     */
+    closestPeers(key: Uint8Array, count?: number): PeerId[];
+    /**
+     * Add or update the routing table with the given peer
+     */
+    add(peer: PeerId): Promise<void>;
+    /**
+     * Remove a given peer from the table
+     */
+    remove(peer: PeerId): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/routing-table/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/routing-table/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,SAAS,CAAA;AAI3B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAA;AAGzE,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,UAAU,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,SAAS,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,UAAU,CAAA;IACvB,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,WAAW,KAAK,IAAI,KAAK,IAAI,CAAA;IACpG,OAAO,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,WAAW,EAAE,CAAA;IAC1D,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,WAAW,CAAA;IAC7C,MAAM,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;IACjC,GAAG,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IAChC,GAAG,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,UAAU,CAAA;IACpC,KAAK,EAAE,MAAM,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;CACpC;AAID,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,OAAO,CAAA;IACZ,OAAO,CAAC,EAAE,uBAAuB,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,qBAAa,YAAa,YAAW,SAAS;IAC5C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IACxB,MAAM,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAyB;IAC3C,WAAW,EAAE,MAAM,CAAA;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAQ;IAC7B,EAAE,CAAC,EAAE,WAAW,CAAA;IACvB,OAAO,CAAC,OAAO,CAAS;IACjB,SAAS,EAAE,KAAK,CAAA;gBAEV,OAAO,EAAE,mBAAmB;IAgBzC,SAAS;IAIH,KAAK;IAYL,IAAI;IAMV;;;;;;;;;OASG;IACH,OAAO,CAAE,WAAW,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,WAAW;IA+D5D;;OAEG;IACH,IAAI,IAAI,WAMP;IAED;;OAEG;IACG,IAAI,CAAE,IAAI,EAAE,MAAM;IASxB;;OAEG;IACH,WAAW,CAAE,GAAG,EAAE,UAAU;IAQ5B;;OAEG;IACH,YAAY,CAAE,GAAG,EAAE,UAAU,EAAE,KAAK,SAAmB;IAUvD;;OAEG;IACG,GAAG,CAAE,IAAI,EAAE,MAAM;IAmBvB;;OAEG;IACG,MAAM,CAAE,IAAI,EAAE,MAAM;CAgB3B"}

package/dist/src/routing-table/index.js

@@ -0,0 +1,183 @@
+// @ts-expect-error no types
+import KBuck from 'k-bucket';
+import * as utils from '../utils.js';
+import Queue from 'p-queue';
+import { PROTOCOL_DHT } from '../constants.js';
+import { TimeoutController } from 'timeout-abort-controller';
+import { logger } from '@libp2p/logger';
+const METRIC_ROUTING_TABLE_SIZE = 'routing-table-size';
+/**
+ * A wrapper around `k-bucket`, to provide easy store and
+ * retrieval for peers.
+ */
+export class RoutingTable {
+    constructor(options) {
+        const { peerId, dialer, kBucketSize, pingTimeout, lan, metrics } = options;
+        this.log = logger(`libp2p:kad-dht:${lan ? 'lan' : 'wan'}:routing-table`);
+        this.peerId = peerId;
+        this.dialer = dialer;
+        this.kBucketSize = kBucketSize ?? 20;
+        this.pingTimeout = pingTimeout ?? 10000;
+        this.lan = lan;
+        this.metrics = metrics;
+        this.pingQueue = new Queue({ concurrency: 1 });
+        this.running = false;
+        this._onPing = this._onPing.bind(this);
+    }
+    isStarted() {
+        return this.running;
+    }
+    async start() {
+        this.running = true;
+        const kBuck = new KBuck({
+            localNodeId: await utils.convertPeerId(this.peerId),
+            numberOfNodesPerKBucket: this.kBucketSize,
+            numberOfNodesToPing: 1
+        });
+        kBuck.on('ping', this._onPing);
+        this.kb = kBuck;
+    }
+    async stop() {
+        this.running = false;
+        this.pingQueue.clear();
+        this.kb = undefined;
+    }
+    /**
+     * Called on the `ping` event from `k-bucket` when a bucket is full
+     * and cannot split.
+     *
+     * `oldContacts.length` is defined by the `numberOfNodesToPing` param
+     * passed to the `k-bucket` constructor.
+     *
+     * `oldContacts` will not be empty and is the list of contacts that
+     * have not been contacted for the longest.
+     */
+    _onPing(oldContacts, newContact) {
+        // add to a queue so multiple ping requests do not overlap and we don't
+        // flood the network with ping requests if lots of newContact requests
+        // are received
+        this.pingQueue.add(async () => {
+            if (!this.running) {
+                return;
+            }
+            let responded = 0;
+            try {
+                await Promise.all(oldContacts.map(async (oldContact) => {
+                    let timeoutController;
+                    try {
+                        timeoutController = new TimeoutController(this.pingTimeout);
+                        this.log('pinging old contact %p', oldContact.peer);
+                        const { stream } = await this.dialer.dialProtocol(oldContact.peer, PROTOCOL_DHT, {
+                            signal: timeoutController.signal
+                        });
+                        await stream.close();
+                        responded++;
+                    }
+                    catch (err) {
+                        if (this.running && this.kb != null) {
+                            // only evict peers if we are still running, otherwise we evict when dialing is
+                            // cancelled due to shutdown in progress
+                            this.log.error('could not ping peer %p', oldContact.peer, err);
+                            this.log('evicting old contact after ping failed %p', oldContact);
+                            this.kb.remove(oldContact.id);
+                        }
+                    }
+                    finally {
+                        if (timeoutController != null) {
+                            timeoutController.clear();
+                        }
+                        this.metrics?.updateComponentMetric({
+                            system: 'libp2p',
+                            component: `kad-dht-${this.lan ? 'lan' : 'wan'}`,
+                            metric: METRIC_ROUTING_TABLE_SIZE,
+                            value: this.size
+                        });
+                    }
+                }));
+                if (this.running && responded < oldContacts.length && this.kb != null) {
+                    this.log('adding new contact %p', newContact.peer);
+                    this.kb.add(newContact);
+                }
+            }
+            catch (err) {
+                this.log.error('could not process k-bucket ping event', err);
+            }
+        })
+            .catch(err => {
+            this.log.error('could not process k-bucket ping event', err);
+        });
+    }
+    // -- Public Interface
+    /**
+     * Amount of currently stored peers
+     */
+    get size() {
+        if (this.kb == null) {
+            return 0;
+        }
+        return this.kb.count();
+    }
+    /**
+     * Find a specific peer by id
+     */
+    async find(peer) {
+        const key = await utils.convertPeerId(peer);
+        const closest = this.closestPeer(key);
+        if (closest != null && peer.equals(closest)) {
+            return closest;
+        }
+    }
+    /**
+     * Retrieve the closest peers to the given key
+     */
+    closestPeer(key) {
+        const res = this.closestPeers(key, 1);
+        if (res.length > 0) {
+            return res[0];
+        }
+    }
+    /**
+     * Retrieve the `count`-closest peers to the given key
+     */
+    closestPeers(key, count = this.kBucketSize) {
+        if (this.kb == null) {
+            return [];
+        }
+        const closest = this.kb.closest(key, count);
+        return closest.map(p => p.peer);
+    }
+    /**
+     * Add or update the routing table with the given peer
+     */
+    async add(peer) {
+        if (this.kb == null) {
+            throw new Error('RoutingTable is not started');
+        }
+        const id = await utils.convertPeerId(peer);
+        this.kb.add({ id: id, peer: peer });
+        this.log('added %p with kad id %b', peer, id);
+        this.metrics?.updateComponentMetric({
+            system: 'libp2p',
+            component: `kad-dht-${this.lan ? 'lan' : 'wan'}`,
+            metric: METRIC_ROUTING_TABLE_SIZE,
+            value: this.size
+        });
+    }
+    /**
+     * Remove a given peer from the table
+     */
+    async remove(peer) {
+        if (this.kb == null) {
+            throw new Error('RoutingTable is not started');
+        }
+        const id = await utils.convertPeerId(peer);
+        this.kb.remove(id);
+        this.metrics?.updateComponentMetric({
+            system: 'libp2p',
+            component: `kad-dht-${this.lan ? 'lan' : 'wan'}`,
+            metric: METRIC_ROUTING_TABLE_SIZE,
+            value: this.size
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/src/routing-table/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/routing-table/index.ts"],"names":[],"mappings":"AAAA,4BAA4B;AAC5B,OAAO,KAAK,MAAM,UAAU,CAAA;AAC5B,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AACpC,OAAO,KAAK,MAAM,SAAS,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAgCvC,MAAM,yBAAyB,GAAG,oBAAoB,CAAA;AAWtD;;;GAGG;AACH,MAAM,OAAO,YAAY;IAYvB,YAAa,OAA4B;QACvC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;QAE1E,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,gBAAgB,CAAC,CAAA;QACxE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,EAAE,CAAA;QACpC,IAAI,CAAC,WAAW,GAAG,WAAW,IAAI,KAAK,CAAA;QACvC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,SAAS,GAAG,IAAI,KAAK,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAA;QAC9C,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QAEpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACxC,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QAEnB,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC;YACtB,WAAW,EAAE,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;YACnD,uBAAuB,EAAE,IAAI,CAAC,WAAW;YACzC,mBAAmB,EAAE,CAAC;SACvB,CAAC,CAAA;QACF,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;QAC9B,IAAI,CAAC,EAAE,GAAG,KAAK,CAAA;IACjB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;QACtB,IAAI,CAAC,EAAE,GAAG,SAAS,CAAA;IACrB,CAAC;IAED;;;;;;;;;OASG;IACH,OAAO,CAAE,WAA0B,EAAE,UAAuB;QAC1D,uEAAuE;QACvE,sEAAsE;QACtE,eAAe;QACf,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBACjB,OAAM;aACP;YAED,IAAI,SAAS,GAAG,CAAC,CAAA;YAEjB,IAAI;gBACF,MAAM,OAAO,CAAC,GAAG,CACf,WAAW,CAAC,GAAG,CAAC,KAAK,EAAC,UAAU,EAAC,EAAE;oBACjC,IAAI,iBAAiB,CAAA;oBAErB,IAAI;wBACF,iBAAiB,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;wBAE3D,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;wBACnD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,EAAE;4BAC/E,MAAM,EAAE,iBAAiB,CAAC,MAAM;yBACjC,CAAC,CAAA;wBACF,MAAM,MAAM,CAAC,KAAK,EAAE,CAAA;wBACpB,SAAS,EAAE,CAAA;qBACZ;oBAAC,OAAO,GAAQ,EAAE;wBACjB,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;4BACnC,+EAA+E;4BAC/E,wCAAwC;4BACxC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,wBAAwB,EAAE,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;4BAC9D,IAAI,CAAC,GAAG,CAAC,2CAA2C,EAAE,UAAU,CAAC,CAAA;4BACjE,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;yBAC9B;qBACF;4BAAS;wBACR,IAAI,iBAAiB,IAAI,IAAI,EAAE;4BAC7B,iBAAiB,CAAC,KAAK,EAAE,CAAA;yBAC1B;wBAED,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC;4BAClC,MAAM,EAAE,QAAQ;4BAChB,SAAS,EAAE,WAAW,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;4BAChD,MAAM,EAAE,yBAAyB;4BACjC,KAAK,EAAE,IAAI,CAAC,IAAI;yBACjB,CAAC,CAAA;qBACH;gBACH,CAAC,CAAC,CACH,CAAA;gBAED,IAAI,IAAI,CAAC,OAAO,IAAI,SAAS,GAAG,WAAW,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;oBACrE,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;oBAClD,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;iBACxB;aACF;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAA;aAC7D;QACH,CAAC,CAAC;aACC,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,uCAAuC,EAAE,GAAG,CAAC,CAAA;QAC9D,CAAC,CAAC,CAAA;IACN,CAAC;IAED,sBAAsB;IAEtB;;OAEG;IACH,IAAI,IAAI;QACN,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;YACnB,OAAO,CAAC,CAAA;SACT;QAED,OAAO,IAAI,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;IACxB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAE,IAAY;QACtB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QAErC,IAAI,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YAC3C,OAAO,OAAO,CAAA;SACf;IACH,CAAC;IAED;;OAEG;IACH,WAAW,CAAE,GAAe;QAC1B,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QAErC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YAClB,OAAO,GAAG,CAAC,CAAC,CAAC,CAAA;SACd;IACH,CAAC;IAED;;OAEG;IACH,YAAY,CAAE,GAAe,EAAE,KAAK,GAAG,IAAI,CAAC,WAAW;QACrD,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;YACnB,OAAO,EAAE,CAAA;SACV;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAE3C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAE,IAAY;QACrB,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAE1C,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;QAEnC,IAAI,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,EAAE,EAAE,CAAC,CAAA;QAE7C,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC;YAClC,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;YAChD,MAAM,EAAE,yBAAyB;YACjC,KAAK,EAAE,IAAI,CAAC,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAE,IAAY;QACxB,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;SAC/C;QAED,MAAM,EAAE,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAE1C,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;QAElB,IAAI,CAAC,OAAO,EAAE,qBAAqB,CAAC;YAClC,MAAM,EAAE,QAAQ;YAChB,SAAS,EAAE,WAAW,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;YAChD,MAAM,EAAE,yBAAyB;YACjC,KAAK,EAAE,IAAI,CAAC,IAAI;SACjB,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/src/routing-table/refresh.d.ts

@@ -0,0 +1,50 @@
+import type { RoutingTable } from './index.js';
+import type { PeerRouting } from '../peer-routing/index.js';
+export interface RoutingTableRefreshOptions {
+    peerRouting: PeerRouting;
+    routingTable: RoutingTable;
+    lan: boolean;
+    refreshInterval?: number;
+    refreshQueryTimeout?: number;
+}
+/**
+ * A wrapper around `k-bucket`, to provide easy store and
+ * retrieval for peers.
+ */
+export declare class RoutingTableRefresh {
+    private readonly log;
+    private readonly peerRouting;
+    private readonly routingTable;
+    private readonly refreshInterval;
+    private readonly refreshQueryTimeout;
+    private readonly commonPrefixLengthRefreshedAt;
+    private refreshTimeoutId?;
+    constructor(options: RoutingTableRefreshOptions);
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    /**
+     * To speed lookups, we seed the table with random PeerIds. This means
+     * when we are asked to locate a peer on the network, we can find a KadId
+     * that is close to the requested peer ID and query that, then network
+     * peers will tell us who they know who is close to the fake ID
+     */
+    refreshTable(force?: boolean): void;
+    _refreshCommonPrefixLength(cpl: number, lastRefresh: Date, force: boolean): Promise<void>;
+    _getTrackedCommonPrefixLengthsForRefresh(maxCommonPrefix: number): Date[];
+    _generateRandomPeerId(targetCommonPrefixLength: number): Promise<import("@libp2p/interfaces/dist/src/peer-id").PeerId>;
+    _makePeerId(localKadId: Uint8Array, randomPrefix: number, targetCommonPrefixLength: number): Promise<Uint8Array>;
+    /**
+     * returns the maximum common prefix length between any peer in the table
+     * and the current peer
+     */
+    _maxCommonPrefix(): number;
+    /**
+     * Returns the number of peers in the table with a given prefix length
+     */
+    _numPeersForCpl(prefixLength: number): number;
+    /**
+     * Yields the common prefix length of every peer in the table
+     */
+    _prefixLengths(): Generator<number, void, unknown>;
+}
+//# sourceMappingURL=refresh.d.ts.map

package/dist/src/routing-table/refresh.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.d.ts","sourceRoot":"","sources":["../../../src/routing-table/refresh.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE9C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAO3D,MAAM,WAAW,0BAA0B;IACzC,WAAW,EAAE,WAAW,CAAA;IACxB,YAAY,EAAE,YAAY,CAAA;IAC1B,GAAG,EAAE,OAAO,CAAA;IACZ,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAED;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAQ;IAC5B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAQ;IACxC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAQ;IACtD,OAAO,CAAC,gBAAgB,CAAC,CAAc;gBAE1B,OAAO,EAAE,0BAA0B;IAY1C,KAAK;IAKL,IAAI;IAMV;;;;;OAKG;IACH,YAAY,CAAE,KAAK,GAAE,OAAe;IAyD9B,0BAA0B,CAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO;IAuBhF,wCAAwC,CAAE,eAAe,EAAE,MAAM;IAe3D,qBAAqB,CAAE,wBAAwB,EAAE,MAAM;IAavD,WAAW,CAAE,UAAU,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,wBAAwB,EAAE,MAAM;IA8BjG;;;OAGG;IACH,gBAAgB;IAchB;;OAEG;IACH,eAAe,CAAE,YAAY,EAAE,MAAM;IAYrC;;OAEG;IACD,cAAc;CAoBjB"}

package/dist/src/routing-table/refresh.js

@@ -0,0 +1,204 @@
+import { xor as uint8ArrayXor } from 'uint8arrays/xor';
+import GENERATED_PREFIXES from './generated-prefix-list.js';
+import { sha256 } from 'multiformats/hashes/sha2';
+import { randomBytes } from '@libp2p/crypto';
+import { peerIdFromBytes } from '@libp2p/peer-id';
+import { logger } from '@libp2p/logger';
+import length from 'it-length';
+import { TimeoutController } from 'timeout-abort-controller';
+import { TABLE_REFRESH_INTERVAL, TABLE_REFRESH_QUERY_TIMEOUT } from '../constants.js';
+/**
+ * Cannot generate random KadIds longer than this + 1
+ */
+const MAX_COMMON_PREFIX_LENGTH = 15;
+/**
+ * A wrapper around `k-bucket`, to provide easy store and
+ * retrieval for peers.
+ */
+export class RoutingTableRefresh {
+    constructor(options) {
+        const { peerRouting, routingTable, refreshInterval, refreshQueryTimeout, lan } = options;
+        this.log = logger(`libp2p:kad-dht:${lan ? 'lan' : 'wan'}:routing-table:refresh`);
+        this.peerRouting = peerRouting;
+        this.routingTable = routingTable;
+        this.refreshInterval = refreshInterval ?? TABLE_REFRESH_INTERVAL;
+        this.refreshQueryTimeout = refreshQueryTimeout ?? TABLE_REFRESH_QUERY_TIMEOUT;
+        this.commonPrefixLengthRefreshedAt = [];
+        this.refreshTable = this.refreshTable.bind(this);
+    }
+    async start() {
+        this.log(`refreshing routing table every ${this.refreshInterval}ms`);
+        this.refreshTable(true);
+    }
+    async stop() {
+        if (this.refreshTimeoutId != null) {
+            clearTimeout(this.refreshTimeoutId);
+        }
+    }
+    /**
+     * To speed lookups, we seed the table with random PeerIds. This means
+     * when we are asked to locate a peer on the network, we can find a KadId
+     * that is close to the requested peer ID and query that, then network
+     * peers will tell us who they know who is close to the fake ID
+     */
+    refreshTable(force = false) {
+        this.log('refreshing routing table');
+        const prefixLength = this._maxCommonPrefix();
+        const refreshCpls = this._getTrackedCommonPrefixLengthsForRefresh(prefixLength);
+        this.log(`max common prefix length ${prefixLength}`);
+        this.log(`tracked CPLs [ ${refreshCpls.map(date => date.toISOString()).join(', ')} ]`);
+        /**
+         * If we see a gap at a common prefix length in the Routing table, we ONLY refresh up until
+         * the maximum cpl we have in the Routing Table OR (2 * (Cpl+ 1) with the gap), whichever
+         * is smaller.
+         *
+         * This is to prevent refreshes for Cpls that have no peers in the network but happen to be
+         * before a very high max Cpl for which we do have peers in the network.
+         *
+         * The number of 2 * (Cpl + 1) can be proved and a proof would have been written here if
+         * the programmer had paid more attention in the Math classes at university.
+         *
+         * So, please be patient and a doc explaining it will be published soon.
+         *
+         * https://github.com/libp2p/go-libp2p-kad-dht/commit/2851c88acb0a3f86bcfe3cfd0f4604a03db801d8#diff-ad45f4ba97ffbc4083c2eb87a4420c1157057b233f048030d67c6b551855ccf6R219
+         */
+        Promise.all(refreshCpls.map(async (lastRefresh, index) => {
+            try {
+                await this._refreshCommonPrefixLength(index, lastRefresh, force);
+                if (this._numPeersForCpl(prefixLength) === 0) {
+                    const lastCpl = Math.min(2 * (index + 1), refreshCpls.length - 1);
+                    for (let n = index + 1; n < lastCpl + 1; n++) {
+                        try {
+                            await this._refreshCommonPrefixLength(n, lastRefresh, force);
+                        }
+                        catch (err) {
+                            this.log.error(err);
+                        }
+                    }
+                }
+            }
+            catch (err) {
+                this.log.error(err);
+            }
+        })).catch(err => {
+            this.log.error(err);
+        }).then(() => {
+            this.refreshTimeoutId = setTimeout(this.refreshTable, this.refreshInterval);
+            if (this.refreshTimeoutId.unref != null) {
+                this.refreshTimeoutId.unref();
+            }
+        }).catch(err => {
+            this.log.error(err);
+        });
+    }
+    async _refreshCommonPrefixLength(cpl, lastRefresh, force) {
+        if (!force && lastRefresh.getTime() > (Date.now() - this.refreshInterval)) {
+            this.log('not running refresh for cpl %s as time since last refresh not above interval', cpl);
+            return;
+        }
+        // gen a key for the query to refresh the cpl
+        const peerId = await this._generateRandomPeerId(cpl);
+        this.log('starting refreshing cpl %s with key %p (routing table size was %s)', cpl, peerId, this.routingTable.size);
+        const controller = new TimeoutController(this.refreshQueryTimeout);
+        try {
+            const peers = await length(this.peerRouting.getClosestPeers(peerId.toBytes(), { signal: controller.signal }));
+            this.log(`found ${peers} peers that were close to imaginary peer %p`, peerId);
+            this.log('finished refreshing cpl %s with key %p (routing table size is now %s)', cpl, peerId, this.routingTable.size);
+        }
+        finally {
+            controller.clear();
+        }
+    }
+    _getTrackedCommonPrefixLengthsForRefresh(maxCommonPrefix) {
+        if (maxCommonPrefix > MAX_COMMON_PREFIX_LENGTH) {
+            maxCommonPrefix = MAX_COMMON_PREFIX_LENGTH;
+        }
+        const dates = [];
+        for (let i = 0; i <= maxCommonPrefix; i++) {
+            // defaults to the zero value if we haven't refreshed it yet.
+            dates[i] = this.commonPrefixLengthRefreshedAt[i] ?? new Date();
+        }
+        return dates;
+    }
+    async _generateRandomPeerId(targetCommonPrefixLength) {
+        if (this.routingTable.kb == null) {
+            throw new Error('Routing table not started');
+        }
+        const randomData = randomBytes(2);
+        const randomUint16 = (randomData[1] << 8) + randomData[0];
+        const key = await this._makePeerId(this.routingTable.kb.localNodeId, randomUint16, targetCommonPrefixLength);
+        return peerIdFromBytes(key);
+    }
+    async _makePeerId(localKadId, randomPrefix, targetCommonPrefixLength) {
+        if (targetCommonPrefixLength > MAX_COMMON_PREFIX_LENGTH) {
+            throw new Error(`Cannot generate peer ID for common prefix length greater than ${MAX_COMMON_PREFIX_LENGTH}`);
+        }
+        const view = new DataView(localKadId.buffer, localKadId.byteOffset, localKadId.byteLength);
+        const localPrefix = view.getUint16(0, false);
+        // For host with ID `L`, an ID `K` belongs to a bucket with ID `B` ONLY IF CommonPrefixLen(L,K) is EXACTLY B.
+        // Hence, to achieve a targetPrefix `T`, we must toggle the (T+1)th bit in L & then copy (T+1) bits from L
+        // to our randomly generated prefix.
+        const toggledLocalPrefix = localPrefix ^ (0x8000 >> targetCommonPrefixLength);
+        // Combine the toggled local prefix and the random bits at the correct offset
+        // such that ONLY the first `targetCommonPrefixLength` bits match the local ID.
+        const mask = 65535 << (16 - (targetCommonPrefixLength + 1));
+        const targetPrefix = (toggledLocalPrefix & mask) | (randomPrefix & ~mask);
+        // Convert to a known peer ID.
+        const keyPrefix = GENERATED_PREFIXES[targetPrefix];
+        const keyBuffer = new ArrayBuffer(34);
+        const keyView = new DataView(keyBuffer, 0, keyBuffer.byteLength);
+        keyView.setUint8(0, sha256.code);
+        keyView.setUint8(1, 32);
+        keyView.setUint32(2, keyPrefix, false);
+        return new Uint8Array(keyView.buffer, keyView.byteOffset, keyView.byteLength);
+    }
+    /**
+     * returns the maximum common prefix length between any peer in the table
+     * and the current peer
+     */
+    _maxCommonPrefix() {
+        // xor our KadId with every KadId in the k-bucket tree,
+        // return the longest id prefix that is the same
+        let prefixLength = 0;
+        for (const length of this._prefixLengths()) {
+            if (length > prefixLength) {
+                prefixLength = length;
+            }
+        }
+        return prefixLength;
+    }
+    /**
+     * Returns the number of peers in the table with a given prefix length
+     */
+    _numPeersForCpl(prefixLength) {
+        let count = 0;
+        for (const length of this._prefixLengths()) {
+            if (length === prefixLength) {
+                count++;
+            }
+        }
+        return count;
+    }
+    /**
+     * Yields the common prefix length of every peer in the table
+     */
+    *_prefixLengths() {
+        if (this.routingTable.kb == null) {
+            return;
+        }
+        for (const { id } of this.routingTable.kb.toIterable()) {
+            const distance = uint8ArrayXor(this.routingTable.kb.localNodeId, id);
+            let leadingZeros = 0;
+            for (const byte of distance) {
+                if (byte === 0) {
+                    leadingZeros++;
+                }
+                else {
+                    break;
+                }
+            }
+            yield leadingZeros;
+        }
+    }
+}
+//# sourceMappingURL=refresh.js.map

package/dist/src/routing-table/refresh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refresh.js","sourceRoot":"","sources":["../../../src/routing-table/refresh.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,IAAI,aAAa,EAAE,MAAM,iBAAiB,CAAA;AACtD,OAAO,kBAAkB,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAC5C,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AACvC,OAAO,MAAM,MAAM,WAAW,CAAA;AAC9B,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAA;AAKrF;;GAEG;AACH,MAAM,wBAAwB,GAAG,EAAE,CAAA;AAUnC;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAS9B,YAAa,OAAmC;QAC9C,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,eAAe,EAAE,mBAAmB,EAAE,GAAG,EAAE,GAAG,OAAO,CAAA;QACxF,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,kBAAkB,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,wBAAwB,CAAC,CAAA;QAChF,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,eAAe,GAAG,eAAe,IAAI,sBAAsB,CAAA;QAChE,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,IAAI,2BAA2B,CAAA;QAC7E,IAAI,CAAC,6BAA6B,GAAG,EAAE,CAAA;QAEvC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,GAAG,CAAC,kCAAkC,IAAI,CAAC,eAAe,IAAI,CAAC,CAAA;QACpE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,EAAE;YACjC,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;SACpC;IACH,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAE,QAAiB,KAAK;QAClC,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;QAEpC,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,wCAAwC,CAAC,YAAY,CAAC,CAAA;QAE/E,IAAI,CAAC,GAAG,CAAC,4BAA4B,YAAY,EAAE,CAAC,CAAA;QACpD,IAAI,CAAC,GAAG,CAAC,kBAAkB,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEtF;;;;;;;;;;;;;;WAcG;QACH,OAAO,CAAC,GAAG,CACT,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE;YAC3C,IAAI;gBACF,MAAM,IAAI,CAAC,0BAA0B,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;gBAEhE,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;oBAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;oBAEjE,KAAK,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;wBAC5C,IAAI;4BACF,MAAM,IAAI,CAAC,0BAA0B,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;yBAC7D;wBAAC,OAAO,GAAQ,EAAE;4BACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;yBACpB;qBACF;iBACF;aACF;YAAC,OAAO,GAAQ,EAAE;gBACjB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;aACpB;QACH,CAAC,CAAC,CACH,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACZ,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACX,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,eAAe,CAAC,CAAA;YAE3E,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,IAAI,IAAI,EAAE;gBACvC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,CAAA;aAC9B;QACH,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;YACb,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,CAAC,0BAA0B,CAAE,GAAW,EAAE,WAAiB,EAAE,KAAc;QAC9E,IAAI,CAAC,KAAK,IAAI,WAAW,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,EAAE;YACzE,IAAI,CAAC,GAAG,CAAC,8EAA8E,EAAE,GAAG,CAAC,CAAA;YAC7F,OAAM;SACP;QAED,6CAA6C;QAC7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAA;QAEpD,IAAI,CAAC,GAAG,CAAC,oEAAoE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAEnH,MAAM,UAAU,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAElE,IAAI;YACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;YAE7G,IAAI,CAAC,GAAG,CAAC,SAAS,KAAK,6CAA6C,EAAE,MAAM,CAAC,CAAA;YAC7E,IAAI,CAAC,GAAG,CAAC,uEAAuE,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;SACvH;gBAAS;YACR,UAAU,CAAC,KAAK,EAAE,CAAA;SACnB;IACH,CAAC;IAED,wCAAwC,CAAE,eAAuB;QAC/D,IAAI,eAAe,GAAG,wBAAwB,EAAE;YAC9C,eAAe,GAAG,wBAAwB,CAAA;SAC3C;QAED,MAAM,KAAK,GAAG,EAAE,CAAA;QAEhB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC,EAAE,EAAE;YACzC,6DAA6D;YAC7D,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,6BAA6B,CAAC,CAAC,CAAC,IAAI,IAAI,IAAI,EAAE,CAAA;SAC/D;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED,KAAK,CAAC,qBAAqB,CAAE,wBAAgC;QAC3D,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,IAAI,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;SAC7C;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;QACjC,MAAM,YAAY,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QAEzD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAA;QAE5G,OAAO,eAAe,CAAC,GAAG,CAAC,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,WAAW,CAAE,UAAsB,EAAE,YAAoB,EAAE,wBAAgC;QAC/F,IAAI,wBAAwB,GAAG,wBAAwB,EAAE;YACvD,MAAM,IAAI,KAAK,CAAC,iEAAiE,wBAAwB,EAAE,CAAC,CAAA;SAC7G;QAED,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,CAAA;QAC1F,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA;QAE5C,6GAA6G;QAC7G,0GAA0G;QAC1G,oCAAoC;QACpC,MAAM,kBAAkB,GAAG,WAAW,GAAG,CAAC,MAAM,IAAI,wBAAwB,CAAC,CAAA;QAE7E,6EAA6E;QAC7E,+EAA+E;QAC/E,MAAM,IAAI,GAAG,KAAK,IAAI,CAAC,EAAE,GAAG,CAAC,wBAAwB,GAAG,CAAC,CAAC,CAAC,CAAA;QAC3D,MAAM,YAAY,GAAG,CAAC,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,CAAA;QAEzE,8BAA8B;QAC9B,MAAM,SAAS,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAA;QAElD,MAAM,SAAS,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAA;QACrC,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,CAAA;QAChE,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;QAChC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACvB,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,CAAA;QAEtC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/E,CAAC;IAED;;;OAGG;IACH,gBAAgB;QACd,uDAAuD;QACvD,gDAAgD;QAChD,IAAI,YAAY,GAAG,CAAC,CAAA;QAEpB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE;YAC1C,IAAI,MAAM,GAAG,YAAY,EAAE;gBACzB,YAAY,GAAG,MAAM,CAAA;aACtB;SACF;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,eAAe,CAAE,YAAoB;QACnC,IAAI,KAAK,GAAG,CAAC,CAAA;QAEb,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE;YAC1C,IAAI,MAAM,KAAK,YAAY,EAAE;gBAC3B,KAAK,EAAE,CAAA;aACR;SACF;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,CAAE,cAAc;QACd,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,IAAI,IAAI,EAAE;YAChC,OAAM;SACP;QAED,KAAK,MAAM,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,EAAE;YACtD,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YACpE,IAAI,YAAY,GAAG,CAAC,CAAA;YAEpB,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE;gBAC3B,IAAI,IAAI,KAAK,CAAC,EAAE;oBACd,YAAY,EAAE,CAAA;iBACf;qBAAM;oBACL,MAAK;iBACN;aACF;YAED,MAAM,YAAY,CAAA;SACnB;IACH,CAAC;CACF"}

package/dist/src/routing-table/types.d.ts

@@ -0,0 +1,24 @@
+import type PeerId from 'peer-id';
+export interface KBucketPeer {
+    id: Uint8Array;
+    peer: PeerId;
+}
+export interface KBucket {
+    id: Uint8Array;
+    contacts: KBucketPeer[];
+    dontSplit: boolean;
+    left: KBucket;
+    right: KBucket;
+}
+export interface KBucketTree {
+    root: KBucket;
+    localNodeId: Uint8Array;
+    on: (event: 'ping', callback: (oldContacts: KBucketPeer[], newContact: KBucketPeer) => void) => void;
+    closest: (key: Uint8Array, count: number) => KBucketPeer[];
+    closestPeer: (key: Uint8Array) => KBucketPeer;
+    remove: (key: Uint8Array) => void;
+    add: (peer: KBucketPeer) => void;
+    count: () => number;
+    toIterable: () => Iterable<KBucket>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/src/routing-table/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/routing-table/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,SAAS,CAAA;AAEjC,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,UAAU,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,QAAQ,EAAE,WAAW,EAAE,CAAA;IACvB,SAAS,EAAE,OAAO,CAAA;IAClB,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,UAAU,CAAA;IACvB,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,EAAE,EAAE,UAAU,EAAE,WAAW,KAAK,IAAI,KAAK,IAAI,CAAA;IACpG,OAAO,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,KAAK,WAAW,EAAE,CAAA;IAC1D,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,WAAW,CAAA;IAC7C,MAAM,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,IAAI,CAAA;IACjC,GAAG,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAA;IAChC,KAAK,EAAE,MAAM,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,QAAQ,CAAC,OAAO,CAAC,CAAA;CACpC"}

package/dist/src/rpc/handlers/add-provider.d.ts

@@ -0,0 +1,13 @@
+import type { Providers } from '../../providers';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { DHTMessageHandler } from '../index.js';
+import type { Message } from '../../message/index.js';
+export interface AddProviderHandlerOptions {
+    providers: Providers;
+}
+export declare class AddProviderHandler implements DHTMessageHandler {
+    private readonly providers;
+    constructor(options: AddProviderHandlerOptions);
+    handle(peerId: PeerId, msg: Message): Promise<undefined>;
+}
+//# sourceMappingURL=add-provider.d.ts.map

package/dist/src/rpc/handlers/add-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-provider.d.ts","sourceRoot":"","sources":["../../../../src/rpc/handlers/add-provider.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAChD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAIrD,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,qBAAa,kBAAmB,YAAW,iBAAiB;IAC1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;gBAExB,OAAO,EAAE,yBAAyB;IAKzC,MAAM,CAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO;CAwC3C"}

package/dist/src/rpc/handlers/add-provider.js

@@ -0,0 +1,42 @@
+import { CID } from 'multiformats/cid';
+import errcode from 'err-code';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:kad-dht:rpc:handlers:add-provider');
+export class AddProviderHandler {
+    constructor(options) {
+        const { providers } = options;
+        this.providers = providers;
+    }
+    async handle(peerId, msg) {
+        log('start');
+        if (msg.key == null || msg.key.length === 0) {
+            throw errcode(new Error('Missing key'), 'ERR_MISSING_KEY');
+        }
+        let cid;
+        try {
+            // this is actually just the multihash, not the whole CID
+            cid = CID.decode(msg.key);
+        }
+        catch (err) {
+            throw errcode(new Error('Invalid CID'), 'ERR_INVALID_CID');
+        }
+        if (msg.providerPeers == null || msg.providerPeers.length === 0) {
+            log.error('no providers found in message');
+        }
+        await Promise.all(msg.providerPeers.map(async (pi) => {
+            // Ignore providers not from the originator
+            if (!pi.id.equals(peerId)) {
+                log('invalid provider peer %p from %p', pi.id, peerId);
+                return;
+            }
+            if (pi.multiaddrs.length < 1) {
+                log('no valid addresses for provider %p. Ignore', peerId);
+                return;
+            }
+            log('received provider %p for %s (addrs %s)', peerId, cid, pi.multiaddrs.map((m) => m.toString()));
+            await this.providers.addProvider(cid, pi.id);
+        }));
+        return undefined;
+    }
+}
+//# sourceMappingURL=add-provider.js.map

package/dist/src/rpc/handlers/add-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-provider.js","sourceRoot":"","sources":["../../../../src/rpc/handlers/add-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,OAAO,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAMvC,MAAM,GAAG,GAAG,MAAM,CAAC,0CAA0C,CAAC,CAAA;AAM9D,MAAM,OAAO,kBAAkB;IAG7B,YAAa,OAAkC;QAC7C,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAA;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAED,KAAK,CAAC,MAAM,CAAE,MAAc,EAAE,GAAY;QACxC,GAAG,CAAC,OAAO,CAAC,CAAA;QAEZ,IAAI,GAAG,CAAC,GAAG,IAAI,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE;YAC3C,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAC,CAAA;SAC3D;QAED,IAAI,GAAQ,CAAA;QACZ,IAAI;YACF,yDAAyD;YACzD,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;SAC1B;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,OAAO,CAAC,IAAI,KAAK,CAAC,aAAa,CAAC,EAAE,iBAAiB,CAAC,CAAA;SAC3D;QAED,IAAI,GAAG,CAAC,aAAa,IAAI,IAAI,IAAI,GAAG,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC/D,GAAG,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAA;SAC3C;QAED,MAAM,OAAO,CAAC,GAAG,CACf,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;YACjC,2CAA2C;YAC3C,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;gBACzB,GAAG,CAAC,kCAAkC,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;gBACtD,OAAM;aACP;YAED,IAAI,EAAE,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC5B,GAAG,CAAC,4CAA4C,EAAE,MAAM,CAAC,CAAA;gBACzD,OAAM;aACP;YAED,GAAG,CAAC,wCAAwC,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;YAElG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,CAAA;QAC9C,CAAC,CAAC,CACH,CAAA;QAED,OAAO,SAAS,CAAA;IAClB,CAAC;CACF"}