mirror of
https://github.com/pezkuwichain/pez-minimal-template.git
synced 2026-04-22 07:57:56 +00:00
Template Bot
101 lines
3.8 KiB
Markdown
101 lines
3.8 KiB
Markdown
<div align="center">
|
|
|
|
# Polkadot SDK's Minimal Template
|
|
|
|
<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"/>
|
|
|
|
> This is a minimal template for creating a blockchain based on Polkadot SDK.
|
|
>
|
|
> This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
|
|
|
|
</div>
|
|
|
|
🤏 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
|
|
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.
|
|
|
|
## 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 blockchain.
|
|
* 🎨 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-minimal-template
|
|
```
|
|
|
|
### Single-Node Development Chain
|
|
|
|
👤 The following command starts a single-node development chain:
|
|
|
|
```sh
|
|
./target/release/minimal-template-node --dev
|
|
|
|
# docker version:
|
|
docker run --rm polkadot-sdk-minimal-template --dev
|
|
```
|
|
|
|
Development chains:
|
|
|
|
* 🧹 Do not persist the state.
|
|
* 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
|
|
* 🧑⚖️ Development accounts are used as `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](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944).
|
|
|
|
🪐 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/minimal).
|
|
|
|
😇 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/).
|