diff --git a/doc/release-notes-33819.md b/doc/release-notes-33819.md deleted file mode 100644 index 79ed1f70749..00000000000 --- 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 00000000000..e48772330c1 --- /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`).