mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-24 06:41:06 +00:00
Markdown linter (#1309)
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
This commit is contained in:
Chevdor
+75
-87
@@ -2,59 +2,53 @@
|
||||
|
||||
[](https://paritytech.github.io/cumulus/)
|
||||
|
||||
This repository contains both the Cumulus SDK and also specific chains implemented on top of this
|
||||
SDK.
|
||||
This repository contains both the Cumulus SDK and also specific chains implemented on top of this SDK.
|
||||
|
||||
If you only want to run a **Polkadot Parachain Node**, check out our [container
|
||||
section](./docs/container.md).
|
||||
If you only want to run a **Polkadot Parachain Node**, check out our [container section](./docs/container.md).
|
||||
|
||||
## Cumulus SDK
|
||||
|
||||
A set of tools for writing [Substrate](https://substrate.io/)-based
|
||||
[Polkadot](https://wiki.polkadot.network/en/)
|
||||
[parachains](https://wiki.polkadot.network/docs/en/learn-parachains). Refer to the included
|
||||
[overview](docs/overview.md) for architectural details, and the [Connect to a relay chain how-to
|
||||
guide](https://docs.substrate.io/reference/how-to-guides/parachains/connect-to-a-relay-chain/) for a
|
||||
guided walk-through of using these tools.
|
||||
A set of tools for writing [Substrate](https://substrate.io/)-based [Polkadot](https://wiki.polkadot.network/en/)
|
||||
[parachains](https://wiki.polkadot.network/docs/en/learn-parachains). Refer to the included [overview](docs/overview.md)
|
||||
for architectural details, and the [Connect to a relay chain how-to
|
||||
guide](https://docs.substrate.io/reference/how-to-guides/parachains/connect-to-a-relay-chain/) 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.
|
||||
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.
|
||||
Cumulus clouds are shaped sort of like dots; together they form a system that is intricate, beautiful and functional.
|
||||
|
||||
### Consensus
|
||||
|
||||
[`parachain-consensus`](https://github.com/paritytech/polkadot-sdk/blob/master/cumulus/client/consensus/common/src/parachain_consensus.rs)
|
||||
is a [consensus engine](https://docs.substrate.io/v3/advanced/consensus) for Substrate that follows
|
||||
a Polkadot [relay chain](https://wiki.polkadot.network/docs/en/learn-architecture#relay-chain). This
|
||||
will run a Polkadot node internally, and dictate to the client and synchronization algorithms which
|
||||
chain to follow,
|
||||
[finalize](https://wiki.polkadot.network/docs/en/learn-consensus#probabilistic-vs-provable-finality),
|
||||
and treat as best.
|
||||
is a [consensus engine](https://docs.substrate.io/v3/advanced/consensus) for Substrate that follows a Polkadot [relay
|
||||
chain](https://wiki.polkadot.network/docs/en/learn-architecture#relay-chain). This will run a Polkadot node internally,
|
||||
and dictate to the client and synchronization algorithms which chain to follow,
|
||||
[finalize](https://wiki.polkadot.network/docs/en/learn-consensus#probabilistic-vs-provable-finality), and treat as best.
|
||||
|
||||
### Collator
|
||||
|
||||
A Polkadot [collator](https://wiki.polkadot.network/docs/en/learn-collator) for the parachain is
|
||||
implemented by the `polkadot-parachain` binary (previously called `polkadot-collator`).
|
||||
A Polkadot [collator](https://wiki.polkadot.network/docs/en/learn-collator) for the parachain is implemented by the
|
||||
`polkadot-parachain` binary (previously called `polkadot-collator`).
|
||||
|
||||
You may run `polkadot-parachain` locally after building it or using one of the container option
|
||||
described [here](./docs/container.md).
|
||||
You may run `polkadot-parachain` locally after building it or using one of the container option described
|
||||
[here](./docs/container.md).
|
||||
|
||||
### Relay Chain Interaction
|
||||
To operate a parachain node, a connection to the corresponding relay
|
||||
chain is necessary. This can be achieved in one of three ways:
|
||||
1. Run a full relay chain node within the parachain node (default)
|
||||
2. Connect to an external relay chain node via WebSocket RPC
|
||||
### Relay Chain Interaction
|
||||
To operate a parachain node, a connection to the corresponding relay chain is necessary. This can be achieved in one of
|
||||
three ways:
|
||||
1. Run a full relay chain node within the parachain node (default)
|
||||
2. Connect to an external relay chain node via WebSocket RPC
|
||||
3. Run a light client for the relay chain
|
||||
|
||||
#### In-process Relay Chain Node
|
||||
If an external relay chain node is not specified (default behavior), then a full relay chain node is
|
||||
spawned within the same process.
|
||||
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.
|
||||
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.
|
||||
|
||||
##### Example command
|
||||
```bash
|
||||
@@ -66,19 +60,16 @@ polkadot-parachain \
|
||||
```
|
||||
|
||||
#### External Relay Chain Node
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
**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.
|
||||
|
||||
##### Example command
|
||||
|
||||
@@ -94,17 +85,15 @@ polkadot-parachain \
|
||||
```
|
||||
|
||||
#### Relay Chain Light Client
|
||||
An internal relay chain light client provides a fast and lightweight approach
|
||||
for connecting to the relay chain network. It provides relay chain notifications
|
||||
and facilitates runtime calls.
|
||||
An internal relay chain light client provides a fast and lightweight approach for connecting to the relay chain network.
|
||||
It provides relay chain notifications and facilitates runtime calls.
|
||||
|
||||
To specify which chain the light client should connect to, users need to supply
|
||||
a relay chain chain-spec as part of the relay chain arguments.
|
||||
To specify which chain the light client should connect to, users need to supply a relay chain chain-spec as part of the
|
||||
relay chain arguments.
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
|
||||
##### Example command
|
||||
@@ -118,23 +107,22 @@ polkadot-parachain \
|
||||
```
|
||||
|
||||
## Installation and Setup
|
||||
Before building Cumulus SDK based nodes / runtimes prepare your environment by
|
||||
following Substrate [installation instructions](https://docs.substrate.io/main-docs/install/).
|
||||
Before building Cumulus SDK based nodes / runtimes prepare your environment by following Substrate [installation
|
||||
instructions](https://docs.substrate.io/main-docs/install/).
|
||||
|
||||
To launch a local network, you can use [zombienet](https://github.com/paritytech/zombienet)
|
||||
for quick setup and experimentation or follow the [manual setup](#manual-setup).
|
||||
To launch a local network, you can use [zombienet](https://github.com/paritytech/zombienet) for quick setup and
|
||||
experimentation or follow the [manual setup](#manual-setup).
|
||||
|
||||
### Zombienet
|
||||
We use Zombienet to spin up networks for integration tests and local networks.
|
||||
Follow [these installation steps](https://github.com/paritytech/zombienet#requirements-by-provider)
|
||||
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/examples/small_network.toml).
|
||||
We use Zombienet to spin up networks for integration tests and local networks. Follow [these installation
|
||||
steps](https://github.com/paritytech/zombienet#requirements-by-provider) 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/examples/small_network.toml).
|
||||
|
||||
#### Which provider should I use?
|
||||
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.
|
||||
- **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.
|
||||
|
||||
#### How to run
|
||||
@@ -183,13 +171,16 @@ cargo build --release --bin polkadot-parachain
|
||||
./target/release/polkadot-parachain export-genesis-wasm > genesis-wasm
|
||||
|
||||
# Collator1
|
||||
./target/release/polkadot-parachain --collator --alice --force-authoring --tmp --port 40335 --rpc-port 9946 -- --chain ../polkadot/rococo-local-cfde.json --port 30335
|
||||
./target/release/polkadot-parachain --collator --alice --force-authoring \
|
||||
--tmp --port 40335 --rpc-port 9946 -- --chain ../polkadot/rococo-local-cfde.json --port 30335
|
||||
|
||||
# Collator2
|
||||
./target/release/polkadot-parachain --collator --bob --force-authoring --tmp --port 40336 --rpc-port 9947 -- --chain ../polkadot/rococo-local-cfde.json --port 30336
|
||||
./target/release/polkadot-parachain --collator --bob --force-authoring \
|
||||
--tmp --port 40336 --rpc-port 9947 -- --chain ../polkadot/rococo-local-cfde.json --port 30336
|
||||
|
||||
# Parachain Full Node 1
|
||||
./target/release/polkadot-parachain --tmp --port 40337 --rpc-port 9948 -- --chain ../polkadot/rococo-local-cfde.json --port 30337
|
||||
./target/release/polkadot-parachain --tmp --port 40337 --rpc-port 9948 -- \
|
||||
--chain ../polkadot/rococo-local-cfde.json --port 30337
|
||||
```
|
||||
|
||||
#### Register the parachain
|
||||
@@ -199,8 +190,8 @@ cargo build --release --bin polkadot-parachain
|
||||
|
||||
## Asset Hub 🪙
|
||||
|
||||
This repository also contains the Asset Hub runtimes. Asset Hub is a system parachain
|
||||
providing an asset store for the Polkadot ecosystem.
|
||||
This repository also contains the Asset Hub runtimes. Asset Hub is a system parachain providing an asset store for the
|
||||
Polkadot ecosystem.
|
||||
|
||||
### Build & Launch a Node
|
||||
|
||||
@@ -228,20 +219,18 @@ See [the `contracts-rococo` readme](parachains/runtimes/contracts/contracts-roco
|
||||
See [the `bridge-hubs` readme](parachains/runtimes/bridge-hubs/README.md) for details.
|
||||
|
||||
## Rococo 👑
|
||||
[Rococo](https://polkadot.js.org/apps/?rpc=wss://rococo-rpc.polkadot.io) is becoming a
|
||||
[Community Parachain Testbed](https://polkadot.network/blog/rococo-revamp-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](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains).
|
||||
[Rococo](https://polkadot.js.org/apps/?rpc=wss://rococo-rpc.polkadot.io) is becoming a [Community Parachain
|
||||
Testbed](https://polkadot.network/blog/rococo-revamp-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](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains).
|
||||
|
||||
Rococo is an elaborate style of design and the name describes the painstaking effort that
|
||||
has gone into this project.
|
||||
Rococo is an elaborate style of design and the name describes the painstaking effort that has gone into this project.
|
||||
|
||||
### Build & Launch Rococo Collators
|
||||
|
||||
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.
|
||||
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:
|
||||
|
||||
@@ -250,8 +239,7 @@ To run a Rococo collator you will need to compile the following binary:
|
||||
cargo build --release --locked --bin polkadot-parachain
|
||||
```
|
||||
|
||||
Once the executable is built, launch collators for each parachain (repeat once each for chain
|
||||
`tick`, `trick`, `track`):
|
||||
Once the executable is built, launch collators for each parachain (repeat once each for chain `tick`, `trick`, `track`):
|
||||
|
||||
```bash
|
||||
./target/release/polkadot-parachain --chain $CHAIN --validator
|
||||
@@ -261,10 +249,10 @@ You can also build [using a container](./docs/container.md).
|
||||
|
||||
### Parachains
|
||||
|
||||
* [Asset Hub](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-statemint-rpc.polkadot.io#/explorer)
|
||||
* [Contracts on Rococo](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-contracts-rpc.polkadot.io#/explorer)
|
||||
* [RILT](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo.kilt.io#/explorer)
|
||||
- [Asset Hub](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-statemint-rpc.polkadot.io#/explorer)
|
||||
- [Contracts on Rococo](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-contracts-rpc.polkadot.io#/explorer)
|
||||
- [RILT](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo.kilt.io#/explorer)
|
||||
|
||||
The 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.
|
||||
The 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.
|
||||
|
||||
Reference in New Issue
Block a user