rust-bitcoin / rust-bitcoin/rust-bitcoin
`base58` stabilisation
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.7k
- Forks
- 1k
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 88
Description
As part of stabilising crypto down the track, base58 will either need to also be stabilised, or hidden in the public API. Since base58 has such a small API and the encoding format won't change, it's best to stabilise the crate.
Before stabilisation, there are a few things to consider:
- The entire crate requires
allocat the moment. How should no-alloc usage be supported, if at all? - Should the functions be renamed to more closely match hex conservative (
decode->decode_to_vec)? - The API guidelines checklist.
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
Start by reviewing the base58 crate's current public API and the API guidelines checklist mentioned in the issue. Resolve whether alloc-free usage is supported and whether functions should be renamed before stabilisation; done means those API decisions are agreed and the crate can be stabilised.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cryptography
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100