feat(docs): enrich documents with metadata

[ffakenz]

trafficstars

Fixes #456

[github-actions[bot]]

Unit Test Results

247 tests  ±0   241 :heavy_check_mark: ±0   15m 17s :stopwatch: +53s   89 suites ±0       6 :zzz: ±0      5 files   ±0       0 :x: ±0 

Results for commit 6a473834. ± Comparison against base commit e293d36a.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

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-08-25 08:38:28.580655508 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
1	4833	10.14	4.01
2	5036	13.38	5.30
3	5242	14.92	5.88
5	5652	18.51	7.25
10	6676	27.18	10.56
46	14059	99.94	38.63

Cost of Commit Transaction

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

UTxO	Tx size	% max Mem	% max CPU
1	5771	19.85	8.02

Cost of CollectCom Transaction

Parties	Tx size	% max Mem	% max CPU
1	13136	21.44	8.60
2	13388	36.59	14.82
3	13701	55.12	22.49
4	13985	76.00	31.17

Cost of Close Transaction

Parties	Tx size	% max Mem	% max CPU
1	9361	8.63	3.53
2	9490	8.97	3.81
3	9690	10.14	4.42
5	9983	11.31	5.17
10	10879	16.04	7.75
30	14217	32.26	17.02
71	16308	42.04	15.91

Cost of Contest Transaction

Parties	Tx size	% max Mem	% max CPU
1	9328	8.16	3.34
2	9493	8.94	3.79
3	9685	10.16	4.42
5	9991	11.28	5.15
10	10841	15.62	7.57
30	14189	32.02	16.92
43	16359	42.74	23.01

Cost of Abort Transaction

Parties	Tx size	% max Mem	% max CPU
1	13495	22.50	9.35
2	14106	44.21	19.55
3	13786	49.11	20.72
4	14535	85.03	38.19
5	14359	95.27	41.49

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
1	13484	10.26	4.46
2	13520	12.08	5.46
3	13620	13.68	6.37
5	13563	15.96	7.83
10	13871	24.63	12.64
50	15314	85.56	47.87
60	15538	99.74	56.26

[ffakenz]

From To

[abailly-iohk]

When trying to build the doc I got this failure:

$ yarn start
yarn run v1.22.17
$ docusaurus start
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at http://localhost:3000/head-protocol/.

✖ Client
  Compiled with some errors in 10.57s



Module not found: Error: Can't resolve '@site/static/docs-metadata.json' in '/home/curry/hydra-poc/docs/src/components/DocumentMetadata'
client (webpack 5.70.0) compiled with 1 error

Any clues?

[ch1bo]

When trying to build the doc I got this failure:

$ yarn start
yarn run v1.22.17
$ docusaurus start
[INFO] Starting the development server...
[SUCCESS] Docusaurus website is running at http://localhost:3000/head-protocol/.

✖ Client
  Compiled with some errors in 10.57s



Module not found: Error: Can't resolve '@site/static/docs-metadata.json' in '/home/curry/hydra-poc/docs/src/components/DocumentMetadata'
client (webpack 5.70.0) compiled with 1 error

Any clues?

Seems like the enrich-document-metadata step is not part of the yarn start. It's only on yarn build.

[ffakenz]

@abailly-iohk nice recommendation. added the enrichment step as part of yarn start