rust-bitcoin / rust-bitcoin/rust-miniscript

Split `miniscript` into `descriptor` and `miniscript` crates.

Open
#783 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
426
Forks
200
Avg merge
7d 17h
Merged PRs (30d)
8

Description

Moving from https://github.com/rust-bitcoin/rust-bitcoin/issues/3695

From @sanket1729:

It is a lot of work, but conceptually it should be possible to split rust-miniscript into descriptors and miniscript. For people who want simple descriptors without miniscript can then use it.

From @apoelstra:

"let's split rust-miniscript into two crates", which I think is a great idea, though it will be a lot of work, and we'll need to spend a bunch of time bikeshedding which parts go into which pieces, and we'll also want to think a bit about how the new descriptors crate would relate to bitcoin-addresses. (Maybe miniscript should depend on addresses which depends on descriptors/bech32/base58/etc?)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the originating rust-bitcoin issue #3695 and the discussion about splitting rust-miniscript into descriptors and miniscript crates. Clarify which functionality belongs in each crate and how they should relate to bitcoin-addresses and related dependencies; done means the crate boundaries and dependency design are agreed and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.