/node-abstract-dht

An implementation of Kademlia-based DHT protocol with abstract networking.

Primary LanguageJavaScriptMIT LicenseMIT

node-abstract-dht Build Status Package Version License Dependencies codecov Greenkeeper badge

An implementation of Kademlia-based DHT protocol with abstract networking.

Goal

WORK IN PROGRESS

Installation

Node >=8.9.0 is required.

npm install --save abstract-dht

To perform tests use:

cd node_modules/abstract-dht
npm i
npm t

Contributing

The source is documented with JSDoc. To generate the documentation use:

npm run docs

Extra debugging information is printed using the debug module:

DEBUG=abstract-dht:* npm t

The documentation will be put in the new docs directory.

To introduce an improvement please fork this project, commit changes in a new branch to your fork and add a pull request on this repository pointing at your fork. Please follow these style recommendations when working on the code:

  • Use tabs (yup).
  • Use async/await and/or Promise where possible.
  • Features must be properly tested.
  • New methods must be properly documented with jscode style comments.