consensus_enocding: Update the readme
What the developer wrote
Authored by Tobin C. Harding
consensus_enocding: Update the readme
In preparation for the 1.0 release remove mention of the RC release
process and make an effort to document how we got from the old
consensus encoding code to this crate.
What changed, and why it matters
This commit only edits a README file in the consensus_encoding crate. It rewrites the crate description and replaces a release-candidate notice with a short history of how the crate was developed. No code, tests, build files, or dependencies were changed.
No action needed; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is limited to consensus_encoding/README.md. It updates marketing/historical text: changes the one-line description, removes the v1.0.0 release candidate paragraph, and adds a ‘History’ section explaining the move from bitcoin::consensus (std::io::Error based) to a sans-IO design and mentions fuzz testing against bitcoin 0.32. There are no functional, API, or security-relevant code changes.
Changed components
consensus_encoding/README.mdInspect captured patch +11 / −8
diff --git a/consensus_encoding/README.md b/consensus_encoding/README.md
index 0759bd46..b8df5316 100644
--- a/consensus_encoding/README.md
+++ b/consensus_encoding/README.md
@@ -1,13 +1,16 @@
# Bitcoin Consensus Encoding
-This crate provides traits that can be used to encode/decode objects in a consensus-consistent way.
+Sans-IO encoding and decoding support used by the `rust-bitcoin` ecosystem for objects that have a
+consensus-specified byte encoding.
-## `consensus_encoding 0.1.0`
+## History
-This is the start of the `v1.0.0` release candidate cycle. We will
-endeavour to not release breaking changes unless totally necessary and
-will honour semver rules as usual. From this release forward we will
-semver trick as possible in subsequent releases to assist downstream
-users testing these releases.
+Historically `rust-bitcoin` supported consensus encoding/decoding by way of the
+[`bitcoin::consensus`](https://docs.rs/bitcoin/0.32.0/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`](https://crates.io/crates/bitcoin-io) crate.
-Thanks for your patience and help.
+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`.
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.