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

Remove core concepts #1486

Merged
merged 10 commits into from
Jul 10, 2024
Merged

Remove core concepts #1486

merged 10 commits into from
Jul 10, 2024

Conversation

ch1bo
Copy link
Collaborator

@ch1bo ch1bo commented Jul 8, 2024

Removes the core concepts section from the hydra.family website.

At last it was only a catch-all remainder of pages:

  • Specification -> is something developers need, moved to developer docs

  • Protocol overview -> every users should know about the lifecycle, moved to user manual

  • Scalability -> generic piece, was moved to developer docs, background section

  • Layer 2 solutions -> also generic (and maybe outdated?), moved to same background section

  • API Behavior -> deprecated, should be part of api reference, but moved next to it for now

@olgahryniuk This undoes some of the changes in #1454, please have a look.

New navigation:

image

and

image


  • CHANGELOG updated
  • Documentation updated
  • Haddocks update not needed
  • No new TODOs introduced

@ch1bo ch1bo requested review from olgahryniuk and a team July 8, 2024 10:20
@ch1bo ch1bo added the documentation 📖 Documentation changes label Jul 8, 2024
Copy link

github-actions bot commented Jul 8, 2024

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 2024-07-09 14:13:02.202676083 UTC
Max. memory units 14000000
Max. CPU units 10000000000
Max. tx size (kB) 16384

Script summary

Name Hash Size (Bytes)
νInitial baafeb5dc37bbe6e068784746bda0a3b1bb1d034fa0c55270f6079c1 4082
νCommit fe7af84822bcba542fae377ae7311fc5fd20152f925ccd980f73ecdc 2061
νHead 93c08c55e804d7f82ca545a01883b5fda6a6d3623cb78885625800ae 9366
μHead 5e65c73722b4bb3f0cbfcc8433e1dcdfea099eaf0a43060f1731a65b* 4237
  • 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 4818 5.78 2.27 0.43
2 5019 7.40 2.91 0.45
3 5221 8.69 3.42 0.47
5 5623 11.39 4.48 0.52
10 6628 18.40 7.24 0.64
58 16279 85.94 33.88 1.81

Cost of Commit Transaction

This is using ada-only outputs for better comparability.

UTxO Tx size % max Mem % max CPU Min fee ₳
1 559 9.69 3.82 0.28
2 749 12.48 5.10 0.32
3 934 15.33 6.40 0.36
5 1313 21.26 9.09 0.45
10 2250 37.35 16.27 0.67
25 5046 96.42 41.75 1.45

Cost of CollectCom Transaction

Parties UTxO (bytes) Tx size % max Mem % max CPU Min fee ₳
1 57 548 14.55 5.82 0.33
2 114 654 23.62 9.53 0.44
3 170 764 32.61 13.33 0.54
4 227 874 44.52 18.31 0.68
5 283 988 58.52 24.19 0.84
6 338 1099 74.64 30.94 1.02
7 394 1205 90.62 37.73 1.21

Cost of Close Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 482 7.58 3.46 0.26
2 720 9.01 5.66 0.30
3 867 9.67 6.71 0.31
5 1218 11.76 9.44 0.37
10 2113 16.90 16.10 0.50
50 7770 47.82 60.90 1.32

Cost of Contest Transaction

Parties Tx size % max Mem % max CPU Min fee ₳
1 627 8.60 4.71 0.28
2 756 9.37 5.80 0.30
3 889 10.10 6.87 0.32
5 1278 12.32 9.69 0.38
10 2016 16.71 15.66 0.49
50 7978 49.86 62.61 1.36

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 4703 17.00 7.36 0.55
2 4807 27.64 12.05 0.67
3 4992 42.07 18.49 0.84
4 5171 59.60 26.25 1.05
5 5135 69.94 30.57 1.16
6 5380 98.30 43.29 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 4652 8.03 3.36 0.44
5 1 57 4685 9.18 4.07 0.46
5 5 284 4821 13.67 6.87 0.52
5 10 569 4991 19.13 10.30 0.60
5 20 1141 5332 31.29 17.70 0.77
5 30 1709 5672 42.40 24.66 0.92
5 40 2277 6010 53.72 31.71 1.08
5 50 2845 6348 66.10 39.20 1.25
5 80 4542 7355 99.70 60.21 1.71

End-To-End Benchmark Results

This page is intended to collect the latest end-to-end benchmarks results produced by Hydra's Continuous Integration system from the latest master code.

Please take those results with a grain of salt as they are currently produced from very limited cloud VMs and not controlled hardware. Instead of focusing on the absolute results, the emphasis should be on relative results, eg. how the timings for a scenario evolve as the code changes.

Generated at 2024-07-09 14:15:25.138899152 UTC

Baseline Scenario

Number of nodes 1
Number of txs 3000
Avg. Confirmation Time (ms) 4.916469680
P99 9.391638399999975ms
P95 6.6683478ms
P50 4.665243ms
Number of Invalid txs 0

Three local nodes

Number of nodes 3
Number of txs 9000
Avg. Confirmation Time (ms) 22.144133395
P99 104.30810561000003ms
P95 30.183972549999986ms
P50 19.9246725ms
Number of Invalid txs 0

Copy link

github-actions bot commented Jul 8, 2024

Test Results

437 tests  ±0   425 ✅ ±0   15m 5s ⏱️ +7s
143 suites ±0    12 💤 ±0 
  5 files   ±0     0 ❌ ±0 

Results for commit 5a8944f. ± Comparison against base commit bceb304.

♻️ This comment has been updated with latest results.

docs/docs/api-behavior.md Outdated Show resolved Hide resolved
docs/docs/faqs.md Outdated Show resolved Hide resolved
docs/sidebars.js Outdated Show resolved Hide resolved
@olgahryniuk
Copy link
Collaborator

Thanks for tagging me, @ch1bo.

Noted the changes, which do simplify the user journey.

Since this PR makes some general structural changes, can I please ask you to update all titles to follow the 'Sentence case' approach?

  • User manual
  • Developer documentation
  • Use cases
  • API behavior
  • API reference, etc
  • FAQs (please add 's')

We're almost ready with reviewing the 'User manual' section (benchmarks coming in soon). This week, we plan to start going through the developer documentation sections. Great the structure is now amended.

@ch1bo ch1bo requested a review from olgahryniuk July 8, 2024 12:23
@olgahryniuk
Copy link
Collaborator

Looking forward to seeing this merged so that we can suggest some edits to the updated developer documentation section, avoiding any conflicts :)

@ch1bo ch1bo merged commit 81230a6 into master Jul 10, 2024
21 checks passed
@ch1bo ch1bo deleted the remove-core-concepts branch July 10, 2024 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📖 Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants