59 releases (breaking)

0.44.1 Dec 9, 2023
0.44.0 Nov 5, 2023
0.43.1 Oct 18, 2023
0.43.0 Jun 20, 2023
0.6.0 Mar 29, 2019

#1868 in Asynchronous

Download history 54651/week @ 2023-11-21 53542/week @ 2023-11-28 46623/week @ 2023-12-05 46880/week @ 2023-12-12 35281/week @ 2023-12-19 18152/week @ 2023-12-26 36415/week @ 2024-01-02 42114/week @ 2024-01-09 47522/week @ 2024-01-16 44917/week @ 2024-01-23 44436/week @ 2024-01-30 51148/week @ 2024-02-06 52574/week @ 2024-02-13 56284/week @ 2024-02-20 53956/week @ 2024-02-27 40417/week @ 2024-03-05

214,066 downloads per month
Used in 192 crates (8 directly)

MIT license

1MB
16K 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:

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

Dependencies

~8–17MB
~220K SLoC