📚 Documentation

• 🦀 rust-docs
• Introduction to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM
• Other Resources:
  • Polkadot Wiki -> Build

🚀 Releases

[!NOTE] Our release process is still Work-In-Progress and may not yet reflect the aspired outline here.

The Polkadot-SDK has two release channels: stable and nightly. Production software is advised to only use stable. nightly is meant for tinkerers to try out the latest features. The detailed release process is described in RELEASE.md.

😌 Stable

stable releases have a support duration of three months. In this period, the release will not have any breaking changes. It will receive bug fixes, security fixes, performance fixes and new non-breaking features on a two week cadence.

🤠 Nightly

nightly releases are released every night from the master branch, potentially with breaking changes. They have pre-release version numbers in the format major.0.0-nightlyYYMMDD.

🔐 Security

The security policy and procedures can be found in docs/contributor/SECURITY.md.

🤍 Contributing & Code of Conduct

Ensure you follow our contribution guidelines. In every interaction and contribution, this project adheres to the Contributor Covenant Code of Conduct.

👾 Ready to Contribute?

Take a look at the issues labeled with mentor (or alternatively this page, created by one of the maintainers) label to get started! We always recognize valuable contributions by proposing an on-chain tip to the Polkadot network as a token of our appreciation.

Polkadot Fellowship

Development in this repo usually goes hand in hand with the fellowship organization. In short, this repository provides all the SDK pieces needed to build both Polkadot and its parachains. But, the actual Polkadot runtime lives in the fellowship/runtimes repository. Read more about the fellowship, this separation, the RFC process here.

History

This repository is the amalgamation of 3 separate repositories that used to make up Polkadot SDK, namely Substrate, Polkadot and Cumulus. Read more about the merge and its history here.

lib.rs:

The CheckMetadataHash signed extension.

The extension for optionally checking the metadata hash. For information how it works and what it does exactly, see the docs of CheckMetadataHash.

Integration

As any signed extension you will need to add it to your runtime signed extensions: As the extension requires the RUNTIME_METADATA_HASH environment variable to be present at compile time, it requires a little bit more setup. To have this environment variable available at compile time required to tell the substrate-wasm-builder to do so: As generating the metadata hash requires to compile the runtime twice, it is recommended to only enable the metadata hash generation when doing a build for a release or when you want to test this feature.