# chik_rs
[](https://coveralls.io/github/Chik-Network/chik_rs?branch=main)
[](https://crates.io/crates/chik)
[](https://crates.io/crates/chik)
[](https://docs.rs/chik/latest/chik/)
A collection of Rust crates for working with the Chik blockchain. There are also Python bindings in the form of a wheel.
## Prerequisites
- [Python](https://www.python.org/downloads/) 3.9 or higher installed.
- The [Rust toolchain](https://rustup.rs/) must be installed.
## Unit Tests
To run the unit tests for the whole workspace:
```bash
cargo test --workspace
```
Some slow tests are only enabled in optimized builds, so it may also be a good idea to run the tests in release mode:
```bash
cargo test --workspace --release
```
### Python Linking
You may need a Python virtual environment activated for the tests to link properly, due to the `pyo3` dependency in `wheel`.
You can setup a virtual environment with the following command:
```bash
python3 -m venv venv
```
Activate the virtual env:
```bash
. ./venv/bin/activate
```
### Python Tests
The `wheel` crate is a single Python wheel that exports bindings to various functionality in the repository, mostly from `chik-consensus` and `chik-protocol`.
It's built with `maturin`, so you need to have activated a python virtual environment for the build to work.
The bindings are tested with `pytest`. Before you run them, install the following dependencies:
```bash
pip install pytest pytest-xdist maturin typing-extensions blspy
```
And build the Python wheel:
```bash
maturin develop -m wheel/Cargo.toml
```
Finally, you can run the Python binding tests:
```bash
pytest tests
```
Note that these tests can take several minutes to complete.
## Benchmarks
To run benchmarks for a specific crate before you make changes:
```bash
cargo bench -- --save-baseline before
```
After you apply the changes, finish the benchmark:
```bash
cargo bench -- --save-baseline after
critcmp after before
```
You can also run all the benchmarks by including `--workspace`.
Note that you must include the flag before the `--`, for example:
```bash
cargo bench --workspace -- --save-baseline before
```
## Precommit Hook
This repository has a pre-commit configuration, which is hooked into git by running:
```bash
pre-commit install --hook-type pre-commit --hook-type pre-push
```
It runs Prettier and then `cargo fmt` on all crates on every commit. When you push, it runs `cargo clippy`, `cargo test`, and `cargo build`.
To run all checks explicitly (without pushing), run:
```bash
pre-commit run --all --hook-stage pre-push
```
## Fuzzers
Fuzzers can't be run or listed for the whole workspace, but only for individual crates. There is a tool to generate a fuzzing corpus from a blockchain database.
It's run like this:
```bash
cd crates/chik-tools
cargo run --release --bin gen-corpus -- --help
```
The following crates have fuzzers:
- chik-bls
- chik-consensus
- chik-protocol
- chik-puzzle-types
- klvm-utils
To list and run fuzzers:
```bash
cargo fuzz list
cargo +nightly fuzz run <name-of-fuzzer> --jobs=10
```
## Bumping Version Number
Make sure you have `cargo-workspaces` installed:
```bash
cargo install cargo-workspaces
```
To bump the versions of all relevant crates:
```bash
cargo ws version --force "**" --all --no-git-commit
```
Select "minor update" if there has not been any incompatible API changes, otherwise "major update".