feat(docs): add glossary page

[ffakenz]

Fixes #495

[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	2022-09-23 14:24:09.829092963 UTC
Max. memory units	14000000
Max. CPU units	10000000000
Max. tx size (kB)	16384

Cost of Init Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	4831	9.31	3.67	0.46
2	5037	10.92	4.28	0.49
3	5242	14.41	5.67	0.54
5	5652	18.53	7.26	0.60
10	6677	29.28	11.42	0.76
45	13859	97.02	37.48	1.81

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	5771	19.92	8.05	0.62

Cost of CollectCom Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	12951	19.11	7.62	0.93
2	13342	35.40	14.33	1.13
3	13667	53.97	22.02	1.35
4	14093	77.45	31.78	1.63

Cost of Close Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	9323	8.19	3.36	0.65
2	9492	8.97	3.81	0.67
3	9657	9.75	4.27	0.68
5	9991	11.31	5.17	0.72
10	10846	15.65	7.60	0.81
30	14178	31.86	16.86	1.15
69	16111	40.98	15.52	1.30

Cost of Contest Transaction

Parties	Tx size	% max Mem	% max CPU	Min fee ₳
1	9328	8.16	3.34	0.65
2	9493	8.94	3.79	0.67
3	9692	10.12	4.40	0.69
5	10024	11.91	5.39	0.73
10	10885	16.25	7.82	0.82
30	14218	32.74	17.20	1.16
43	16374	43.11	23.15	1.39

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	13495	22.50	9.35	0.99
2	13604	34.02	14.28	1.13
3	13927	52.72	22.50	1.35
4	14250	75.81	33.05	1.63

Cost of FanOut Transaction

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

UTxO	Tx size	% max Mem	% max CPU	Min fee ₳
1	13421	9.88	4.31	0.85
2	13585	12.16	5.49	0.89
3	13556	13.55	6.32	0.90
5	13691	16.72	8.12	0.95
10	13743	23.57	12.23	1.03
50	15245	85.18	47.72	1.85
59	15504	98.52	55.50	2.03

[github-actions]

Unit Test Results

253 tests   247 ✔️  16m 27s ⏱️
  91 suites      6 💤
    5 files        0 ❌

Results for commit baee5fb.

♻️ This comment has been updated with latest results.

[ch1bo]

I don't want to maintain two explanations of a single term.

[ch1bo]

I also tried the replacement feature as documented here https://github.com/woondossier/docusaurus-terminology#use-patterns-to-reference-a-term, but it seems not to work.

The whole plugin feels super inefficient and unnecessarily hard to maintain :(

Maybe we should just write a glossary.md page ourselves and have it contain a single list of explanations? I don't see why we need this parsing/auto-generating of glossary page etc. -> it does not appear to be worth its weight.

[KtorZ]

This is a bit unclear 🤔

[KtorZ]

What about: "The time window between closing of the head and the last possible contest from a head participant."

[ch1bo]

Much better 😌