Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Stability: 1 - Experimental
Kademlia DHT K-bucket implementation as a binary tree.
npm install k-bucket
npm test
var KBucket = require('k-bucket');
var kBucket = new KBucket({
localNodeId: "my node id", /* default: random SHA-1 */
root: kBucket /* default: self (for internal implementation use) */
});
A Distributed Hash Table (DHT) is a decentralized distributed system that provides a lookup table similar to a hash table.
k-bucket is an implementation of a storage mechanism for keys within a DHT. It stores contact
objects which represent locations and addresses of nodes in the decentralized distributed system. contact
objects are typically identified by a SHA-1 hash, however this restriction is lifted in this implementation. Additionally, node ids of different lengths can be compared.
This Kademlia DHT k-bucket implementation is meant to be as minimal as possible. It assumes that contact
objects consist only of id
, and an optional vectorClock
. It is useful, and necessary, to attach other properties to a contact
. For example, one may want to attach ip
and port
properties which allow the application to send IP traffic to the contact
. However, this information is extraneous and irrelevant to the operation of a k-bucket.
It is worth highlighting the presence of an optional vectorClock
as part of contact
implementation. The purpose of the vectorClock
(a simple integer) is to enable distinguishing between contact
objects that may have "physically" moved to a different machine while keeping the same contact.id
. This is useful when working with actors and an actor moves from one machine to another.
Implementation of a Kademlia DHT k-bucket used for storing contact (peer node) information.
KBucket starts off as a single k-bucket with capacity of k. As contacts are added, once the k+1 contact is added, the k-bucket is split into two k-buckets. The split happens according to the first bit of the contact node id. The k-bucket that would contain the local node id is the "near" k-bucket, and the other one is the "far" k-bucket. The "far" k-bucket is marked as don't split in order to prevent further splitting. The contact nodes that existed are then redistributed along the two new k-buckets and the old k-bucket becomes an inner node within a tree data structure.
As even more contacts are added to the "near" k-bucket, the "near" k-bucket will split again as it becomes full. However, this time it is split along the second bit of the contact node id. Again, the two newly created k-buckets are marked "near" and "far" and the "far" k-bucket is marked as don't split. Again, the contact nodes that existed in the old bucket are redistributed. This continues as long as nodes are being added to the "near" k-bucket, until the number of splits reaches the length of the local node id.
As more contacts are added to the "far" k-bucket and it reaches its capacity, it does not split. Instead, the k-bucket emits a "ping" event (register a listener: kBucket.on('ping', function (oldContacts, newContact) {...});
and includes an array of old contact nodes that it hasn't heard from in a while and requires you to confirm that those contact nodes still respond (literally respond to a PING RPC). If an old contact node still responds, it should be re-added (kBucket.add(oldContact)
) back to the k-bucket. This puts the old contact on the "recently heard from" end of the list of nodes in the k-bucket. If the old contact does not respond, it should be removed (kBucket.remove(oldContact)
) and the new contact being added now has room to be stored (kBucket.add(newContact)
).
Creates a new KBucket. The options
are:
localNodeId
: An optional string or a Buffer representing the local node id. If not provided, a local node id will be created via crypto.createHash('sha1').digest()
. If a string is provided, it will be converted into a Buffer.root
: (reserved for internal use) provides a reference for to the root of the tree data structure as the k-bucket splits as new contacts are addedcontact
ObjectbitIndex
Integer, Optional, Default: 0Adds a contact to the k-bucket.
contact
Objectn
IntegerbitIndex
Integer, Optional, Default: 0Get the n closest contacts to the provided contact. "Closest" here means: closest according to the XOR metric of the contact node id.
id
BufferbitIndex
Integerreserved for internal use Determines whether the id at the bitIndex is 0 or 1. If 0, returns -1, else 1. Id is a Buffer.
firstId
BuffersecondId
BufferFinds the XOR distance between firstId and secondId.
contact
ObjectReturns the index of the contact if it exists, returns -1 otherwise.
contact
ObjectbitIndex
Integer, Optional, Default: 0Removes the contact.
contact
ObjectbitIndex
Integer, Optional, Default: 0reserved for internal use Splits the bucket, redistributes contacts to the new buckets, and marks the bucket that was split as an inner node of the binary tree of buckets by setting self.bucket = undefined. Also, marks the "far away" bucket as dontSplit
.
contact
Objectindex
Integerreserved for internal use Updates the contact and compares the vector clocks if provided. If new contact vector clock is deprecated, contact is abandoned (not added). If new contact vector clock is the same, contact is marked as moste recently contacted (by being moved to the right/end of the bucket array). If new contact vector clock is more recent, the old contact is removed and the new contact is marked as most recently contacted.
oldContacts
Array The array of contacts to pingnewContact
Object The new contact to be added if one of old contacts does not respondEmitted every time a contact is added that would exceed the capacity of a don't split k-bucket it belongs to.
The implementation has been sourced from:
FAQs
Kademlia DHT K-bucket implementation as a binary tree
The npm package k-bucket receives a total of 5,858 weekly downloads. As such, k-bucket popularity was classified as popular.
We found that k-bucket demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.