bitcoin-consensus-encoding 1.0.0

Consensus encoding and decoding

Coverage
100%
91 out of 91 items documented4 out of 16 items with examples
Size
Source code size: 121.41 kB This is the summed size of all the files inside the crates.io package for this release.
Documentation size: 3.68 MB This is the summed size of all files generated by rustdoc for all configured targets
Ø build duration
this release: 4s Average build duration of successful builds.
all releases: 18s Average build duration of successful builds in releases after 2024-10-23.
Links
Homepage
rust-bitcoin/rust-bitcoin
2625 976 385
crates.io
Dependencies
- bitcoin-internals ^0.5.0 normal
- hex-conservative ^1.1.0 dev
Versions
Owners

Bitcoin Consensus Encoding

Sans-IO encoding and decoding support used by the rust-bitcoin ecosystem for objects that have a consensus-specified byte encoding.

History

Historically rust-bitcoin supported consensus encoding/decoding by way of the bitcoin::consensus module. This code included the std::io::Error type which turned out to be the cause of a lot of pain, including but not restricted to, creation of the bitcoin_io crate.

The solution was to re-write the consensus encoding/decoding logic using the sans-IO paradigm.

As part of developing this crate we fuzz against the latest bitcoin 0.32 release. If interested see rust-bitcoin/fuzz/fuzz_targets/bitcoin/compare_consensus_encoding.rs.