1 stable release
10.2.0 | Oct 4, 2024 |
---|
#4 in #miniscript
169 downloads per month
4MB
45K
SLoC
Minimum Supported Rust Version: 1.41.1
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
- 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
compiler
flag) - 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
bellscoin::PublicKey
- Determining satisfiability, and optimal witnesses, for a given descriptor;
completing an unsigned
bellscoin::TxIn
with appropriate data - Determining the specific keys, hash preimages and timelocks used to spend coins in a given Bitcoin transaction
no_std
support enabled by disabling thedefault-features
and enabling"no-std"
. Seeembedded/
for an example.
More information can be found in the documentation
or in the examples/
directory
Building
The cargo feature std
is enabled by default. At least one of the features std
or no-std
or both must be enabled.
Enabling the no-std
feature does not disable std
. To disable the std
feature you must disable default features. The no-std
feature only enables additional features required for this crate to be usable without std
. Both can be enabled without conflict.
Minimum Supported Rust Version (MSRV)
This library should always compile with any combination of features (minus
no-std
) on Rust 1.41.1 or Rust 1.47 with no-std
.
Some dependencies do not play nicely with our MSRV, if you are running the tests you may need to pin as follows:
cargo update --package url --precise 2.2.2
cargo update --package form_urlencoded --precise 1.0.1
cargo update -p once_cell --precise 1.13.1
cargo update -p bzip2 --precise 0.4.2
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.
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.
Dependencies
~7.5MB
~95K SLoC