What the developer wrote
Authored by Tobin C. Harding
doc: Add version document
Add a document that explicitly states which versions of `bitcoin` are
long term support (LTS).
Include a list that maps `bitcoin` version to its dependency versions
for crates in this repo.
What changed, and why it matters
This commit only adds a new documentation file describing which versions of the rust-bitcoin library are considered long-term support (LTS) and which dependency versions correspond to each release. No code was changed, and there is no security fix or vulnerability present.
No action required; this is a documentation-only commit with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The commit introduces docs/supported-versions.md, a markdown document listing LTS bitcoin crate versions (0.30, 0.31, 0.32) and a dependency version map for in-repo crates. It is purely informational project policy documentation with no source-code modifications.
Changed components
Inspect captured patch +58 / −0
diff --git a/docs/supported-versions.md b/docs/supported-versions.md
new file mode 100644
index 00000000..3f6c49ac
--- /dev/null
+++ b/docs/supported-versions.md
@@ -0,0 +1,58 @@
+# Supported versions
+
+List of crates, their versions that we still actively maintain, and the dependency versions.
+
+## Bitcoin LTS versions
+
+- `v0.30` (Security and bug fixes only)
+- `v0.31` (Security and bug fixes only)
+- `v0.32`
+
+`v0.32` is the version most of the eccosystem is on. It is actively maintained. This means:
+
+1. Will backport anything that is easy enough if requested and if possible within semver rules.
+2. May attempt more involved backport work if we deem it important enough.
+3. Backport deprecations where possible as the API is developed to assist upgrade path.
+4. Security and bug fixes, obviously.
+
+(1) includes new features developed on `master`, so contributors are welcome to contribute a new
+feature with the explicit aim of then backporting it to `0.32`.
+
+## Dependency version map
+
+The LTS `bitcoin` releases and dependency versions (of crates in this repository).
+
+- `bitcoin 0.30`
+ -> `bitcoin-private 0.1`
+ -> `hashes 0.12`
+
+- `bitcoin 0.31`
+ -> `internals 0.2`
+ -> `hashes 0.13`
+
+- `bitcoin 0.32`
+ -> `base58ck 0.1`
+ -> `internals 0.3`
+ -> `io 0.1`
+ -> `units 0.1`
+ -> `hashes 0.14`
+
+Currently in development:
+
+- `bitcoin 0.33-rc.x`
+ -> `hashes 0.17`
+ -> `io 0.2`
+ -> `internals 0.4`
+ -> `primitives-1.0.0-rc.x`
+ -> `units-1.0.0-rc.x`
+ -> (transitively `consensus-encoding 1.0.0-rc.x`)
+
+Once the RC cycle is done:
+
+- `bitcoin 0.33`
+ -> `hashes 0.17`
+ -> `io 0.2`
+ -> `internals 0.4`
+ -> `primitives-1.0.0`
+ -> `units-1.0.0`
+ -> `consensus-encoding 1.0.0`
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.