pop-chains 0.14.0

Library for generating, building and running parachains.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use clap::ValueEnum;
use serde::Serialize;
use std::{fmt, fmt::Formatter};
use strum::EnumMessage as _;
use strum_macros::{EnumIter, EnumMessage};

/// This enum is used to register from the CLI which types that are kind of usual in config traits
/// are included in the pallet
#[derive(Debug, Copy, Clone, PartialEq, EnumIter, EnumMessage, ValueEnum, Serialize)]
pub enum TemplatePalletConfigCommonTypes {
	/// This type will enable your pallet to emit events.
	#[strum(
		message = "RuntimeEvent",
		detailed_message = "This type will enable your pallet to emit events."
	)]
	RuntimeEvent,
	/// This type will be helpful if your pallet needs to deal with the outer RuntimeOrigin enum,
	/// or if your pallet needs to use custom origins. Note: If you have run the command using -o,
	/// this type will be added anyway.
	#[strum(
		message = "RuntimeOrigin",
		detailed_message = "This type will be helpful if your pallet needs to deal with the outer RuntimeOrigin enum, or if your pallet needs to use custom origins. Note: If you have run the command using -o, this type will be added anyway."
	)]
	RuntimeOrigin,
	/// This type will allow your pallet to interact with the native currency of the blockchain.
	#[strum(
		message = "Currency",
		detailed_message = "This type will allow your pallet to interact with the native currency of the blockchain."
	)]
	Currency,
}

impl fmt::Display for TemplatePalletConfigCommonTypes {
	fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
		write!(f, "{}", self.get_message().unwrap_or("Unknown"))
	}
}

/// This enum is used to determine which storage shape has a storage item in the pallet
#[derive(Debug, Copy, Clone, PartialEq, EnumIter, EnumMessage, ValueEnum, Serialize)]
pub enum TemplatePalletStorageTypes {
	/// A storage value is a single value of a given type stored on-chain.
	#[strum(
		message = "StorageValue",
		detailed_message = "A storage value is a single value of a given type stored on-chain."
	)]
	StorageValue,
	/// A storage map is a mapping of keys to values of a given type stored on-chain.
	#[strum(
		message = "StorageMap",
		detailed_message = "A storage map is a mapping of keys to values of a given type stored on-chain."
	)]
	StorageMap,
	/// A wrapper around a StorageMap and a StorageValue (with the value being u32) to keep track
	/// of how many items are in a map.
	#[strum(
		message = "CountedStorageMap",
		detailed_message = "A wrapper around a StorageMap and a StorageValue (with the value being u32) to keep track of how many items are in a map."
	)]
	CountedStorageMap,
	/// This structure associates a pair of keys with a value of a specified type stored on-chain.
	#[strum(
		message = "StorageDoubleMap",
		detailed_message = "This structure associates a pair of keys with a value of a specified type stored on-chain."
	)]
	StorageDoubleMap,
	/// This structure associates an arbitrary number of keys with a value of a specified type
	/// stored on-chain.
	#[strum(
		message = "StorageNMap",
		detailed_message = "This structure associates an arbitrary number of keys with a value of a specified type stored on-chain."
	)]
	StorageNMap,
	/// A wrapper around a StorageNMap and a StorageValue (with the value being u32) to keep track
	/// of how many items are in a map.
	#[strum(
		message = "CountedStorageNMap",
		detailed_message = "A wrapper around a StorageNMap and a StorageValue (with the value being u32) to keep track of how many items are in a map."
	)]
	CountedStorageNMap,
}

impl fmt::Display for TemplatePalletStorageTypes {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		write!(f, "{}", self.get_message().unwrap_or("Unknown"))
	}
}

/// This enum is used to register from the CLI which options are selected by the user to be included
/// in the pallet.
#[derive(Debug, Copy, Clone, PartialEq, EnumIter, EnumMessage)]
pub enum TemplatePalletOptions {
	/// Uses a default configuration for the pallet's config trait.
	#[strum(
		message = "DefaultConfig",
		detailed_message = "Use a default configuration for your config trait."
	)]
	DefaultConfig,
	/// Adds a genesis config to the pallet.
	#[strum(message = "GenesisConfig", detailed_message = "Add a genesis config to your pallet.")]
	GenesisConfig,
	/// Adds a custom origin to the pallet.
	#[strum(message = "Custom Origin", detailed_message = "Add a custom origin to your pallet.")]
	CustomOrigin,
}