61 releases (breaking)
0.45.0 | Aug 9, 2024 |
---|---|
0.44.2 | May 1, 2024 |
0.44.1 | Dec 9, 2023 |
0.44.0 | Nov 5, 2023 |
0.6.0 | Mar 29, 2019 |
#924 in Network programming
282,030 downloads per month
Used in 243 crates
(9 directly)
800KB
16K
SLoC
Central repository for work on libp2p
This repository is the central place for Rust development of the libp2p spec.
Getting started
-
Main documentation can be found on https://docs.rs/libp2p.
-
The examples folder contains small binaries showcasing the many protocols in this repository.
-
For security related issues please file a private security vulnerability report . Please do not file a public issue on GitHub.
-
To report bugs, suggest improvements or request new features please open a GitHub issue on this repository.
-
For rust-libp2p specific questions please use the GitHub Discussions forum https://github.com/libp2p/rust-libp2p/discussions.
-
For discussions and questions related to multiple libp2p implementations please use the libp2p Discourse forum https://discuss.libp2p.io.
-
For synchronous discussions join the open rust-libp2p maintainer calls or the biweekly libp2p community calls.
Repository Structure
The main components of this repository are structured as follows:
-
core/
: The implementation oflibp2p-core
with itsTransport
andStreamMuxer
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 thelibp2p-core
Transport
API. -
muxers/
: Implementations of theStreamMuxer
interface oflibp2p-core
, e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections. Multiplexing protocols are (mandatory)Transport
upgrades. -
swarm/
: The implementation oflibp2p-swarm
building onlibp2p-core
with the central interfacesNetworkBehaviour
andConnectionHandler
used to implement application protocols (seeprotocols/
). -
protocols/
: Implementations of application protocols based on thelibp2p-swarm
APIs. -
misc/
: Utility libraries. -
libp2p/examples/
: Worked examples of built-in application protocols (seeprotocols/
) with commonTransport
configurations.
Community Guidelines
The libp2p project operates under the IPFS Code of Conduct.
tl;dr
- Be respectful.
- We're here to help: abuse@ipfs.io
- Abusive behavior is never tolerated.
- Violations of this code may result in swift and permanent expulsion from the IPFS [and libp2p] community.
- "Too long, didn't read" is not a valid excuse for not knowing what is in this document.
Maintainers
(In alphabetical order.)
- Guillaume Michel (@guillaumemichel)
- João Oliveira (@jxs)
Notable users
(open a pull request if you want your project to be added here)
- COMIT - Bitcoin–Monero Cross-chain Atomic Swap.
- Forest - An implementation of Filecoin written in Rust.
- fuel-core - A Rust implementation of the Fuel protocol.
- HotShot - Decentralized sequencer in Rust developed by Espresso Systems.
- ipfs-embed - A small embeddable ipfs implementation used and maintained by Actyx.
- Homestar - An InterPlanetary Virtual Machine (IPVM) implementation used and maintained by Fission.
- beetle - Next-generation implementation of IPFS for Cloud & Mobile platforms.
- Lighthouse - Ethereum consensus client in Rust.
- Locutus - Global, observable, decentralized key-value store.
- OpenMina - In-browser Mina Rust implementation.
- rust-ipfs - IPFS implementation in Rust.
- Safe Network - Safe Network implementation in Rust.
- Starcoin - A smart contract blockchain network that scales by layering.
- Subspace - Subspace Network reference implementation
- Substrate - Framework for blockchain innovation, used by Polkadot.
- Taple - Sustainable DLT for asset and process traceability by OpenCanarias.
- Ceylon - A Multi-Agent System (MAS) Development Framework.
lib.rs
:
Implementation of the Identify protocol.
This implementation of the protocol periodically exchanges
Info
messages between the peers on an established connection.
At least one identification request is sent on a newly established connection, beyond which the behaviour does not keep connections alive.
Important Discrepancies
- Using Identify with other protocols Unlike some other libp2p implementations, rust-libp2p does not treat Identify as a core protocol. This means that other protocols cannot rely upon the existence of Identify, and need to be manually hooked up to Identify in order to make use of its capabilities.
Usage
The Behaviour
struct implements a NetworkBehaviour
that negotiates and executes the protocol on every established connection, emitting
Event
s.
Dependencies
~8–15MB
~184K SLoC