milksad

History

Tobin C. Harding 4f68e79da0 bitcoin: Stop using base58 errors We are currently using the `base58::Error` type to create errors in `bitcoin`, these are bitcoin errors not `base58` errors. Note that we add what looks like duplicate `InvalidBase58PayloadLengthError` types but they are different because of the expected length. This could have been a field but I elected not to do so for two reasons: 1. We will need to do so anyways if we crate smash more 2. The `crypto::key` one can have one of two values 33 or 34. With this applied we can remove the now unused error variants from `base58::Error`.		2024-03-21 06:22:51 +11:00
..
contrib	Add a new base58 crate	2024-02-23 12:54:24 +11:00
src	bitcoin: Stop using base58 errors	2024-03-21 06:22:51 +11:00
Cargo.toml	base58: Add InvalidCharacterError for decoding	2024-03-21 06:22:51 +11:00
README.md	base58: Re-name crate to base58ck	2024-03-19 09:00:46 +11:00

Bitcoin base58 encoding

This crate provides encoding and decoding of base58 strings as defined by the Bitcoin ecosystem including the checksum.

There are a bunch of crates on crates.io that implement base58 encoding and decoding. The more obviously named ones differ from this crate because:

bitcoin-base58 is transpiled from the C++ code in Bitcoin Core as part of a large long-term transpilation project, whereas this crate is a pure Rust implementation intended to be production-ready and to provide an Rust-idiomatic API.
base58 implements parsing but does not validate checksums (see base58check). It may be appropriate in cases where performance is more important than safety. Appears unmaintained.
base58check Adds checksum to the base58 crate and depends on sha2 for hashing. Appears unmaintained.

This crate uses bitcoin_hashes when hashing to calculate the checksum.

Minimum Supported Rust Version (MSRV)

This library should always compile with any combination of features on Rust 1.56.1.