https://github.com/substrate-developer-hub/substrate-pallet-template

A template for creating pluggable pallets.
https://github.com/substrate-developer-hub/substrate-pallet-template

Last synced: 2 months ago
JSON representation

A template for creating pluggable pallets.

• Host: GitHub
• URL: https://github.com/substrate-developer-hub/substrate-pallet-template
• Owner: substrate-developer-hub
• License: unlicense
• Archived: true
• Created: 2019-12-17T04:19:32.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-09T15:10:41.000Z (almost 3 years ago)
• Last Synced: 2024-04-24T07:25:40.853Z (2 months ago)
• Language: Rust
• Homepage:
• Size: 65.4 KB
• Stars: 23
• Watchers: 16
• Forks: 24
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-substrate - Pallet - Easily create (Templates)

README

        
> :information_source: This repository has been deprecated in favor of the [Substrate Node Template](https://github.com/substrate-developer-hub/substrate-node-template).

> 

> You can still create your own custom pallets in their own crate by extracting the [`/pallet/template/`](https://github.com/substrate-developer-hub/substrate-node-template/tree/master/pallets/template) folder of the `substrate-node-template` project.

# 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](https://github.com/paritytech/substrate/tree/master/bin/node-template/pallets/template) that is included with the [Substrate node template](https://github.com/paritytech/substrate/tree/master/bin/node-template).

Check out the [HOWTO](HOWTO.md) 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:

```TOML

[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:

```TOML

std = [

    # --snip--

    'pallet-template/std',

]

```

### Runtime `lib.rs`

You should implement it's trait like so:

```rust

/// Used for test_module

impl pallet_template::Config for Runtime {

	type Event = Event;

}

```

and include it in your `construct_runtime!` macro:

```rust

TemplatePallet: pallet_template::{Module, Call, Storage, Event},

```

### 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

```