29 major breaking releases
31.0.0 | Mar 18, 2024 |
---|---|
30.0.0 | Feb 26, 2024 |
29.0.0 | Feb 13, 2024 |
28.0.0 | Jan 23, 2024 |
2.0.0 | Sep 25, 2020 |
#1060 in Magic Beans
282 downloads per month
2MB
43K
SLoC
NOTE: We have recently made significant changes to our repository structure. In order to streamline our development process and foster better contributions, we have merged three separate repositories Cumulus, Substrate and Polkadot into this repository. Read more about the changes here.
Polkadot 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. The Polkadot SDK comprises three main pieces of software:
Polkadot
Implementation of a node for the https://polkadot.network in Rust, using the Substrate framework. This directory
currently contains runtimes for the Westend and Rococo test networks. Polkadot, Kusama and their system chain runtimes
are located in the runtimes
repository maintained by
the Polkadot Technical Fellowship.
Substrate
Substrate is the primary blockchain SDK used by developers to create the parachains that make up the Polkadot network. Additionally, it allows for the development of self-sovereign blockchains that operate completely independently of Polkadot.
Cumulus
Cumulus is a set of tools for writing Substrate-based Polkadot parachains.
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
.
Upstream Dependencies
Below are the primary upstream dependencies utilized in this project:
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.
Additional Resources
- For monitoring upcoming changes and current proposals related to the technical implementation of the Polkadot network,
visit the
Requests for Comment (RFC)
repository. While it's maintained by the Polkadot Fellowship, the RFC process welcomes contributions from everyone.
lib.rs
:
Node authorization pallet
This pallet manages a configurable set of nodes for a permissioned network.
Each node is dentified by a PeerId (i.e. Vec<u8>
). It provides two ways to
authorize a node,
- a set of well known nodes across different organizations in which the connections are allowed.
- users can claim the ownership for each node, then manage the connections of the node.
A node must have an owner. The owner can additionally change the connections for the node. Only one user is allowed to claim a specific node. To eliminate false claim, the maintainer of the node should claim it before even starting the node. This pallet uses offchain worker to set reserved nodes, if the node is not an authority, make sure to enable offchain worker with the right CLI flag. The node can be lagged with the latest block, in this case you need to disable offchain worker and manually set reserved nodes when starting it.
Dependencies
~17–37MB
~620K SLoC