1 unstable release
0.4.2-alpha.1 | Apr 30, 2024 |
---|
#1226 in Asynchronous
256 downloads per month
145KB
3K
SLoC
Hypercore Protocol
Hypercore protocol is a streaming, message based protocol. This is a Rust port of the wire protocol implementation in the original Javascript version. This crate targets the Hypercore LTS version 10.
This crate provides a low-level streaming API to hypercore-protocol and exposes an interface that should make it easy to implement actual protocol logic on top.
This crate uses either async-std or tokio for async IO, snow for the Noise handshake and RustCrypto's crypto_secretsteram for encryption.
Features
- Complete the Noise handshake
- Establish libsodium's
crypto_secretstream
. - Open channels with a key
- Accept channels opened by the remote end if your end knows the key
- Create and verify capability hashes
- Send and receive all protocol messages
- Support
async-std
ortokio
runtimes - Support WASM
- Test Javascript interoperability
- Support the new manifest in the wire protocol to remain compatible with upcoming v11
- Finalize documentation and release v1.0.0
Installation
cargo add hypercore-protocol
Examples
These examples sync data between Rust and NodeJS hypercore-protocol implementations. To prepare, run
cd examples-nodejs && npm install && cd ..
replication.rs
Runs the replication.rs
example by replicating a hypercore between Rust and Node hypercores and printing the result.
- Node Server / Rust Client
node examples-nodejs/run.js nodeServer
- Rust Server / Node Client
node examples-nodejs/run.js rustServer
- Rust Server / Rust Client
node examples-nodejs/run.js rust
- Node Server / Node Client
node examples-nodejs/run.js node
Development
To test interoperability with Javascript, enable the js_interop_tests
feature:
cargo test --features js_interop_tests
Run benches with:
cargo bench
Contributing
We're actively looking for contributors to the datrust development! If you're interested, the
easiest is to say hi in the #rust
channel on the
Hypercore Protocol Discord.
Want to help with Hypercore Protocol? Check out our "Contributing" guide and take a look at the open issues.
License
MIT OR Apache-2.0
Dependencies
~6–19MB
~266K SLoC