75 releases (40 breaking)

0.41.2 Dec 4, 2023
0.41.1 Nov 12, 2023
0.40.1 Sep 22, 2023
0.40.0 Jun 20, 2023
0.6.0 Mar 29, 2019

#167 in Network programming

Download history 62593/week @ 2023-11-23 55839/week @ 2023-11-30 55658/week @ 2023-12-07 50866/week @ 2023-12-14 32612/week @ 2023-12-21 26769/week @ 2023-12-28 48017/week @ 2024-01-04 49570/week @ 2024-01-11 56780/week @ 2024-01-18 54127/week @ 2024-01-25 49093/week @ 2024-02-01 57528/week @ 2024-02-08 62367/week @ 2024-02-15 59671/week @ 2024-02-22 56581/week @ 2024-02-29 36721/week @ 2024-03-07

224,934 downloads per month
Used in 336 crates (56 directly)

MIT license

420KB
8K SLoC

Central repository for work on libp2p

dependency status Crates.io docs.rs docs.rs master

This repository is the central place for Rust development of the libp2p spec.

Getting started

Repository Structure

The main components of this repository are structured as follows:

  • core/: The implementation of libp2p-core with its 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 ConnectionHandler used to implement application protocols (see protocols/).

  • protocols/: Implementations of application protocols based on the libp2p-swarm APIs.

  • misc/: Utility libraries.

  • libp2p/examples/: Worked examples of built-in application protocols (see protocols/) with common Transport 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.)

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.

lib.rs:

Transports, upgrades, multiplexing and node handling of libp2p.

The main concepts of libp2p-core are:

  • 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.

Dependencies

~7–15MB
~194K SLoC