-
Notifications
You must be signed in to change notification settings - Fork 131
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update polkadot, substrate, cumulus readme (#1182)
* update readmes * temporary ReadMe for the Polkadot SDK * delete welcome readme * update links on substrate readme * update links on polkadot readme * update links on cumulus readme * update overseer feature comment Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Update cumulus/README.md Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Update cumulus/README.md Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Update polkadot/README.md Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Update polkadot/README.md Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * Update polkadot/README.md Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * update gitlab links Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> * terminal friendly convention --------- Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
- Loading branch information
1 parent
b728724
commit c80f76f
Showing
3 changed files
with
559 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,270 @@ | ||
| Dear contributors and users, | ||
| # Cumulus ☁️ | ||
|
|
||
| We would like to inform you that 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 a single new repository: [the Polkadot SDK](https://github.com/paritytech/polkadot-sdk). Go ahead and make sure to support us by giving a star ⭐️ to the new repo. | ||
| [](https://paritytech.github.io/cumulus/) | ||
|
|
||
| By consolidating our codebase, we aim to enhance collaboration and provide a more efficient platform for future development. | ||
| This repository contains both the Cumulus SDK and also specific chains implemented on top of this | ||
| SDK. | ||
|
|
||
| If you currently have an open pull request in any of the merged repositories, we kindly request that you resubmit your PR in the new repository. This will ensure that your contributions are considered within the updated context and enable us to review and merge them more effectively. | ||
| If you only want to run a **Polkadot Parachain Node**, check out our [container | ||
| section](./docs/container.md). | ||
|
|
||
| We appreciate your understanding and ongoing support throughout this transition. Should you have any questions or require further assistance, please don't hesitate to [reach out to us](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883). | ||
| ## Cumulus SDK | ||
|
|
||
| Best Regards, | ||
| 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. | ||
|
|
||
| Parity Technologies | ||
| 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. | ||
|
|
||
| ### 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. | ||
|
|
||
| ### 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). | ||
|
|
||
| ### 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. | ||
|
|
||
| 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 | ||
| polkadot-parachain \ | ||
| --chain parachain-chainspec.json \ | ||
| --tmp \ | ||
| -- \ | ||
| --chain relaychain-chainspec.json | ||
| ``` | ||
|
|
||
| #### 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. | ||
|
|
||
| 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. | ||
|
|
||
| ##### Example command | ||
|
|
||
| ```bash | ||
| 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 | ||
| ``` | ||
|
|
||
| #### 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. | ||
|
|
||
| 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. | ||
|
|
||
|
|
||
| ##### Example command | ||
| ```bash | ||
| polkadot-parachain \ | ||
| --chain parachain-chainspec.json \ | ||
| --tmp \ | ||
| --relay-chain-light-client \ | ||
| -- \ | ||
| --chain relaychain-chainspec.json | ||
| ``` | ||
|
|
||
| ## 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/). | ||
|
|
||
| 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). | ||
|
|
||
| #### 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. | ||
| - **Kubernetes:** Choose this for advanced use-cases or running on cloud-infrastructure. | ||
|
|
||
| #### How to run | ||
| To run the example network, use the following commands: | ||
| ```bash | ||
| # 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 | ||
| ``` | ||
|
|
||
| ### Manual Setup | ||
| #### Launch the Relay Chain | ||
|
|
||
| ```bash | ||
| # Clone | ||
| git clone https://github.com/paritytech/polkadot-sdk | ||
|
|
||
| # Compile Polkadot | ||
| 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 | ||
| ``` | ||
|
|
||
| #### Launch the Parachain | ||
|
|
||
| ```bash | ||
| # Clone | ||
| git clone https://github.com/paritytech/polkadot-sdk | ||
|
|
||
| # 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 --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 | ||
|
|
||
| # Parachain Full Node 1 | ||
| ./target/release/polkadot-parachain --tmp --port 40337 --rpc-port 9948 -- --chain ../polkadot/rococo-local-cfde.json --port 30337 | ||
| ``` | ||
|
|
||
| #### Register the 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. | ||
|
|
||
| ### Build & Launch a Node | ||
|
|
||
| To run an Asset Hub node, you will need to compile the `polkadot-parachain` binary: | ||
|
|
||
| ```bash | ||
| cargo build --release --locked --bin polkadot-parachain | ||
| ``` | ||
|
|
||
| Once the executable is built, launch the parachain node via: | ||
|
|
||
| ```bash | ||
| CHAIN=asset-hub-westend # or asset-hub-kusama | ||
| ./target/release/polkadot-parachain --chain $CHAIN | ||
| ``` | ||
|
|
||
| Refer to the [setup instructions](#manual-setup) to run a local network for development. | ||
|
|
||
| ## Contracts 📝 | ||
|
|
||
| See [the `contracts-rococo` readme](parachains/runtimes/contracts/contracts-rococo/README.md) for details. | ||
|
|
||
| ## Bridge-hub 📝 | ||
|
|
||
| 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 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. | ||
|
|
||
| To run a Rococo collator you will need to compile the following binary: | ||
|
|
||
|
|
||
| ```bash | ||
| 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`): | ||
|
|
||
| ```bash | ||
| ./target/release/polkadot-parachain --chain $CHAIN --validator | ||
| ``` | ||
|
|
||
| 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) | ||
|
|
||
| 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. |
Oops, something went wrong.