Central repository for work on susyp2p

This repository is the central place for Rust development of the susyp2p spec.

Warning: While we are trying our best to be compatible with other susyp2p implementations, we cannot guarantee that this is the case considering the lack of a precise susyp2p specifications.

Documentation

How to use the library?

• Main documentation: https://docs.rs/susyp2p

Where to ask questions?

• In the Rust section of https://discuss.susyp2p.io.
• In the #susyp2p IRC channel on freenode.
• By opening an issue in this repository.

Notable users

(open a pull request if you want your project to be added here)

• https://github.com/susytech/polkadot
• https://github.com/susytech/higgsfield
• https://github.com/sigp/lighthouse

lib.rs:

Kademlia protocol. Allows peer discovery, records store and records fetch.

Usage

Usage is done in the following steps:

• Build a KadSystemConfig and a KadConnecConfig object that contain the way you want the Kademlia protocol to behave.

• Create a swarm that upgrades incoming connections with the KadConnecConfig.

• Build a KadSystem from the KadSystemConfig. This requires passing a closure that provides the Kademlia controller of a peer.

• You can perform queries using the KadSystem.