Skip to content

Conversation

vrom911
Copy link
Contributor

@vrom911 vrom911 commented Sep 15, 2025

Resolves #1868

This PR adds a banner and version tag to the documentation site to clearly distinguish between stable and unstable versions.
When viewing the unstable documentation, a banner is displayed at the top of the page. For the stable version, this banner is hidden. Both versions now display a tag in the navigation bar indicating either the specific version number or "unstable".
This is handled by the GitHub Actions publish-docs job, which sets a version at build time.

Here are the screenshots of the local (and also the unstable) version of the docs page

Screenshot 2025-09-15 at 17 14 32 Screenshot 2025-09-15 at 17 14 46
  • CHANGELOG updated or not needed
  • Documentation updated or not needed
  • Haddocks updated or not needed
  • No new TODOs introduced or explained herafter

@vrom911 vrom911 self-assigned this Sep 15, 2025
Copy link

github-actions bot commented Sep 15, 2025

Transaction costs

Sizes and execution budgets for Hydra protocol transactions. Note that unlisted parameters are currently using arbitrary values and results are not fully deterministic and comparable to previous runs.

Metadata
Generated at 2025-09-19 15:39:59.234729177 UTC
Max. memory units 14000000
Max. CPU units 10000000000
Max. tx size (kB) 16384

Script summary

Name Hash Size (Bytes)
νInitial c8a101a5c8ac4816b0dceb59ce31fc2258e387de828f02961d2f2045 2652
νCommit 61458bc2f297fff3cc5df6ac7ab57cefd87763b0b7bd722146a1035c 685
νHead a1442faf26d4ec409e2f62a685c1d4893f8d6bcbaf7bcb59d6fa1340 14599
μHead fd173b993e12103cd734ca6710d364e17120a5eb37a224c64ab2b188* 5284
νDeposit ae01dade3a9c346d5c93ae3ce339412b90a0b8f83f94ec6baa24e30c 1102
  • The minting policy hash is only usable for comparison. As the script is parameterized, the actual script is unique per head.

Init transaction costs

Parties Tx size % max Mem % max CPU Min fee ₳
1 5834 10.55 3.35 0.52
2 6037 12.92 4.11 0.55
3 6239 14.97 4.75 0.58
5 6638 18.60 5.87 0.63
10 7651 29.14 9.19 0.79
43 14279 99.16 31.00 1.80

Commit transaction costs

This uses ada-only outputs for better comparability.

UTxO Tx size % max Mem % max CPU Min fee ₳
1 561 2.44 1.16 0.20
2 739 3.38 1.73 0.22
3 923 4.36 2.33 0.24
5 1283 6.41 3.60 0.28
10 2183 12.13 7.25 0.40
54 10083 98.61 68.52 1.88

CollectCom transaction costs

Parties UTxO (bytes) Tx size % max Mem % max CPU Min fee ₳
1 57 529 25.20 7.30 0.43
2 114 636 32.30 9.40 0.51
3 171 747 40.09 11.66 0.59
4 226 862 52.29 14.99 0.72
5 281 974 60.67 17.33 0.81
6 337 1081 73.76 20.93 0.94
7 395 1192 72.39 21.00 0.94
8 450 1303 98.09 27.55 1.20
9 505 1414 96.00 27.46 1.19
10 560 1525 99.46 28.68 1.23

Cost of Increment Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 1798 24.00 7.62 0.48
2 1940 25.39 8.68 0.50
3 2102 28.09 10.09 0.54
5 2321 29.96 11.95 0.58
10 3040 39.19 17.84 0.73
43 7856 98.69 56.43 1.70

Cost of Decrement Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 622 22.80 7.36 0.41
2 772 24.28 8.45 0.44
3 880 25.16 9.34 0.46
5 1336 31.75 12.54 0.56
10 2003 39.45 18.03 0.69
42 6658 98.24 55.71 1.64

Close transaction costs

Parties Tx size % max Mem % max CPU Min fee ₳
1 678 27.47 8.46 0.46
2 824 31.58 10.26 0.52
3 948 30.82 10.73 0.52
5 1301 37.85 14.02 0.61
10 2112 45.31 19.49 0.75
36 6088 98.90 51.94 1.59

Contest transaction costs

Parties Tx size % max Mem % max CPU Min fee ₳
1 684 33.79 10.15 0.53
2 769 35.17 11.17 0.55
3 937 37.84 12.60 0.59
5 1242 42.45 15.23 0.66
10 2005 54.10 21.82 0.83
28 4868 97.71 45.99 1.49

Abort transaction costs

There is some variation due to the random mixture of initial and already committed outputs.

Parties Tx size % max Mem % max CPU Min fee ₳
1 5788 27.13 9.09 0.69
2 5950 35.92 12.08 0.79
3 6080 44.61 15.03 0.89
4 6233 51.08 17.20 0.96
5 6291 59.29 19.84 1.05
6 6468 66.27 22.20 1.13
7 6691 79.78 26.85 1.28
8 6987 90.04 30.34 1.40

FanOut transaction costs

Involves spending head output and burning head tokens. Uses ada-only UTXO for better comparability.

Parties UTxO UTxO (bytes) Tx size % max Mem % max CPU Min fee ₳
10 0 0 5835 19.19 6.41 0.61
10 5 287 6006 28.90 10.28 0.72
10 20 1136 6510 59.98 22.53 1.08
10 30 1710 6856 80.48 30.61 1.32
10 39 2219 7159 98.93 37.88 1.54

End-to-end benchmark results

This page is intended to collect the latest end-to-end benchmark results produced by Hydra's continuous integration (CI) system from the latest master code.

Please note that these results are approximate as they are currently produced from limited cloud VMs and not controlled hardware. Rather than focusing on the absolute results, the emphasis should be on relative results, such as how the timings for a scenario evolve as the code changes.

Generated at 2025-09-19 15:42:46.622545184 UTC

Baseline Scenario

Number of nodes 1
Number of txs 300
Avg. Confirmation Time (ms) 5.837382840
P99 11.872328859999994ms
P95 6.946525000000001ms
P50 5.2913285000000005ms
Number of Invalid txs 0

Memory data

Time Used Free
2025-09-19 15:41:26.759189411 UTC 1164M 7418M
2025-09-19 15:41:27.759091348 UTC 1164M 7418M
2025-09-19 15:41:28.759069351 UTC 1212M 7369M
2025-09-19 15:41:29.759016195 UTC 1233M 7322M
2025-09-19 15:41:30.759118897 UTC 1246M 7308M
2025-09-19 15:41:31.759046534 UTC 1258M 7293M
2025-09-19 15:41:32.759112305 UTC 1270M 7276M
2025-09-19 15:41:33.759109385 UTC 1270M 7276M
2025-09-19 15:41:34.759063526 UTC 1270M 7276M
2025-09-19 15:41:35.759005019 UTC 1270M 7276M
2025-09-19 15:41:36.75910316 UTC 1270M 7276M
2025-09-19 15:41:37.759086028 UTC 1270M 7276M
2025-09-19 15:41:38.759146327 UTC 1270M 7276M
2025-09-19 15:41:39.759110025 UTC 1270M 7276M
2025-09-19 15:41:40.759150387 UTC 1270M 7276M
2025-09-19 15:41:41.75913589 UTC 1270M 7276M
2025-09-19 15:41:42.759082828 UTC 1270M 7276M
2025-09-19 15:41:43.75909374 UTC 1270M 7276M
2025-09-19 15:41:44.759069868 UTC 1271M 7275M
2025-09-19 15:41:45.759078961 UTC 1272M 7274M
2025-09-19 15:41:46.759124286 UTC 1272M 7274M
2025-09-19 15:41:47.759122787 UTC 1271M 7274M
2025-09-19 15:41:48.759088146 UTC 1271M 7274M
2025-09-19 15:41:49.759090573 UTC 1271M 7274M
2025-09-19 15:41:50.759124727 UTC 1271M 7273M
2025-09-19 15:41:51.759071714 UTC 1272M 7273M
2025-09-19 15:41:52.759133325 UTC 1272M 7272M
2025-09-19 15:41:53.759102713 UTC 1272M 7272M
2025-09-19 15:41:54.759123186 UTC 1277M 7267M

Three local nodes

Number of nodes 3
Number of txs 900
Avg. Confirmation Time (ms) 40.905547438
P99 77.70512410999999ms
P95 66.71326415ms
P50 36.7159195ms
Number of Invalid txs 0

Memory data

Time Used Free
2025-09-19 15:42:06.199122807 UTC 1185M 7397M
2025-09-19 15:42:07.199395302 UTC 1194M 7387M
2025-09-19 15:42:08.199000876 UTC 1285M 7270M
2025-09-19 15:42:09.199171812 UTC 1372M 7129M
2025-09-19 15:42:10.199011008 UTC 1433M 7068M
2025-09-19 15:42:11.199802084 UTC 1433M 7068M
2025-09-19 15:42:12.200175516 UTC 1456M 7035M
2025-09-19 15:42:13.200716322 UTC 1474M 7007M
2025-09-19 15:42:14.199745348 UTC 1504M 6967M
2025-09-19 15:42:15.199315389 UTC 1498M 6961M
2025-09-19 15:42:16.200610444 UTC 1500M 6950M
2025-09-19 15:42:17.199368498 UTC 1523M 6916M
2025-09-19 15:42:18.201702522 UTC 1544M 6888M
2025-09-19 15:42:19.200200097 UTC 1543M 6884M
2025-09-19 15:42:20.200689797 UTC 1546M 6875M
2025-09-19 15:42:21.200969752 UTC 1549M 6866M
2025-09-19 15:42:22.199694133 UTC 1567M 6841M
2025-09-19 15:42:23.199018149 UTC 1566M 6833M
2025-09-19 15:42:24.199087699 UTC 1566M 6828M
2025-09-19 15:42:25.199049583 UTC 1567M 6827M
2025-09-19 15:42:26.199009115 UTC 1567M 6827M
2025-09-19 15:42:27.199013111 UTC 1567M 6827M
2025-09-19 15:42:28.199090284 UTC 1568M 6826M
2025-09-19 15:42:29.199007794 UTC 1568M 6826M
2025-09-19 15:42:30.199083193 UTC 1569M 6824M
2025-09-19 15:42:31.199078994 UTC 1569M 6824M
2025-09-19 15:42:32.199083511 UTC 1569M 6823M
2025-09-19 15:42:33.199000127 UTC 1569M 6823M
2025-09-19 15:42:34.198999657 UTC 1577M 6815M
2025-09-19 15:42:35.199113803 UTC 1577M 6815M
2025-09-19 15:42:36.19902353 UTC 1577M 6815M
2025-09-19 15:42:37.199020965 UTC 1579M 6813M
2025-09-19 15:42:38.199083867 UTC 1579M 6813M
2025-09-19 15:42:39.199019884 UTC 1579M 6813M
2025-09-19 15:42:40.199074846 UTC 1578M 6813M
2025-09-19 15:42:41.199084185 UTC 1579M 6812M
2025-09-19 15:42:42.199020505 UTC 1579M 6812M
2025-09-19 15:42:43.199020494 UTC 1578M 6812M
2025-09-19 15:42:44.199014953 UTC 1578M 6812M
2025-09-19 15:42:45.199073481 UTC 1580M 6810M
2025-09-19 15:42:46.199005018 UTC 1580M 6810M

Copy link

Transaction cost differences

No cost or size differences found

@vrom911 vrom911 requested a review from a team September 16, 2025 10:04
Copy link
Contributor

@v0d1ch v0d1ch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice!

@noonio noonio moved this to In progress 🕐 in ☕ Hydra Team Work Sep 18, 2025
id: get_version
run: |
latest_tag=$(git describe --tags --abbrev=0)
echo "version=${latest_tag#v}" >> $GITHUB_OUTPUT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity what does the #v do here? formats it as a version??

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It basically removes the prefix "v", cause version here would come in the format v0.22.4, and what we really need is 0.22.4, so I am removing it

Copy link
Contributor

@noonio noonio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@github-project-automation github-project-automation bot moved this from In progress 🕐 to In review 👀 in ☕ Hydra Team Work Sep 19, 2025
@vrom911 vrom911 force-pushed the vrom911/1868-unstable-docs-banner branch from 4b5b4ed to 5c7f0c8 Compare September 19, 2025 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review 👀
Development

Successfully merging this pull request may close these issues.

Indicate the version being viewed on the docs website
3 participants