milksad

History

Tobin C. Harding 85e04315d5 Remove test_ prefix from unit tests There is a loose convention in Rust to not use `test_` prefix. The reason being that `cargo test` outputs 'test <test name>' using the prefix makes the output stutter. This patch smells a bit like code-churn but having the prefix in some places and not others is confusing to new contributors and is leading me to explain this many times now. Lets just fix it. Remove the prefix unless doing so breaks the code.		2025-01-02 10:06:50 +11:00
..
contrib	Add/fix alloc features	2024-07-11 10:14:50 +10:00
src	Remove test_ prefix from unit tests	2025-01-02 10:06:50 +11:00
CHANGELOG.md	base58ck: Bump version to 0.2.0	2024-12-10 13:47:29 +11:00
Cargo.toml	hashes: Bump version to 0.16.0	2024-12-16 12:41:17 +11:00
README.md	Bump MSRV to 1.63	2024-07-27 07:24:32 +02: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.63.0.