0.17.0

Add the versioned network protocol, make the commit process more flexible (open more use-cases) and improve our website experience.

⚠️ Warning
There are still several known issues, which are explained in the documentation.

Build artifacts

• 📦 Binaries for Linux x86_64 and MacOS ARM64, also attached
• 🐋 Docker image

Hydra Scripts

Transaction IDs to be used as --hydra-scripts-tx-id when running hydra-node on common networks are now also stored in the repository:

• preview: 6d3f02bc648c1b62bb90fc221a8476fc47d4faaea4a293b00e58ac40c3377b85
• preprod: c7b9db4986611d0ce7ff8546ef5d42af68566783a40604c372182342c4124e7d
• mainnet: 0d2eca8c8daf23061f5ba24a8f3113afba52a2e26318dc78c5583d9fc86b7b85

Compatible / tested with

• cardano-node: 8.9.0
• cardano-cli: 8.20.3.0
• mithril: 2418.1

Upgrade instructions

This release contains breaking changes of the persisted data and on-chain scripts. This means that you'll need to apply the following procedure to upgrade all the nodes currently running a head:

1. Close and fanout the head
2. Stop hydra-node
3. Remove persistent files stored in --persistence-dir, in particular server-output, acks and state
4. Upgrade hydra-node to this version
5. Upgrade cardano-node to compatible version (above)
6. Start new hydra-node version with new --hydra-scripts-tx-id (above)
7. Open a new head

Changelog

• BREAKING Change hydra-node API /commit endpoint for committing from scripts #1380:

  • Instead of the custom witness extension of UTxO, the endpoint now accepts a blueprint transaction together with the UTxO which is spent in this transaction.
  • Usage is still the same for commiting "normal" UTxO owned by public key addresses.
  • Spending from a script UTxO now needs the blueprintTx request type, which also unlocks more involved use-cases, where the commit transaction should also satisfy script spending constraints (like additional signers, validity ranges etc.)

• DEPRECATED the GetUTxO client input and GetUTxOResponse server output. Use GET /snapshot/utxo instead.

• Update navigation and re-organized documentation website https://hydra.family #1440

  • Updated logos
  • Removed localization as it got outdated and on-demand site translation tools exist.

• Add GET /snapshot/utxo API endpoint to query confirmed UTxO set on demand. #1398

  • Always responds with the last confirmed UTxO

• Set CORS headers on hydra-node API to allow requests from any origin *. #1434

• hydra-node logs will now report NetworkEvents to distinguish between ConnectivityEvents and ReceivedMessages on the network. #1396

• Hydra now uses a versioned protocol for handshaking. In the event of a node
  attempting to connect using a different version of the networking protocol, a
  HandshakeFailure event will be recorded in the logs and sent as a server
  output on the API. #1381

• Make hydra-cluster --devnet more configurable

  • Now it is idle by default again and a --busy will make it busy respending the same UTxO. #1420

Contributors: @v0d1ch @abailly-iohk @locallycompact @ffakenz @ch1bo

Full Changelog: 0.16.0...0.17.0