#network #peer-to-peer

tentacle

Minimal implementation for a multiplexed p2p network framework

21 releases

0.5.0-alpha.1 May 6, 2023
0.4.2 Dec 29, 2022
0.4.1 Jul 29, 2022
0.4.0-beta.4 Feb 17, 2022
0.2.0-alpha.1 Mar 14, 2019

#102 in Asynchronous

Download history 1242/week @ 2023-10-22 1038/week @ 2023-10-29 522/week @ 2023-11-05 806/week @ 2023-11-12 970/week @ 2023-11-19 978/week @ 2023-11-26 791/week @ 2023-12-03 989/week @ 2023-12-10 953/week @ 2023-12-17 912/week @ 2023-12-24 520/week @ 2023-12-31 762/week @ 2024-01-07 843/week @ 2024-01-14 1093/week @ 2024-01-21 934/week @ 2024-01-28 652/week @ 2024-02-04

3,554 downloads per month
Used in 19 crates (6 directly)

MIT license

765KB
18K SLoC

Tentacle

Build Status image

Overview

This is a minimal implementation for a multiplexed p2p network based on yamux that supports mounting custom protocols.

Architecture

  1. Data stream transmission
+----+      +----------------+      +-----------+      +-------------+      +----------+      +------+
|user| <--> | custom streams | <--> |Yamux frame| <--> |Secure stream| <--> |TCP stream| <--> |remote|
+----+      +----------------+      +-----------+      +-------------+      +----------+      +------+
  1. Code implementation

All data is passed through the futures channel, yamux splits the actual tcp/websocket stream into multiple substreams, and the service layer wraps the yamux substream into a protocol stream.

Detailed introduction: 中文/English

Note: It is not compatible with libp2p.

Status

The API of this project is basically usable. However we still need more tests. PR is welcome.

The codes in the protocols/ directory are no longer maintained and only used as reference

Usage

From cargo

[dependencies]
tentacle = { version = "0.4.0" }

Example

  1. Clone
$ git clone https://github.com/nervosnetwork/tentacle.git
  1. On one terminal:

Listen on 127.0.0.1:1337

$ RUST_LOG=simple=info,tentacle=debug cargo run --example simple --features ws -- server
  1. On another terminal:
$ RUST_LOG=simple=info,tentacle=debug cargo run --example simple
  1. Now you can see some data interaction information on the terminal.

You can see more detailed example in these three repos:

Run on browser and test

  1. setup a ws server:
$ cd tentacle && RUST_LOG=info cargo run --example simple --features ws -- server
  1. setup a browser client
$ cd simple_wasm/www && wasm-pack build
$ npm install && npm run start

all wasm code generate from book

  1. Use a browser to visit http://localhost:8080/

  2. Now you can see the connection on the server workbench or on browser's console

Other Languages

Implementations in other languages

Why?

Because when I use rust-libp2p, I have encountered some difficult problems, and it is difficult to locate whether it is my problem or the library itself, it is better to implement one myself.

Dependencies

~11–27MB
~381K SLoC