polkadot-omni-node: add GetParachainInfo runtime api

.github/workflows/misc-sync-templates.yml

@@ -69,12 +69,8 @@ jobs:
             srtool build --package ${{ matrix.package_name }} --runtime-dir ${{ matrix.runtime_path }} --root
 
             # Generate chain spec
-            # Note that para-id is set to 1000 for both minimal/parachain templates. 
-            # `parachain-runtime` is hardcoded to use this parachain id. 
-            # `minimal` template isn't using it, but when started with Omni Node, this para id is required (any number can do it, so setting it to 1000 for convenience).
             chain-spec-builder -c dev_chain_spec.json create \
               --relay-chain "${{ matrix.relay_chain }}" \
-              --para-id 1000 \
               --runtime "${{ matrix.runtime_path }}/target/srtool/release/wbuild/${{ matrix.runtime_wasm_path }}" \
               named-preset development
 
@@ -162,9 +158,9 @@ jobs:
           [workspace]
           EOF
 
-          [ ${{ matrix.template }} != "solochain" ] && echo "# Leave out the node compilation from regular template usage." \
+          [ ${{ matrix.template }} == "parachain" ] && echo "# Leave out the node compilation from regular template usage." \
             && echo "default-members = [\"pallets/template\", \"runtime\"]" >> Cargo.toml
-          [ ${{ matrix.template }} == "solochain" ] && echo "# The node isn't yet replaceable by Omni Node."
+          [ ${{ matrix.template }} != "parachain" ] && echo "# The node isn't yet replaceable by Omni Node."
           cat << EOF >> Cargo.toml
           members = [
               "node",

cumulus/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs

@@ -2046,6 +2046,12 @@ impl_runtime_apis! {
 		}
 	}
 
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
+
 	impl xcm_runtime_apis::authorized_aliases::AuthorizedAliasersApi<Block> for Runtime {
 		fn authorized_aliasers(target: VersionedLocation) -> Result<
 			Vec<xcm_runtime_apis::authorized_aliases::OriginAliaser>,

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-rococo/src/lib.rs

@@ -1573,6 +1573,12 @@ impl_runtime_apis! {
 			PolkadotXcm::is_trusted_teleporter(asset, location)
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 #[cfg(test)]

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-westend/src/lib.rs

@@ -1437,6 +1437,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/collectives/collectives-westend/src/lib.rs

@@ -1322,6 +1322,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/coretime/coretime-rococo/src/lib.rs

@@ -1190,6 +1190,12 @@ impl_runtime_apis! {
 			PolkadotXcm::is_trusted_teleporter(asset, location)
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/coretime/coretime-westend/src/lib.rs

@@ -1209,6 +1209,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/glutton/glutton-westend/src/lib.rs

@@ -65,7 +65,7 @@ use sp_runtime::{
 use sp_version::NativeVersion;
 use sp_version::RuntimeVersion;
 
-use cumulus_primitives_core::{AggregateMessageOrigin, ClaimQueueOffset, CoreSelector};
+use cumulus_primitives_core::{AggregateMessageOrigin, ClaimQueueOffset, CoreSelector, ParaId};
 pub use frame_support::{
 	construct_runtime, derive_impl,
 	dispatch::DispatchClass,
@@ -510,6 +510,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/people/people-rococo/src/lib.rs

@@ -1115,6 +1115,12 @@ impl_runtime_apis! {
 			PolkadotXcm::is_trusted_teleporter(asset, location)
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/people/people-westend/src/lib.rs

@@ -1130,6 +1130,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/testing/penpal/src/lib.rs

@@ -1219,6 +1219,12 @@ impl_runtime_apis! {
 			genesis_config_presets::preset_names()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/parachains/runtimes/testing/rococo-parachain/src/lib.rs

@@ -886,6 +886,12 @@ impl_runtime_apis! {
 			ParachainSystem::core_selector()
 		}
 	}
+
+	impl cumulus_primitives_core::GetParachainInfo<Block> for Runtime {
+		fn parachain_id() -> ParaId {
+			ParachainInfo::parachain_id()
+		}
+	}
 }
 
 cumulus_pallet_parachain_system::register_validate_block! {

cumulus/polkadot-omni-node/Cargo.toml

@@ -16,7 +16,7 @@ workspace = true
 color-eyre = { workspace = true }
 
 # Local
-polkadot-omni-node-lib = { workspace = true }
+polkadot-omni-node-lib = { workspace = true, features = ["rococo-native", "westend-native"] }
 
 [dev-dependencies]
 assert_cmd = { workspace = true }

cumulus/polkadot-omni-node/README.md

@@ -39,9 +39,20 @@ cargo install staging-chain-spec-builder --locked
 
 ### 2. Generate a chain spec
 
-Omni Node expects for the chain spec to contain parachains related fields like `relay_chain` and `para_id`.
-These fields can be introduced by running [`staging-chain-spec-builder`](https://crates.io/crates/staging-chain-spec-builder)
-with additional flags:
+Omni Node requires the chain spec to include a JSON key named `relay_chain`. It is set to a chain id,
+representing the chain name, e.g. `westend`, `paseo`, `rococo`, `polkadot`, or `kusama`, but
+there are also local variants that can be used for testing, like `rococo-local` or `westend-local`. The
+local variants are available only for a build of `polkadot-omni-node` with
+`westend-native` and `rococo-native` features respectively.
+
+<!-- TODO: https://github.com/paritytech/polkadot-sdk/issues/8747 -->
+<!-- TODO: https://github.com/paritytech/polkadot-sdk/issues/8740 -->
+Additionaly, although deprecated, the `--para-id` flag can still be used to set the JSON key named
+`para_id`. The removal of the flag will happen starting with `stable2512`. The alternative of not using
+it is to implement the `cumulus_primitives_core::GetParachainInfo` runtime API for the runtime, and
+upgrade it on-chain as well, to be compatible with nodes released starting with `stable2512`.
+
+Example command bellow:
 
 ```bash
 chain-spec-builder create --relay-chain <relay_chain_id> --para-id <id> -r <runtime.wasm> named-preset <preset_name>

cumulus/polkadot-omni-node/lib/src/command.rs

@@ -17,7 +17,7 @@
 use crate::{
 	cli::{Cli, RelayChainCli, Subcommand},
 	common::{
-		chain_spec::{Extensions, LoadSpec},
+		chain_spec::LoadSpec,
 		runtime::{
 			AuraConsensusId, Consensus, Runtime, RuntimeResolver as RuntimeResolverT,
 			RuntimeResolver,
@@ -33,11 +33,9 @@ use crate::{
 use clap::{CommandFactory, FromArgMatches};
 #[cfg(feature = "runtime-benchmarks")]
 use cumulus_client_service::storage_proof_size::HostFunctions as ReclaimHostFunctions;
-use cumulus_primitives_core::ParaId;
 use frame_benchmarking_cli::{BenchmarkCmd, SUBSTRATE_REFERENCE_HARDWARE};
 use log::info;
 use sc_cli::{CliConfiguration, Result, SubstrateCli};
-use sp_runtime::traits::AccountIdConversion;
 #[cfg(feature = "runtime-benchmarks")]
 use sp_runtime::traits::HashingFor;
 
@@ -304,24 +302,19 @@ where
 			runner.run_node_until_exit(|config| async move {
 				let node_spec =
 					new_node_spec(&config, &cmd_config.runtime_resolver, &cli.node_extra_args())?;
-				let para_id = ParaId::from(
-					Extensions::try_get(&*config.chain_spec)
-						.map(|e| e.para_id)
-						.ok_or("Could not find parachain extension in chain-spec.")?,
-				);
 
 				if cli.run.base.is_dev()? {
 					// Set default dev block time to 3000ms if not set.
 					// TODO: take block time from AURA config if set.
 					let dev_block_time = cli.dev_block_time.unwrap_or(DEFAULT_DEV_BLOCK_TIME_MS);
 					return node_spec
-						.start_manual_seal_node(config, para_id, dev_block_time)
+						.start_manual_seal_node(config, dev_block_time)
 						.map_err(Into::into);
 				}
 
 				if let Some(dev_block_time) = cli.dev_block_time {
 					return node_spec
-						.start_manual_seal_node(config, para_id, dev_block_time)
+						.start_manual_seal_node(config, dev_block_time)
 						.map_err(Into::into);
 				}
 
@@ -375,27 +368,18 @@ where
 						})
 					})
 					.flatten();
-
-				let parachain_account =
-					AccountIdConversion::<polkadot_primitives::AccountId>::into_account_truncating(
-						&para_id,
-					);
-
 				let tokio_handle = config.tokio_handle.clone();
 				let polkadot_config =
 					SubstrateCli::create_configuration(&polkadot_cli, &polkadot_cli, tokio_handle)
 						.map_err(|err| format!("Relay chain argument error: {}", err))?;
 
-				info!("🪪 Parachain id: {:?}", para_id);
-				info!("🧾 Parachain Account: {}", parachain_account);
 				info!("✍️ Is collating: {}", if config.role.is_authority() { "yes" } else { "no" });
 
 				node_spec
 					.start_node(
 						config,
 						polkadot_config,
 						collator_options,
-						para_id,
 						hwbench,
 						cli.node_extra_args(),
 					)

cumulus/polkadot-omni-node/lib/src/common/chain_spec.rs

@@ -32,7 +32,7 @@ pub struct DiskChainSpecLoader;
 
 impl LoadSpec for DiskChainSpecLoader {
 	fn load_spec(&self, path: &str) -> Result<Box<dyn ChainSpec>, String> {
-		Ok(Box::new(GenericChainSpec::from_json_file(path.into())?))
+		Ok(Box::new(DeprecatedGenericChainSpec::from_json_file(path.into())?))
 	}
 }
 
@@ -42,12 +42,35 @@ pub struct Extensions {
 	/// The relay chain of the Parachain.
 	#[serde(alias = "relayChain", alias = "RelayChain")]
 	pub relay_chain: String,
+}
+
+impl Extensions {
+	/// Try to get the extension from the given `ChainSpec`.
+	pub fn try_get(chain_spec: &dyn sc_service::ChainSpec) -> Option<&Self> {
+		sc_chain_spec::get_extension(chain_spec.extensions())
+	}
+}
+
+/// Generic extensions for Parachain ChainSpecs used for extracting the extensions from chain specs.
+/// This is also used only while `para_id` is around the corner.
+// TODO: https://github.com/paritytech/polkadot-sdk/issues/8747
+// TODO: https://github.com/paritytech/polkadot-sdk/issues/8740
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecExtension)]
+pub struct DeprecatedExtensions {
+	/// The relay chain of the Parachain. It is kept here only for compatibility reasons until
+	/// people migrate to using the new `Extensions` struct and associated logic in the node
+	/// corresponding to pulling the parachain id from the runtime.
+	#[serde(alias = "relayChain", alias = "RelayChain")]
+	pub relay_chain: String,
 	/// The id of the Parachain.
 	#[serde(alias = "paraId", alias = "ParaId")]
-	pub para_id: u32,
+	#[deprecated(
+		note = "The para_id information is not required anymore and will be removed starting with `stable2512`. Runtimes must implement a new API called `cumulus_primitives_core::GetParachainInfo` to still be compatible with node versions starting with `stable2512`."
+	)]
+	pub para_id: Option<u32>,
 }
 
-impl Extensions {
+impl DeprecatedExtensions {
 	/// Try to get the extension from the given `ChainSpec`.
 	pub fn try_get(chain_spec: &dyn sc_service::ChainSpec) -> Option<&Self> {
 		sc_chain_spec::get_extension(chain_spec.extensions())
@@ -56,6 +79,12 @@ impl Extensions {
 
 /// Generic chain spec for all polkadot-parachain runtimes
 pub type GenericChainSpec = sc_service::GenericChainSpec<Extensions>;
+/// Generic chain spec which keeps chain spec loading compatible for those who provide
+/// `para_id` extension instead of implementing the runtime API
+/// `cumulus_primitives_core::GetParachainInfo`.
+// TODO: https://github.com/paritytech/polkadot-sdk/issues/8747
+// TODO: https://github.com/paritytech/polkadot-sdk/issues/8740
+pub type DeprecatedGenericChainSpec = sc_service::GenericChainSpec<DeprecatedExtensions>;
 
 #[cfg(test)]
 mod tests {
@@ -66,12 +95,23 @@ mod tests {
 		let camel_case = r#"{"relayChain":"relay","paraId":1}"#;
 		let snake_case = r#"{"relay_chain":"relay","para_id":1}"#;
 		let pascal_case = r#"{"RelayChain":"relay","ParaId":1}"#;
+		let para_id_missing = r#"{"RelayChain":"westend"}"#;
 
-		let camel_case_extension: Extensions = serde_json::from_str(camel_case).unwrap();
-		let snake_case_extension: Extensions = serde_json::from_str(snake_case).unwrap();
-		let pascal_case_extension: Extensions = serde_json::from_str(pascal_case).unwrap();
-
+		let camel_case_extension: DeprecatedExtensions = serde_json::from_str(camel_case).unwrap();
+		let snake_case_extension: DeprecatedExtensions = serde_json::from_str(snake_case).unwrap();
+		let pascal_case_extension: DeprecatedExtensions =
+			serde_json::from_str(pascal_case).unwrap();
+		let missing_paraid_extension: Extensions = serde_json::from_str(para_id_missing).unwrap();
+		let missing_paraid_deprecated: DeprecatedExtensions =
+			serde_json::from_str(para_id_missing).unwrap();
 		assert_eq!(camel_case_extension, snake_case_extension);
 		assert_eq!(snake_case_extension, pascal_case_extension);
+		assert_eq!(missing_paraid_extension.relay_chain, "westend".to_string());
+
+		// TODO: remove it once `para_id` is removed: https://github.com/paritytech/polkadot-sdk/issues/8740
+		assert_eq!(missing_paraid_deprecated.relay_chain, "westend".to_string());
+		#[allow(deprecated)]
+		let test = missing_paraid_deprecated.para_id.is_none();
+		assert!(test);
 	}
 }