driftluo / tentacle Goto Github PK

View Code? Open in Web Editor NEW

204.0 13.0 49.0 2.08 MB

A multiplexed p2p network framework that supports custom protocols

Home Page: https://docs.rs/tentacle

License: MIT License

Rust 99.29% Makefile 0.31% HTML 0.03% JavaScript 0.26% Python 0.11%

p2p rust-library framework rust

tentacle's Introduction

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.

tentacle's People

Contributors

Stargazers

Watchers

tentacle's Issues

when to implement kademlia protocol?

Reinstate original copyright

This code is a fork of rust-libp2p but this is not mentioned anywhere (which is required by the license). Can you please put back the original copyright notice?

wrong module name in yamux example?

i encounter a error when running yamux example

https://github.com/driftluo/p2p/blob/a3fa13b15ab0350e624ee900639b758de4175f64/yamux/examples/simple.rs#L11

then i change yamux to tokio_yamux to run this example successfully

use tokio_yamux::{config::Config, session::Session, stream::StreamHandle};

`error: Please choose a serialization format via feature. Possible choices: flatc, molc
--> secio/src/handshake/mod.rs:13:1
|
13 | compile_error!("Please choose a serialization format via feature. Possible choices: flatc, molc");
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

error[E0599]: no method named encode found for struct handshake::handshake_struct::Exchange in the current scope
--> secio/src/handshake/procedure.rs:120:37
|
120 | let local_exchanges = exchanges.encode();
| ^^^^^^ method not found in handshake::handshake_struct::Exchange
|
::: secio/src/handshake/handshake_struct.rs:139:1
|
139 | pub struct Exchange {
| ------------------- method encode not found for this
|
= help: items from traits can only be used if the trait is implemented and in scope
= note: the following traits define an item encode, perhaps you need to implement one of them:
candidate #1: tokio_util::codec::encoder::Encoder
candidate #2: ring::rsa::padding::RsaEncoding

error[E0599]: no function or associated item named decode found for struct handshake::handshake_struct::Exchange in the current scope
--> secio/src/handshake/procedure.rs:137:44
|
137 | let remote_exchanges = match Exchange::decode(&raw_exchanges) {
| ^^^^^^ function or associated item not found in handshake::handshake_struct::Exchange
|
::: secio/src/handshake/handshake_struct.rs:139:1
|
139 | pub struct Exchange {
| ------------------- function or associated item decode not found for this
|
= help: items from traits can only be used if the trait is implemented and in scope
= note: the following trait defines an item decode, perhaps you need to implement it:
candidate #1: tokio_util::codec::decoder::Decoder

error: aborting due to 3 previous errors

For more information about this error, try rustc --explain E0599.
error: could not compile tentacle-secio.

To learn more, run the command again with --verbose.
warning: build failed, waiting for other jobs to finish...
error: build failed
`