Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 1.81 KB

README.md

File metadata and controls

73 lines (46 loc) · 1.81 KB
Raw

Substrate Pallet Template

This is a template for a Substrate pallet which lives as its own crate so it can be imported into multiple runtimes. It is based on the "template" pallet that is included with the Substrate node template.

Check out the HOWTO to learn how to use this for your own runtime module.

This README should act as a general template for distributing your pallet to others.

Purpose

This pallet acts as a template for building other pallets.

It currently allows a user to put a u32 value into storage, which triggers a runtime event.

Dependencies

Traits

This pallet does not depend on any externally defined traits.

Pallets

This pallet does not depend on any other FRAME pallet or externally developed modules.

Installation

Runtime Cargo.toml

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

[dependencies.pallet-template]
default_features = false
git = 'https://github.com/substrate-developer-hub/substrate-pallet-template.git'

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

std = [
    # --snip--
    'pallet-template/std',
]

Runtime lib.rs

You should implement it's trait like so:

/// Used for test_module
impl pallet_template::Config for Runtime {
	type Event = Event;
}

and include it in your construct_runtime! macro:

TemplatePallet: pallet_template::{Module, Call, Storage, Event<T>},

Genesis Configuration

This template pallet does not have any genesis configuration.

Reference Docs

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

cargo doc --open