diff --git a/README.md b/README.md index e5d9991..d02b15a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,73 @@ +
+ # Assets Parachain Template -A new [Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus)-based Substrate node, configured with fungible and non-fungilble asset functionalities, including asset fractionalization. +Polkadot SDK Logo +Polkadot SDK Logo +

+R0GUE Logo + +[![Twitter URL](https://img.shields.io/twitter/follow/Pop?style=social)](https://x.com/onpopio/) +[![Twitter URL](https://img.shields.io/twitter/follow/R0GUE?style=social)](https://twitter.com/gor0gue) +[![Telegram](https://img.shields.io/badge/Telegram-gray?logo=telegram)](https://t.me/onpopio) + +> This is the [Pop CLI](https://github.com/r0gue-io/pop-cli) assets parachain template. + +> It is based on the [Polkadot SDK](https://github.com/paritytech/polkadot-sdk) and is updated by [R0GUE](r0gue.io) after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk). + +
+ +* âĢ This template provides a starting point to build an assets [parachain](https://wiki.polkadot.network/docs/learn-parachains). + +* ☁ī¸ It is based on the +[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework. + +* 🔧 Its [runtime](./runtime) is configured with fungible and non-fungilble asset functionalities, including asset fractionalization. + +## Template Structure + +A Polkadot SDK based project such as this one consists of: + +* đŸ’ŋ [Node](./node/README.md) - the binary application. +* 🧮 [Runtime](./runtime/README.md) - the core logic of the parachain. + +## Getting Started + +#### Install [Pop CLI](https://github.com/r0gue-io/pop-cli) - the all-in-one Polkadot development tool: +> Detailed installation instructions can be found [here](https://learn.onpop.io/v/cli/installing-pop-cli). +``` +cargo install --force --locked pop-cli +``` + +#### Start a new parachain project with this template: +``` +pop new parachain +``` +> When prompted, select 'Pop' as the template provider and 'Assets' as the type of parachain. +> +> More info can be found [here](https://learn.onpop.io/v/appchains/guides/create-a-new-parachain/create-an-assets-parachain). + +#### Learn how to run your parachain using the `pop up` command: +```sh +pop up parachain -f ./network.toml +``` +> 👉 https://learn.onpop.io/v/appchains/guides/running-your-parachain + +### Learning Resources + +* 🧑‍đŸĢ To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point. -This project is a fork of the [Base Parachain Template](https://github.com/r0gue-io/base-parachain). + * ⭕ Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains). -It is used to generate parachains using [Pop CLI](https://github.com/r0gue-io/pop-cli), an all-in-one tool for Polkadot development. +* 🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are +the Polkadot SDK documentation resources. -## Next Steps +* 📖 To learn how to develop parachains with Pop CLI, read the [guides](https://learn.onpop.io/v/appchains). -đŸ’Ĩ Learn more about Pop CLI [here](https://learn.onpop.io/pop/v/pop-cli). +### Support -🚀 Learn about how to run your own parachain testnet using Pop CLI [here](https://learn.onpop.io/pop/v/pop-cli/parachains/running-your-parachain). +* 💡 Be part of our passionate community of Web3 pioneers. [Join our Telegram](https://t.me/onpopio)! -👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains). +* đŸ‘Ĩ Additionally, there are [GitHub issues](https://github.com/r0gue-io/base-parachain/issues) and +[Polkadot Stack Exchange](https://polkadot.stackexchange.com/). -🧙 Learn about how to build using this template [here](https://docs.substrate.io/tutorials/). diff --git a/node/README.md b/node/README.md new file mode 100644 index 0000000..ad309d4 --- /dev/null +++ b/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 the 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. diff --git a/runtime/README.md b/runtime/README.md new file mode 100644 index 0000000..63684d7 --- /dev/null +++ b/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). + +👉 Learn more about FRAME +[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).