https://github.com/rust-bitcoin/rust-miniscript

Support for Miniscript and Output Descriptors for rust-bitcoin
https://github.com/rust-bitcoin/rust-miniscript

Last synced: 2 days ago
JSON representation

Support for Miniscript and Output Descriptors for rust-bitcoin

• Host: GitHub
• URL: https://github.com/rust-bitcoin/rust-miniscript
• Owner: rust-bitcoin
• License: cc0-1.0
• Created: 2018-08-16T17:06:29.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-24T18:52:49.000Z (10 days ago)
• Last Synced: 2024-12-24T19:38:39.602Z (10 days ago)
• Language: Rust
• Homepage:
• Size: 4.31 MB
• Stars: 361
• Watchers: 19
• Forks: 138
• Open Issues: 86
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Build](https://github.com/rust-bitcoin/rust-miniscript/workflows/Continuous%20integration/badge.svg)

**Minimum Supported Rust Version:** 1.63.0

# Miniscript

Library for handling [Miniscript](http://bitcoin.sipa.be/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](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md)

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

* `no_std` support enabled by disabling the `default-features`. See `embedded/` for an example.

More information can be found in [the documentation](https://docs.rs/miniscript)

or in [the `examples/` directory](https://github.com/rust-bitcoin/rust-miniscript/tree/master/examples)

## 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](https://web.libera.chat/?channels=##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](CHANGELOG.md).

## Licensing

The code in this project is licensed under the [Creative Commons CC0 1.0

Universal license](LICENSE). We use the [SPDX license list](https://spdx.org/licenses/) and [SPDX

IDs](https://spdx.dev/ids/).