Adding `pallet_octopus_appchain` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add pallet-octopus-appchain

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

pallet-octopus-appchain = "3.0.0-pre.0"

The pallet_octopus_appchain library will be automatically available globally. Read the pallet_octopus_appchain library documentation.

Back to the crate overview.

Readme

Octopus Appchain Pallet

This is a support component of Octopus Network.

Purpose

With this pallet, a chain built from substrate can join octopus network as an appchain.

An appchain can rent security from motherchain on demand.

Dependencies

Traits

This pallet depend on CreateSignedTransaction.

Pallets

This pallet depend on pallet_session.

Installation

Runtime `Cargo.toml`

To add this pallet to your runtime, simply include the following to your runtime's Cargo.toml file:

[dependencies]
pallet-session = { default-features = false, version = '3.0.0' }
pallet-octopus-appchain = { default-features = false, git = 'https://github.com/octopus-network/pallet-octopus-appchain.git' }

and update your runtime's std feature to include this pallet:

std = [
    # --snip--
    'pallet-session/std',
    'pallet-octopus-appchain/std',
]

Runtime `lib.rs`

You should implement it's trait like so:

parameter_types! {
	pub const AppchainId: pallet_octopus_appchain::ChainId = 0;
	pub const Motherchain: pallet_octopus_appchain::MotherchainType = pallet_octopus_appchain::MotherchainType::NEAR;
	pub const GracePeriod: u32 = 5;
	pub const UnsignedPriority: u64 = 1 << 20;
}

impl pallet_octopus_appchain::Config for Runtime {
	type Event = Event;
	type AuthorityId = pallet_octopus_appchain::crypto::OctopusAuthId;
	type Call = Call;
	type AppchainId = AppchainId;
	type Motherchain = Motherchain;
	const RELAY_CONTRACT_NAME: &'static [u8] = b"dev-1616239154529-4812993";
	type GracePeriod = GracePeriod;
	type UnsignedPriority = UnsignedPriority;
}

and include it in your construct_runtime! macro:

OctopusAppchain: pallet_octopus_appchain::{Module, Call, Storage, Config<T>, Event<T>, ValidateUnsigned},

Genesis Configuration

See this commit of Barnacle for genesis configuration and other settings.

We will explain these configurations in detail later.

Reference Docs

You can view the reference docs for this pallet by running:

cargo doc --open

Adding pallet_octopus_appchain library as a dependency

Adding `pallet_octopus_appchain` library as a dependency