Home

Awesome

Build

Minimum Supported Rust Version: 1.63.0

Miniscript

Library for handling Miniscript, which is a subset of Bitcoin Script designed to support simple and general tooling. Miniscripts represent threshold circuits of spending conditions, and can therefore be easily visualized or serialized as human-readable strings.

High-Level Features

This library supports

More information can be found in the documentation or in the examples/ directory

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.63.0.

Some dependencies do not play nicely with our MSRV, if you are running the tests you may need to pin some dependencies. See ./contrib/pin.sh for current pinning.

Contributing

Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss please join us in ##miniscript on Libera.

Benchmarks

We use a custom Rust compiler configuration conditional to guard the bench mark code. To run the benchmarks use: RUSTFLAGS='--cfg=bench' cargo +nightly bench benchmarks.

Release Notes

See CHANGELOG.md.

Licensing

The code in this project is licensed under the Creative Commons CC0 1.0 Universal license. We use the SPDX license list and SPDX IDs.