#bitcoin #script #analysis #version #subset #support #minimum #handling

miniscript

Miniscript: a subset of Bitcoin Script designed for analysis

27 releases (8 breaking)

new 0.10.0 Sep 9, 2019
0.8.1 Aug 23, 2019
0.5.7 Jun 13, 2019
0.4.8 Mar 25, 2019
0.1.0 Nov 13, 2018
Download history 24/week @ 2019-05-27 54/week @ 2019-06-03 58/week @ 2019-06-10 74/week @ 2019-06-17 261/week @ 2019-06-24 70/week @ 2019-07-01 93/week @ 2019-07-08 27/week @ 2019-07-22 25/week @ 2019-07-29 125/week @ 2019-08-05 5/week @ 2019-08-12 14/week @ 2019-08-19 337/week @ 2019-08-26 130/week @ 2019-09-02

406 downloads per month

CC0 license

435KB
9K SLoC

Status

Minimum Supported Rust Version: 1.22.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

  • 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 bitcoin::PublicKey
  • Determining satisfiability, and optimal witnesses, for a given descriptor; completing an unsigned bitcoin::TxIn with 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

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 freenode.

Stability

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.

Dependencies

~1.5MB
~31K SLoC