Release 0.21.0

Author: ffakenz

CHANGELOG.md

@@ -8,9 +8,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 As a minor extension, we also keep a semantic version for the `UNRELEASED`
 changes.
 
-## [0.21.0] - UNRELEASED
+## [0.21.0] - 2025-04-28
 
-- New metric for counting the number of active peers: `hydra_head_peers_connected`
 - **BREAKING** Switch to using `etcd` internally to establish a reliable L2 network
   - New run-time dependency onto `etcd` binary
   - The peer network options to `hydra-node` (`--peer`) need to match across the Hydra network.
@@ -27,11 +26,16 @@ changes.
     ETCD_AUTO_COMPACTION_RETENTION=168h
     ```
 
-- Changed default contestation period to 600 seconds and deposit deadline to 3600 seconds.
-
-- Introduce an option to publish hydra scripts using blockfrost.
+- **BREAKING** Enable multi-party, networked "offline" heads by providing an `--offline-head-seed` option to `hydra-node`.
+  - Drop `hydra-node offline` as a sub-command. Use `--offline-head-seed` and `--initial-utxo` options to switch to offline mode.
 
-- Remove checks that rely on hydra-node's local state and trust on-chain data when we observe decrement/recover transactions.
+- **BREAKING** API changes
+  - API Server does **NOT** serve the event history by default any more. Clients need to add a query parameter `?history=yes` in order to obtain the history.
+  - Remove `GetUTxO` client input and corresponding `GetUTxOResponse`. There is already a way to query the `UTxO` in the Head with `GET /snapshot/utxo` query.
+  - Renamed 'CommitFinalized' field 'theDeposit' to 'depositTxId'.
+  - We now store the `time` in `StateEvent` which is a breaking change to our persistence loading
+  - Query parameter `?address=..` does **NOT** filter `TxValid` and `TxInvalid` server outputs anymore.
+  - Removed the `transaction` from `TxValid` server outputs. Use `SnapshotConfirmed` to determine what transactions got confirmed intead!
 
 - Fix a bug in increment observation where wrong deposited UTxO was picked up.
 
@@ -41,38 +45,35 @@ changes.
   - A problematic transaction will now be ignored and not deemed a valid head protocol transaction.
   - An example was if the datum would contain CBOR instead of just hex encoded bytes.
 
-- **BREAKING** Enable multi-party, networked "offline" heads by providing an `--offline-head-seed` option to `hydra-node`.
-  - Drop `hydra-node offline` as a sub-command. Use `--offline-head-seed` and `--initial-utxo` options to switch to offline mode.
+- Fix a bug on HeadFannedOut as it should always display the observed fanned-out UTxO instead of local confirmed snapshot.
+
+- API Additions
+    - Add query (GET /snapshot/last-seen) to fetch the latest seen snapshot by a node and help identify non-cooperating peers.
+    - Add command (POST /snapshot) to adopt the given snapshot as the latest confirmed.
+      * add new `SideLoadSnapshot` client input.
+      * add new `LocalStateCleared` state changed event.
+      * add new `SnapshotSideLoaded` server output.
+      * add new `SideLoadSnapshotFailed` logic error.
+
+- Changed default contestation period to 600 seconds and deposit deadline to 3600 seconds.
 
 - Add support for "withdraw zero trick" transactions:
   - Any transaction with a `Rewarding` redeemer for a `Withdrawal` of `0 lovelace`, will be validated as if there would be a corresponding stake `RewardAccount` already registered.
   - No need to register the script's stake address before.
 
-- Stream historical data from disk in the hydra-node API server.
+- Remove checks that rely on hydra-node's local state and trust on-chain data when we observe decrement/recover transactions.
 
-- Record used and free memory when running `bench-e2e` benchmark.
+- Publish scripts using blockfrost via new `hydra-node publish-scripts --blockfrost` option.
 
-- Submit observations to a `hydra-explorer` via optional `--explorer` option.
-
-- Add API query (GET /snapshot/last-seen) to fetch the latest seen snapshot by a node and help identify non-cooperating peers.
+- New metric for counting the number of active peers: `hydra_head_peers_connected`
 
-- Bugfix: HeadFannedOut should always display the observed fanned-out UTxO instead of local confirmed snapshot.
+- Record used and free memory when running `bench-e2e` benchmark.
 
-- **BREAKING** API changes
-  - API Server does **NOT** serve the event history by default any more. Clients need to add a query parameter `?history=yes` in order to obtain the history.
-  - Remove `GetUTxO` client input and corresponding `GetUTxOResponse`. There is already a way to query the `UTxO` in the Head with `GET /snapshot/utxo` query.
-  - Renamed 'CommitFinalized' field 'theDeposit' to 'depositTxId'.
-  - We now store the `time` in `StateEvent` which is a breaking change to our persistence loading
-  - Query parameter `?address=..` does **NOT** filter `TxValid` and `TxInvalid` server outputs anymore.
-  - Removed the `transaction` from `TxValid` server outputs. Use `SnapshotConfirmed` to determine what transactions got confirmed intead!
+- Submit observations to a `hydra-explorer` via optional `--explorer` option.
 
 - Add a list of [clients](https://hydra.family/head-protocol/unstable/docs/clients) to the docs
 
-- Add API command (POST /snapshot) which allows to adopt the given snapshot as the latest confirmed.
-  * add new `SideLoadSnapshot` client input.
-  * add new `LocalStateCleared` state changed event.
-  * add new `SnapshotSideLoaded` server output.
-  * add new `SideLoadSnapshotFailed` logic error.
+- Stream historical data from disk in the hydra-node API server.
 
 ## [0.20.0] - 2025-02-04
 

demo/docker-compose.yaml

@@ -21,7 +21,7 @@ services:
 
   hydra-node-1:
    # NOTE: Make sure to use the same image in ./seed-devnet.sh
-    image: ghcr.io/cardano-scaling/hydra-node:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-node:0.21.0
     build:
       context: ../
       target: hydra-node
@@ -58,7 +58,7 @@ services:
 
   hydra-node-2:
     # NOTE: Make sure to use the same image in ./seed-devnet.sh
-    image: ghcr.io/cardano-scaling/hydra-node:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-node:0.21.0
     build:
       context: ../
       target: hydra-node
@@ -95,7 +95,7 @@ services:
 
   hydra-node-3:
     # NOTE: Make sure to use the same image in ./seed-devnet.sh
-    image: ghcr.io/cardano-scaling/hydra-node:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-node:0.21.0
     build:
       context: ../
       target: hydra-node
@@ -131,7 +131,7 @@ services:
     restart: always
 
   hydra-tui-1:
-    image: ghcr.io/cardano-scaling/hydra-tui:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-tui:0.21.0
     build:
        context: ../
        target: hydra-tui
@@ -148,7 +148,7 @@ services:
         ipv4_address: 172.16.238.11
 
   hydra-tui-2:
-    image: ghcr.io/cardano-scaling/hydra-tui:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-tui:0.21.0
     build:
        context: ../
        target: hydra-tui
@@ -165,7 +165,7 @@ services:
         ipv4_address: 172.16.238.21
 
   hydra-tui-3:
-    image: ghcr.io/cardano-scaling/hydra-tui:0.20.0
+    image: ghcr.io/cardano-scaling/hydra-tui:0.21.0
     build:
        context: ../
        target: hydra-tui

demo/seed-devnet.sh

@@ -55,7 +55,7 @@ function hnode() {
       docker run --rm -it \
         --pull always \
         -v ${SCRIPT_DIR}/devnet:/devnet \
-        ghcr.io/cardano-scaling/hydra-node:0.20.0 -- ${@}
+        ghcr.io/cardano-scaling/hydra-node:0.21.0 -- ${@}
   fi
 }
 

docs/docs/tutorial/index.md

@@ -45,7 +45,7 @@ that you have a good version of jq with this command:
 
 ```shell
 mkdir -p bin
-hydra_version=0.20.0
+hydra_version=0.21.0
 cardano_node_version=10.1.4
 curl -L -O https://github.com/cardano-scaling/hydra/releases/download/${hydra_version}/hydra-x86_64-linux-${hydra_version}.zip
 unzip -d bin hydra-x86_64-linux-${hydra_version}.zip
@@ -61,7 +61,7 @@ chmod +x bin/*
 
 ```shell
 mkdir -p bin
-hydra_version=0.20.0
+hydra_version=0.21.0
 cardano_node_version=10.1.4
 curl -L -O https://github.com/cardano-scaling/hydra/releases/download/${hydra_version}/hydra-aarch64-darwin-${hydra_version}.zip
 unzip -d bin hydra-aarch64-darwin-${hydra_version}.zip
@@ -391,7 +391,7 @@ Start the `hydra-node` using these parameters:
 <TabItem value="alice" label="Alice">
 
 ```shell
-hydra_version=0.20.0
+hydra_version=0.21.0
 hydra-node \
   --node-id "alice-node" \
   --persistence-dir persistence-alice \
@@ -413,7 +413,7 @@ hydra-node \
 <TabItem value="bob" label="Bob">
 
 ```shell
-hydra_version=0.20.0
+hydra_version=0.21.0
 hydra-node \
   --node-id "bob-node" \
   --persistence-dir persistence-bob \

hydra-cardano-api/hydra-cardano-api.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name:          hydra-cardano-api
-version:       0.20.0
+version:       0.21.0
 synopsis:      A Haskell API for Cardano, tailored to the Hydra project.
 author:        IOG
 copyright:     2022 IOG

hydra-chain-observer/hydra-chain-observer.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name:          hydra-chain-observer
-version:       0.20.1
+version:       0.21.0
 synopsis:      Hydra Chain Observer
 author:        IOG
 copyright:     2023 IOG

hydra-cluster/hydra-cluster.cabal

@@ -1,6 +1,6 @@
 cabal-version:      3.0
 name:               hydra-cluster
-version:            0.20.0
+version:            0.21.0
 synopsis:
   Integration test suite using a local cluster of cardano and hydra nodes
 

hydra-node/json-schemas/api.yaml

@@ -1,7 +1,7 @@
 asyncapi: '2.3.0'
 info:
   title: Hydra Node API
-  version: '0.20.0'
+  version: '0.21.0'
   description: |
     WebSocket/HTTP API for administrating & interacting with Hydra Heads: multi-party isomorphic state-channels for Cardano.
 

hydra-plutus-extras/hydra-plutus-extras.cabal

@@ -1,6 +1,6 @@
 cabal-version: 3.0
 name:          hydra-plutus-extras
-version:       0.20.0
+version:       0.21.0
 synopsis:
   Several extras and extensions of plutus-tx and plutus-ledger-api
 

hydra-plutus/hydra-plutus.cabal

@@ -1,6 +1,6 @@
 cabal-version:      2.2
 name:               hydra-plutus
-version:            0.20.0
+version:            0.21.0
 synopsis:           Hydra Plutus Contracts
 author:             IOG
 copyright:          2022 IOG