f787f3d8b8
* Rename Transport::RawConn to Output * Remove AsyncRead + AsyncWrite bound on Transport::Output * UpgradedNode now always implements Transport * Add and tweak modifiers for Transport and ConnectionUpgrade * Secio upgrade now returns the pubkey in its output * Add upgrade::apply * Add Transport::and_then * Rework the swarm * Rustfmt * Fix concerns
[WIP] Central repository for work on libp2p
This repository is the central place for rust development of the libp2p spec.
This readme along with many others will be more fleshed out the closer the project gets to completion. Right now everything including the crate organization is very much Work in Progress.
General overview of the architecture
Architecture of the crates of this repository:
datastore: Utility library whose API provides a key-value storage with multiple possible backends. Used bypeerstore.example: Example usages of this library.libp2p-identify: Protocol implementation that allows a node A to query another node B what information B knows about A. Implements theConnectionUpgradetrait oflibp2p-swarm.libp2p-peerstore: Generic storage for information about remote peers (their multiaddresses and their public key), with multiple possible backends. Each multiaddress also has a time-to-live. Used bylibp2p-swarm.libp2p-ping: Implementation of thepingprotocol (the exact protocol is specific to libp2p). Implements theConnectionUpgradetrait oflibp2p-swarm.libp2p-secio: Implementation of thesecioprotocol. Encrypts communications. Implements theConnectionUpgradetrait oflibp2p-swarm.libp2p-swarm: Core library that contains all the traits of libp2p and plugs things together.libp2p-tcp-transport: Implementation of theTransporttrait oflibp2p-swarmfor TCP/IP.libp2p-websocket: Implementation of theTransporttrait oflibp2p-swarmfor Websockets.multistream-select: Implementation of themultistream-selectprotocol, which is used to negotiate a protocol over a newly-established connection with a peer, or after a connection upgrade.rw-stream-sink: Utility library that makes it possible to wrap around a tokioStream + Sinkof bytes and implementsAsyncRead + AsyncWrite.
About the impl Trait syntax
Right now a lot of code of this library uses Box<Future> or Box<Stream> objects, or forces
'static lifetime bounds.
This is caused by the lack of a stable impl Trait syntax in the Rust language. Once this syntax
is fully implemented and stabilized, it will be possible to change this code to use plain and
non-static objects instead of boxes.
Progress for the impl Trait syntax can be tracked in this issue of the Rust repository.
Once this syntax is stable in the nightly version, we will consider requiring the nightly version of the compiler and switching to this syntax.