milksad

History

Tobin C. Harding d6296cd3d1 Remove usage of hex::test_hex_unwrap We have the `hex_lit` dependency for converting a hex string literal to an array. Currently we have a `test_hex_unwrap` macro in the `hex v0.3.0` release but not on either `master` or the upcoming `v1.0.0-alpha.0` release. This is making PRs around releasing and depending on the release more noisy than required. Use `hex_lit::hex` where possible (often needing an additional call to `to_vec()`) and where not possible use `Vec::from_hex`.		2025-04-11 06:49:06 +10:00
..
contrib	Add/fix alloc features	2024-07-11 10:14:50 +10:00
src	Remove usage of hex::test_hex_unwrap	2025-04-11 06:49:06 +10:00
CHANGELOG.md	base58ck: Bump version to 0.2.0	2024-12-10 13:47:29 +11:00
Cargo.toml	refactor: use path dependencies for workspace members in bitcoin/Cargo.toml	2025-03-27 12:55:16 +08:00
README.md	docs: fix LICENCE link	2025-03-23 11:41:07 +00: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.