A DHT based on Discv5 with libp2p provider records support
Go to file
Jaremy Creechley d4331f8062
Remove nimbus build (#73)
* Remove Nimbus
* adds docs for Nimble 0.14
* cleanup
2023-07-17 12:43:14 -07:00
.github Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
codexdht finishing renaming 2023-07-12 14:57:26 -07:00
tests Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
vendor import nimbus build tools 2023-07-11 15:19:45 -07:00
.gitignore Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
LICENSE-APACHEv2 initial commit based on nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46 2022-02-14 01:51:28 +01:00
LICENSE-MIT initial commit based on nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46 2022-02-14 01:51:28 +01:00
README.md Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
atlas.lock caching - change names 2023-07-11 17:44:54 -07:00
build.nims Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
codecov.yml update codecov path to be informational 2022-03-22 11:00:26 +11:00
codexdht.nim renaming imports 2023-07-12 14:58:29 -07:00
codexdht.nimble Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
config.nims Remove nimbus build (#73) 2023-07-17 12:43:14 -07:00
nimble.lock Migrate to nimble lock files 2023-07-10 15:50:06 +03:00

README.md

A DHT implementation for Codex

License: Apache License: MIT Stability: experimental CI (GitHub Actions) codecov

This DHT implementation is aiming to provide a DHT for Codex with the following properties

  • flexible secure transport usage with
    • fast UDP based operation
    • eventual fallback to TCP-based operation (maybe though libp2p)
    • eventually support operation on top of libp2p
  • flexible message encoding that plays well with the above transports
  • provide node lookup, content storage/lookup, and provider storage/lookup operations

Current implementation is based on nim-eth's Discovery v5 implementation.

Base files were copied from status-im/nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46

Building

This repo is setup to use Nimble lockfiles. This requires Nimble 0.14+ which isn't installed by default when this was written. If nimble -v reports 0.13.x then you will need to install Nimble 0.14. Note that using Nimble 0.14 changes how Nimble behaves!

Nimble 0.14 can be install by:

nimble install nimble@0.14.2

After this you can setup your Nimble environment. Note that this will build the pinned version of Nim! The first run can take ~15 minutes.

nimble setup # creates a nimble.paths used for rest of Nimble commands
nimble testAll

You can also run tasks directly:

nim testAll