pezkuwi_sdk_docs/pezkuwi_sdk/
templates.rs

1//! # Templates
2//!
3//! This document enumerates a non-exhaustive list of templates that one can use to get started with
4//! pezkuwi-sdk.
5//!
6//! > Know more tools/templates that are not listed here? please contribute them by opening a PR.
7//!
8//! ## Internal
9//!
10//! The following templates are maintained as a part of the `pezkuwi-sdk` repository:
11//!
12//! - [`minimal-template`](https://github.com/pezkuwichain/pezkuwi-sdk/issues/25): A minimal
13//!   template that contains the least amount of features to be a functioning blockchain. Suitable
14//!   for learning and testing.
15//! - [`solochain-template`](https://github.com/pezkuwichain/pezkuwi-sdk/issues/25): Formerly known
16//!   as "substrate-node-template", is a white-labeled substrate-based blockchain (aka. solochain)
17//!   that contains moderate features, such as a basic consensus engine and some FRAME pallets. This
18//!   template can act as a good starting point for those who want to launch a solochain.
19//! - [`teyrchain-template`](https://github.com/pezkuwichain/pezkuwi-sdk-teyrchain-template):
20//! A teyrchain template ready to be connected to a relay-chain, such as [Paseo](https://github.com/paseo-network/.github)
21//! , Kusama  or Pezkuwi.
22//!
23//! Note that these templates are mirrored automatically from [this](https://github.com/pezkuwichain/pezkuwi-sdk/blob/master/templates)
24//! directory of pezkuwi-sdk, therefore any changes to them should be made as a PR to this repo.
25//!
26//! ## OpenZeppelin
27//!
28//! In June 2023, OpenZeppelin was awarded a grant from the Pezkuwi
29//! treasury for building a number of Pezkuwi-sdk
30//! based templates. These templates are a great starting point for developers and newcomers.
31//! So far OpenZeppelin has released two templates, which have been fully [audited](https://github.com/pezkuwichain/pezkuwi-runtime-templates/tree/main/audits):
32//! - [`generic-runtime-template`](https://github.com/pezkuwichain/pezkuwi-runtime-templates?tab=readme-ov-file#generic-runtime-template):
33//!   A minimal template that has all the common pallets that teyrchains use with secure defaults.
34//! - [`evm-runtime-template`](https://github.com/pezkuwichain/pezkuwi-runtime-templates/tree/main?tab=readme-ov-file#evm-template):
35//! This template has EVM compatibility out of the box and allows migrating your solidity contracts
36//! or EVM compatible dapps easily. It also uses 20 byte addresses like Ethereum and has some
37//! Account Abstraction support.
38//!
39//! ## POP-CLI
40//!
41//! Is a CLI tool capable of scaffolding a new pezkuwi-sdk-based project, possibly removing the
42//! need for templates.
43//!
44//! - <https://pop.r0gue.io/cli/>