rust-bitcoin / rust-bitcoin/rust-miniscript
Usage of qualifying path in types
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 426
- Forks
- 200
- Avg merge
- 7d 17h
- Merged PRs (30d)
- 8
Description
This crate uses qualifying paths for types eg, bitcoin::PublicKey and secp256k1::PublicKey. I understand that this adds clarity, especially for types that exist in multiple places (like the given example). However qualifying paths like bitcoin::Transaction do not really add any additional clarity.
Note also that if the bitcoin_primitives crate comes into play the bitcoin:: paths will get a bunch longer/noisier (excluding using any alias magic).
Would we be open to changing the qualifying path strategy in this crate? One suggestion would be to only qualify non-bitcoin types eg., still qualify the secp256k1 types.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no files, tests, or entry points. Start by locating qualified type paths throughout the crate and compare uses of bitcoin types with non-bitcoin types such as secp256k1; done requires an agreed qualification strategy, consistent application, and passing tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100