Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation related to running on mainnet #795

Merged
merged 10 commits into from
Mar 30, 2023
Merged

Conversation

v0d1ch
Copy link
Contributor

@v0d1ch v0d1ch commented Mar 28, 2023

Small changes to the documentation related to running on the mainnet.


  • CHANGELOG updated
  • Documentation updated
  • Added and/or updated haddocks
  • No new TODOs introduced or explained herafter

@v0d1ch v0d1ch mentioned this pull request Mar 28, 2023
4 tasks
@github-actions
Copy link

github-actions bot commented Mar 28, 2023

Transactions 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 2023-03-30 08:10:34.682198778 UTC
Max. memory units 14000000
Max. CPU units 10000000000
Max. tx size (kB) 16384

Script summary

Name Hash Size (Bytes)
νInitial 9492414f8f96e8483a0b8ee268fc06a954641cb2cbaa9a8b093c2c9b 4621
νCommit 5d3f107aaa56d06188cf231941cf8163e777236a9cfdc48fd4bbfa23 2422
νHead 82f16b51e2d81c6f4d42dd7398b4713a445464902f63dfd86ffe754e 8954
μHead 4083fa7081a0f4b4092fb02867c9ac594bb0e8bab8110ab242ba5a72* 4458
  • The minting policy hash is only usable for comparison. As the script is parameterized, the actual script is unique per Head.

Cost of Init Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 5058 15.89 6.31 0.55
2 5260 18.11 7.14 0.58
3 5468 19.16 7.49 0.60
5 5875 25.01 9.74 0.68
10 6897 36.18 13.93 0.85
36 12231 98.85 37.63 1.76

Cost of Commit Transaction

Currently only one UTxO per commit allowed (this is about to change soon)

UTxO Tx size % max Mem % max CPU Min fee ₳
1 603 15.83 6.22 0.35

Cost of CollectCom Transaction

Parties UTxO (bytes) Tx size % max Mem % max CPU Min fee ₳
1 57 817 24.67 10.02 0.46
2 114 1138 40.41 16.53 0.65
3 171 1463 59.32 24.41 0.87
4 227 1783 80.71 33.34 1.12

Cost of Close Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 640 17.29 7.42 0.37
2 804 18.73 8.21 0.40
3 766 17.54 7.53 0.38
5 1299 22.61 10.40 0.47
10 2124 29.71 14.30 0.59
50 8721 86.18 45.37 1.56

Cost of Contest Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 709 22.70 9.66 0.43
2 840 23.54 10.03 0.45
3 997 25.16 10.88 0.48
5 1335 29.06 12.83 0.54
10 2169 37.72 17.28 0.67
46 8101 99.40 49.06 1.66

Cost of Abort Transaction

Some variation because of random mixture of still initial and already committed outputs.

Parties Tx size % max Mem % max CPU Min fee ₳
1 5171 29.49 12.60 0.71
2 5494 48.00 20.73 0.93
3 5817 70.09 30.47 1.19
4 6138 95.22 41.56 1.49

Cost of FanOut Transaction

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 ₳
5 0 0 5073 10.59 4.43 0.49
5 1 57 5114 12.12 5.31 0.51
5 5 285 5258 18.22 8.83 0.59
5 10 570 5438 25.85 13.24 0.69
5 20 1137 5791 41.11 22.05 0.90
5 30 1709 6154 56.37 30.86 1.10
5 40 2277 6512 71.64 39.68 1.30
5 50 2845 6875 86.92 48.50 1.50
5 58 3301 7166 99.14 55.56 1.67

@github-actions
Copy link

github-actions bot commented Mar 28, 2023

Test Results

297 tests   - 11   291 ✔️  - 11   21m 36s ⏱️ -36s
100 suites  -   4       6 💤 ±  0 
    5 files    -   1       0 ±  0 

Results for commit cd56f52. ± Comparison against base commit 2cf8aba.

This pull request removes 11 tests.
Hydra.TUI.Options ‑ parses --cardano-signing-key option
Hydra.TUI.Options ‑ parses --connect option
Hydra.TUI.Options ‑ parses --node-socket option
Hydra.TUI.Options ‑ parses --testnet-magic option
Hydra.TUI/end-to-end smoke tests ‑ display feedback long enough
Hydra.TUI/end-to-end smoke tests ‑ doesn't allow multiple initializations
Hydra.TUI/end-to-end smoke tests ‑ starts & renders
Hydra.TUI/end-to-end smoke tests ‑ supports the full Head life cycle
Hydra.TUI/end-to-end smoke tests ‑ supports the init & abort Head life cycle
Hydra.TUI/text rendering errors ‑ should show not enough fuel message and suggestion
…

♻️ This comment has been updated with latest results.

Copy link
Contributor

@pgrange pgrange left a comment

Choose a reason for hiding this comment

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

This review tries to apply the perfection game protocol

I will describe what I like about this P.R. and then what improvement I can think of to make it perfect.
Ask for clarifications if my comments are not clear.

If you disagree with my comments, just ignore them and don’t answer or explain.
Hence I, in advance, approve the P.R.

For me to find it perfect you would have to:

  • be explicit in Mainnet compatibility #713 that we still need to put the appropriate warnings in the appropriate places
  • see other improvement proposals inline

docs/docs/getting-started/quickstart.md Outdated Show resolved Hide resolved
docs/docs/getting-started/quickstart.md Outdated Show resolved Hide resolved
docs/docs/getting-started/troubleshooting.md Show resolved Hide resolved
docs/docs/getting-started/troubleshooting.md Outdated Show resolved Hide resolved
hydra-cluster/README.md Outdated Show resolved Hide resolved
@pgrange pgrange force-pushed the mainnet-docs-update branch from 33c9a67 to bbb4b8e Compare March 30, 2023 07:30
v0d1ch and others added 5 commits March 30, 2023 09:46
Co-authored-by: Pascal Grange <pgrange@users.noreply.github.com>
Co-authored-by: Pascal Grange <pgrange@users.noreply.github.com>
Co-authored-by: Pascal Grange <pgrange@users.noreply.github.com>
@v0d1ch v0d1ch merged commit b30f985 into master Mar 30, 2023
@v0d1ch v0d1ch deleted the mainnet-docs-update branch March 30, 2023 08:19
@v0d1ch v0d1ch mentioned this pull request Mar 30, 2023
4 tasks

> Note: This setup is meant to configure your cluster for devnet network. If you want to run the node on mainnet check out _Running on Mainnet_ paragraph.

## Running on Mainnet
Copy link
Collaborator

@ch1bo ch1bo Mar 30, 2023

Choose a reason for hiding this comment

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

@v0d1ch What about running on preview/preprod testnets before? I think we should suggest that at and IMO this section would be better if it explains more generally how the hydra-node needs to be configured for a given network. Maybe even a bit earlier in this document (it feels out of place here).


+ If you run into this, file an issue and the Hydra team will be able to help
you finalize your head in a manual workaround.
Copy link
Collaborator

@ch1bo ch1bo Mar 30, 2023

Choose a reason for hiding this comment

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

@v0d1ch Why was this point about reference scripts removed? This is still relevant!

@pgrange pgrange added this to the 0.10.0 milestone May 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants