milksad

History

Tobin C. Harding a2b019f823 Enable internals "alloc" feature We have 2 crates that require an allocator, `bitcoin` and `base58ck` - these crates should enable the "alloc" feature when depending on `internals`. For `units` we use the `internals::error::InputString` but do not enable the "alloc" feature - this is a bug, it means that the parsed string is being lost from the error types that use `InputString`. Enable "alloc" for `bitcoin`, `base58ck`, and `units`. - `bitcoin` and `base56ck` is just for good measure so we don't get bitten later on. - `units` is a bug fix and requires a point release.		2024-04-04 08:18:51 +11:00
..
contrib	Add a new base58 crate	2024-02-23 12:54:24 +11:00
src	2024-03-31 automated rustfmt nightly	2024-03-31 01:03:18 +00:00
CHANGELOG.md	base58: Add changelog	2024-03-25 06:41:38 +11:00
Cargo.toml	Enable internals "alloc" feature	2024-04-04 08:18: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.