milksad

History

Tobin C. Harding 6b7d02e5ae Add inherent functions to hashes Currently we have a trait `Hash` that is required for `Hmac`, `Hkdf`, and other use cases. However, it is unegonomic for users who just want to do a simple hash to have to import the trait. Add inherent functions to all hash types including those created with the new wrapper type macros. This patch introduces some duplicate code but we are trying to make progress in the hashes API re-write. We can come back and de-dublicate later. Includes making `to_byte_array`,`from_byte_array`, `as_byte_array`, and `all_zeros` const where easily possible.		2024-06-14 10:17:00 +10:00
..
contrib	CI: Remove shebang from non-executable scripts	2024-05-31 10:10:00 +10:00
src	Add inherent functions to hashes	2024-06-14 10:17:00 +10:00
CHANGELOG.md	base58: Add changelog	2024-03-25 06:41:38 +11:00
Cargo.toml	cargo: whitelist all cfgs used in this repo	2024-05-22 13:32:24 +00:00
README.md	chore: format and standardize all markdowns files	2024-04-27 06:29:23 -03: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.