#dat #p2p #stream #feed #merkle

hypercore

Secure, distributed, append-only log

34 releases

0.12.1 Oct 28, 2023
0.11.1-beta.10 Jul 19, 2020
0.11.1-beta.3 Mar 3, 2020
0.10.0 Jul 27, 2019
0.0.0 Mar 30, 2018

#1 in #dat

Download history 53/week @ 2023-11-04 57/week @ 2023-11-11 46/week @ 2023-11-18 126/week @ 2023-11-25 287/week @ 2023-12-02 186/week @ 2023-12-09 29/week @ 2023-12-16 98/week @ 2023-12-23 70/week @ 2023-12-30 233/week @ 2024-01-06 184/week @ 2024-01-13 78/week @ 2024-01-20 102/week @ 2024-01-27 48/week @ 2024-02-03 188/week @ 2024-02-10 691/week @ 2024-02-17

1,032 downloads per month
Used in 3 crates (2 directly)

MIT/Apache

230KB
5.5K SLoC

Hypercore

crates.io version build status downloads docs.rs docs

Hypercore is a secure, distributed append-only log. This crate is a limited Rust port of the original Javascript holepunchto/hypercore. The goal is to maintain binary compatibility with the LTS version with regards to disk storage.

See hypercore-protocol-rs for the corresponding wire protocol implementation.

Features

  • Create in-memory and disk hypercores
  • Append to hypercore either a single entry or a batch of entries
  • Get entries from hypercore
  • Clear range from hypercore, with optional support for sparse files
  • Support basic replication by creating proofs in a source hypercore and verifying and applying them to a destination hypercore
  • Support tokio or async-std runtimes
  • Support WASM for in-memory storage
  • Test Javascript interoperability for supported features
  • Add optional read cache
  • Support the new manifest in the wire protocol to remain compatible with upcoming v11
  • Finalize documentation and release v1.0.0

Usage

// Create an in-memory hypercore using a builder
let mut hypercore = HypercoreBuilder::new(Storage::new_memory().await.unwrap())
    .build()
    .await
    .unwrap();

// Append entries to the log
hypercore.append(b"Hello, ").await.unwrap();
hypercore.append(b"world!").await.unwrap();

// Read entries from the log
assert_eq!(hypercore.get(0).await.unwrap().unwrap(), b"Hello, ");
assert_eq!(hypercore.get(1).await.unwrap().unwrap(), b"world!");

Find more examples in the examples folder, and/or run:

cargo run --example memory
cargo run --example disk
cargo run --example replication

Installation

cargo add hypercore

Safety

This crate uses #![forbid(unsafe_code)] to ensure everythong is implemented in 100% Safe Rust.

Development

To test interoperability with Javascript, enable the js_interop_tests feature:

cargo test --features js_interop_tests

Run benches with:

cargo bench

Contributing

Want to join us? Check out our "Contributing" guide and take a look at some of these issues:

License

MIT OR Apache-2.0

Dependencies

~4–19MB
~254K SLoC