Skip to content

Commit dcbae3f

Browse files
committed
Add changelog and some documentation
Signed-off-by: Sasha Bogicevic <[email protected]>
1 parent ec7733f commit dcbae3f

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ changes.
4848

4949
- Add API query (GET /head) to fetch the latest head state by a node and help introspecting the whole internal state.
5050

51+
- Provide `--network` option to hydra-node in order to use pre-published hydra scripts.
52+
5153
## [0.21.0] - 2025-04-28
5254

5355
- New metric for counting the number of active peers: `hydra_head_peers_connected`

docs/docs/configuration.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Being a protocol parameter, all participants in a head must configure the same `
5252

5353
:::
5454

55-
The default contestation period is _600 seconds_, but it should be tailored to the network conditions, as different networks have varying block production rates. A good rule of thumb is the maximum time you would expect an attacker to launch a withholding attack onto the cardano network you are on. Also, consider the time it takes to propagate a transaction to the network and the time it takes for a block to be produced, and the contestation period should be long enough to accommodate any downtime of the `hydra-node`.
55+
The default contestation period is _600 seconds_, but it should be tailored to the network conditions, as different networks have varying block production rates. A good rule of thumb is the maximum time you would expect an attacker to launch a withholding attack onto the cardano network you are on. Also, consider the time it takes to propagate a transaction to the network and the time it takes for a block to be produced, and the contestation period should be long enough to accomodate any downtime of the `hydra-node`.
5656

5757
The contestation deadline decides when a closed head can be fanned out. At worst, this is `(1 + n) * CP` after submitting a `Close` transaction, where `n` is the number of participants in the head. This is because the deadline is pushed forward on each `Contest`. With no contestations which may still be `2 * CP` after `Close` depending on the upper validity set on che close transaction. The `hydra-node` currently picks a blanket 200 seconds as [max grace time](https://hydra.family/head-protocol/haddock/hydra-node/Hydra-Chain-Direct-Handlers.html#v:maxGraceTime).
5858

@@ -83,6 +83,8 @@ See the [how-to](./how-to/incremental-commit) and [protocol documentation](./dev
8383

8484
The `hydra-node` uses reference scripts to reduce transaction sizes driving the head's lifecycle. Specify the `--hydra-scripts-tx-id` to reference the correct scripts. The `hydra-node` will verify the availability of these scripts on-chain.
8585

86+
Since we pre-publish hydra scrips before each release, in case you want to run the official released version instead of specifying hydra-scripts using `--hydra-scripts-tx-id`, you can use `--network` together with the network name you would like to run your hydra-node on (e.g. `--network preview`).
87+
8688
Check the scripts against which a hydra-node was compiled using:
8789

8890
```shell

0 commit comments

Comments
 (0)