31 major breaking releases

34.0.0 May 24, 2024
33.0.0 May 1, 2024
32.0.0 Apr 9, 2024
31.0.0 Mar 18, 2024
0.0.0 Nov 21, 2022

#944 in Magic Beans

Download history 1247/week @ 2024-02-26 471/week @ 2024-03-04 404/week @ 2024-03-11 789/week @ 2024-03-18 707/week @ 2024-03-25 789/week @ 2024-04-01 684/week @ 2024-04-08 429/week @ 2024-04-15 392/week @ 2024-04-22 558/week @ 2024-04-29 395/week @ 2024-05-06 573/week @ 2024-05-13 850/week @ 2024-05-20 768/week @ 2024-05-27 1061/week @ 2024-06-03 913/week @ 2024-06-10

3,613 downloads per month
Used in 11 crates (3 directly)

Apache-2.0

3MB
57K SLoC

SDK Logo SDK Logo

Polkadot SDK

GitHub stars  GitHub forks

StackExchange  GitHub contributors  GitHub commit activity

GitHub lines of code   GitHub last commit

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.

📚 Documentation

🚀 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:

A BEEFY+MMR pallet combo.

While both BEEFY and Merkle Mountain Range (MMR) can be used separately, these tools were designed to work together in unison.

The pallet provides a standardized MMR Leaf format that can be used to bridge BEEFY+MMR-based networks (both standalone and Polkadot-like).

The MMR leaf contains:

  1. Block number and parent block hash.
  2. Merkle Tree Root Hash of next BEEFY validator set.
  3. Arbitrary extra leaf data to be used by downstream pallets to include custom data.

and thanks to versioning can be easily updated in the future.

Dependencies

~18–33MB
~559K SLoC