5 unstable releases
0.3.0 | Apr 23, 2021 |
---|---|
0.2.2 | Mar 2, 2021 |
0.2.1 | Jan 26, 2021 |
0.2.0 | Jan 14, 2021 |
0.1.0 | Oct 26, 2020 |
#17 in #handshake
26 downloads per month
Used in libp2p-rs
335KB
5.5K
SLoC
Alternative repository for work on libp2p
This repository is an alternative implementation in Rust
of the libp2p spec. Not like rust-libp2p
, libp2p-rs
is written with async/await syntax, and driven by async runtime. Even though, many codes are borrowed from rust-libp2p
and some from go-libp2p
. We are trying to keep compatible with the two implementations, but it is unfortunately not guaranteed.
Documentations
How to use the library?
As mentioned above, the API is completely different from rust-libp2p
. There is no such thing as 'NetworkBehaviour' in libp2p-rs
at all. Instead, you should build the Swarm with the transports you like to use, then you have to create a Swarm::Control from it. The Swarm::Control is exposing all Swarm APIs which can be used to manipulate the Swarm - open/read/write/close streams and even more. This is quite similar as the BasicHost in go-libp2p
. As for Kad-DHT, similarly you should get the Kad::Control for the same reason. Furthermore, you can combine the Swarm with Kad, after that you have the RoutedHost, which has a routing functionality over the BasicHost.
It is strongly recommended to check the docs and sample code in details:
- API Documentations can be found: https://docs.rs/libp2p-rs
- Design documentation can be found in
docs
Code examples:
- Details about how to write your code can be found in
examples
- swarm_simple demonstrates how to build transport and create sub-stream for communication
- kad_simple demonstrates how to run a Kad-DHT server. In this example, the interactive shell is integrated for debugging/observing Kad-DHT internal data structures
- ...
Releases
NOTE: The master branch is now an active development branch (starting with v0.1.0), which means breaking changes could be made at any time.
lib.rs
:
Noise protocol framework support for libp2p.
Note: This crate is still experimental and subject to major breaking changes both on the API and the wire protocol.
This crate provides libp2p_core::InboundUpgrade
and libp2p_core::OutboundUpgrade
implementations for various noise handshake patterns (currently IK
, IX
, and XX
)
over a particular choice of Diffie–Hellman key agreement (currently only X25519).
Note: Only the
XX
handshake pattern is currently guaranteed to provide interoperability with other libp2p implementations.
All upgrades produce as output a pair, consisting of the remote's static public key
and a NoiseOutput
which represents the established cryptographic session with the
remote, implementing futures::io::AsyncRead
and futures::io::AsyncWrite
.
Dependencies
~20MB
~442K SLoC