76abab9e20
Previously, the `with_bandwidth_logging` extension to `Transport` would track the bytes sent and received on a socket level. This however only works in conjunction with `Transport` upgrades where a separate multiplexer is negotiated on top of a regular stream. With QUIC and WebRTC landing, this no longer works as those `Transport`s bring their own multiplexing stack. To still allow for tracking of bandwidth, we refactor the `with_bandwidth_logging` extension to count the bytes send on all substreams opened through a `StreamMuxer`. This works, regardless of the underlying transport technology. It does omit certain layers. However, there isn't necessarily a "correct" layer to count bandwidth on because you can always go down another layer (IP, Ethernet, etc). Closes #3157.
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 or reach out to security@libp2p.io. 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 general project updates and discussions join the biweekly libp2p Community Calls.
Repository Structure
The main components of this repository are structured as follows:
-
core/: The implementation oflibp2p-corewith itsTransportandStreamMuxerAPI 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-coreTransportAPI . -
muxers/: Implementations of theStreamMuxerinterface oflibp2p-core, e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections. Multiplexing protocols are (mandatory)Transportupgrades. -
swarm/: The implementation oflibp2p-swarmbuilding onlibp2p-corewith the central interfacesNetworkBehaviourandConnectionHandlerused to implement application protocols (seeprotocols/). -
protocols/: Implementations of application protocols based on thelibp2p-swarmAPIs. -
misc/: Utility libraries. -
examples/: Worked examples of built-in application protocols (seeprotocols/) with commonTransportconfigurations.
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.)
- Elena Frank (@elenaf9)
- Max Inden (@mxinden)
- Thomas Eizinger (@thomaseizinger)
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.
- iroh - Next-generation implementation of IPFS for Cloud & Mobile platforms.
- Lighthouse - Ethereum consensus client in Rust.
- Locutus - Global, observable, decentralized key-value store.
- rust-ipfs - IPFS 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.