Skip to content

Conversation

nhussein11
Copy link
Collaborator

@nhussein11 nhussein11 commented Jul 8, 2025

This pull request updates documentation to reflect the deprecation of the para_id field in Polkadot SDK chain specifications. It introduces guidance for transitioning to the new runtime API using the GetParachainInfo trait.

DISCLAIMER: This PR uses the following url: tutorials/polkadot-sdk/parachains/zero-to-hero/runtime-upgrade which is introduced by #760

Updates to documentation on para_id deprecation:

  • llms.txt: Added a note explaining the upcoming removal of the para_id field in chain specifications starting with Polkadot SDK release stable2512. It provides details on updating runtimes to implement the cumulus_primitives_core::GetParachainInfo trait and links to a runtime upgrade tutorial for further guidance.

  • tutorials/polkadot-sdk/parachains/zero-to-hero/deploy-to-testnet.md: Included the same note about the deprecation of the para_id field, emphasizing the need for runtime updates and compatibility with future node versions.

Fixes #689

@nhussein11 nhussein11 self-assigned this Jul 8, 2025
@Copilot Copilot AI review requested due to automatic review settings July 8, 2025 14:24
@nhussein11 nhussein11 requested a review from a team as a code owner July 8, 2025 14:24
@nhussein11 nhussein11 added B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task labels Jul 8, 2025
@nhussein11 nhussein11 added the A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) label Jul 8, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the parachain deployment documentation to note the deprecation and upcoming removal of the para_id field in chain specifications and guides developers to implement the GetParachainInfo runtime API.

  • Add a deprecation note about para_id in deploy-to-testnet.md
  • Mirror the same note in llms.txt for generated docs

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
tutorials/polkadot-sdk/parachains/zero-to-hero/deploy-to-testnet.md Added deprecation notice and upgrade guidance
llms.txt Updated generated docs with the same deprecation note
Comments suppressed due to low confidence (1)

tutorials/polkadot-sdk/parachains/zero-to-hero/deploy-to-testnet.md:154

  • The introduction version stable2509 conflicts with the PR description mentioning deprecation starting in stable2512. Please align these version numbers to avoid confusion.
    The `para_id` field in JSON chain specifications, added through the [`chain-spec-builder`](https://paritytech.github.io/polkadot-sdk/master/staging_chain_spec_builder/index.html){target=\_blank} command, is currently used by nodes for configuration purposes. However, beginning with Polkadot SDK release `stable2509`, the `para_id` field will no longer be required in chain specifications. Instead, runtimes need to be updated to implement the [`cumulus_primitives_core::GetParachainInfo`](https://paritytech.github.io/polkadot-sdk/master/cumulus_primitives_core/trait.GetParachainInfo.html){target=\_blank} trait to successfully operate with nodes using chain specs that omit the `para_id` field.

@eshaben eshaben merged commit 0ea64f7 into master Jul 14, 2025
3 checks passed
@eshaben eshaben deleted the 689-polkadot-omni-node-para_id-key-from-generated-chain-specs-is-deprecated branch July 14, 2025 19:41

The `para_id` field in JSON chain specifications, added through the [`chain-spec-builder`](https://paritytech.github.io/polkadot-sdk/master/staging_chain_spec_builder/index.html){target=\_blank} command, is currently used by nodes for configuration purposes. However, beginning with Polkadot SDK release `stable2509`, the `para_id` field will no longer be required in chain specifications. Instead, runtimes need to be updated to implement the [`cumulus_primitives_core::GetParachainInfo`](https://paritytech.github.io/polkadot-sdk/master/cumulus_primitives_core/trait.GetParachainInfo.html){target=\_blank} trait to successfully operate with nodes using chain specs that omit the `para_id` field.

With the upcoming `stable2512` release, the `para_id` field will be completely removed from chain specifications in favor of the new runtime API. New nodes will be unable to start with chain specs containing the `para_id` field unless the runtime implements the `GetParachainInfo` trait. Ensure your runtime is updated to maintain compatibility with future node versions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nhussein11 ! Sorry for the trouble, FYI see this: paritytech/polkadot-sdk#8740 (comment). We'll need to update this section, and I'll open an issue soon.


The `para_id` field in JSON chain specifications, added through the [`chain-spec-builder`](https://paritytech.github.io/polkadot-sdk/master/staging_chain_spec_builder/index.html){target=\_blank} command, is currently used by nodes for configuration purposes. However, beginning with Polkadot SDK release `stable2509`, the `para_id` field will no longer be required in chain specifications. Instead, runtimes need to be updated to implement the [`cumulus_primitives_core::GetParachainInfo`](https://paritytech.github.io/polkadot-sdk/master/cumulus_primitives_core/trait.GetParachainInfo.html){target=\_blank} trait to successfully operate with nodes using chain specs that omit the `para_id` field.

With the upcoming `stable2512` release, the `para_id` field will be completely removed from chain specifications in favor of the new runtime API. New nodes will be unable to start with chain specs containing the `para_id` field unless the runtime implements the `GetParachainInfo` trait. Ensure your runtime is updated to maintain compatibility with future node versions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an update is required here too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) B0 - Needs Review Pull request is ready for review C1 - Medium Medium priority task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

polkadot-omni-node: para_id key from generated chain specs is deprecated
4 participants