polkadot-omni-node

Crates.iopolkadot-omni-node
lib.rspolkadot-omni-node
version
sourcesrc
created_at2024-10-08 12:49:49.590991
updated_at2025-01-29 22:08:10.070003
descriptionGeneric binary that can run a parachain node with u32 block number and Aura consensus
homepage
repository
max_upload_size
id1401106
Cargo.toml error:TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Parity Crate Owner (parity-crate-owner)

documentation

README

Polkadot Omni Node

This is a white labeled implementation based on polkadot-omni-node-lib. It can be used to start a parachain node from a provided chain spec file. It is only compatible with runtimes that use block number u32 and Aura consensus.

Installation

Download & expose it via PATH:

# Download and set it on PATH.
wget https://github.com/paritytech/polkadot-sdk/releases/download/<stable_release_tag>/polkadot-omni-node
chmod +x polkadot-omni-node
export PATH="$PATH:`pwd`"

Compile & install via cargo:

# Assuming ~/.cargo/bin is on the PATH
cargo install polkadot-omni-node

Usage

A basic example for an Omni Node run starts from a runtime which implements the sp_genesis_builder::GenesisBuilder. The interface mandates the runtime to expose a named-preset.

1. Install chain-spec-builder

Note: chain-spec-builder binary is published on crates.io under staging-chain-spec-builder due to a name conflict. Install it with cargo like bellow :

cargo install staging-chain-spec-builder

2. Generate a chain spec

Omni Node expects for the chain spec to contain parachains related fields like relay_chain and para_id. These fields can be introduced by running staging-chain-spec-builder with additional flags:

chain-spec-builder create --relay-chain <relay_chain_id> --para-id <id> -r <runtime.wasm> named-preset <preset_name>

3. Run Omni Node

And now with the generated chain spec we can start the node in development mode like so:

polkadot-omni-node --dev --chain <chain_spec.json>

Useful links

Release

Polkadot SDK Stable 2412

Commit count: 0

cargo fmt