milksad

History

Tobin C. Harding e68da281ff Warn on future deprecations We use `TBD` in our `deprecated` string and it was discovered that there is an exception on this string so as not to warn because it is used internally by the Rust language. However there is a special lint to enable warnings, lets use it. Add `#![warn(deprecated_in_future)]` to the coding conventions section of all crates except `fuzz`.		2024-10-15 07:56:06 +11:00
..
contrib	Add/fix alloc features	2024-07-11 10:14:50 +10:00
src	Warn on future deprecations	2024-10-15 07:56:06 +11:00
CHANGELOG.md	base58: Add changelog	2024-03-25 06:41:38 +11:00
Cargo.toml	Remove the SliceIndex implementation from hash types	2024-10-02 10:18:45 +10: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.