2017-11-08 13:03:59 +01:00
|
|
|
# [WIP] Central repository for work on libp2p
|
|
|
|
|
|
|
|
|
|
This repository is the central place for rust development of the
|
|
|
|
|
[libp2p](https://libp2p.io) 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.
|
2017-11-17 15:38:53 +01:00
|
|
|
|
|
|
|
|
## 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
|
2017-11-20 10:34:56 +01:00
|
|
|
backends. Used by `peerstore`.
|
2017-11-17 15:38:53 +01:00
|
|
|
- `libp2p-host`: Stub. Will probably get reworked or removed.
|
2017-11-20 10:34:56 +01:00
|
|
|
- `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.
|
2017-11-20 10:19:36 +01:00
|
|
|
- `libp2p-secio`: Implementation of the `secio` protocol. Encrypts communications.
|
2017-11-17 15:38:53 +01:00
|
|
|
- `libp2p-tcp-transport`: Implementation of the `Transport` trait for TCP/IP.
|
|
|
|
|
- `libp2p-transport`: Contains the `Transport` trait. Will probably get reworked or removed.
|
2017-11-20 10:34:56 +01:00
|
|
|
- `multihash`: Utility library that allows one to represent and manipulate
|
|
|
|
|
[*multihashes*](https://github.com/multiformats/multihash). A *multihash* is a combination of a
|
|
|
|
|
hash and its hashing algorithm.
|
2017-11-17 15:38:53 +01:00
|
|
|
- `multistream-select`: Implementation of the `multistream-select` protocol, which is used to
|
|
|
|
|
negotiate a protocol over a newly-established connection with a peer, or after a connection
|
|
|
|
|
upgrade.
|
2017-11-08 14:51:51 +01:00
|
|
|
- `rw-stream-sink`: Utility library that makes it possible to wrap around a tokio `Stream + Sink`
|
|
|
|
|
of bytes and implements `AsyncRead + AsyncWrite`.
|
