Built on Substrate.
A FRAME-based Substrate parachain, ready for fighting back scammers ๐
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 Gitpod ๐ ๏ธ
You can open this repository in gitpod and wait for the next steps to be completed for you
Complete the basic Rust setup instructions.
Use the prep-relay
script we use on gitpod
Note: The setup script currently assumes you have the set the
POLKADOT_BIN
environment variable with full path to polkadot relay binary (v0.9.28)
# Download the polkadot binary to ./bins/polkadot eg
mkdir bins
cd bins
VER="v0.9.28"
wget https://github.com/paritytech/polkadot/releases/download/${VER}/polkadot && chmod +x ./polkadot
# Back in the folder you extracted this repo to, Run only the buildSpec function to avoid building an image
bash ./scripts/prep-relay.sh buildSpec
Use cargo
to build the parachain in release mode
cargo build --release
Note, if you build the debug target using
cargo build
, you may run into an issue with slow block times
# If you're only running the binary, you can cleanup the target directory:
find target/release -type f ! -name parachain-collator -exec rm {} +
Mirror development binary in bins directory.
ln -s $(pwd)/target/release/parachain-collator $(pwd)/bins/parachain-collator
Export the chain spec, genesis header and validation code to ch_spec
bash ./scripts/prep-collator.sh exportChainSpec
Start a two-validator test net
zombienet spawn zombienet/config.toml -p native
Note: This assumes you have the polkadot and parachain-collator binaries in the
bins
directory.
Start alice
bash ./scripts/start-relay.sh alice
Start relay bob
bash ./scripts/start-relay.sh alice
Then Start a collator
bash ./scripts/start-collator.sh
Follow the steps from substrate-docs to register the parachain
Note: Your Paraid is 2000, and The genesis header and validation code should be in ch_spec
Use Rust's native cargo
command to build and launch the node:
cargo run --release -- --dev --tmp
The cargo run
command will perform an initial build. Use the following command to build the node
without launching it:
cargo build --release
Once the project has been built, the following command can be used to explore all parameters and subcommands:
./target/release/parachain-collator -h
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.
This command will start the single-node development chain with persistent state:
./target/release/parachain-collator --dev
Purge the development chain's state:
./target/release/parachain-collator purge-chain --dev
Start the development chain with detailed logging:
RUST_BACKTRACE=1 ./target/release/parachain-collator -ldebug --dev
Once the node is running locally, you can connect it with Polkadot-JS Apps front-end to interact with your chain. Click here connecting the Apps to your local node.
As above once you have the node running locally, you can open this link 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.
If you want to see the multi-node consensus algorithm in action, refer to our Start a Private Network tutorial.
A Substrate project such as this consists of a number of components that are spread across a few directories.
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
networking stack to allow the nodes in the network to communicate with one another. - Consensus: Blockchains must have a way to come to 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.
- 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
: A chain specification 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 thedevelopment_config
andtestnet_genesis
functions, which are used to define the genesis state for the local development chain configuration. These functions identify some well-known accounts and use them to configure the blockchain's initial state.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, the Aura block authoring mechanism and the GRANDPA finality gadget.
After the node has been built, refer to the embedded documentation to learn more about the capabilities and configuration parameters that it exposes:
./target/release/parachain-collator --help
In Substrate, the terms "runtime" and "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 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 that makes it easy to create pallets and flexibly compose them to create blockchains that can address a variety of needs.
Review the FRAME runtime implementation 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!
macro, which is part of the core FRAME Support library.
The runtime in this project is constructed using many FRAME pallets that ship with the
core Substrate repository and a pallet that is defined in the pallets
directory.
A FRAME pallet is compromised of a number of blockchain primitives:
- Storage: FRAME defines a rich set of powerful storage abstractions 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 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.
- This folder is customised for chocolate with modules that aren't part of runtime but shared across different pallets. It's a single primitives package that is imported as needed.