Release Consensus packages for Node 10.2.0 (#1354)

IntersectMBO · Jan 8, 2025 · e924f61 · e924f61
2 parents 442f88c + 21f62ae
commit e924f61
Show file tree

Hide file tree

Showing 38 changed files with 159 additions and 202 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
 # Ouroboros Consensus
 
-[![consensus](https://img.shields.io/badge/ouroboros--consensus-0.21.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-0.21.0.0/)
-[![diffusion](https://img.shields.io/badge/ouroboros--consensus--diffusion-0.18.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-diffusion-0.18.0.0/)
-[![protocol](https://img.shields.io/badge/ouroboros--consensus--protocol-0.9.0.2-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-protocol-0.9.0.2/)
-[![cardano](https://img.shields.io/badge/ouroboros--consensus--cardano-0.20.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-cardano-0.20.0.0/)
+[![consensus](https://img.shields.io/badge/ouroboros--consensus-0.22.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-0.22.0.0/)
+[![diffusion](https://img.shields.io/badge/ouroboros--consensus--diffusion-0.19.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-diffusion-0.19.0.0/)
+[![protocol](https://img.shields.io/badge/ouroboros--consensus--protocol-0.10.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-protocol-0.10.0.0/)
+[![cardano](https://img.shields.io/badge/ouroboros--consensus--cardano-0.21.0.0-blue)](https://chap.intersectmbo.org/package/ouroboros-consensus-cardano-0.21.0.0/)
 [![sop-extras](https://img.shields.io/badge/sop--extras-0.2.1.0-blue)](https://chap.intersectmbo.org/package/sop-extras-0.2.1.0/)
 [![strict-sop-core](https://img.shields.io/badge/strict--sop--core-0.1.2.0-blue)](https://chap.intersectmbo.org/package/strict-sop-core-0.1.2.0/)
 
+
 [![docs](https://img.shields.io/badge/Documentation-yellow)][webpage]
 
 Implementation of the Ouroboros family of consensus algorithms.

diff --git a/ouroboros-consensus-cardano/CHANGELOG.md b/ouroboros-consensus-cardano/CHANGELOG.md
@@ -2,6 +2,62 @@
 
 # Changelog entries
 
+<a id='changelog-0.21.0.0'></a>
+## 0.21.0.0 — 2025-01-08
+
+### Patch
+
+- Adapted to removed `PraosParams` fields.
+
+- fixup NodeToClientV_19 mapping to ShelleyNodeToClientVersion11
+
+- Fixed a bug where a valid tx with less than `4` bytes less than the max tx
+  size would be incorrectly rejected by the mempool.
+
+* Use [`resource-registry`](https://hackage.haskell.org/package/resource-registry).
+
+### Non-Breaking
+
+- Remove references to `Ouroboros.Consensus.Fragment.InFuture`.
+- Adapt the code to account for the removed `cdbFutureBlocks` and related fields.
+
+- Updated to `ouroboros-network-0.14`, and `typed-protocols-0.3.0.0` as a consequence.
+- Updated to `ouroboros-network-api-0.11`, which introduced `NodeToClientV_19`.
+
+- Removed now-redundant hack in Babbage→Conway translation.
+
+- Depend on `network-mux` and use its types.
+
+### Breaking
+
+- Remove `CheckInFuture m blk` from `openChainDB`.
+
+- Changed `CardanoHardTriggers` to contain `CardanoHardForkTrigger`s which are a
+  simpler version of the previous `TriggerHardForkAt`. In particular, this will
+  affect call sites of `protocolInfoCardano`.
+
+  Migration notes:
+
+    - Change `TriggerHardForkAtEpoch` to `CardanoTriggerHardForkAtEpoch`.
+    - Change `TriggerHardForkAtVersion` to `CardanoTriggerHardForkAtDefaultVersion`.
+
+      This constructor does not take a version argument, but rather defaults to
+      the corresponding first ledger protocol version. We are not aware of any
+      use case that requires a different value, but if there is, it is still
+      possible to manually modify the returned `LedgerConfig`s of
+      `protocolInfoCardano` directly.
+
+- Added ShelleyNodeToClientVersion11 for GetBigLedgerPeerSnapshot query
+
+- Removed legacy (pre-Conway) diffusion pipelining scheme.
+
+- Changed `Ouroboros.Consensus.Cardano.CanHardFork` to expose
+  `crossEraForecastAcrossShelley`, in particular for testing.
+
+- Change the type of the `mkKeyHashVrf` function to use the new `VRFVerKeyHash` ledger type.
+
+- Remove versions before `NodeToClientV_16` from the `supportedNodeToClientVersions`.
+
 <a id='changelog-0.20.0.0'></a>
 ## 0.20.0.0 — 2024-10-14
 

diff --git a/...rdano/changelog.d/20240927_125151_damian.nadales_1260_remove_cdbFutureBlocks.md b/...rdano/changelog.d/20240927_125151_damian.nadales_1260_remove_cdbFutureBlocks.md
diff --git a/...ensus-cardano/changelog.d/20241014_170244_alexander.esgen_cardano_hf_trigger.md b/...ensus-cardano/changelog.d/20241014_170244_alexander.esgen_cardano_hf_trigger.md
diff --git a/...s-consensus-cardano/changelog.d/20241021_094824_coot_typed_protocols_new_api.md b/...s-consensus-cardano/changelog.d/20241021_094824_coot_typed_protocols_new_api.md
diff --git a/...us-cardano/changelog.d/20241022_125701_alexander.esgen_simplify_praos_params.md b/...us-cardano/changelog.d/20241022_125701_alexander.esgen_simplify_praos_params.md
diff --git a/...ano/changelog.d/20241023_102416_crocodile-dentist_ledger_query_peer_snapshot.md b/...ano/changelog.d/20241023_102416_crocodile-dentist_ledger_query_peer_snapshot.md
diff --git a/...cardano/changelog.d/20241024_182059_alexander.esgen_remove_legacy_pipelining.md b/...cardano/changelog.d/20241024_182059_alexander.esgen_remove_legacy_pipelining.md
diff --git a/...elog.d/20241028_153011_alexander.esgen_shelley_cross_era_forecasting_cleanup.md b/...elog.d/20241028_153011_alexander.esgen_shelley_cross_era_forecasting_cleanup.md
diff --git a/...ngelog.d/20241030_190550_alexander.esgen_remove_babbage_conway_hfc_tick_hack.md b/...ngelog.d/20241030_190550_alexander.esgen_remove_babbage_conway_hfc_tick_hack.md
diff --git a/ouroboros-consensus-cardano/changelog.d/20241114_150147_crocodile-dentist.md b/ouroboros-consensus-cardano/changelog.d/20241114_150147_crocodile-dentist.md
diff --git a/ouroboros-consensus-cardano/changelog.d/20241128_174448_neilmayhew_release_srp.md b/ouroboros-consensus-cardano/changelog.d/20241128_174448_neilmayhew_release_srp.md
diff --git a/...ano/changelog.d/20250107_124744_alexander.esgen_shelley_mempool_txsize_check.md b/...ano/changelog.d/20250107_124744_alexander.esgen_shelley_mempool_txsize_check.md
diff --git a/ouroboros-consensus-cardano/changelog.d/js-resourcereg.md b/ouroboros-consensus-cardano/changelog.d/js-resourcereg.md
diff --git a/ouroboros-consensus-cardano/changelog.d/js-versions.md b/ouroboros-consensus-cardano/changelog.d/js-versions.md
diff --git a/ouroboros-consensus-cardano/ouroboros-consensus-cardano.cabal b/ouroboros-consensus-cardano/ouroboros-consensus-cardano.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-consensus-cardano
-version: 0.20.0.0
+version: 0.21.0.0
 synopsis:
   The instantation of the Ouroboros consensus layer used by Cardano
 
@@ -157,8 +157,8 @@ library
     microlens,
     mtl,
     nothunks,
-    ouroboros-consensus ^>=0.21,
-    ouroboros-consensus-protocol ^>=0.9,
+    ouroboros-consensus ^>=0.22,
+    ouroboros-consensus-protocol ^>=0.10,
     ouroboros-network-api ^>=0.12,
     serialise ^>=0.2,
     small-steps,
@@ -201,7 +201,7 @@ library unstable-byronspec
     containers >=0.5 && <0.8,
     mtl,
     nothunks,
-    ouroboros-consensus ^>=0.21,
+    ouroboros-consensus ^>=0.22,
     serialise ^>=0.2,
     small-steps,
     transformers,
@@ -551,11 +551,11 @@ library unstable-cardano-tools
     network,
     network-mux,
     nothunks,
-    ouroboros-consensus ^>=0.21,
+    ouroboros-consensus ^>=0.22,
     ouroboros-consensus-cardano,
-    ouroboros-consensus-diffusion ^>=0.18,
+    ouroboros-consensus-diffusion ^>=0.19,
     ouroboros-consensus-protocol:unstable-protocol-testlib,
-    ouroboros-consensus-protocol ^>=0.9,
+    ouroboros-consensus-protocol ^>=0.10,
     ouroboros-network,
     ouroboros-network-api,
     ouroboros-network-framework ^>=0.15,

diff --git a/ouroboros-consensus-diffusion/CHANGELOG.md b/ouroboros-consensus-diffusion/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 # Changelog entries
 
+<a id='changelog-0.19.0.0'></a>
+## 0.19.0.0 — 2025-01-08
+
+### Patch
+
+- Remove references to `Ouroboros.Consensus.Fragment.InFuture`.
+
+- Depend on `network-mux` from `ouroboros-network` and use its types.
+
+* Use [`resource-registry`](https://hackage.haskell.org/package/resource-registry).
+
+### Breaking
+
+- Adapted to Genesis-related changes in `ouroboros-consensus` ([#1179](https://github.com/IntersectMBO/ouroboros-consensus/pull/1179)).
+
+- Remove `CheckInFuture m blk` argument from `openChainDB`.
+
+- Updated to `typed-protocols-0.3.0.0`
+- Added `KeepAlive` tracer to `Tracers'` data type.
+
 <a id='changelog-0.18.0.0'></a>
 ## 0.18.0.0 — 2024-10-14
 

diff --git a/...-consensus-diffusion/changelog.d/20240807_100458_alexander.esgen_milestone_1.md b/...-consensus-diffusion/changelog.d/20240807_100458_alexander.esgen_milestone_1.md
diff --git a/...usion/changelog.d/20240927_131047_damian.nadales_1260_remove_cdbFutureBlocks.md b/...usion/changelog.d/20240927_131047_damian.nadales_1260_remove_cdbFutureBlocks.md
diff --git a/...consensus-diffusion/changelog.d/20241021_094154_coot_typed_protocols_new_api.md b/...consensus-diffusion/changelog.d/20241021_094154_coot_typed_protocols_new_api.md
diff --git a/...boros-consensus-diffusion/changelog.d/20241120_160052_neilmayhew_release_srp.md b/...boros-consensus-diffusion/changelog.d/20241120_160052_neilmayhew_release_srp.md
diff --git a/ouroboros-consensus-diffusion/changelog.d/js-resourcereg.md b/ouroboros-consensus-diffusion/changelog.d/js-resourcereg.md
diff --git a/ouroboros-consensus-diffusion/ouroboros-consensus-diffusion.cabal b/ouroboros-consensus-diffusion/ouroboros-consensus-diffusion.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-consensus-diffusion
-version: 0.18.0.0
+version: 0.19.0.0
 synopsis: Integration for the Ouroboros Network layer
 description:
   Top level integration for consensus & network layers of the Ouroboros blockchain protocol.
@@ -90,7 +90,7 @@ library
     io-classes ^>=1.5,
     mtl,
     network-mux ^>=0.6,
-    ouroboros-consensus ^>=0.21,
+    ouroboros-consensus ^>=0.22,
     ouroboros-network ^>=0.19,
     ouroboros-network-api ^>=0.12,
     ouroboros-network-framework ^>=0.15,

diff --git a/ouroboros-consensus-protocol/CHANGELOG.md b/ouroboros-consensus-protocol/CHANGELOG.md
@@ -2,6 +2,20 @@
 
 # Changelog entries
 
+<a id='changelog-0.10.0.0'></a>
+## 0.10.0.0 — 2025-01-08
+
+### Patch
+
+- Expose functions to simplify thorough testing of header validation
+  logic, and introduce generators and properties to actually test it.
+
+* Use the `VRFVerKeyHash` type from `cardano-ledger-core-1.16`
+
+### Breaking
+
+- Removed unused fields from `PraosParams`.
+
 <a id='changelog-0.9.0.2'></a>
 ## 0.9.0.2 — 2024-10-14
 

diff --git a/...s-protocol/changelog.d/20241022_125606_alexander.esgen_simplify_praos_params.md b/...s-protocol/changelog.d/20241022_125606_alexander.esgen_simplify_praos_params.md
diff --git a/...onsensus-protocol/changelog.d/20241029_062000_abailly_header_validation_test.md b/...onsensus-protocol/changelog.d/20241029_062000_abailly_header_validation_test.md
diff --git a/...s-consensus-protocol/changelog.d/20241218_141944_neilmayhew_integrate_ledger.md b/...s-consensus-protocol/changelog.d/20241218_141944_neilmayhew_integrate_ledger.md
diff --git a/ouroboros-consensus-protocol/ouroboros-consensus-protocol.cabal b/ouroboros-consensus-protocol/ouroboros-consensus-protocol.cabal
@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name: ouroboros-consensus-protocol
-version: 0.9.0.2
+version: 0.10.0.0
 synopsis: Cardano consensus protocols
 description: Cardano consensus protocols.
 license: Apache-2.0
@@ -76,7 +76,7 @@ library
     containers,
     mtl,
     nothunks,
-    ouroboros-consensus ^>=0.21,
+    ouroboros-consensus ^>=0.22,
     serialise,
     text,