dc96475f58
Eventually we would like all our crates other than `bitcoin` to be able to be used without an allocator. Currently, and during crate smashing, this is not that useful because so much of the code comes from `bitcoin` and relies on the availability of an allocator. As an initial step, add the `alloc` feature to `addresses` , `base58`, and `primitives`. In order to to keep `--no-default-features` builds working make the crates empty if the `alloc` feature is not enabled. This is a suboptimal solution because the error messages users will get when they forget to enable `alloc` will be confusing (eg something like primitives does not contain Transaction). However our CI script (`run_task.sh`) expects `--no-default-features` to build cleanly (as do I). |
||
|---|---|---|
| .. | ||
| contrib | ||
| src | ||
| CHANGELOG.md | ||
| Cargo.toml | ||
| README.md | ||
README.md
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
base58crate 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.
Licensing
The code in this project is licensed under the Creative Commons CC0 1.0 Universal license. We use the SPDX license list and SPDX IDs.