Metadata documentation

[ascjones]

WIP Document the metadata format and generation process.

rel use-ink/ink-docs#12 closes #940

[paritytech-cicd-pr]

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

⚠️ The ink! master is ahead of your branch, this might skew the comparison data below.

These are the results when building the examples/* contracts from this branch with cargo-contract 1.1.0-ef194a0 and comparing them to ink! master:

	Δ Optimized Size	Δ Used Gas	Total Optimized Size	Total Used Gas
accumulator			1.03 K
adder			2.17 K
contract-introspection			2.37 K
contract-terminate			0.94 K	214_418
contract-transfer			8.15 K	14_418
delegate-calls			2.99 K	14_950
delegator			6.37 K	46_295
dns			8.84 K	43_254
erc1155			17.23 K	86_508
erc20			8.49 K	43_254
erc721			11.81 K	115_344
flipper			1.31 K	14_418
forward-calls			2.90 K	29_536
incrementer			1.21 K	14_418
multisig			25.20 K	93_527
rand-extension			3.92 K	14_418
subber			2.19 K
trait-erc20			8.76 K	43_254
trait-flipper			1.00 K	14_418
trait-incrementer			1.19 K	28_836
upgradeable-flipper			1.55 K

Link to the run | Last update: Fri Apr 1 14:11:17 CEST 2022

[codecov-commenter]

Codecov Report

Merging #1208 (a928df7) into master (3d15fef) will decrease coverage by 17.31%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master    #1208       +/-   ##
===========================================
- Coverage   79.03%   61.72%   -17.32%     
===========================================
  Files         229      228        -1     
  Lines        8667     8637       -30     
===========================================
- Hits         6850     5331     -1519     
- Misses       1817     3306     +1489     

Impacted Files	Coverage Δ
crates/lang/codegen/src/traits.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/ir/src/ir/contract.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/env.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/mod.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/enforced_error.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/blake2b.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/storage.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/arg_list.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/contract.rs	0.00% <0.00%> (-100.00%)	⬇️
crates/lang/codegen/src/generator/selector.rs	0.00% <0.00%> (-100.00%)	⬇️
... and 51 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3d15fef...a928df7. Read the comment docs.

[HCastano]

Superseded by #1290