libp2p-dht/README.md

# A DHT implementation for Codex

[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](#stability)
[![CI (GitHub Actions)](https://github.com/status-im/nim-libp2p-dht/workflows/CI/badge.svg?branch=main)](https://github.com/status-im/nim-libp2p-dht/actions?query=workflow%3ACI+branch%3Amain)
[![codecov](https://codecov.io/gh/status-im/nim-libp2p-dht/branch/main/graph/badge.svg?token=tlmMJgU4l7)](https://codecov.io/gh/status-im/nim-libp2p-dht)

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
  * roughly follow the libp2p-dht specifications from https://github.com/libp2p/specs/tree/master/kad-dht
  * eventually provide compatibility mode with the above specs

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

Base files were copied from [`status-im/nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46`](https://github.com/status-im/nim-eth/commit/779d767b024175a51cf74c79ec7513301ebe2f46)
Update README.md 2023-06-23 08:30:32 +00:00			`# A DHT implementation for Codex`
adding minimal readme 2022-02-16 10:30:06 +00:00
protobuf encoding for all message types 2022-04-07 19:02:12 +00:00			`[![License: Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)`
			`[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)`
			`[![Stability: experimental](https://img.shields.io/badge/stability-experimental-orange.svg)](#stability)`
			`[![CI (GitHub Actions)](https://github.com/status-im/nim-libp2p-dht/workflows/CI/badge.svg?branch=main)](https://github.com/status-im/nim-libp2p-dht/actions?query=workflow%3ACI+branch%3Amain)`
			`[![codecov](https://codecov.io/gh/status-im/nim-libp2p-dht/branch/main/graph/badge.svg?token=tlmMJgU4l7)](https://codecov.io/gh/status-im/nim-libp2p-dht)`
build: Add CI Actions Add CI workflow to run tests. Add code coverage workflow that publishes results to CodeCov. Add CI and coverage badges to README. Bump asynctest to allow for `setupAll` and `teardownAll`. Add local coverage nimble task. Combine tests in to a testAll file. 2022-02-25 02:39:07 +00:00
Update README.md 2023-06-23 08:30:32 +00:00			`This DHT implementation is aiming to provide a DHT for Codex with the following properties`
			`* flexible secure transport usage with`
adding minimal readme 2022-02-16 10:30:06 +00:00			`* fast UDP based operation`
Update README.md 2023-06-23 08:30:32 +00:00			`* eventual fallback to TCP-based operation (maybe though libp2p)`
			`* eventually support operation on top of libp2p`
adding minimal readme 2022-02-16 10:30:06 +00:00			`* flexible message encoding that plays well with the above transports`
			`* provide node lookup, content storage/lookup, and provider storage/lookup operations`
			`* roughly follow the libp2p-dht specifications from https://github.com/libp2p/specs/tree/master/kad-dht`
Update README.md 2023-06-23 08:30:32 +00:00			`* eventually provide compatibility mode with the above specs`
adding minimal readme 2022-02-16 10:30:06 +00:00
protobuf encoding for all message types 2022-04-07 19:02:12 +00:00			`Current implementation is based on nim-eth's Discovery v5 implementation.`

			Base files were copied from [`status-im/nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46`](https://github.com/status-im/nim-eth/commit/779d767b024175a51cf74c79ec7513301ebe2f46)