28 breaking releases
new 0.37.0 | Mar 18, 2024 |
---|---|
0.35.0 | Feb 13, 2024 |
0.33.0 | Dec 13, 2023 |
0.32.0 | Nov 20, 2023 |
0.9.0 | Feb 10, 2021 |
#1141 in Magic Beans
2,992 downloads per month
Used in 9 crates
(2 directly)
1MB
26K
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
:
A RPC handler to create sync states for light clients.
Currently only usable with BABE + GRANDPA.
Usage
To use the light sync state, it needs to be added as an extension to the chain spec:
use sc_sync_state_rpc::LightSyncStateExtension;
#[derive(Default, Clone, serde::Serialize, serde::Deserialize, sc_chain_spec::ChainSpecExtension)]
#[serde(rename_all = "camelCase")]
pub struct Extensions {
light_sync_state: LightSyncStateExtension,
}
type ChainSpec = sc_chain_spec::GenericChainSpec<(), Extensions>;
If the LightSyncStateExtension
is not added as an extension to the chain spec,
the SyncState
will fail at instantiation.
Dependencies
~58–100MB
~2M SLoC