#p2p #transport #networking #external #wasm #remote

mwc-libp2p-wasm-ext

Allows passing in an external transport in a WASM environment

2 releases

0.27.1 Nov 6, 2024
0.27.0 Nov 5, 2024

#2075 in Network programming

Download history 209/week @ 2024-11-01 45/week @ 2024-11-08 5/week @ 2024-11-15

259 downloads per month
Used in mwc-libp2p

MIT license

480KB
8K SLoC

Central repository for work on libp2p

dependency status

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?

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)


lib.rs:

Implementation of the libp2p Transport trait for external transports.

This Transport is used in the context of WASM to allow delegating the transport mechanism to the code that uses rust-libp2p, as opposed to inside of rust-libp2p itself.

Note: This only allows transports that produce a raw stream with the remote. You couldn't, for example, pass an implementation QUIC.

Usage

Call new() with a JavaScript object that implements the interface described in the ffi module.

Dependencies

~11–17MB
~292K SLoC