rust-bitcoin / rust-bitcoin/rust-miniscript

`roundtrip_descriptor` test fails with `c:pk_h`

Open
#468 5 comments 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

I get

---- tests::test stdout ----
thread 'tests::test' panicked at 'assertion failed: `(left == right)`
  left: `[B/nduesm]c:[K/nduesm]pk_h(DummyKey)`,
 right: `pkh(DummyKey)`', fuzz_targets/roundtrip_descriptor.rs:14:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

This fuzz test parses a string as a descriptor, serializes this as a string, then re-parses. What's happening is that we parse c:pk_h as a bare descriptor, re-serialize it as pkh, then parse this as a PkH descriptor.

This may be a bug in our normalization logic, or just a bug in the fuzztest, I can't decide.

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 with fuzz_targets/roundtrip_descriptor.rs and reproduce the assertion for c:pk_h and pkh(DummyKey). Trace how parsing and serialization handle the two forms, then determine whether normalization or the fuzz-test expectation is wrong and rerun the roundtrip test to verify the chosen behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cryptography, testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.