@libp2p/kad-dht 9.3.2 → 9.3.4

package/dist/src/routing-table/k-bucket.js

@@ -0,0 +1,409 @@
+/*
+index.js - Kademlia DHT K-bucket implementation as a binary tree.
+
+The MIT License (MIT)
+
+Copyright (c) 2013-2021 Tristan Slominski
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+*/
+import { EventEmitter } from '@libp2p/interfaces/events';
+function arrayEquals(array1, array2) {
+    if (array1 === array2) {
+        return true;
+    }
+    if (array1.length !== array2.length) {
+        return false;
+    }
+    for (let i = 0, length = array1.length; i < length; ++i) {
+        if (array1[i] !== array2[i]) {
+            return false;
+        }
+    }
+    return true;
+}
+function createNode() {
+    // @ts-expect-error loose types
+    return { contacts: [], dontSplit: false, left: null, right: null };
+}
+function ensureInt8(name, val) {
+    if (!(val instanceof Uint8Array)) {
+        throw new TypeError(name + ' is not a Uint8Array');
+    }
+}
+/**
+ * Implementation of a Kademlia DHT k-bucket used for storing
+ * contact (peer node) information.
+ *
+ * @extends EventEmitter
+ */
+export class KBucket extends EventEmitter {
+    localNodeId;
+    root;
+    numberOfNodesPerKBucket;
+    numberOfNodesToPing;
+    distance;
+    arbiter;
+    constructor(options) {
+        super();
+        this.localNodeId = options.localNodeId;
+        this.numberOfNodesPerKBucket = options.numberOfNodesPerKBucket ?? 20;
+        this.numberOfNodesToPing = options.numberOfNodesToPing ?? 3;
+        this.distance = options.distance ?? KBucket.distance;
+        // use an arbiter from options or vectorClock arbiter by default
+        this.arbiter = options.arbiter ?? KBucket.arbiter;
+        ensureInt8('option.localNodeId as parameter 1', this.localNodeId);
+        this.root = createNode();
+    }
+    /**
+     * Default arbiter function for contacts with the same id. Uses
+     * contact.vectorClock to select which contact to update the k-bucket with.
+     * Contact with larger vectorClock field will be selected. If vectorClock is
+     * the same, candidate will be selected.
+     *
+     * @param {object} incumbent - Contact currently stored in the k-bucket.
+     * @param {object} candidate - Contact being added to the k-bucket.
+     * @returns {object} Contact to updated the k-bucket with.
+     */
+    static arbiter(incumbent, candidate) {
+        return (incumbent.vectorClock ?? 0) > (candidate.vectorClock ?? 0) ? incumbent : candidate;
+    }
+    /**
+     * Default distance function. Finds the XOR
+     * distance between firstId and secondId.
+     *
+     * @param  {Uint8Array} firstId -  Uint8Array containing first id.
+     * @param  {Uint8Array} secondId -  Uint8Array containing second id.
+     * @returns {number} Integer The XOR distance between firstId and secondId.
+     */
+    static distance(firstId, secondId) {
+        let distance = 0;
+        let i = 0;
+        const min = Math.min(firstId.length, secondId.length);
+        const max = Math.max(firstId.length, secondId.length);
+        for (; i < min; ++i) {
+            distance = distance * 256 + (firstId[i] ^ secondId[i]);
+        }
+        for (; i < max; ++i)
+            distance = distance * 256 + 255;
+        return distance;
+    }
+    /**
+     * Adds a contact to the k-bucket.
+     *
+     * @param {object} contact - the contact object to add
+     */
+    add(contact) {
+        ensureInt8('contact.id', contact?.id);
+        let bitIndex = 0;
+        let node = this.root;
+        while (node.contacts === null) {
+            // this is not a leaf node but an inner node with 'low' and 'high'
+            // branches; we will check the appropriate bit of the identifier and
+            // delegate to the appropriate node for further processing
+            node = this._determineNode(node, contact.id, bitIndex++);
+        }
+        // check if the contact already exists
+        const index = this._indexOf(node, contact.id);
+        if (index >= 0) {
+            this._update(node, index, contact);
+            return this;
+        }
+        if (node.contacts.length < this.numberOfNodesPerKBucket) {
+            node.contacts.push(contact);
+            this.safeDispatchEvent('added', { detail: contact });
+            return this;
+        }
+        // the bucket is full
+        if (node.dontSplit) {
+            // we are not allowed to split the bucket
+            // we need to ping the first this.numberOfNodesToPing
+            // in order to determine if they are alive
+            // only if one of the pinged nodes does not respond, can the new contact
+            // be added (this prevents DoS flodding with new invalid contacts)
+            this.safeDispatchEvent('ping', {
+                detail: {
+                    oldContacts: node.contacts.slice(0, this.numberOfNodesToPing),
+                    newContact: contact
+                }
+            });
+            return this;
+        }
+        this._split(node, bitIndex);
+        return this.add(contact);
+    }
+    /**
+     * Get the n closest contacts to the provided node id. "Closest" here means:
+     * closest according to the XOR metric of the contact node id.
+     *
+     * @param {Uint8Array} id - Contact node id
+     * @param {number} n - Integer (Default: Infinity) The maximum number of closest contacts to return
+     * @returns {Array} Array Maximum of n closest contacts to the node id
+     */
+    closest(id, n = Infinity) {
+        ensureInt8('id', id);
+        if ((!Number.isInteger(n) && n !== Infinity) || n <= 0) {
+            throw new TypeError('n is not positive number');
+        }
+        let contacts = [];
+        for (let nodes = [this.root], bitIndex = 0; nodes.length > 0 && contacts.length < n;) {
+            const node = nodes.pop();
+            if (node == null) {
+                continue;
+            }
+            if (node.contacts === null) {
+                const detNode = this._determineNode(node, id, bitIndex++);
+                nodes.push(node.left === detNode ? node.right : node.left);
+                nodes.push(detNode);
+            }
+            else {
+                contacts = contacts.concat(node.contacts);
+            }
+        }
+        return contacts
+            .map(a => ({
+            distance: this.distance(a.id, id),
+            contact: a
+        }))
+            .sort((a, b) => a.distance - b.distance)
+            .slice(0, n)
+            .map(a => a.contact);
+    }
+    /**
+     * Counts the total number of contacts in the tree.
+     *
+     * @returns {number} The number of contacts held in the tree
+     */
+    count() {
+        // return this.toArray().length
+        let count = 0;
+        for (const nodes = [this.root]; nodes.length > 0;) {
+            const node = nodes.pop();
+            if (node == null) {
+                continue;
+            }
+            if (node.contacts === null) {
+                nodes.push(node.right, node.left);
+            }
+            else {
+                count += node.contacts.length;
+            }
+        }
+        return count;
+    }
+    /**
+     * Determines whether the id at the bitIndex is 0 or 1.
+     * Return left leaf if `id` at `bitIndex` is 0, right leaf otherwise
+     *
+     * @param {object} node - internal object that has 2 leafs: left and right
+     * @param {Uint8Array} id - Id to compare localNodeId with.
+     * @param {number} bitIndex - Integer (Default: 0) The bit index to which bit to check in the id Uint8Array.
+     * @returns {object} left leaf if id at bitIndex is 0, right leaf otherwise.
+     */
+    _determineNode(node, id, bitIndex) {
+        // **NOTE** remember that id is a Uint8Array and has granularity of
+        // bytes (8 bits), whereas the bitIndex is the _bit_ index (not byte)
+        // id's that are too short are put in low bucket (1 byte = 8 bits)
+        // (bitIndex >> 3) finds how many bytes the bitIndex describes
+        // bitIndex % 8 checks if we have extra bits beyond byte multiples
+        // if number of bytes is <= no. of bytes described by bitIndex and there
+        // are extra bits to consider, this means id has less bits than what
+        // bitIndex describes, id therefore is too short, and will be put in low
+        // bucket
+        const bytesDescribedByBitIndex = bitIndex >> 3;
+        const bitIndexWithinByte = bitIndex % 8;
+        if ((id.length <= bytesDescribedByBitIndex) && (bitIndexWithinByte !== 0)) {
+            return node.left;
+        }
+        const byteUnderConsideration = id[bytesDescribedByBitIndex];
+        // byteUnderConsideration is an integer from 0 to 255 represented by 8 bits
+        // where 255 is 11111111 and 0 is 00000000
+        // in order to find out whether the bit at bitIndexWithinByte is set
+        // we construct (1 << (7 - bitIndexWithinByte)) which will consist
+        // of all bits being 0, with only one bit set to 1
+        // for example, if bitIndexWithinByte is 3, we will construct 00010000 by
+        // (1 << (7 - 3)) -> (1 << 4) -> 16
+        if ((byteUnderConsideration & (1 << (7 - bitIndexWithinByte))) !== 0) {
+            return node.right;
+        }
+        return node.left;
+    }
+    /**
+     * Get a contact by its exact ID.
+     * If this is a leaf, loop through the bucket contents and return the correct
+     * contact if we have it or null if not. If this is an inner node, determine
+     * which branch of the tree to traverse and repeat.
+     *
+     * @param {Uint8Array} id - The ID of the contact to fetch.
+     * @returns {object | null} The contact if available, otherwise null
+     */
+    get(id) {
+        ensureInt8('id', id);
+        let bitIndex = 0;
+        let node = this.root;
+        while (node.contacts === null) {
+            node = this._determineNode(node, id, bitIndex++);
+        }
+        // index of uses contact id for matching
+        const index = this._indexOf(node, id);
+        return index >= 0 ? node.contacts[index] : undefined;
+    }
+    /**
+     * Returns the index of the contact with provided
+     * id if it exists, returns -1 otherwise.
+     *
+     * @param {object} node - internal object that has 2 leafs: left and right
+     * @param {Uint8Array} id - Contact node id.
+     * @returns {number} Integer Index of contact with provided id if it exists, -1 otherwise.
+     */
+    _indexOf(node, id) {
+        for (let i = 0; i < node.contacts.length; ++i) {
+            if (arrayEquals(node.contacts[i].id, id))
+                return i;
+        }
+        return -1;
+    }
+    /**
+     * Removes contact with the provided id.
+     *
+     * @param {Uint8Array} id - The ID of the contact to remove
+     * @returns {object} The k-bucket itself
+     */
+    remove(id) {
+        ensureInt8('the id as parameter 1', id);
+        let bitIndex = 0;
+        let node = this.root;
+        while (node.contacts === null) {
+            node = this._determineNode(node, id, bitIndex++);
+        }
+        const index = this._indexOf(node, id);
+        if (index >= 0) {
+            const contact = node.contacts.splice(index, 1)[0];
+            this.safeDispatchEvent('removed', {
+                detail: contact
+            });
+        }
+        return this;
+    }
+    /**
+     * Splits the node, redistributes contacts to the new nodes, and marks the
+     * node that was split as an inner node of the binary tree of nodes by
+     * setting this.root.contacts = null
+     *
+     * @param {object} node - node for splitting
+     * @param {number} bitIndex - the bitIndex to which byte to check in the Uint8Array for navigating the binary tree
+     */
+    _split(node, bitIndex) {
+        node.left = createNode();
+        node.right = createNode();
+        // redistribute existing contacts amongst the two newly created nodes
+        for (const contact of node.contacts) {
+            this._determineNode(node, contact.id, bitIndex).contacts.push(contact);
+        }
+        // @ts-expect-error loose types
+        node.contacts = null; // mark as inner tree node
+        // don't split the "far away" node
+        // we check where the local node would end up and mark the other one as
+        // "dontSplit" (i.e. "far away")
+        const detNode = this._determineNode(node, this.localNodeId, bitIndex);
+        const otherNode = node.left === detNode ? node.right : node.left;
+        otherNode.dontSplit = true;
+    }
+    /**
+     * Returns all the contacts contained in the tree as an array.
+     * If this is a leaf, return a copy of the bucket. If this is not a leaf,
+     * return the union of the low and high branches (themselves also as arrays).
+     *
+     * @returns {Array} All of the contacts in the tree, as an array
+     */
+    toArray() {
+        let result = [];
+        for (const nodes = [this.root]; nodes.length > 0;) {
+            const node = nodes.pop();
+            if (node == null) {
+                continue;
+            }
+            if (node.contacts === null) {
+                nodes.push(node.right, node.left);
+            }
+            else {
+                result = result.concat(node.contacts);
+            }
+        }
+        return result;
+    }
+    /**
+     * Similar to `toArray()` but instead of buffering everything up into an
+     * array before returning it, yields contacts as they are encountered while
+     * walking the tree.
+     *
+     * @returns {Iterable} All of the contacts in the tree, as an iterable
+     */
+    *toIterable() {
+        for (const nodes = [this.root]; nodes.length > 0;) {
+            const node = nodes.pop();
+            if (node == null) {
+                continue;
+            }
+            if (node.contacts === null) {
+                nodes.push(node.right, node.left);
+            }
+            else {
+                yield* node.contacts;
+            }
+        }
+    }
+    /**
+     * Updates the contact selected by the arbiter.
+     * If the selection is our old contact and the candidate is some new contact
+     * then the new contact is abandoned (not added).
+     * If the selection is our old contact and the candidate is our old contact
+     * then we are refreshing the contact and it is marked as most recently
+     * contacted (by being moved to the right/end of the bucket array).
+     * If the selection is our new contact, the old contact is removed and the new
+     * contact is marked as most recently contacted.
+     *
+     * @param {object} node - internal object that has 2 leafs: left and right
+     * @param {number} index - the index in the bucket where contact exists (index has already been computed in a previous calculation)
+     * @param {object} contact - The contact object to update
+     */
+    _update(node, index, contact) {
+        // sanity check
+        if (!arrayEquals(node.contacts[index].id, contact.id)) {
+            throw new Error('wrong index for _update');
+        }
+        const incumbent = node.contacts[index];
+        const selection = this.arbiter(incumbent, contact);
+        // if the selection is our old contact and the candidate is some new
+        // contact, then there is nothing to do
+        if (selection === incumbent && incumbent !== contact)
+            return;
+        node.contacts.splice(index, 1); // remove old contact
+        node.contacts.push(selection); // add more recent contact version
+        this.safeDispatchEvent('updated', {
+            detail: {
+                incumbent, selection
+            }
+        });
+    }
+}
+//# sourceMappingURL=k-bucket.js.map

package/dist/src/routing-table/k-bucket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"k-bucket.js","sourceRoot":"","sources":["../../../src/routing-table/k-bucket.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;EA2BE;AAEF,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAGxD,SAAS,WAAW,CAAE,MAAkB,EAAE,MAAkB;IAC1D,IAAI,MAAM,KAAK,MAAM,EAAE;QACrB,OAAO,IAAI,CAAA;KACZ;IACD,IAAI,MAAM,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE;QACnC,OAAO,KAAK,CAAA;KACb;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE;QACvD,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE;YAC3B,OAAO,KAAK,CAAA;SACb;KACF;IACD,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,UAAU;IACjB,+BAA+B;IAC/B,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAA;AACpE,CAAC;AAED,SAAS,UAAU,CAAE,IAAY,EAAE,GAAgB;IACjD,IAAI,CAAC,CAAC,GAAG,YAAY,UAAU,CAAC,EAAE;QAChC,MAAM,IAAI,SAAS,CAAC,IAAI,GAAG,sBAAsB,CAAC,CAAA;KACnD;AACH,CAAC;AAiED;;;;;GAKG;AACH,MAAM,OAAO,OAAQ,SAAQ,YAA2B;IAC/C,WAAW,CAAY;IACvB,IAAI,CAAQ;IACF,uBAAuB,CAAQ;IAC/B,mBAAmB,CAAQ;IAC3B,QAAQ,CAA0C;IAClD,OAAO,CAAqD;IAE7E,YAAa,OAAuB;QAClC,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAA;QACtC,IAAI,CAAC,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,IAAI,EAAE,CAAA;QACpE,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,IAAI,CAAC,CAAA;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAA;QACpD,gEAAgE;QAChE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAA;QAEjD,UAAU,CAAC,mCAAmC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;QAEjE,IAAI,CAAC,IAAI,GAAG,UAAU,EAAE,CAAA;IAC1B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,OAAO,CAAE,SAAkB,EAAE,SAAkB;QACpD,OAAO,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IAC5F,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAE,OAAmB,EAAE,QAAoB;QACxD,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,CAAC,CAAA;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAA;QACrD,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC,EAAE;YACnB,QAAQ,GAAG,QAAQ,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAA;SACvD;QACD,OAAO,CAAC,GAAG,GAAG,EAAE,EAAE,CAAC;YAAE,QAAQ,GAAG,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAA;QACpD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAE,OAAgB;QACnB,UAAU,CAAC,YAAY,EAAE,OAAO,EAAE,EAAE,CAAC,CAAA;QAErC,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QAEpB,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;YAC7B,kEAAkE;YAClE,oEAAoE;YACpE,0DAA0D;YAC1D,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;SACzD;QAED,sCAAsC;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,CAAC,CAAA;QAC7C,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;YAClC,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,IAAI,CAAC,uBAAuB,EAAE;YACvD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC3B,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;YACpD,OAAO,IAAI,CAAA;SACZ;QAED,qBAAqB;QACrB,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,yCAAyC;YACzC,qDAAqD;YACrD,0CAA0C;YAC1C,wEAAwE;YACxE,kEAAkE;YAClE,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE;gBAC7B,MAAM,EAAE;oBACN,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC;oBAC7D,UAAU,EAAE,OAAO;iBACpB;aACF,CAAC,CAAA;YACF,OAAO,IAAI,CAAA;SACZ;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAE,EAAc,EAAE,CAAC,GAAG,QAAQ;QACnC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAEpB,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YACtD,MAAM,IAAI,SAAS,CAAC,0BAA0B,CAAC,CAAA;SAChD;QAED,IAAI,QAAQ,GAAc,EAAE,CAAA;QAE5B,KAAK,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,QAAQ,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG;YACpF,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAA;YAExB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,SAAQ;aACT;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;gBAC1B,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;gBACzD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBAC1D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;aACpB;iBAAM;gBACL,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aAC1C;SACF;QAED,OAAO,QAAQ;aACZ,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACT,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;SACX,CAAC,CAAC;aACF,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC;aACvC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;aACX,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;IACxB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,+BAA+B;QAC/B,IAAI,KAAK,GAAG,CAAC,CAAA;QACb,KAAK,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAA;YAExB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,SAAQ;aACT;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;gBAC1B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;aAClC;iBAAM;gBACL,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAA;aAC9B;SACF;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,cAAc,CAAE,IAAS,EAAE,EAAc,EAAE,QAAgB;QACzD,mEAAmE;QACnE,qEAAqE;QAErE,kEAAkE;QAClE,8DAA8D;QAC9D,kEAAkE;QAClE,wEAAwE;QACxE,oEAAoE;QACpE,wEAAwE;QACxE,SAAS;QACT,MAAM,wBAAwB,GAAG,QAAQ,IAAI,CAAC,CAAA;QAC9C,MAAM,kBAAkB,GAAG,QAAQ,GAAG,CAAC,CAAA;QACvC,IAAI,CAAC,EAAE,CAAC,MAAM,IAAI,wBAAwB,CAAC,IAAI,CAAC,kBAAkB,KAAK,CAAC,CAAC,EAAE;YACzE,OAAO,IAAI,CAAC,IAAI,CAAA;SACjB;QAED,MAAM,sBAAsB,GAAG,EAAE,CAAC,wBAAwB,CAAC,CAAA;QAE3D,2EAA2E;QAC3E,0CAA0C;QAC1C,oEAAoE;QACpE,kEAAkE;QAClE,kDAAkD;QAClD,yEAAyE;QACzE,mCAAmC;QACnC,IAAI,CAAC,sBAAsB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE;YACpE,OAAO,IAAI,CAAC,KAAK,CAAA;SAClB;QAED,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAE,EAAc;QACjB,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QAEpB,IAAI,QAAQ,GAAG,CAAC,CAAA;QAEhB,IAAI,IAAI,GAAW,IAAI,CAAC,IAAI,CAAA;QAC5B,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;SACjD;QAED,wCAAwC;QACxC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACrC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACtD,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAE,IAAY,EAAE,EAAc;QACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YAC7C,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC;gBAAE,OAAO,CAAC,CAAA;SACnD;QAED,OAAO,CAAC,CAAC,CAAA;IACX,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAE,EAAc;QACpB,UAAU,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAA;QAEvC,IAAI,QAAQ,GAAG,CAAC,CAAA;QAChB,IAAI,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QAEpB,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;YAC7B,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;SACjD;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACrC,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACjD,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;gBAChC,MAAM,EAAE,OAAO;aAChB,CAAC,CAAA;SACH;QAED,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAE,IAAY,EAAE,QAAgB;QACpC,IAAI,CAAC,IAAI,GAAG,UAAU,EAAE,CAAA;QACxB,IAAI,CAAC,KAAK,GAAG,UAAU,EAAE,CAAA;QAEzB,qEAAqE;QACrE,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE;YACnC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;SACvE;QAED,+BAA+B;QAC/B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA,CAAC,0BAA0B;QAE/C,kCAAkC;QAClC,uEAAuE;QACvE,gCAAgC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;QACrE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAA;QAChE,SAAS,CAAC,SAAS,GAAG,IAAI,CAAA;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,IAAI,MAAM,GAAc,EAAE,CAAA;QAC1B,KAAK,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAA;YAExB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,SAAQ;aACT;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;gBAC1B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;aAClC;iBAAM;gBACL,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtC;SACF;QACD,OAAO,MAAM,CAAA;IACf,CAAC;IAED;;;;;;OAMG;IACH,CAAE,UAAU;QACV,KAAK,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG;YACjD,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAA;YAExB,IAAI,IAAI,IAAI,IAAI,EAAE;gBAChB,SAAQ;aACT;YAED,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI,EAAE;gBAC1B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAA;aAClC;iBAAM;gBACL,KAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAA;aACtB;SACF;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAE,IAAY,EAAE,KAAa,EAAE,OAAgB;QACpD,eAAe;QACf,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,CAAA;QAClD,oEAAoE;QACpE,uCAAuC;QACvC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,OAAO;YAAE,OAAM;QAE5D,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA,CAAC,qBAAqB;QACpD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA,CAAC,kCAAkC;QAChE,IAAI,CAAC,iBAAiB,CAAC,SAAS,EAAE;YAChC,MAAM,EAAE;gBACN,SAAS,EAAE,SAAS;aACrB;SACF,CAAC,CAAA;IACJ,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/kad-dht",
-  "version": "9.3.2",
+  "version": "9.3.4",
   "description": "JavaScript implementation of the Kad-DHT for libp2p",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-kad-dht#readme",
@@ -137,7 +137,7 @@
     "test:chrome-webworker": "aegir test -t webworker",
     "test:firefox": "aegir test -t browser -- --browser firefox",
     "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
-    "dep-check": "aegir dep-check -i protons",
+    "dep-check": "aegir dep-check -i protons -i events",
     "release": "aegir release",
     "docs": "aegir docs"
   },
@@ -165,6 +165,7 @@
     "abortable-iterator": "^5.0.1",
     "any-signal": "^4.1.1",
     "datastore-core": "^9.0.1",
+    "events": "^3.3.0",
     "hashlru": "^2.3.0",
     "interface-datastore": "^8.0.0",
     "it-all": "^3.0.1",
@@ -178,7 +179,6 @@
     "it-pipe": "^3.0.0",
     "it-stream-types": "^2.0.1",
     "it-take": "^3.0.1",
-    "k-bucket": "^5.1.0",
     "multiformats": "^11.0.0",
     "p-defer": "^4.0.0",
     "p-queue": "^7.3.4",

package/src/routing-table/index.ts

@@ -1,9 +1,8 @@
 import { logger } from '@libp2p/logger'
 import { PeerSet } from '@libp2p/peer-collections'
-// @ts-expect-error no types
-import KBuck from 'k-bucket'
 import Queue from 'p-queue'
 import * as utils from '../utils.js'
+import { KBucket, type PingEventDetails } from './k-bucket.js'
 import type { ConnectionManager } from '@libp2p/interface-connection-manager'
 import type { Metric, Metrics } from '@libp2p/interface-metrics'
 import type { PeerId } from '@libp2p/interface-peer-id'
@@ -17,42 +16,6 @@ export const KBUCKET_SIZE = 20
 export const PING_TIMEOUT = 10000
 export const PING_CONCURRENCY = 10
 
-export interface KBucketPeer {
-  id: Uint8Array
-  peer: PeerId
-}
-
-export interface KBucket {
-  id: Uint8Array
-  contacts: KBucketPeer[]
-  dontSplit: boolean
-  left: KBucket
-  right: KBucket
-}
-
-interface KBucketTreeEvents {
-  'ping': (oldContacts: KBucketPeer[], newContact: KBucketPeer) => void
-  'added': (contact: KBucketPeer) => void
-  'removed': (contact: KBucketPeer) => void
-}
-
-export interface KBucketTree {
-  root: KBucket
-  localNodeId: Uint8Array
-
-  on: <U extends keyof KBucketTreeEvents>(
-    event: U, listener: KBucketTreeEvents[U]
-  ) => this
-
-  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<KBucketPeer>
-}
-
 export interface RoutingTableInit {
   lan: boolean
   protocol: string
@@ -76,7 +39,7 @@ export interface RoutingTableComponents {
  */
 export class RoutingTable implements Startable {
   public kBucketSize: number
-  public kb?: KBucketTree
+  public kb?: KBucket
   public pingQueue: Queue
 
   private readonly log: Logger
@@ -135,7 +98,7 @@ export class RoutingTable implements Startable {
       }
     }
 
-    const kBuck: KBucketTree = new KBuck({
+    const kBuck = new KBucket({
       localNodeId: await utils.convertPeerId(this.components.peerId),
       numberOfNodesPerKBucket: this.kBucketSize,
       numberOfNodesToPing: 1
@@ -143,7 +106,7 @@ export class RoutingTable implements Startable {
     this.kb = kBuck
 
     // test whether to evict peers
-    kBuck.on('ping', this._onPing)
+    kBuck.addEventListener('ping', this._onPing)
 
     // tag kad-close peers
     this._tagPeers(kBuck)
@@ -160,7 +123,7 @@ export class RoutingTable implements Startable {
    * - this will lower the chances that connections to them get closed when
    * we reach connection limits
    */
-  _tagPeers (kBuck: KBucketTree): void {
+  _tagPeers (kBuck: KBucket): void {
     let kClosest = new PeerSet()
 
     const updatePeerTags = utils.debounce(() => {
@@ -197,10 +160,10 @@ export class RoutingTable implements Startable {
       kClosest = newClosest
     })
 
-    kBuck.on('added', () => {
+    kBuck.addEventListener('added', () => {
       updatePeerTags()
     })
-    kBuck.on('removed', () => {
+    kBuck.addEventListener('removed', () => {
       updatePeerTags()
     })
   }
@@ -215,7 +178,12 @@ export class RoutingTable implements Startable {
    * `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 {
+  _onPing (evt: CustomEvent<PingEventDetails>): void {
+    const {
+      oldContacts,
+      newContact
+    } = evt.detail
+
     // 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