Minimum Supported Rust Version: 1.22.0
This crate uses "2015" edition and won't be ported over "2018" edition in the near future as this will change the MSRV to 1.31.
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.
This library supports
- Output descriptors including embedded Miniscripts
- Parsing and serializing descriptors to a human-readable string format
- Compilation of abstract spending policies to Miniscript (enabled by the
compilerflag) - Semantic analysis of Miniscripts and spending policies, with user-defined public key types
- Encoding and decoding Miniscript as Bitcoin Script, given key types that
are convertible to
bitcoin::PublicKey - Determining satisfiability, and optimal witnesses, for a given descriptor;
completing an unsigned
bitcoin::TxInwith appropriate data - Determining the specific keys, hash preimages and timelocks used to spend coins in a given Bitcoin transaction
More information can be found in the documentation
or in the examples/ directory
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 freenode.
This library is stable enough that it will no longer publish breaking changes
in minor releases. However, the library (and Miniscript itself) is still under
active development and is not held to the same standards as rust-bitcoin or
rust-secp256k1.
For this reason, it is not recommended to use it in production.
See CHANGELOG.md.