25 releases (9 breaking)

0.10.0 Nov 7, 2024
0.9.0 Sep 20, 2024
0.8.0 Jul 15, 2024
0.6.1 Mar 12, 2024
0.1.20 Feb 1, 2022

#1 in #chia

Download history 5185/week @ 2024-08-24 2685/week @ 2024-08-31 1896/week @ 2024-09-07 2895/week @ 2024-09-14 3348/week @ 2024-09-21 1319/week @ 2024-09-28 2392/week @ 2024-10-05 4933/week @ 2024-10-12 6878/week @ 2024-10-19 2664/week @ 2024-10-26 2158/week @ 2024-11-02 2676/week @ 2024-11-09 1020/week @ 2024-11-16 1612/week @ 2024-11-23 1129/week @ 2024-11-30 2402/week @ 2024-12-07

6,575 downloads per month
Used in 29 crates (25 directly)

Apache-2.0

755KB
8K SLoC

Rust implementation of clvm.

The cargo workspace includes an rlib crate, for use with rust or other applications, and a python wheel.

The python wheel is in wheel. The npm package is in wasm.

Tests

In order to run the unit tests, run:

cargo test

Fuzzing

The fuzzing infrastructure for clvm_rs uses cargo-fuzz.

Documentation for setting up fuzzing in rust can be found here.

To generate an initial corpus (for the run_program fuzzer), run:

cd tools
cargo run generate-fuzz-corpus

To get started, run:

cargo fuzz run fuzz_run_program --jobs=32 -- -rss_limit_mb=4096

But with whatever number of jobs works best for you.

If you find issues in clvm_rs please use our bug bounty program.

Build Wheel

The clvm_rs wheel has python bindings for the rust implementation of clvm.

Use maturin to build the python interface. First, install into current virtualenv with

$ pip install maturin

While in the wheel directory, build clvm_rs into the current virtualenv with

$ maturin develop --release

On UNIX-based platforms, you may get a speed boost on sha256 operations by building with OpenSSL.

$ maturin develop --release --features=openssl

To build the wheel, do

$ maturin build --release

or

$ maturin build --release --features=openssl

Dependencies

~11MB
~277K SLoC