-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from chocolatenetwork/SHA888-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
196 additions
and
16 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,22 +1,202 @@ | ||
| # Substrate Cumulus Parachain Template | ||
| <div align="center"> | ||
| <img src="https://avatars.githubusercontent.com/u/89528034?s=400&u=37141744cd31c4d2bb349b18627f3903ab7eac34&v=4"> | ||
| </div> | ||
|
|
||
| A new [Cumulus](https://github.com/paritytech/cumulus/)-based Substrate node, ready for hacking ☁️.. | ||
| <div align="Center"> | ||
| <h1> Chocolate Parachain</h1> | ||
| <h2> Decentralized Blockchain Verification Platform </h2> | ||
| Ending scam & spam in crypto once and for all. | ||
| <br> | ||
| Built on Substrate. | ||
|
|
||
| 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**. | ||
| <br> | ||
| <br> | ||
|
|
||
| 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/cumulus/tree/master/parachain-template) | ||
| at each release branch using the | ||
| [Substrate Template Generator](https://github.com/paritytech/substrate-template-generator/). | ||
| [](https://substrate.dev/) | ||
| [](https://medium.com/) | ||
|
|
||
| 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains), and | ||
| parathreads [here](https://wiki.polkadot.network/docs/learn-parathreads). | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| 🧙 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/). | ||
| # Chocolate Parachain | ||
|
|
||
| A FRAME-based [Substrate](https://www.substrate.io/) parachain, ready for fighting back scammers :rocket: | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Follow the steps below to get started with the Chocolate Parachain, or get it up and running right from your browser | ||
| in just a few clicks using [Playground](https://playground.substrate.dev/) :hammer_and_wrench: | ||
|
|
||
| ### Using Nix | ||
|
|
||
| Install [nix](https://nixos.org/) and optionally [direnv](https://github.com/direnv/direnv) and [lorri](https://github.com/target/lorri) for a fully plug | ||
| and play experience for setting up the development environment. To get all the correct dependencies activate direnv `direnv allow` and lorri `lorri shell`. | ||
|
|
||
| ### Rust Setup | ||
|
|
||
| First, complete the [basic Rust setup instructions](./docs/rust-setup.md). | ||
|
|
||
| ### Run | ||
|
|
||
| Use Rust's native `cargo` command to build and launch the node: | ||
|
|
||
| ```sh | ||
| cargo run --release -- --dev --tmp | ||
| ``` | ||
|
|
||
| ### Build | ||
|
|
||
| The `cargo run` command will perform an initial build. Use the following command to build the node | ||
| without launching it: | ||
|
|
||
| ```sh | ||
| cargo build --release | ||
| ``` | ||
|
|
||
| ### Embedded Docs | ||
|
|
||
| Once the project has been built, the following command can be used to explore all parameters and | ||
| subcommands: | ||
|
|
||
| ```sh | ||
| ./target/release/chocolate -h | ||
| ``` | ||
|
|
||
| ## Run | ||
|
|
||
| The provided `cargo run` command will launch a temporary node and its state will be discarded after | ||
| you terminate the process. After the project has been built, there are other ways to launch the | ||
| node. | ||
|
|
||
| ### Single-Node Development Chain | ||
|
|
||
| This command will start the single-node development chain with persistent state: | ||
|
|
||
| ```bash | ||
| ./target/release/chocolate --dev | ||
| ``` | ||
|
|
||
| Purge the development chain's state: | ||
|
|
||
| ```bash | ||
| ./target/release/chocolate purge-chain --dev | ||
| ``` | ||
|
|
||
| Start the development chain with detailed logging: | ||
|
|
||
| ```bash | ||
| RUST_BACKTRACE=1 ./target/release/chocolate -ldebug --dev | ||
| ``` | ||
|
|
||
| ### Connect with Polkadot-JS Apps Front-end | ||
|
|
||
| Once the node is running locally, you can connect it with **Polkadot-JS Apps** front-end | ||
| to interact with your chain. [Click here](https://polkadot.js.org/apps/#/explorer?rpc=ws://localhost:9944) connecting the Apps to your local node. | ||
|
|
||
|
|
||
| ### Connect with Chocolate Demo Front-end | ||
|
|
||
| As above once you have the node running locally, you can [open this link](https://chocolate-demo.web.app?rpc=ws%3A%2F%2F127.0.0.1%3A9944) which has the added param `?rpc=ws%3A%2F%2F127.0.0.1%3A9944` you can modify this if you have changed the default ports. | ||
|
|
||
| ### Multi-Node Local Testnet | ||
|
|
||
| If you want to see the multi-node consensus algorithm in action, refer to | ||
| [our Start a Private Network tutorial](https://substrate.dev/docs/en/tutorials/start-a-private-network/). | ||
|
|
||
| ## Project Structure | ||
|
|
||
| A Substrate project such as this consists of a number of components that are spread across a few | ||
| directories. | ||
|
|
||
| ### Node | ||
|
|
||
| A blockchain node is an application that allows users to participate in a blockchain network. | ||
| Substrate-based blockchain nodes expose a number of capabilities: | ||
|
|
||
| - Networking: Substrate nodes use the [`libp2p`](https://libp2p.io/) networking stack to allow the | ||
| nodes in the network to communicate with one another. | ||
| - Consensus: Blockchains must have a way to come to | ||
| [consensus](https://substrate.dev/docs/en/knowledgebase/advanced/consensus) on the state of the | ||
| network. Substrate makes it possible to supply custom consensus engines and also ships with | ||
| several consensus mechanisms that have been built on top of | ||
| [Web3 Foundation research](https://research.web3.foundation/en/latest/polkadot/NPoS/index.html). | ||
| - RPC Server: A remote procedure call (RPC) server is used to interact with Substrate nodes. | ||
|
|
||
| There are several files in the `node` directory - take special note of the following: | ||
|
|
||
| - [`chain_spec.rs`](./node/src/chain_spec.rs): A | ||
| [chain specification](https://substrate.dev/docs/en/knowledgebase/integrate/chain-spec) is a | ||
| source code file that defines a Substrate chain's initial (genesis) state. Chain specifications | ||
| are useful for development and testing, and critical when architecting the launch of a | ||
| production chain. Take note of the `development_config` and `testnet_genesis` functions, which | ||
| are used to define the genesis state for the local development chain configuration. These | ||
| functions identify some | ||
| [well-known accounts](https://substrate.dev/docs/en/knowledgebase/integrate/subkey#well-known-keys) | ||
| and use them to configure the blockchain's initial state. | ||
| - [`service.rs`](./node/src/service.rs): This file defines the node implementation. Take note of | ||
| the libraries that this file imports and the names of the functions it invokes. In particular, | ||
| there are references to consensus-related topics, such as the | ||
| [longest chain rule](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#longest-chain-rule), | ||
| the [Aura](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#aura) block authoring | ||
| mechanism and the | ||
| [GRANDPA](https://substrate.dev/docs/en/knowledgebase/advanced/consensus#grandpa) finality | ||
| gadget. | ||
|
|
||
| After the node has been [built](#build), refer to the embedded documentation to learn more about the | ||
| capabilities and configuration parameters that it exposes: | ||
|
|
||
| ```shell | ||
| ./target/release/chocolate --help | ||
| ``` | ||
|
|
||
| ### Runtime | ||
|
|
||
| In Substrate, the terms | ||
| "[runtime](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#runtime)" and | ||
| "[state transition function](https://substrate.dev/docs/en/knowledgebase/getting-started/glossary#stf-state-transition-function)" | ||
| are analogous - they refer to the core logic of the blockchain that is responsible for validating | ||
| blocks and executing the state changes they define. The Substrate project in this repository uses | ||
| the [FRAME](https://substrate.dev/docs/en/knowledgebase/runtime/frame) framework to construct a | ||
| blockchain runtime. FRAME allows runtime developers to declare domain-specific logic in modules | ||
| called "pallets". At the heart of FRAME is a helpful | ||
| [macro language](https://substrate.dev/docs/en/knowledgebase/runtime/macros) that makes it easy to | ||
| create pallets and flexibly compose them to create blockchains that can address | ||
| [a variety of needs](https://www.substrate.io/substrate-users/). | ||
|
|
||
| Review the [FRAME runtime implementation](./runtime/src/lib.rs) included in this project and note | ||
| the following: | ||
|
|
||
| - This file configures several pallets to include in the runtime. Each pallet configuration is | ||
| defined by a code block that begins with `impl $PALLET_NAME::Config for Runtime`. | ||
| - The pallets are composed into a single runtime by way of the | ||
| [`construct_runtime!`](https://crates.parity.io/frame_support/macro.construct_runtime.html) | ||
| macro, which is part of the core | ||
| [FRAME Support](https://substrate.dev/docs/en/knowledgebase/runtime/frame#support-library) | ||
| library. | ||
|
|
||
| ### Pallets | ||
|
|
||
| The runtime in this project is constructed using many FRAME pallets that ship with the | ||
| [core Substrate repository](https://github.com/paritytech/substrate/tree/master/frame) and a pallet that is [defined in the `pallets`](./pallets/chocolate/src/lib.rs) directory. | ||
|
|
||
| A FRAME pallet is compromised of a number of blockchain primitives: | ||
|
|
||
| - Storage: FRAME defines a rich set of powerful | ||
| [storage abstractions](https://substrate.dev/docs/en/knowledgebase/runtime/storage) that makes | ||
| it easy to use Substrate's efficient key-value database to manage the evolving state of a | ||
| blockchain. | ||
| - Dispatchables: FRAME pallets define special types of functions that can be invoked (dispatched) | ||
| from outside of the runtime in order to update its state. | ||
| - Events: Substrate uses [events](https://substrate.dev/docs/en/knowledgebase/runtime/events) to | ||
| notify users of important changes in the runtime. | ||
| - Errors: When a dispatchable fails, it returns an error. | ||
| - Config: The `Config` configuration interface is used to define the types and parameters upon | ||
| which a FRAME pallet depends. | ||
|
|
||
| ### primitives | ||
|
|
||
| - This folder is customised for chocolate with packages that aren't part of runtime but shared across different pallets. Right now the package name is the same as the folder name for the packages inside primitives. This is simply for ease of use because it sort of gets confusing not knowing how packages and paths are different and trying to modularise things. | ||
| - `chocolate-` is prefixed to the packages here for uniqueness, although we probably won't be publishing. | ||
|
|
||
| <!-- Sounds good, or should we prioritise cleanness in package names? --> |