This repository contains both the Cumulus SDK and also specific chains implemented on top of this SDK.
A set of tools for writing Substrate-based Polkadot parachains. Refer to the included overview for architectural details, and the Connect to relay and parachain tutorials for a guided walk-through of using these tools.
It's easy to write blockchains using Substrate, and the overhead of writing parachains' distribution, p2p, database, and synchronization layers should be just as low. This project aims to make it easy to write parachains for Polkadot by leveraging the power of Substrate.
Cumulus clouds are shaped sort of like dots; together they form a system that is intricate, beautiful and functional.
parachain-consensus is a
consensus engine for Substrate
that follows a Polkadot
relay chain. This will run
a Polkadot node internally, and dictate to the client and synchronization algorithms which chain
to follow,
finalize,
and treat as best.
A Polkadot collator for the parachain is
implemented by the polkadot-parachain binary (previously called polkadot-collator).
To operate a parachain node, a connection to the corresponding relay chain is necessary. This can be achieved in one of two ways:
- Run a full relay chain node within the parachain node (default)
- Connect to an external relay chain node via WebSocket RPC
If an external relay chain node is not specified (default behavior), then a full relay chain node is spawned within the same process.
This node has all of the typical components of a regular Polkadot node and will have to fully sync with the relay chain to work.
polkadot-parachain \
--chain parachain-chainspec.json \
--tmp \
-- \
--chain relaychain-chainspec.json
An external relay chain node is connected via WebsSocket RPC by using the --relay-chain-rpc-urls
command line argument. This option accepts one or more space-separated WebSocket URLs to a full relay
chain node. By default, only the first URL will be used, with the rest as a backup in case the
connection to the first node is lost.
Parachain nodes using this feature won't have to fully sync with the relay chain to work, so in general they will use fewer system resources.
Note: At this time, any parachain nodes using this feature will still spawn a significantly cut-down relay chain node in-process. Even though they lack the majority of normal Polkadot subsystems, they will still need to connect directly to the relay chain network.
polkadot-parachain \
--chain parachain-chainspec.json \
--tmp \
--relay-chain-rpc-urls \
"ws://relaychain-rpc-endpoint:9944" \
"ws://relaychain-rpc-endpoint-backup:9944" \
-- \
--chain relaychain-chainspec.json
Before building Cumulus SDK based nodes / runtimes prepare your environment by following Substrate installation instructions.
To launch a local network, you can use zombienet for quick setup and experimentation or follow the manual setup.
We use Zombienet to spin up networks for integration tests and local networks. Follow these installation steps to set it up on your machine. A simple network specification with two relay chain nodes and one collator is located at zombienet/examples/small_network.toml.
Zombienet offers multiple providers to run networks. Choose the one that best fits your needs:
- Podman: Choose this if you want to spin up a network quick and easy.
- Native: Choose this if you want to develop and deploy your changes. Requires compilation of the binaries.
- Kubernetes: Choose this for advanced use-cases or running on cloud-infrastructure.
To run the example network, use the following commands:
# Podman provider
zombienet --provider podman spawn ./zombienet/examples/small_network.toml
# Native provider, assumes polkadot and polkadot-parachains binary in $PATH
zombienet --provider native spawn ./zombienet/examples/small_network.toml# Clone
git clone https://github.com/paritytech/polkadot
cd polkadot
# Compile Polkadot with the real overseer feature
cargo build --release --bin polkadot
# Generate a raw chain spec
./target/release/polkadot build-spec --chain rococo-local --disable-default-bootnode --raw > rococo-local-cfde.json
# Alice
./target/release/polkadot --chain rococo-local-cfde.json --alice --tmp
# Bob (In a separate terminal)
./target/release/polkadot --chain rococo-local-cfde.json --bob --tmp --port 30334# Clone
git clone https://github.com/paritytech/cumulus
cd cumulus
# Compile
cargo build --release --bin polkadot-parachain
# Export genesis state
./target/release/polkadot-parachain export-genesis-state > genesis-state
# Export genesis wasm
./target/release/polkadot-parachain export-genesis-wasm > genesis-wasm
# Collator1
./target/release/polkadot-parachain --collator --alice --force-authoring --tmp --port 40335 --ws-port 9946 -- --execution wasm --chain ../polkadot/rococo-local-cfde.json --port 30335
# Collator2
./target/release/polkadot-parachain --collator --bob --force-authoring --tmp --port 40336 --ws-port 9947 -- --execution wasm --chain ../polkadot/rococo-local-cfde.json --port 30336
# Parachain Full Node 1
./target/release/polkadot-parachain --tmp --port 40337 --ws-port 9948 -- --execution wasm --chain ../polkadot/rococo-local-cfde.json --port 30337
This repository also contains the Statemint runtime (as well as the canary runtime Statemine and the test runtime Westmint). Statemint is a system parachain providing an asset store for the Polkadot ecosystem.
To run a Statemine or Westmint node (Statemint is not deployed, yet) you will need to compile the
polkadot-parachain binary:
cargo build --release --locked -p polkadot-parachainOnce the executable is built, launch the parachain node via:
CHAIN=westmint # or statemine
./target/release/polkadot-parachain --chain $CHAINRefer to the setup instructions to run a local network for development.
See the contracts-rococo readme for details.
See the bridge-hubs readme for details.
Rococo is becoming a Community Parachain Testbed for parachain teams in the Polkadot ecosystem. It supports multiple parachains with the differentiation of long-term connections and recurring short-term connections, to see which parachains are currently connected and how long they will be connected for see here.
Rococo is an elaborate style of design and the name describes the painstaking effort that has gone into this project.
Collators are similar to validators in the relay chain. These nodes build the blocks that will eventually be included by the relay chain for a parachain.
To run a Rococo collator you will need to compile the following binary:
cargo build --release --locked -p polkadot-parachainOtherwise you can compile it with Parity CI docker image:
docker run --rm -it -w /shellhere/cumulus \
-v $(pwd):/shellhere/cumulus \
paritytech/ci-linux:production cargo build --release --locked -p polkadot-parachain
sudo chown -R $(id -u):$(id -g) target/If you want to reproduce other steps of CI process you can use the following guide.
Once the executable is built, launch collators for each parachain (repeat once each for chain
tick, trick, track):
./target/release/polkadot-parachain --chain $CHAIN --validatorThe network uses horizontal message passing (HRMP) to enable communication between parachains and the relay chain and, in turn, between parachains. This means that every message is sent to the relay chain, and from the relay chain to its destination parachain.
After building polkadot-parachain with cargo or with Parity CI image as documented in this chapter,
the following will allow producing a new docker image where the compiled binary is injected:
./docker/scripts/build-injected-image.shAlternatively, you can build an image with a builder pattern:
docker build --tag $OWNER/$IMAGE_NAME --file ./docker/polkadot-parachain_builder.Containerfile .
You may then run your new container:
```bash
docker run --rm -it $OWNER/$IMAGE_NAME --collator --tmp --execution wasm --chain /specs/westmint.json