Central repository for work on libp2p

This repository is the central place for Rust development of the libp2p 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 mwc-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 mwc-libp2p-core Transport API .

• muxers/: Implementations of the StreamMuxer interface of mwc-libp2p-core, e.g. (sub)stream multiplexing protocols on top of (typically TCP) connections. Multiplexing protocols are (mandatory) Transport upgrades.

• swarm/: The implementation of mwc-libp2p-swarm building on mwc-libp2p-core with the central interfaces NetworkBehaviour and ProtocolsHandler used to implement application protocols (see protocols/).

• protocols/: Implementations of application protocols based on the mwc-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
• https://github.com/rs-ipfs/rust-ipfs
• https://github.com/marcopoloprotocol/marcopolo
• https://github.com/ChainSafe/forest

lib.rs:

Transports, upgrades, multiplexing and node handling of libp2p.

The main concepts of mwc-libp2p-core are:

• A PeerId is a unique global identifier for a node on the network. Each node must have a different PeerId. Normally, a PeerId is the hash of the public key used to negotiate encryption on the communication channel, thereby guaranteeing that they cannot be spoofed.
• The Transport trait defines how to reach a remote node or listen for incoming remote connections. See the transport module.
• The StreamMuxer trait is implemented on structs that hold a connection to a remote and can subdivide this connection into multiple substreams. See the muxing module.
• The UpgradeInfo, InboundUpgrade and OutboundUpgrade traits define how to upgrade each individual substream to use a protocol. See the upgrade module.