Docs restructure

[ch1bo]

Updates the structure of our documentation page.

📚 Drops internationalization (thats why there are so many files changed)

📚 Removed some severely outdated pages

📚 Grouped user manual into some general info, tutorials, docs + how-tos and reference material. This uses a hand-rolled sidebars.js config to allow for the sectioning.

📚 Re-interpreted the demos as "getting started" tutorial. Using this also as the very prominently deep-linked /docs/getting-started page. So we have now one tutorial that runs on a local devnet using hydra-tui, and one more involved that uses a public testnet and the API directly.

• Also simplified the demo of not using --profile on the docker compose setup.

📚 Cleaned up the installation and quickstart pages into installation and configuration pages. The latter is intended to hold various documentation of hydra-node options and concepts.

📚 Converted some documentation as "how-to" which besides the tutorial serve as "recipes" on how to do one or the other thing.

📚 There are still some legacy "core concepts" articles which are in need for a new home (maybe on https://cardano-scaling.org?). Specifically the API behavior should be part of the api reference, but this is a good follow-up.

Main entry point of the user manual:

And developer documentation (still a bit of a catch-all area):

---

• CHANGELOG updated or not needed
• Documentation updated or not needed
• Haddocks updated or not needed
• No new TODOs introduced or explained herafter

[github-actions]

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-05-08 17:58:52.026150237 UTC
Max. memory units	14000000
Max. CPU units	10000000000
Max. tx size (kB)	16384

Script summary

Name	Hash	Size (Bytes)
νInitial	bccf2a430c016bc960fbf31b02694011cd399d20da8882aac9d33611	4110
νCommit	56b0f0b597150e619c76bed60683f3b1e42d7bc0685ed951b882bfc5	1975
νHead	86bff95ba20e9d1d1b34899a56d86bbacc9fed999260b27dcc92d128	9351
μHead	88f533cf67cd0fc93d7d9ccf0a8b1d69ffd1208a825efbebbc1d36ba*	4213

• 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	4795	8.89	3.40	0.46
2	4996	10.61	4.05	0.49
3	5196	12.55	4.80	0.51
5	5599	16.53	6.33	0.58
10	6604	26.22	10.05	0.73
48	14245	99.81	38.30	1.86

Cost of Commit Transaction

This is using ada-only outputs for better comparability.

UTxO	Tx size	% max Mem	% max CPU	Min fee ₳
1	556	10.24	4.04	0.29
2	745	13.88	5.64	0.34
3	936	17.66	7.29	0.39
5	1310	25.66	10.74	0.49
10	2236	48.19	20.30	0.78
19	3936	97.83	40.79	1.41

Cost of CollectCom Transaction

Parties	UTxO (bytes)	Tx size	% max Mem	% max CPU	Min fee ₳
1	57	548	16.88	6.67	0.36
2	114	654	27.34	10.88	0.48
3	168	764	37.69	15.18	0.60
4	228	874	54.03	21.78	0.78
5	281	984	68.64	27.86	0.95
6	338	1095	87.96	35.80	1.17
7	395	1205	99.90	41.12	1.31

Cost of Close Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	592	8.29	4.59	0.28
2	749	9.00	5.68	0.30
3	909	10.11	7.05	0.32
5	874	10.24	5.24	0.31
10	1952	16.26	15.46	0.48
50	8439	52.23	64.87	1.41

Cost of Contest Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	640	8.65	4.75	0.28
2	811	9.88	6.17	0.31
3	846	9.70	6.54	0.31
5	1316	12.83	10.11	0.38
10	1896	15.57	14.71	0.47
50	8228	53.07	64.63	1.41

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	4696	17.05	7.38	0.55
2	4853	28.78	12.62	0.69
3	4907	38.41	16.72	0.80
4	5031	53.48	23.38	0.97
5	5145	74.44	32.68	1.21
6	5221	89.42	39.16	1.38

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	4627	7.85	3.28	0.44
5	1	57	4662	9.00	3.99	0.46
5	5	285	4797	13.40	6.75	0.52
5	10	569	4966	19.37	10.40	0.60
5	20	1140	5308	30.90	17.53	0.76
5	30	1709	5648	42.64	24.76	0.92
5	40	2278	5987	54.17	31.89	1.08
5	50	2848	6328	65.50	38.95	1.24
5	79	4498	7310	99.00	59.68	1.70

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-05-08 18:01:55.137530697 UTC

Baseline Scenario

Number of nodes	3
Number of txs	9000
Avg. Confirmation Time (ms)	22.643671615
P99	52.731425940000065ms
P95	33.1844583ms
P50	20.3645635ms
Number of Invalid txs	0

Baseline Scenario

Number of nodes	1
Number of txs	3000
Avg. Confirmation Time (ms)	4.777192250
P99	12.970031049999866ms
P95	6.2967662ms
P50	4.4829435ms
Number of Invalid txs	0

[github-actions]

Test Results

426 tests  ±0   416 ✅ ±0   14m 41s ⏱️ +9s
138 suites ±0    10 💤 ±0 
  2 files   ±0     0 ❌ ±0 

Results for commit ab9be42. ± Comparison against base commit 7d66414.

♻️ This comment has been updated with latest results.

[ch1bo]

While working on the how-to instructions I stumbled over #1421