polkadot_sdk_docs/polkadot_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//! polkadot-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 `polkadot-sdk` repository:
11//!
12//! - [`minimal-template`](https://github.com/paritytech/polkadot-sdk-minimal-template): 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/paritytech/polkadot-sdk-solochain-template):
16//! Formerly known as "substrate-node-template", is a white-labeled substrate-based blockchain
17//! (aka. solochain) that contains moderate features, such as a basic consensus engine and some
18//! FRAME pallets. This template can act as a good starting point for those who want to launch a
19//! solochain.
20//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template):
21//! A parachain template ready to be connected to a relay-chain, such as [Paseo](https://github.com/paseo-network/.github)
22//! , Kusama or Polkadot.
23//!
24//! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates)
25//! directory of polkadot-sdk, therefore any changes to them should be made as a PR to this repo.
26//!
27//! ## OpenZeppelin
28//!
29//! In June 2023, OpenZeppelin was awarded a grant from the Polkadot
30//! treasury for building a number of Polkadot-sdk
31//! based templates. These templates are a great starting point for developers and newcomers.
32//! So far OpenZeppelin has released two templates, which have been fully [audited](https://github.com/OpenZeppelin/polkadot-runtime-templates/tree/main/audits):
33//! - [`generic-runtime-template`](https://github.com/OpenZeppelin/polkadot-runtime-templates?tab=readme-ov-file#generic-runtime-template):
34//! A minimal template that has all the common pallets that parachains use with secure defaults.
35//! - [`evm-runtime-template`](https://github.com/OpenZeppelin/polkadot-runtime-templates/tree/main?tab=readme-ov-file#evm-template):
36//! This template has EVM compatibility out of the box and allows migrating your solidity contracts
37//! or EVM compatible dapps easily. It also uses 20 byte addresses like Ethereum and has some
38//! Account Abstraction support.
39//!
40//! ## POP-CLI
41//!
42//! Is a CLI tool capable of scaffolding a new polkadot-sdk-based project, possibly removing the
43//! need for templates.
44//!
45//! - <https://pop.r0gue.io/cli/>