Add encoding section to primitives 1.0.0 doc
What the developer wrote
Authored by Tobin C. Harding
Add encoding section to primitives 1.0.0 doc
Consensus encoding work is ongoing, add a quick and dirty section
linking to the discussion and initial work.
What changed, and why it matters
This commit only adds a documentation section to a planning markdown file. It adds links to an ongoing GitHub discussion and a pull request about consensus encoding. No code was changed, and there is no security relevance.
No action needed; this is a documentation-only commit with no security implications.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff modifies docs/primitives.md to insert a ‘consensus encoding’ TODO section with hyperlinks to discussion #4856 and PR #4912. It is purely documentation/planning with no functional code changes, no API changes, and no bug fixes.
Changed components
docs/primitives.mdInspect captured patch +8 / −0
diff --git a/docs/primitives.md b/docs/primitives.md
index 58415eaf..e8b1e048 100644
--- a/docs/primitives.md
+++ b/docs/primitives.md
@@ -4,6 +4,14 @@ Design considerations and TODOs for the `bitcoin-primitives 1.0.0` release.
## TODOs
+### consensus encoding
+
+GitHub discussion: https://github.com/rust-bitcoin/rust-bitcoin/discussions/4856
+
+Pull encoding done in: https://github.com/rust-bitcoin/rust-bitcoin/pull/4912
+
+<!-- TODO: Add a consenus-encoding.md file? -->
+
### Remove `hashes` from the public API.
Required due to [C-STABLE](https://rust-lang.github.io/api-guidelines/necessities.html#c-stable).
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.