https://github.com/paritytech/polkadot-sdk
The Parity Polkadot Blockchain SDK
https://github.com/paritytech/polkadot-sdk
blockchain cumulus polkadot substrate
Last synced: 7 days ago
JSON representation
The Parity Polkadot Blockchain SDK
- Host: GitHub
- URL: https://github.com/paritytech/polkadot-sdk
- Owner: paritytech
- Created: 2023-08-04T08:33:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-26T15:56:57.000Z (20 days ago)
- Last Synced: 2025-03-26T16:25:19.123Z (20 days ago)
- Topics: blockchain, cumulus, polkadot, substrate
- Language: Rust
- Homepage: https://polkadot.com/
- Size: 681 MB
- Stars: 2,178
- Watchers: 77
- Forks: 868
- Open Issues: 1,965
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-dot - Paritytech - Rust implementation of Polkadot SDK which provides all the resources needed to start building on the Polkadot. (Resources / Polkadot Host Implementation)
- awesome-rust - polkadot-sdk
- awesome-polkadot - The Polkadot SDK
- awesome-rust - polkadot-sdk - The Parity Polkadot Blockchain SDK (Applications / Blockchain)
- awesome-rust-list - Polkadot - sdk?style=social"/> : The Parity Polkadot Blockchain SDK. The Polkadot SDK repository provides all the resources 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. [polkadot.network/](https://polkadot.network/) (Web3 and ZKP Framework)
- awesome-rust-list - Polkadot - sdk?style=social"/> : The Parity Polkadot Blockchain SDK. The Polkadot SDK repository provides all the resources 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. [polkadot.network/](https://polkadot.network/) (Web3 and ZKP Framework)
- fucking-awesome-rust - polkadot-sdk - The Parity Polkadot Blockchain SDK (Applications / Blockchain)
- fucking-awesome-rust - polkadot-sdk - The Parity Polkadot Blockchain SDK (Applications / Blockchain)
README
# Polkadot SDK
 
[](https://substrate.stackexchange.com/)   
> The Polkadot SDK repository provides all the components needed to start building on the
> [Polkadot](https://polkadot.com/) 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](https://docs.polkadot.com)
* [🦀 rust-docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html): Where we keep track of
the API docs of our Rust crates. Includes:
* [Introduction](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html)
to each component of the Polkadot SDK: Substrate, FRAME, Cumulus, and XCM
* [Guides](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/index.html),
namely how to build your first FRAME pallet
* [Templates](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/templates/index.html)
for starting a new project.
* [External Resources](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/external_resources/index.html)
Have a question? You can ask in the Polkadot SDK Developers Chat.
Messages from either of these channels are bridged to the other, so you can use whichever one you like.
* [Telegram](https://t.me/substratedevs)
* [Matrix](https://matrix.to/#/#substratedevs:matrix.org)
* [Discord](https://discord.com/channels/722223075629727774/997505821955076196)
## 🚀 Releases
 
The Polkadot SDK is released every three months as a `Polkadot stableYYMM` release. Each stable release is supported for
one year with patches. See the next upcoming versions in the [Release
Registry](https://github.com/paritytech/release-registry/) and more docs in [RELEASE.md](./docs/RELEASE.md).
You can use [`psvm`](https://github.com/paritytech/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](https://github.com/paritytech/psvm):
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](./docs/contributor/SECURITY.md).
## 🤍 Contributing & Code of Conduct
Ensure you follow our [contribution guidelines](./docs/contributor/CONTRIBUTING.md). In every
interaction and contribution, this project adheres to the [Contributor Covenant Code of
Conduct](./docs/contributor/CODE_OF_CONDUCT.md).
### 👾 Ready to Contribute?
Take a look at the issues labeled with [`mentor`](https://github.com/paritytech/polkadot-sdk/labels/C1-mentor)
(or alternatively [this](https://mentor.tasty.limo/) 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](https://polkadot-fellows.github.io/dashboard/).
## 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](https://polkadot-public.notion.site/Polkadot-SDK-FAQ-fbc4cecc2c46443fb37b9eeec2f0d85f).