From 4937f779068d1ab947c9eada8e1d3f5b7191eb94 Mon Sep 17 00:00:00 2001
From: seemantaggarwal <32275622+seemantaggarwal@users.noreply.github.com>
Date: Mon, 20 Jan 2025 15:51:29 +0530
Subject: [PATCH] Use docify export for parachain template hardcoded
configuration and embed it in its README #6333 (#7093)
Use docify export for parachain template hardcoded configuration and
embed it in its README #6333
Docify currently has a limitation of not being able to embed a
variable/const in its code, without embedding it's definition, even if
do something in a string like
"this is a sample string ${sample_variable}"
It will embed the entire string
"this is a sample string ${sample_variable}"
without replacing the value of sample_variable from the code
Hence, the goal was just to make it obvious in the README where the
PARACHAIN_ID value is coming from, so a note has been added at the start
for the same, so whenever somebody is running these commands, they will
be aware about the value and replace accordingly.
To make it simpler, we added a
rust ignore block so the user can just look it up in the readme itself
and does not have to scan through the runtime directory for the value.
---------
Co-authored-by: Iulian Barbu <14218860+iulianbarbu@users.noreply.github.com>
---
.github/scripts/generate-prdoc.py | 4 +-
.github/workflows/misc-sync-templates.yml | 6 +
Cargo.lock | 220 ++++++++-------
Cargo.toml | 1 +
prdoc/pr_7093.prdoc | 8 +
templates/parachain/Cargo.toml | 16 ++
templates/parachain/README.docify.md | 254 ++++++++++++++++++
templates/parachain/README.md | 46 ++--
.../runtime/src/genesis_config_presets.rs | 1 +
templates/parachain/src/lib.rs | 22 ++
10 files changed, 465 insertions(+), 113 deletions(-)
create mode 100644 prdoc/pr_7093.prdoc
create mode 100644 templates/parachain/Cargo.toml
create mode 100644 templates/parachain/README.docify.md
create mode 100644 templates/parachain/src/lib.rs
diff --git a/.github/scripts/generate-prdoc.py b/.github/scripts/generate-prdoc.py
index 9154f185e64..43e8437a0c9 100644
--- a/.github/scripts/generate-prdoc.py
+++ b/.github/scripts/generate-prdoc.py
@@ -86,10 +86,10 @@ def create_prdoc(pr, audience, title, description, patch, bump, force):
if p == '/':
exit(1)
p = os.path.dirname(p)
-
+
with open(os.path.join(p, "Cargo.toml")) as f:
manifest = toml.load(f)
-
+
if not "package" in manifest:
continue
diff --git a/.github/workflows/misc-sync-templates.yml b/.github/workflows/misc-sync-templates.yml
index 8d06d89621d..ac66e697562 100644
--- a/.github/workflows/misc-sync-templates.yml
+++ b/.github/workflows/misc-sync-templates.yml
@@ -131,6 +131,12 @@ jobs:
- name: Copy over the new changes
run: |
cp -r polkadot-sdk/templates/${{ matrix.template }}/* "${{ env.template-path }}/"
+ - name: Remove unnecessary files from parachain template
+ if: ${{ matrix.template == 'parachain' }}
+ run: |
+ rm -f "${{ env.template-path }}/README.docify.md"
+ rm -f "${{ env.template-path }}/Cargo.toml"
+ rm -f "${{ env.template-path }}/src/lib.rs"
- name: Run psvm on monorepo workspace dependencies
run: psvm -o -v ${{ github.event.inputs.stable_release_branch }} -p ./Cargo.toml
diff --git a/Cargo.lock b/Cargo.lock
index c9a139f3074..0907830c5e7 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -36,6 +36,12 @@ version = "1.0.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe"
+[[package]]
+name = "adler2"
+version = "2.0.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627"
+
[[package]]
name = "adler32"
version = "1.2.0"
@@ -112,9 +118,9 @@ dependencies = [
[[package]]
name = "aho-corasick"
-version = "1.0.4"
+version = "1.1.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6748e8def348ed4d14996fa801f4122cd763fff530258cdc03f64b25f89d3a5a"
+checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
dependencies = [
"memchr",
]
@@ -363,23 +369,24 @@ dependencies = [
[[package]]
name = "anstream"
-version = "0.6.11"
+version = "0.6.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6e2e1ebcb11de5c03c67de28a7df593d32191b44939c482e97702baaaa6ab6a5"
+checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
dependencies = [
"anstyle",
"anstyle-parse",
"anstyle-query",
"anstyle-wincon",
"colorchoice",
+ "is_terminal_polyfill",
"utf8parse",
]
[[package]]
name = "anstyle"
-version = "1.0.6"
+version = "1.0.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8901269c6307e8d93993578286ac0edf7f195079ffff5ebdeea6a59ffb7e36bc"
+checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
[[package]]
name = "anstyle-parse"
@@ -401,12 +408,12 @@ dependencies = [
[[package]]
name = "anstyle-wincon"
-version = "3.0.1"
+version = "3.0.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f0699d10d2f4d628a98ee7b57b289abbc98ff3bad977cb3152709d4bf2330628"
+checksum = "2109dbce0e72be3ec00bed26e6a7479ca384ad226efdd66db8fa2e3a38c83125"
dependencies = [
"anstyle",
- "windows-sys 0.48.0",
+ "windows-sys 0.59.0",
]
[[package]]
@@ -1679,7 +1686,7 @@ dependencies = [
"cc",
"cfg-if",
"libc",
- "miniz_oxide",
+ "miniz_oxide 0.7.1",
"object 0.32.2",
"rustc-demangle",
]
@@ -3079,12 +3086,12 @@ dependencies = [
[[package]]
name = "bstr"
-version = "1.6.0"
+version = "1.11.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6798148dccfbff0fae41c7574d2fa8f1ef3492fba0face179de5d8d447d67b05"
+checksum = "531a9155a481e2ee699d4f98f43c0ca4ff8ee1bfd55c31e9e98fb29d2b176fe0"
dependencies = [
"memchr",
- "regex-automata 0.3.6",
+ "regex-automata 0.4.8",
"serde",
]
@@ -3187,9 +3194,9 @@ dependencies = [
[[package]]
name = "cargo-platform"
-version = "0.1.3"
+version = "0.1.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2cfa25e60aea747ec7e1124f238816749faa93759c6ff5b31f1ccdda137f4479"
+checksum = "e35af189006b9c0f00a064685c727031e3ed2d8020f7ba284d78cc2671bd36ea"
dependencies = [
"serde",
]
@@ -3202,7 +3209,7 @@ checksum = "eee4243f1f26fc7a42710e7439c149e2b10b05472f88090acce52632f231a73a"
dependencies = [
"camino",
"cargo-platform",
- "semver 1.0.18",
+ "semver 1.0.24",
"serde",
"serde_json",
"thiserror",
@@ -3487,12 +3494,12 @@ dependencies = [
[[package]]
name = "clap"
-version = "4.5.13"
+version = "4.5.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0fbb260a053428790f3de475e304ff84cdbc4face759ea7a3e64c1edd938a7fc"
+checksum = "a8eb5e908ef3a6efbe1ed62520fb7287959888c88485abe072543190ecc66783"
dependencies = [
"clap_builder",
- "clap_derive 4.5.13",
+ "clap_derive 4.5.24",
]
[[package]]
@@ -3506,24 +3513,24 @@ dependencies = [
[[package]]
name = "clap_builder"
-version = "4.5.13"
+version = "4.5.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "64b17d7ea74e9f833c7dbf2cbe4fb12ff26783eda4782a8975b72f895c9b4d99"
+checksum = "96b01801b5fc6a0a232407abc821660c9c6d25a1cafc0d4f85f29fb8d9afc121"
dependencies = [
"anstream",
"anstyle",
- "clap_lex 0.7.0",
+ "clap_lex 0.7.4",
"strsim 0.11.1",
"terminal_size",
]
[[package]]
name = "clap_complete"
-version = "4.5.13"
+version = "4.5.42"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "aa3c596da3cf0983427b0df0dba359df9182c13bd5b519b585a482b0c351f4e8"
+checksum = "33a7e468e750fa4b6be660e8b5651ad47372e8fb114030b594c2d75d48c5ffd0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
]
[[package]]
@@ -3541,9 +3548,9 @@ dependencies = [
[[package]]
name = "clap_derive"
-version = "4.5.13"
+version = "4.5.24"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "501d359d5f3dcaf6ecdeee48833ae73ec6e42723a1e52419c79abf9507eec0a0"
+checksum = "54b755194d6389280185988721fffba69495eed5ee9feeee9a599b53db80318c"
dependencies = [
"heck 0.5.0",
"proc-macro2 1.0.86",
@@ -3562,9 +3569,9 @@ dependencies = [
[[package]]
name = "clap_lex"
-version = "0.7.0"
+version = "0.7.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "98cc8fbded0c607b7ba9dd60cd98df59af97e84d24e49c8557331cfc26d301ce"
+checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"
[[package]]
name = "cmd_lib"
@@ -3750,23 +3757,23 @@ dependencies = [
[[package]]
name = "color-print"
-version = "0.3.4"
+version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f2a5e6504ed8648554968650feecea00557a3476bc040d0ffc33080e66b646d0"
+checksum = "3aa954171903797d5623e047d9ab69d91b493657917bdfb8c2c80ecaf9cdb6f4"
dependencies = [
"color-print-proc-macro",
]
[[package]]
name = "color-print-proc-macro"
-version = "0.3.4"
+version = "0.3.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d51beaa537d73d2d1ff34ee70bc095f170420ab2ec5d687ecd3ec2b0d092514b"
+checksum = "692186b5ebe54007e45a59aea47ece9eb4108e141326c304cdc91699a7118a22"
dependencies = [
"nom",
"proc-macro2 1.0.86",
"quote 1.0.37",
- "syn 1.0.109",
+ "syn 2.0.87",
]
[[package]]
@@ -4441,7 +4448,7 @@ dependencies = [
"anes",
"cast",
"ciborium",
- "clap 4.5.13",
+ "clap 4.5.26",
"criterion-plot",
"futures",
"is-terminal",
@@ -4586,7 +4593,7 @@ dependencies = [
name = "cumulus-client-cli"
version = "0.7.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"parity-scale-codec",
"sc-chain-spec",
"sc-cli",
@@ -5250,7 +5257,7 @@ name = "cumulus-pov-validator"
version = "0.1.0"
dependencies = [
"anyhow",
- "clap 4.5.13",
+ "clap 4.5.26",
"parity-scale-codec",
"polkadot-node-primitives",
"polkadot-parachain-primitives 6.0.0",
@@ -5690,7 +5697,7 @@ name = "cumulus-test-service"
version = "0.1.0"
dependencies = [
"async-trait",
- "clap 4.5.13",
+ "clap 4.5.26",
"criterion",
"cumulus-client-cli",
"cumulus-client-collator",
@@ -5784,9 +5791,9 @@ dependencies = [
[[package]]
name = "curl-sys"
-version = "0.4.72+curl-8.6.0"
+version = "0.4.78+curl-8.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "29cbdc8314c447d11e8fd156dcdd031d9e02a7a976163e396b548c03153bc9ea"
+checksum = "8eec768341c5c7789611ae51cf6c459099f22e64a5d5d0ce4892434e33821eaf"
dependencies = [
"cc",
"libc",
@@ -6938,14 +6945,14 @@ dependencies = [
[[package]]
name = "filetime"
-version = "0.2.22"
+version = "0.2.25"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d4029edd3e734da6fe05b6cd7bd2960760a616bd2ddd0d59a0124746d6272af0"
+checksum = "35c0522e981e68cbfa8c3f978441a5f34b30b96e146b33cd3359176b50fe8586"
dependencies = [
"cfg-if",
"libc",
- "redox_syscall 0.3.5",
- "windows-sys 0.48.0",
+ "libredox",
+ "windows-sys 0.59.0",
]
[[package]]
@@ -7022,12 +7029,12 @@ checksum = "0ce7134b9999ecaf8bcd65542e436736ef32ddca1b3e06094cb6ec5755203b80"
[[package]]
name = "flate2"
-version = "1.0.27"
+version = "1.0.35"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c6c98ee8095e9d1dcbf2fcc6d95acccb90d1c81db1e44725c6a984b1dbdfb010"
+checksum = "c936bfdafb507ebbf50b8074c54fa31c5be9a1e7e5f467dd659697041407d07c"
dependencies = [
"crc32fast",
- "miniz_oxide",
+ "miniz_oxide 0.8.2",
]
[[package]]
@@ -7180,7 +7187,7 @@ dependencies = [
"Inflector",
"array-bytes",
"chrono",
- "clap 4.5.13",
+ "clap 4.5.26",
"comfy-table",
"cumulus-client-parachain-inherent",
"cumulus-primitives-proof-size-hostfunction 0.2.0",
@@ -7346,7 +7353,7 @@ dependencies = [
name = "frame-election-solution-type-fuzzer"
version = "2.0.0-alpha.5"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"frame-election-provider-solution-type 13.0.0",
"frame-election-provider-support 28.0.0",
"frame-support 28.0.0",
@@ -7479,7 +7486,7 @@ name = "frame-omni-bencher"
version = "0.1.0"
dependencies = [
"assert_cmd",
- "clap 4.5.13",
+ "clap 4.5.26",
"cumulus-primitives-proof-size-hostfunction 0.2.0",
"cumulus-test-runtime",
"frame-benchmarking-cli",
@@ -9194,6 +9201,12 @@ dependencies = [
"winapi",
]
+[[package]]
+name = "is_terminal_polyfill"
+version = "1.70.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
+
[[package]]
name = "isahc"
version = "1.7.2"
@@ -10285,6 +10298,17 @@ dependencies = [
"yamux 0.13.3",
]
+[[package]]
+name = "libredox"
+version = "0.1.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d"
+dependencies = [
+ "bitflags 2.6.0",
+ "libc",
+ "redox_syscall 0.5.8",
+]
+
[[package]]
name = "librocksdb-sys"
version = "0.11.0+8.1.1"
@@ -10361,9 +10385,9 @@ dependencies = [
[[package]]
name = "libz-sys"
-version = "1.1.12"
+version = "1.1.21"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d97137b25e321a73eef1418d1d5d2eda4d77e12813f8e6dead84bc52c5870a7b"
+checksum = "df9b68e50e6e0b26f672573834882eb57759f6db9b3be2ea3c35c91188bb4eaa"
dependencies = [
"cc",
"libc",
@@ -10832,7 +10856,7 @@ checksum = "68354c5c6bd36d73ff3feceb05efa59b6acb7626617f4962be322a825e61f79a"
name = "minimal-template-node"
version = "0.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"docify",
"futures",
"futures-timer",
@@ -10862,6 +10886,15 @@ dependencies = [
"adler",
]
+[[package]]
+name = "miniz_oxide"
+version = "0.8.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ffbe83022cedc1d264172192511ae958937694cd57ce297164951b8b3568394"
+dependencies = [
+ "adler2",
+]
+
[[package]]
name = "mio"
version = "1.0.2"
@@ -11339,7 +11372,7 @@ version = "0.9.0-dev"
dependencies = [
"array-bytes",
"async-trait",
- "clap 4.5.13",
+ "clap 4.5.26",
"derive_more 0.99.17",
"fs_extra",
"futures",
@@ -11415,7 +11448,7 @@ dependencies = [
name = "node-runtime-generate-bags"
version = "3.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"generate-bags",
"kitchensink-runtime",
]
@@ -11424,7 +11457,7 @@ dependencies = [
name = "node-template-release"
version = "3.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"flate2",
"fs_extra",
"glob",
@@ -14916,7 +14949,7 @@ name = "pallet-revive-eth-rpc"
version = "0.1.0"
dependencies = [
"anyhow",
- "clap 4.5.13",
+ "clap 4.5.26",
"env_logger 0.11.3",
"ethabi",
"futures",
@@ -16252,11 +16285,18 @@ dependencies = [
"staging-xcm-builder 17.0.1",
]
+[[package]]
+name = "parachain-template"
+version = "0.0.0"
+dependencies = [
+ "docify",
+]
+
[[package]]
name = "parachain-template-node"
version = "0.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"color-print",
"docify",
"futures",
@@ -17240,7 +17280,7 @@ name = "polkadot-cli"
version = "7.0.0"
dependencies = [
"cfg-if",
- "clap 4.5.13",
+ "clap 4.5.26",
"frame-benchmarking-cli",
"futures",
"log",
@@ -18111,7 +18151,7 @@ version = "0.1.0"
dependencies = [
"assert_cmd",
"async-trait",
- "clap 4.5.13",
+ "clap 4.5.26",
"color-print",
"cumulus-client-cli",
"cumulus-client-collator",
@@ -19629,7 +19669,7 @@ dependencies = [
"async-trait",
"bincode",
"bitvec",
- "clap 4.5.13",
+ "clap 4.5.26",
"clap-num",
"color-eyre",
"colored",
@@ -19731,7 +19771,7 @@ version = "1.0.0"
dependencies = [
"assert_matches",
"async-trait",
- "clap 4.5.13",
+ "clap 4.5.26",
"color-eyre",
"futures",
"futures-timer",
@@ -19873,7 +19913,7 @@ dependencies = [
name = "polkadot-voter-bags"
version = "7.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"generate-bags",
"sp-io 30.0.0",
"westend-runtime",
@@ -21197,12 +21237,6 @@ dependencies = [
"regex-syntax 0.6.29",
]
-[[package]]
-name = "regex-automata"
-version = "0.3.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fed1ceff11a1dddaee50c9dc8e4938bd106e9d89ae372f192311e7da498e3b69"
-
[[package]]
name = "regex-automata"
version = "0.4.8"
@@ -21302,7 +21336,7 @@ dependencies = [
name = "remote-ext-tests-bags-list"
version = "1.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"frame-system 28.0.0",
"log",
"pallet-bags-list-remote-tests",
@@ -21915,7 +21949,7 @@ version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bfa0f585226d2e68097d4f95d113b15b83a82e819ab25717ec0590d9584ef366"
dependencies = [
- "semver 1.0.18",
+ "semver 1.0.24",
]
[[package]]
@@ -22334,7 +22368,7 @@ name = "sc-chain-spec"
version = "28.0.0"
dependencies = [
"array-bytes",
- "clap 4.5.13",
+ "clap 4.5.26",
"docify",
"log",
"memmap2 0.9.3",
@@ -22377,7 +22411,7 @@ version = "0.36.0"
dependencies = [
"array-bytes",
"chrono",
- "clap 4.5.13",
+ "clap 4.5.26",
"fdlimit",
"futures",
"futures-timer",
@@ -23725,7 +23759,7 @@ dependencies = [
name = "sc-storage-monitor"
version = "0.16.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"fs4",
"log",
"sp-core 28.0.0",
@@ -24299,9 +24333,9 @@ dependencies = [
[[package]]
name = "semver"
-version = "1.0.18"
+version = "1.0.24"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b0293b4b29daaf487284529cc2f5675b8e57c61f70167ba415a463651fd6a918"
+checksum = "3cb6eb87a131f756572d7fb904f6e7b68633f09cca868c5df1c4b8d1a694bbba"
dependencies = [
"serde",
]
@@ -25613,7 +25647,7 @@ dependencies = [
name = "solochain-template-node"
version = "0.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"frame-benchmarking-cli",
"frame-metadata-hash-extension 0.1.0",
"frame-system 28.0.0",
@@ -26996,7 +27030,7 @@ dependencies = [
name = "sp-npos-elections-fuzzer"
version = "2.0.0-alpha.5"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"honggfuzz",
"rand",
"sp-npos-elections 26.0.0",
@@ -28220,7 +28254,7 @@ checksum = "a8f112729512f8e442d81f95a8a7ddf2b7c6b8a1a6f509a95864142b30cab2d3"
name = "staging-chain-spec-builder"
version = "1.6.1"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"cmd_lib",
"docify",
"log",
@@ -28237,7 +28271,7 @@ version = "3.0.0-dev"
dependencies = [
"array-bytes",
"assert_cmd",
- "clap 4.5.13",
+ "clap 4.5.26",
"clap_complete",
"criterion",
"futures",
@@ -28274,7 +28308,7 @@ dependencies = [
name = "staging-node-inspect"
version = "0.12.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"parity-scale-codec",
"sc-cli",
"sc-client-api",
@@ -28619,7 +28653,7 @@ dependencies = [
name = "subkey"
version = "9.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"sc-cli",
]
@@ -29045,7 +29079,7 @@ dependencies = [
"rand",
"reqwest 0.12.9",
"scale-info",
- "semver 1.0.18",
+ "semver 1.0.24",
"serde",
"serde_json",
"sp-version 35.0.0",
@@ -29458,9 +29492,9 @@ checksum = "55937e1799185b12863d447f42597ed69d9928686b8d88a1df17376a097d8369"
[[package]]
name = "tar"
-version = "0.4.40"
+version = "0.4.43"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b16afcea1f22891c49a00c751c7b63b2233284064f11a200fc624137c51e2ddb"
+checksum = "c65998313f8e17d0d553d28f91a0df93e4dbbbf770279c7bc21ca0f09ea1a1f6"
dependencies = [
"filetime",
"libc",
@@ -29508,12 +29542,12 @@ dependencies = [
[[package]]
name = "terminal_size"
-version = "0.3.0"
+version = "0.4.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "21bebf2b7c9e0a515f6e0f8c51dc0f8e4696391e6f1ff30379559f8365fb0df7"
+checksum = "5352447f921fda68cf61b4101566c0bdb5104eff6804d0678e5227580ab6a4e9"
dependencies = [
"rustix 0.38.42",
- "windows-sys 0.48.0",
+ "windows-sys 0.59.0",
]
[[package]]
@@ -29560,7 +29594,7 @@ dependencies = [
name = "test-parachain-adder-collator"
version = "1.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"futures",
"futures-timer",
"log",
@@ -29607,7 +29641,7 @@ dependencies = [
name = "test-parachain-undying-collator"
version = "1.0.0"
dependencies = [
- "clap 4.5.13",
+ "clap 4.5.26",
"futures",
"futures-timer",
"log",
@@ -31903,11 +31937,13 @@ dependencies = [
[[package]]
name = "xattr"
-version = "1.0.1"
+version = "1.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f4686009f71ff3e5c4dbcf1a282d0a44db3f021ba69350cd42086b3e5f1c6985"
+checksum = "e105d177a3871454f754b33bb0ee637ecaaac997446375fd3e5d43a2ed00c909"
dependencies = [
"libc",
+ "linux-raw-sys 0.4.14",
+ "rustix 0.38.42",
]
[[package]]
diff --git a/Cargo.toml b/Cargo.toml
index e17f08148b1..18c1dd2c68d 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -538,6 +538,7 @@ members = [
"templates/minimal/node",
"templates/minimal/pallets/template",
"templates/minimal/runtime",
+ "templates/parachain",
"templates/parachain/node",
"templates/parachain/pallets/template",
"templates/parachain/runtime",
diff --git a/prdoc/pr_7093.prdoc b/prdoc/pr_7093.prdoc
new file mode 100644
index 00000000000..cad4477e883
--- /dev/null
+++ b/prdoc/pr_7093.prdoc
@@ -0,0 +1,8 @@
+title: 'initial docify readme with some content #6333'
+doc:
+- audience: Runtime Dev
+ description: |
+ Docifying the README.MD under templates/parachain by adding a Docify.
+ Also Adding the Cargo.toml under the same folder, essentially making it a crate as Docify acts
+ for Readmes only under the same crate.
+crates: [ ]
diff --git a/templates/parachain/Cargo.toml b/templates/parachain/Cargo.toml
new file mode 100644
index 00000000000..84b9d5e29bb
--- /dev/null
+++ b/templates/parachain/Cargo.toml
@@ -0,0 +1,16 @@
+[package]
+name = "parachain-template"
+description = "A parachain-template helper crate to keep documentation in sync with the template's components."
+version = "0.0.0"
+license = "Unlicense"
+authors.workspace = true
+homepage.workspace = true
+repository.workspace = true
+edition.workspace = true
+publish = false
+
+[dependencies]
+docify = "0.2.9"
+
+[features]
+generate-readme = []
diff --git a/templates/parachain/README.docify.md b/templates/parachain/README.docify.md
new file mode 100644
index 00000000000..47385e0bbf1
--- /dev/null
+++ b/templates/parachain/README.docify.md
@@ -0,0 +1,254 @@
+<div align="center">
+
+# Polkadot SDK's Parachain Template
+
+<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_White.png#gh-dark-mode-only"/>
+<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_Black.png#gh-light-mode-only"/>
+
+> This is a template for creating a [parachain](https://wiki.polkadot.network/docs/learn-parachains) based on Polkadot SDK.
+>
+> This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
+
+</div>
+
+## Table of Contents
+
+- [Intro](#intro)
+
+- [Template Structure](#template-structure)
+
+- [Getting Started](#getting-started)
+
+- [Starting a Development Chain](#starting-a-development-chain)
+
+ - [Omni Node](#omni-node-prerequisites)
+ - [Zombienet setup with Omni Node](#zombienet-setup-with-omni-node)
+ - [Parachain Template Node](#parachain-template-node)
+ - [Connect with the Polkadot-JS Apps Front-End](#connect-with-the-polkadot-js-apps-front-end)
+ - [Takeaways](#takeaways)
+
+- [Runtime development](#runtime-development)
+- [Contributing](#contributing)
+- [Getting Help](#getting-help)
+
+## Intro
+
+- â« This template provides a starting point to build a [parachain](https://wiki.polkadot.network/docs/learn-parachains).
+
+- â˜ï¸ It is based on the
+ [Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.
+
+- 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
+ such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
+
+- 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains)
+
+## Template Structure
+
+A Polkadot SDK based project such as this one consists of:
+
+- 🧮 the [Runtime](./runtime/README.md) - the core logic of the parachain.
+- 🎨 the [Pallets](./pallets/README.md) - from which the runtime is constructed.
+- 💿 a [Node](./node/README.md) - the binary application, not part of the project default-members list and not compiled unless
+ building the project with `--workspace` flag, which builds all workspace members, and is an alternative to
+ [Omni Node](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/omni_node/index.html).
+
+## Getting Started
+
+- 🦀 The template is using the Rust language.
+
+- 👉 Check the
+ [Rust installation instructions](https://www.rust-lang.org/tools/install) for your system.
+
+- ðŸ› ï¸ Depending on your operating system and Rust version, there might be additional
+ packages required to compile this template - please take note of the Rust compiler output.
+
+Fetch parachain template code:
+
+```sh
+git clone https://github.com/paritytech/polkadot-sdk-parachain-template.git parachain-template
+
+cd parachain-template
+```
+
+## Starting a Development Chain
+
+The parachain template relies on a hardcoded parachain id which is defined in the runtime code
+and referenced throughout the contents of this file as `{{PARACHAIN_ID}}`. Please replace
+any command or file referencing this placeholder with the value of the `PARACHAIN_ID` constant:
+
+<!-- docify::embed!("runtime/src/genesis_config_presets.rs", PARACHAIN_ID)-->
+
+### Omni Node Prerequisites
+
+[Omni Node](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/omni_node/index.html) can
+be used to run the parachain template's runtime. `polkadot-omni-node` binary crate usage is described at a high-level
+[on crates.io](https://crates.io/crates/polkadot-omni-node).
+
+#### Install `polkadot-omni-node`
+
+Please see the installation section at [`crates.io/omni-node`](https://crates.io/crates/polkadot-omni-node).
+
+#### Build `parachain-template-runtime`
+
+```sh
+cargo build --release
+```
+
+#### Install `staging-chain-spec-builder`
+
+Please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
+
+#### Use `chain-spec-builder` to generate the `chain_spec.json` file
+
+```sh
+chain-spec-builder create --relay-chain "rococo-local" --para-id {{PARACHAIN_ID}} --runtime \
+ target/release/wbuild/parachain-template-runtime/parachain_template_runtime.wasm named-preset development
+```
+
+**Note**: the `relay-chain` and `para-id` flags are mandatory information required by
+Omni Node, and for parachain template case the value for `para-id` must be set to `{{PARACHAIN_ID}}`, since this
+is also the value injected through [ParachainInfo](https://docs.rs/staging-parachain-info/0.17.0/staging_parachain_info/)
+pallet into the `parachain-template-runtime`'s storage. The `relay-chain` value is set in accordance
+with the relay chain ID where this instantiation of parachain-template will connect to.
+
+#### Run Omni Node
+
+Start Omni Node with the generated chain spec. We'll start it in development mode (without a relay chain config), producing
+and finalizing blocks based on manual seal, configured below to seal a block with each second.
+
+```bash
+polkadot-omni-node --chain <path/to/chain_spec.json> --dev --dev-block-time 1000
+```
+
+However, such a setup is not close to what would run in production, and for that we need to setup a local
+relay chain network that will help with the block finalization. In this guide we'll setup a local relay chain
+as well. We'll not do it manually, by starting one node at a time, but we'll use [zombienet](https://paritytech.github.io/zombienet/intro.html).
+
+Follow through the next section for more details on how to do it.
+
+### Zombienet setup with Omni Node
+
+Assuming we continue from the last step of the previous section, we have a chain spec and we need to setup a relay chain.
+We can install `zombienet` as described [here](https://paritytech.github.io/zombienet/install.html#installation), and
+`zombienet-omni-node.toml` contains the network specification we want to start.
+
+#### Relay chain prerequisites
+
+Download the `polkadot` (and the accompanying `polkadot-prepare-worker` and `polkadot-execute-worker`) binaries from
+[Polkadot SDK releases](https://github.com/paritytech/polkadot-sdk/releases). Then expose them on `PATH` like so:
+
+```sh
+export PATH="$PATH:<path/to/binaries>"
+```
+
+#### Update `zombienet-omni-node.toml` with a valid chain spec path
+
+```toml
+# ...
+[[parachains]]
+id = {{PARACHAIN_ID}}
+chain_spec_path = "<TO BE UPDATED WITH A VALID PATH>"
+# ...
+```
+
+#### Start the network
+
+```sh
+zombienet --provider native spawn zombienet-omni-node.toml
+```
+
+### Parachain Template Node
+
+As mentioned in the `Template Structure` section, the `node` crate is optionally compiled and it is an alternative
+to `Omni Node`. Similarly, it requires setting up a relay chain, and we'll use `zombienet` once more.
+
+#### Install the `parachain-template-node`
+
+```sh
+cargo install --path node
+```
+
+#### Setup and start the network
+
+For setup, please consider the instructions for `zombienet` installation [here](https://paritytech.github.io/zombienet/install.html#installation)
+and [relay chain prerequisites](#relay-chain-prerequisites).
+
+We're left just with starting the network:
+
+```sh
+zombienet --provider native spawn zombienet.toml
+```
+
+### Connect with the Polkadot-JS Apps Front-End
+
+- 🌠You can interact with your local node using the
+ hosted version of the Polkadot/Substrate Portal:
+ [relay chain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944)
+ and [parachain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9988).
+
+- 🪠A hosted version is also
+ available on [IPFS](https://dotapps.io/).
+
+- 🧑â€ðŸ”§ You can also find the source code and instructions for hosting your own instance in the
+ [`polkadot-js/apps`](https://github.com/polkadot-js/apps) repository.
+
+### Takeaways
+
+Development parachains:
+
+- 🔗 Connect to relay chains, and we showcased how to connect to a local one.
+- 🧹 Do not persist the state.
+- 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
+- 🧑â€âš–ï¸ Development accounts are used as validators, collators, and `sudo` accounts.
+
+## Runtime development
+
+We recommend using [`chopsticks`](https://github.com/AcalaNetwork/chopsticks) when the focus is more on the runtime
+development and `OmniNode` is enough as is.
+
+### Install chopsticks
+
+To use `chopsticks`, please install the latest version according to the installation [guide](https://github.com/AcalaNetwork/chopsticks?tab=readme-ov-file#install).
+
+### Build a raw chain spec
+
+Build the `parachain-template-runtime` as mentioned before in this guide and use `chain-spec-builder`
+again but this time by passing `--raw-storage` flag:
+
+```sh
+chain-spec-builder create --raw-storage --relay-chain "rococo-local" --para-id {{PARACHAIN_ID}} --runtime \
+ target/release/wbuild/parachain-template-runtime/parachain_template_runtime.wasm named-preset development
+```
+
+### Start `chopsticks` with the chain spec
+
+```sh
+npx @acala-network/chopsticks@latest --chain-spec <path/to/chain_spec.json>
+```
+
+### Alternatives
+
+`OmniNode` can be still used for runtime development if using the `--dev` flag, while `parachain-template-node` doesn't
+support it at this moment. It can still be used to test a runtime in a full setup where it is started alongside a
+relay chain network (see [Parachain Template node](#parachain-template-node) setup).
+
+## Contributing
+
+- 🔄 This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
+
+- âž¡ï¸ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain).
+
+- 😇 Please refer to the monorepo's
+ [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
+ [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
+
+## Getting Help
+
+- 🧑â€ðŸ« To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
+
+- 🧑â€ðŸ”§ For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
+ the Polkadot SDK documentation resources.
+
+- 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
+ [Substrate StackExchange](https://substrate.stackexchange.com/).
diff --git a/templates/parachain/README.md b/templates/parachain/README.md
index c1e333df9e9..15e9f7fe61c 100644
--- a/templates/parachain/README.md
+++ b/templates/parachain/README.md
@@ -36,10 +36,10 @@
- â« This template provides a starting point to build a [parachain](https://wiki.polkadot.network/docs/learn-parachains).
- â˜ï¸ It is based on the
-[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.
+ [Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.
- 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
-such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
+ such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
- 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains)
@@ -50,18 +50,18 @@ A Polkadot SDK based project such as this one consists of:
- 🧮 the [Runtime](./runtime/README.md) - the core logic of the parachain.
- 🎨 the [Pallets](./pallets/README.md) - from which the runtime is constructed.
- 💿 a [Node](./node/README.md) - the binary application, not part of the project default-members list and not compiled unless
-building the project with `--workspace` flag, which builds all workspace members, and is an alternative to
-[Omni Node](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/omni_node/index.html).
+ building the project with `--workspace` flag, which builds all workspace members, and is an alternative to
+ [Omni Node](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/omni_node/index.html).
## Getting Started
- 🦀 The template is using the Rust language.
- 👉 Check the
-[Rust installation instructions](https://www.rust-lang.org/tools/install) for your system.
+ [Rust installation instructions](https://www.rust-lang.org/tools/install) for your system.
- ðŸ› ï¸ Depending on your operating system and Rust version, there might be additional
-packages required to compile this template - please take note of the Rust compiler output.
+ packages required to compile this template - please take note of the Rust compiler output.
Fetch parachain template code:
@@ -73,6 +73,14 @@ cd parachain-template
## Starting a Development Chain
+The parachain template relies on a hardcoded parachain id which is defined in the runtime code
+and referenced throughout the contents of this file as `{{PARACHAIN_ID}}`. Please replace
+any command or file referencing this placeholder with the value of the `PARACHAIN_ID` constant:
+
+```rust,ignore
+pub const PARACHAIN_ID: u32 = 1000;
+```
+
### Omni Node Prerequisites
[Omni Node](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/omni_node/index.html) can
@@ -96,12 +104,12 @@ Please see the installation section at [`crates.io/staging-chain-spec-builder`](
#### Use `chain-spec-builder` to generate the `chain_spec.json` file
```sh
-chain-spec-builder create --relay-chain "rococo-local" --para-id 1000 --runtime \
+chain-spec-builder create --relay-chain "rococo-local" --para-id {{PARACHAIN_ID}} --runtime \
target/release/wbuild/parachain-template-runtime/parachain_template_runtime.wasm named-preset development
```
**Note**: the `relay-chain` and `para-id` flags are mandatory information required by
-Omni Node, and for parachain template case the value for `para-id` must be set to `1000`, since this
+Omni Node, and for parachain template case the value for `para-id` must be set to `{{PARACHAIN_ID}}`, since this
is also the value injected through [ParachainInfo](https://docs.rs/staging-parachain-info/0.17.0/staging_parachain_info/)
pallet into the `parachain-template-runtime`'s storage. The `relay-chain` value is set in accordance
with the relay chain ID where this instantiation of parachain-template will connect to.
@@ -141,7 +149,7 @@ export PATH="$PATH:<path/to/binaries>"
```toml
# ...
[[parachains]]
-id = 1000
+id = {{PARACHAIN_ID}}
chain_spec_path = "<TO BE UPDATED WITH A VALID PATH>"
# ...
```
@@ -177,15 +185,15 @@ zombienet --provider native spawn zombienet.toml
### Connect with the Polkadot-JS Apps Front-End
- 🌠You can interact with your local node using the
-hosted version of the Polkadot/Substrate Portal:
-[relay chain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944)
-and [parachain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9988).
+ hosted version of the Polkadot/Substrate Portal:
+ [relay chain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944)
+ and [parachain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9988).
- 🪠A hosted version is also
-available on [IPFS](https://dotapps.io/).
+ available on [IPFS](https://dotapps.io/).
- 🧑â€ðŸ”§ You can also find the source code and instructions for hosting your own instance in the
-[`polkadot-js/apps`](https://github.com/polkadot-js/apps) repository.
+ [`polkadot-js/apps`](https://github.com/polkadot-js/apps) repository.
### Takeaways
@@ -211,7 +219,7 @@ Build the `parachain-template-runtime` as mentioned before in this guide and use
again but this time by passing `--raw-storage` flag:
```sh
-chain-spec-builder create --raw-storage --relay-chain "rococo-local" --para-id 1000 --runtime \
+chain-spec-builder create --raw-storage --relay-chain "rococo-local" --para-id {{PARACHAIN_ID}} --runtime \
target/release/wbuild/parachain-template-runtime/parachain_template_runtime.wasm named-preset development
```
@@ -234,15 +242,15 @@ relay chain network (see [Parachain Template node](#parachain-template-node) set
- âž¡ï¸ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain).
- 😇 Please refer to the monorepo's
-[contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
-[Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
+ [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
+ [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
## Getting Help
- 🧑â€ðŸ« To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
- 🧑â€ðŸ”§ For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
-the Polkadot SDK documentation resources.
+ the Polkadot SDK documentation resources.
- 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
-[Substrate StackExchange](https://substrate.stackexchange.com/).
+ [Substrate StackExchange](https://substrate.stackexchange.com/).
diff --git a/templates/parachain/runtime/src/genesis_config_presets.rs b/templates/parachain/runtime/src/genesis_config_presets.rs
index f1b24e43724..8cdadca5060 100644
--- a/templates/parachain/runtime/src/genesis_config_presets.rs
+++ b/templates/parachain/runtime/src/genesis_config_presets.rs
@@ -17,6 +17,7 @@ use sp_keyring::Sr25519Keyring;
/// The default XCM version to set in genesis config.
const SAFE_XCM_VERSION: u32 = xcm::prelude::XCM_VERSION;
/// Parachain id used for genesis config presets of parachain template.
+#[docify::export_content]
pub const PARACHAIN_ID: u32 = 1000;
/// Generate the session keys from individual elements.
diff --git a/templates/parachain/src/lib.rs b/templates/parachain/src/lib.rs
new file mode 100644
index 00000000000..d3c5b8ba310
--- /dev/null
+++ b/templates/parachain/src/lib.rs
@@ -0,0 +1,22 @@
+// Copyright (C) Parity Technologies (UK) Ltd.
+// This file is part of Cumulus.
+
+// Cumulus is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+
+// Cumulus is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+
+// You should have received a copy of the GNU General Public License
+// along with Cumulus. If not, see <http://www.gnu.org/licenses/>.
+
+// The parachain-template crate helps with keeping the README.md in sync
+// with code sections across the components under the template: node,
+// pallets & runtime, by using `docify`.
+
+#[cfg(feature = "generate-readme")]
+docify::compile_markdown!("README.docify.md", "README.md");
--
GitLab