Revamp the Readme of the parachain template

templates/minimal/README.md

@@ -11,12 +11,13 @@
 
 </div>
 
-🤏 This template is a minimal (in terms of complexity and the number of components) template for building a blockchain node.
+* 🤏 This template is a minimal (in terms of complexity and the number of components)
+template for building a blockchain node.
 
-🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
+* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
 such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
 
-👤 The template has no consensus configured - it is best for experimenting with a single node network.
+* 👤 The template has no consensus configured - it is best for experimenting with a single node network.
 
 ## Template Structure
 
@@ -28,12 +29,12 @@ A Polkadot SDK based project such as this one consists of:
 
 ## Getting Started
 
-🦀 The template is using the Rust language.
+* 🦀 The template is using the Rust language.
 
-👉 Check the
+* 👉 Check the
 [Rust installation instructions](https://www.rust-lang.org/tools/install) for your system.
 
-🛠️ Depending on your operating system and Rust version, there might be additional
+* 🛠️ Depending on your operating system and Rust version, there might be additional
 packages required to compile this template - please take note of the Rust compiler output.
 
 ### Build
@@ -69,32 +70,32 @@ Development chains:
 
 ### Connect with the Polkadot-JS Apps Front-End
 
-🌐 You can interact with your local node using the
+* 🌐 You can interact with your local node using the
 hosted version of the [Polkadot/Substrate
 Portal](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944).
 
-🪐 A hosted version is also
+* 🪐 A hosted version is also
 available on [IPFS](https://dotapps.io/).
 
-🧑‍🔧 You can also find the source code and instructions for hosting your own instance in the
+* 🧑‍🔧 You can also find the source code and instructions for hosting your own instance in the
 [`polkadot-js/apps`](https://github.com/polkadot-js/apps) repository.
 
 ## Contributing
 
-🔄 This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
+* 🔄 This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
 
-➡️ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/minimal).
+* ➡️ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/minimal).
 
-😇 Please refer to the monorepo's
+* 😇 Please refer to the monorepo's
 [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
 [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
 
 ## Getting Help
 
-🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
+* 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
 
-🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
+* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
 the Polkadot SDK documentation resources.
 
-👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
+* 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
 [Substrate StackExchange](https://substrate.stackexchange.com/).

templates/parachain/README.md

@@ -1,22 +1,121 @@
-# Substrate Cumulus Parachain Template
+<div align="center">
 
-A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node, ready for hacking ☁️..
+# Polkadot SDK's Parachain Template
 
-This project is originally a fork of the
-[Substrate Node Template](https://github.com/substrate-developer-hub/substrate-node-template)
-modified to include dependencies required for registering this node as a **parathread** or
-**parachain** to a **relay chain**.
+<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_White.png#gh-dark-mode-only"/>
+<img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_Black.png#gh-light-mode-only"/>
 
-The stand-alone version of this template is hosted on the
-[Substrate Devhub Parachain Template](https://github.com/substrate-developer-hub/substrate-parachain-template/)
-for each release of Polkadot. It is generated directly to the upstream
-[Parachain Template in Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus/parachain-template)
-at each release branch using the
-[Substrate Template Generator](https://github.com/paritytech/substrate-template-generator/).
+> This is a template for creating a [parachain](https://wiki.polkadot.network/docs/learn-parachains) based on Polkadot SDK.
+>
+> This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
 
-👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains), and
-parathreads [here](https://wiki.polkadot.network/docs/learn-parathreads).
+</div>
 
+* ⏫ This template provides a starting point to build a [parachain](https://wiki.polkadot.network/docs/learn-parachains).
 
-🧙 Learn about how to use this template and run your own parachain testnet for it in the
-[Devhub Cumulus Tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay/).
+* ☁️ It is based on the
+[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.
+
+* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
+such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
+
+* 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains)
+
+## Template Structure
+
+A Polkadot SDK based project such as this one consists of:
+
+* 💿 a [Node](./node/README.md) - the binary application.
+* 🧮 the [Runtime](./runtime/README.md) - the core logic of the parachain.
+* 🎨 the [Pallets](./pallets/README.md) - from which the runtime is constructed.
+
+## Getting Started
+
+* 🦀 The template is using the Rust language.
+
+* 👉 Check the
+[Rust installation instructions](https://www.rust-lang.org/tools/install) for your system.
+
+* 🛠️ Depending on your operating system and Rust version, there might be additional
+packages required to compile this template - please take note of the Rust compiler output.
+
+### Build
+
+🔨 Use the following command to build the node without launching it:
+
+```sh
+cargo build --release
+```
+
+🐳 Alternatively, build the docker image:
+
+```sh
+docker build . -t polkadot-sdk-parachain-template
+```
+
+### Local Development Chain
+
+🧟 This project uses [Zombienet](https://github.com/paritytech/zombienet) to orchestrate the relaychain and parachain nodes.
+You can grab a [released binary](https://github.com/paritytech/zombienet/releases/latest) or use an [npm version](https://www.npmjs.com/package/@zombienet/cli).
+
+This template produces a parachain node.
+You still need a relaychain node - you can download the `polkadot`
+(and the accompanying `polkadot-prepare-worker` and `polkadot-execute-worker`)
+binaries from [Polkadot SDK releases](https://github.com/paritytech/polkadot-sdk/releases/latest).
+
+Make sure to bring the parachain node - as well as `polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`,
+and `zombienet` - into `PATH` like so:
+
+```sh
+export PATH="./target/release/:$PATH"
+```
+
+This way, we can conveniently use them un the following steps.
+
+👥 The following command starts a local development chain, with a single relay chain node and a single parachain collator:
+
+```sh
+zombienet --provider native spawn ./zombienet.toml
+
+# Alternatively, the npm version:
+npx --yes @zombienet/cli --provider native spawn ./zombienet.toml
+```
+
+Development chains:
+
+* 🧹 Do not persist the state.
+* 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
+* 🧑‍⚖️ Development accounts are used as validators, collators, and `sudo` accounts.
+
+### Connect with the Polkadot-JS Apps Front-End
+
+* 🌐 You can interact with your local node using the
+hosted version of the Polkadot/Substrate Portal:
+[relay chain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944)
+and [parachain](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9988).
+
+* 🪐 A hosted version is also
+available on [IPFS](https://dotapps.io/).
+
+* 🧑‍🔧 You can also find the source code and instructions for hosting your own instance in the
+[`polkadot-js/apps`](https://github.com/polkadot-js/apps) repository.
+
+## Contributing
+
+* 🔄 This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
+
+* ➡️ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain).
+
+* 😇 Please refer to the monorepo's
+[contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
+[Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
+
+## Getting Help
+
+* 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
+
+* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
+the Polkadot SDK documentation resources.
+
+* 👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
+[Substrate StackExchange](https://substrate.stackexchange.com/).

templates/parachain/node/README.md

@@ -0,0 +1,18 @@
+# Node
+
+ℹ️ A node -  in Polkadot - is a binary executable, whose primary purpose is to execute the [runtime](../runtime/README.md).
+
+🔗 It communicates with other nodes in the network, and aims for
+[consensus](https://wiki.polkadot.network/docs/learn-consensus) among them.
+
+⚙️ It acts as a remote procedure call (RPC) server, allowing interaction with the blockchain.
+
+👉 Learn more about the architecture, and a difference between a node and a runtime
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html).
+
+👇 Here are the most important files in this node template:
+
+- [`chain_spec.rs`](./src/chain_spec.rs): A chain specification is a source code file that defines the chain's
+initial (genesis) state.
+- [`service.rs`](./src/service.rs): This file defines the node implementation.
+It's a place to configure consensus-related topics.

templates/parachain/pallets/README.md

@@ -0,0 +1,13 @@
+# Pallets
+
+ℹ️ A pallet is a unit of encapsulated logic, with a clearly defined responsibility. A pallet is analogous to a
+module in the runtime.
+
+💁 In this template, there is a simple custom pallet based on the FRAME framework.
+
+👉 Learn more about FRAME
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).
+
+🧑‍🏫 Please refer to
+[this guide](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/your_first_pallet/index.html)
+to learn how to write a basic pallet.

templates/parachain/runtime/README.md

@@ -0,0 +1,10 @@
+# Runtime
+
+ℹ️ The runtime (in other words, a state transition function), refers to the core logic of the parachain that is
+responsible for validating blocks and executing the state changes they define.
+
+💁 The runtime in this template is constructed using ready-made FRAME pallets that ship with
+[Polkadot SDK](https://github.com/paritytech/polkadot-sdk), and a [template for a custom pallet](../pallets/README.md).
+
+👉 Learn more about FRAME
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).

templates/parachain/zombienet.toml

@@ -0,0 +1,16 @@
+[relaychain]
+default_command = "polkadot"
+chain = "dev"
+
+[[relaychain.nodes]]
+name = "alice"
+validator = true
+ws_port = 9944
+
+[[parachains]]
+id = 1000
+
+[parachains.collator]
+name = "alice"
+ws_port = 9988
+command = "parachain-template-node"