Polkadot SDK
The Polkadot SDK repository provides all the components needed to start building on the Polkadot network, a multi-chain blockchain platform that enables different blockchains to interoperate and share information in a secure and scalable way.
⚡ Quickstart
If you want to get an example node running quickly you can execute the following getting started script:
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh | bash📚 Documentation
- Polkadot Documentation Portal
-
🦀 rust-docs: Where we keep track of
the API docs of our Rust crates. Includes:
- Introduction to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM
- Guides, namely how to build your first FRAME pallet
- Templates for starting a new project.
- External Resources
🚀 Releases
The Polkadot SDK is released every three months as a stableYYMM release. They are supported for
one year with patches. See the next upcoming versions in the Release
Registry and more docs in RELEASE.md.
You can use psvm to update all dependencies to a specific
version without needing to manually select the correct version for each crate.
🛠️ Tooling
Polkadot SDK Version Manager: A simple tool to manage and update the Polkadot SDK dependencies in any Cargo.toml file. It will automatically update the Polkadot SDK dependencies to their correct crates.io version.
🔐 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.