Tentacle
Overview
This is a minimal implementation for a multiplexed p2p network based on yamux that supports mounting custom protocols.
Architecture
- Data stream transmission
+----+ +----------------+ +-----------+ +-------------+ +----------+ +------+
|user| <--> | custom streams | <--> |Yamux frame| <--> |Secure stream| <--> |TCP stream| <--> |remote|
+----+ +----------------+ +-----------+ +-------------+ +----------+ +------+- 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
- Clone
$ git clone https://github.com/nervosnetwork/tentacle.git- On one terminal:
Listen on 127.0.0.1:1337
$ RUST_LOG=simple=info,tentacle=debug cargo run --example simple --features ws -- server- On another terminal:
$ RUST_LOG=simple=info,tentacle=debug cargo run --example simple- 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
- setup a ws server:
$ cd tentacle && RUST_LOG=info cargo run --example simple --features ws -- server
- setup a browser client
$ cd simple_wasm/www && wasm-pack build
$ npm install && npm run start
all wasm code generate from book
-
Use a browser to visit http://localhost:8080/
-
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.