Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 2.31 KB

README.md

File metadata and controls

61 lines (40 loc) · 2.31 KB
Raw

Central repository for work on tetsy-libp2p

dependency status

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

Warning: While we are trying our best to be compatible with other tetsy-libp2p implementations, we cannot guarantee that this is the case considering the lack of a precise tetsy-libp2p specifications.

Documentation

How to use the library?

Where to ask questions?

  • On Twitter
  • In the #tetsy-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 tetsy-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 tetsy-libp2p-core Transport API .

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

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

  • protocols/: Implementations of application protocols based on the tetsy-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)