mirror of
https://github.com/fluencelabs/rust-libp2p
synced 2025-04-25 03:02:12 +00:00
d94d53abbb
Move transport upgrade protocols from `protocols/` to `transports/`, such that only "application protocols" that depend on `libp2p-swarm` remain in `protocols/`, whereas there is no such dependency in `transports/` outside of integration tests. Tweak README and top-level CHANGELOG.
65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
# Central repository for work on libp2p
|
|
|
|
<a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
|
|
<a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
|
|
<a href="https://riot.permaweb.io/#/room/#libp2p:permaweb.io"><img src="https://img.shields.io/badge/matrix-%23libp2p%3Apermaweb.io-blue.svg?style=flat-square" /> </a>
|
|
<a href="https://discord.gg/66KBrm2"><img src="https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord&style=flat-square" /></a>
|
|
[](https://deps.rs/repo/github/libp2p/rust-libp2p)
|
|
|
|
This repository is the central place for Rust development of the [libp2p](https://libp2p.io) spec.
|
|
|
|
**Warning**: While we are trying our best to be compatible with other libp2p implementations, we
|
|
cannot guarantee that this is the case considering the lack of a precise libp2p specifications.
|
|
|
|
## Documentation
|
|
|
|
How to use the library?
|
|
|
|
- Main documentation: https://docs.rs/libp2p
|
|
|
|
Where to ask questions?
|
|
|
|
- In the Rust section of https://discuss.libp2p.io.
|
|
- In the #libp2p IRC channel on freenode.
|
|
- By opening an issue in this repository.
|
|
|
|
|
|
## Repository Structure
|
|
|
|
The main components of this repository are structured as follows:
|
|
|
|
* `core/`: The implementation of `libp2p-core` with its `Network`,
|
|
`Transport` and `StreamMuxer` API on which almost all other crates depend.
|
|
|
|
* `transports/`: Implementations of transport protocols (e.g. TCP) and protocol upgrades
|
|
(e.g. for authenticated encryption, compression, ...) based on the `libp2p-core` `Transport`
|
|
API .
|
|
|
|
* `muxers/`: Implementations of the `StreamMuxer` interface of `libp2p-core`,
|
|
e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections.
|
|
Multiplexing protocols are (mandatory) `Transport` upgrades.
|
|
|
|
* `swarm/`: The implementation of `libp2p-swarm` building on `libp2p-core`
|
|
with the central interfaces `NetworkBehaviour` and `ProtocolsHandler` used
|
|
to implement application protocols (see `protocols/`).
|
|
|
|
* `protocols/`: Implementations of application protocols based on the
|
|
`libp2p-swarm` APIs.
|
|
|
|
* `misc/`: Utility libraries.
|
|
|
|
* `examples/`: Worked examples of built-in application protocols (see `protocols/`)
|
|
with common `Transport` configurations.
|
|
|
|
## Notable users
|
|
|
|
(open a pull request if you want your project to be added here)
|
|
|
|
- https://github.com/paritytech/polkadot
|
|
- https://github.com/paritytech/substrate
|
|
- https://github.com/sigp/lighthouse
|
|
- https://github.com/golemfactory/golem-libp2p
|
|
- https://github.com/comit-network/comit-rs
|
|
- https://github.com/rs-ipfs/rust-ipfs
|
|
- https://github.com/marcopoloprotocol/marcopolo
|