doc: Release notes for mining IPC interface bump
What changed, and why it matters
This commit only updates release note documentation for an upcoming Bitcoin Core release. It deletes one release-notes file and adds another describing changes to the mining IPC (inter-process communication) interface. There are no code changes, no bug fixes, and no security-sensitive behavior altered in the commit itself.
No security action required. Review the release notes as part of normal release-process documentation review.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff is purely documentation: doc/release-notes-33819.md is removed and doc/release-notes-34568.md is created. The new file documents an interface version bump for the Cap’n Proto mining IPC schema, listing API signature changes such as required context parameters, new default timeout behavior, a structured CoinbaseTx return type, removed methods, and updated default values for option structs. No source code, build system, or configuration is modified.
Changed components
doc/release-notes-33819.mddoc/release-notes-34568.mdInspect captured patch +11 / −8
diff --git a/doc/release-notes-33819.md b/doc/release-notes-33819.md
deleted file mode 100644
index 79ed1f70..00000000
--- a/doc/release-notes-33819.md
+++ /dev/null
@@ -1,8 +0,0 @@
-Mining IPC
-----------
-
-- The `getCoinbaseTx()` method is renamed to `getCoinbaseRawTx()` and deprecated.
- IPC clients do not use the function name, so they're not affected. (#33819)
-- Adds `getCoinbaseTx()` which clients should use instead of `getCoinbaseRawTx()`. It
- contains all fields required to construct a coinbase transaction, and omits the
- dummy output which Bitcoin Core uses internally. (#33819)
diff --git a/doc/release-notes-34568.md b/doc/release-notes-34568.md
new file mode 100644
index 00000000..e4877233
--- /dev/null
+++ b/doc/release-notes-34568.md
@@ -0,0 +1,11 @@
+Mining IPC
+----------
+
+The IPC mining interface now requires mining clients to use the latest `mining.capnp` schema. Clients built against older schemas will fail when calling `Init.makeMining` and receive an RPC error indicating the old mining interface is no longer supported. Mining clients must update to the latest schema and regenerate bindings to continue working. (#34568)
+
+Notable IPC mining interface changes since the last release:
+- `Mining.createNewBlock` and `Mining.checkBlock` now require a `context` parameter.
+- `Mining.waitTipChanged` now has a default `timeout` (effectively infinite / `maxDouble`) if the client omits it.
+- `BlockTemplate.getCoinbaseTx()` now returns a structured `CoinbaseTx` instead of raw bytes.
+- Removed `BlockTemplate.getCoinbaseCommitment()` and `BlockTemplate.getWitnessCommitmentIndex()`.
+- Cap’n Proto default values were updated to match the corresponding C++ defaults for mining-related option structs (e.g. `BlockCreateOptions`, `BlockWaitOptions`, `BlockCheckOptions`).
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.