Add development chain-spec file for minimal/parachain templates for Omni Node compatibility

.github/workflows/verify-templates-dev-chain-spec.yml

@@ -0,0 +1,145 @@
+name: Verify Templates Dev Chain Spec
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  setup:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        template:
+          - package_name: 'parachain-template-runtime'
+            runtime_path: './templates/parachain/runtime'
+            artifact_name: 'wasm-parachain-template-runtime'
+            chain_spec_output: 'parachain_test_chain_spec.json'
+            runtime_wasm_path: 'parachain-template-runtime/parachain_template_runtime.compact.compressed.wasm'
+            relay_chain: 'rococo-local'
+          - package_name: 'minimal-template-runtime'
+            runtime_path: './templates/minimal/runtime'
+            artifact_name: 'wasm-minimal-template-runtime'
+            chain_spec_output: 'minimal_test_chain_spec.json'
+            runtime_wasm_path: 'minimal-template-runtime/minimal_template_runtime.compact.compressed.wasm'
+            relay_chain: 'dev'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set rust version from env file
+        run: |
+          RUST_VERSION=$(cat .github/env | sed -E 's/.*ci-unified:([^-]+)-([^-]+).*/\2/')
+          echo $RUST_VERSION
+          echo "RUST_VERSION=${RUST_VERSION}" >> $GITHUB_ENV
+
+      - name: Install Rust
+        uses: actions-rust-lang/setup-rust-toolchain@11df97af8e8102fd60b60a77dfbf58d40cd843b8 # v1.10.1
+        with:
+          cache: false
+          toolchain: ${{ env.RUST_VERSION }}
+          components: cargo, clippy, rust-docs, rust-src, rustfmt, rustc, rust-std
+
+      - name: Install srtool-cli
+        run: |
+          cargo install --git https://github.com/chevdor/srtool-cli
+          echo "Using srtool-cli Version:"
+          srtool --version
+
+      - name: Pull srtool docker image
+        run: |
+          srtool pull
+
+      - name: Prepare build directories
+        run: |
+          sudo mkdir -p ${{ matrix.template.runtime_path }}/target
+          sudo chmod -R 777 ${{ matrix.template.runtime_path }}/target
+
+      - name: Build runtime binary
+        run: |
+          srtool build --package ${{ matrix.template.package_name }} --runtime-dir ${{ matrix.template.runtime_path }} --root
+
+      - name: Install staging-chain-spec-builder and deps
+        run: |
+          # Install protobuf compiler
+          sudo apt-get update
+          sudo apt-get install -y protobuf-compiler
+
+          # Verify protoc installation
+          protoc --version
+
+          cargo install --path substrate/bin/utils/chain-spec-builder
+
+      - name: Create chain spec
+        run: |
+          chain-spec-builder  -c ${{ matrix.template.chain_spec_output }}  create \
+            --relay-chain "${{ matrix.template.relay_chain }}" \
+            --para-id 1000 \
+            --runtime "${{ matrix.template.runtime_path }}/target/srtool/release/wbuild/${{ matrix.template.runtime_wasm_path }}" \
+            named-preset development
+
+      - name: Upload chain spec artifact
+        uses: actions/[email protected]
+        with:
+          name: ${{ matrix.template.chain_spec_output }}
+          path: ${{ matrix.template.chain_spec_output }}
+          overwrite: true
+
+  verify-template-chain-specs:
+    if: success()
+    needs: setup
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        template:
+          - runtime_path: './templates/parachain'
+            chain_spec_output: 'parachain_test_chain_spec.json'
+          - runtime_path: './templates/minimal'
+            chain_spec_output: 'minimal_test_chain_spec.json'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Download generated spec
+        uses: actions/[email protected]
+        with:
+          name: ${{ matrix.template.chain_spec_output }}
+          path: ./downloaded_spec
+
+      - name: Compare chain specs
+        run: |
+          sudo apt-get update && sudo apt-get install -y jq
+          # Check if files exist
+          if [ ! -f "${{ matrix.template.runtime_path }}/dev_chain_spec.json" ]; then
+            echo "❌ Reference spec not found at ${{ matrix.template.runtime_path }}/dev_chain_spec.json"
+            exit 1
+          fi
+
+          if [ ! -f "./downloaded_spec/${{ matrix.template.chain_spec_output }}" ]; then
+            echo "❌ Generated spec not found at ./downloaded_spec/${{ matrix.template.chain_spec_output }}"
+            exit 1
+          fi
+
+          jq -S . ${{ matrix.template.runtime_path }}/dev_chain_spec.json > existing_spec_sorted.json
+          jq -S . ./downloaded_spec/${{ matrix.template.chain_spec_output }} > generated_spec_sorted.json
+
+          # Compare files and handle the exit condition properly
+          if diff -C 3 existing_spec_sorted.json generated_spec_sorted.json | while read -r line; do
+            echo "${line:0:200}..."
+          done; then
+            echo "✅ Spec files are identical."
+          else
+            echo "❌ Spec files differ. Exiting with failure."
+            exit 1
+          fi

templates/minimal/README.md

@@ -37,11 +37,32 @@
 - 🤏 This template is a minimal (in terms of complexity and the number of components)
 template for building a blockchain node.
 
+
+- 🔧 To simplify the process of using Zombienet with Omni Node, we've added a pre-configured development
+chain spec (dev_chain_spec.json) to the minimal template. Additionally, the zombienet-omni-node.toml file
+has been updated to include a valid chain spec path pointing to dev_chain_spec.json
+
+
 - 🔧 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).
 
+
 - 👤 The template has no consensus configured - it is best for experimenting with a single node network.
 
+
+- ⚠️ The README files for the templates in this repository are currently speculative.
+A stable release addressing this is expected in December.
+
+
+-  Follow solely the templates' READMEs and templates themselves from Polkadot-sdk master branch,
+but ignore the references to the dedicated templates directory.
+For the most accurate chain spec generation,  `staging-chain-spec-builder` or other mentioned binaries and runtimes,
+please try to build them based on the Polkadot-sdk most updated master branch an example:
+  ```bash
+  cargo install --path substrate/bin/utils/chain-spec-builder
+  ```
+
+
 ## Template Structure
 
 A Polkadot SDK based project such as this one consists of:
@@ -61,7 +82,7 @@ compiled unless building the entire workspace).
 - 🛠️ 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 minimal template code:
+Fetch minimal template code (Note: The template repositories are outdated, and their READMEs are not synced. Please ignore this step for now.):
 
 ```sh
 git clone https://github.com/paritytech/polkadot-sdk-minimal-template.git minimal-template
@@ -81,15 +102,18 @@ be used to run the minimal template's runtime. `polkadot-omni-node` binary crate
 
 Please see installation section on [crates.io/omni-node](https://crates.io/crates/polkadot-omni-node).
 
-#### Build `minimal-template-runtime`
+#### Build `minimal-template-runtime` (A reminder to  build on the most updated version of polkadot-sdk master)
 
 ```sh
 cargo build -p minimal-template-runtime --release
 ```
 
 #### Install `staging-chain-spec-builder`
+  ```bash
+  cargo install --path substrate/bin/utils/chain-spec-builder
+```
 
-Please see the installation section at [`crates.io/staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder).
+Or 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
 

templates/minimal/zombienet-omni-node.toml

@@ -1,8 +1,8 @@
 [relaychain]
 default_command = "polkadot-omni-node"
 chain = "dev"
-chain_spec_path = "<path/to/chain_spec.json>"
-default_args = ["--dev"]
+chain_spec_path = "./dev_chain_spec.json"
+default_args = ["--dev-block-time 3000"]
 
 [[relaychain.nodes]]
 name = "alice"

templates/parachain/README.md

@@ -35,14 +35,38 @@
 
 - ⏫ This template provides a starting point to build a [parachain](https://wiki.polkadot.network/docs/learn-parachains).
 
+
+- 🔧 To simplify the process of using Zombienet with Omni Node, we’ve added a pre-configured
+development chain spec (dev_chain_spec.json) to the parachain template. Additionally,
+the zombienet-omni-node.toml file has been updated to include a valid chain spec path
+pointing to dev_chain_spec.json
+
+
 - ☁️ 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)
 
+
+- ⚠️ The README files for the templates in this repository are currently speculative. 
+A stable release addressing this is expected in December.
+
+
+-  Follow solely the templates' READMEs and templates themselves from Polkadot-sdk master branch,
+but ignore the references to the dedicated templates directory.
+For the most accurate chain spec generation,  `staging-chain-spec-builder` or other mentioned
+binaries and runtimes,please try to build them based on the Polkadot-sdk most updated master branch 
+an example:
+  ```bash
+  cargo install --path substrate/bin/utils/chain-spec-builder
+```
+
+
 ## Template Structure
 
 A Polkadot SDK based project such as this one consists of:

templates/parachain/zombienet-omni-node.toml

@@ -14,7 +14,7 @@ ws_port = 9955
 
 [[parachains]]
 id = 1000
-chain_spec_path = "<path/to/chain_spec.json>"
+chain_spec_path = "./dev_chain_spec.json"
 
 [parachains.collator]
 name = "charlie"