partner_chains_cli/create_chain_spec/
mod.rs1use crate::config::ConfigFieldDefinition;
2use crate::io::IOContext;
3use crate::permissioned_candidates::{ParsedPermissionedCandidatesKeys, PermissionedCandidateKeys};
4use crate::runtime_bindings::PartnerChainRuntime;
5use crate::{CmdRun, config::config_fields};
6use anyhow::anyhow;
7use authority_selection_inherents::MaybeFromCandidateKeys;
8use sidechain_domain::{AssetName, MainchainAddress, PolicyId, UtxoId};
9use sp_core::ecdsa;
10use sp_runtime::{AccountId32, DeserializeOwned};
11use std::marker::PhantomData;
12
13#[cfg(test)]
14mod tests;
15
16#[derive(Clone, Debug, Default, clap::Parser)]
17pub struct CreateChainSpecCmd<T: PartnerChainRuntime> {
18 #[clap(skip)]
19 _phantom: PhantomData<T>,
20}
21
22impl<T: PartnerChainRuntime> CmdRun for CreateChainSpecCmd<T> {
23 fn run<C: IOContext>(&self, context: &C) -> anyhow::Result<()> {
24 let config = CreateChainSpecConfig::load(context)?;
25 context.print("This wizard will create a chain spec JSON file according to the provided configuration, using WASM runtime code from the compiled node binary.");
26 Self::print_config(context, &config);
27 if context.prompt_yes_no("Do you want to continue?", true) {
28 let content = T::create_chain_spec(&config);
29 context.write_file("chain-spec.json", &serde_json::to_string_pretty(&content)?);
30 context.print("chain-spec.json file has been created.");
31 context.print(
32 "If you are the governance authority, you can distribute it to the validators.",
33 );
34 Ok(())
35 } else {
36 context.print("Aborted.");
37 Ok(())
38 }
39 }
40}
41
42impl<T: PartnerChainRuntime> CreateChainSpecCmd<T> {
43 fn print_config<C: IOContext>(context: &C, config: &CreateChainSpecConfig<T::Keys>) {
44 context.print("Chain parameters:");
45 context.print(format!("- Genesis UTXO: {}", config.genesis_utxo).as_str());
46 context.print("SessionValidatorManagement Main Chain Configuration:");
47 context.print(
48 format!("- committee_candidate_address: {}", config.committee_candidate_address)
49 .as_str(),
50 );
51 context.print(
52 format!("- d_parameter_policy_id: {}", config.d_parameter_policy_id.to_hex_string())
53 .as_str(),
54 );
55 context.print(
56 format!(
57 "- permissioned_candidates_policy_id: {}",
58 config.permissioned_candidates_policy_id.to_hex_string()
59 )
60 .as_str(),
61 );
62 context.print("Bridge Configuration (unused if empty):");
63 context.print(&format!("- asset name: {}", config.bridge_token_asset_name.to_hex_string()));
64 context
65 .print(&format!("- asset policy ID: {}", config.bridge_token_policy.to_hex_string()));
66 context.print(&format!(
67 "- illiquid circulation supply validator address: {}",
68 config.illiquid_circulation_supply_validator_address
69 ));
70 context.print("Governed Map Configuration:");
71 context.print(&format!(
72 "- validator address: {}",
73 config.governed_map_validator_address.clone().unwrap_or_default()
74 ));
75 context.print(&format!(
76 "- asset policy ID: {}",
77 config.governed_map_asset_policy_id.clone().unwrap_or_default().to_hex_string()
78 ));
79 use colored::Colorize;
80 if config.initial_permissioned_candidates_parsed.is_empty() {
81 context.print("WARNING: The list of initial permissioned candidates is empty. Generated chain spec will not allow the chain to start.".red().to_string().as_str());
82 let update_msg = format!(
83 "Update 'initial_permissioned_candidates' field of {} file with keys of initial committee.",
84 context
85 .config_file_path(config_fields::INITIAL_PERMISSIONED_CANDIDATES.config_file)
86 );
87 context.print(update_msg.red().to_string().as_str());
88 context.print(INITIAL_PERMISSIONED_CANDIDATES_EXAMPLE.yellow().to_string().as_str());
89 } else {
90 context.print("Initial permissioned candidates:");
91 for candidate in config.initial_permissioned_candidates_raw.iter() {
92 context.print(format!("- {}", candidate).as_str());
93 }
94 }
95 }
96}
97
98#[allow(missing_docs)]
99#[derive(Debug)]
100pub struct CreateChainSpecConfig<Keys> {
102 pub genesis_utxo: UtxoId,
103 pub initial_permissioned_candidates_raw: Vec<PermissionedCandidateKeys>,
104 pub initial_permissioned_candidates_parsed: Vec<ParsedPermissionedCandidatesKeys<Keys>>,
105 pub committee_candidate_address: MainchainAddress,
106 pub d_parameter_policy_id: PolicyId,
107 pub permissioned_candidates_policy_id: PolicyId,
108 pub bridge_token_policy: PolicyId,
109 pub bridge_token_asset_name: AssetName,
110 pub illiquid_circulation_supply_validator_address: MainchainAddress,
111 pub governed_map_validator_address: Option<MainchainAddress>,
112 pub governed_map_asset_policy_id: Option<PolicyId>,
113}
114
115impl<Keys: MaybeFromCandidateKeys> CreateChainSpecConfig<Keys> {
116 pub(crate) fn load<C: IOContext>(c: &C) -> Result<Self, anyhow::Error> {
117 let initial_permissioned_candidates_raw =
118 load_config_field(c, &config_fields::INITIAL_PERMISSIONED_CANDIDATES)?;
119 let initial_permissioned_candidates_parsed: Vec<ParsedPermissionedCandidatesKeys<Keys>> =
120 initial_permissioned_candidates_raw
121 .iter()
122 .map(TryFrom::try_from)
123 .collect::<Result<Vec<ParsedPermissionedCandidatesKeys<Keys>>, anyhow::Error>>()?;
124 Ok(Self {
125 genesis_utxo: load_config_field(c, &config_fields::GENESIS_UTXO)?,
126 initial_permissioned_candidates_raw,
127 initial_permissioned_candidates_parsed,
128 committee_candidate_address: load_config_field(
129 c,
130 &config_fields::COMMITTEE_CANDIDATES_ADDRESS,
131 )?,
132 d_parameter_policy_id: load_config_field(c, &config_fields::D_PARAMETER_POLICY_ID)?,
133 permissioned_candidates_policy_id: load_config_field(
134 c,
135 &config_fields::PERMISSIONED_CANDIDATES_POLICY_ID,
136 )?,
137 bridge_token_policy: load_config_field(c, &config_fields::BRIDGE_TOKEN_POLICY)?,
138 bridge_token_asset_name: load_config_field(c, &config_fields::BRIDGE_TOKEN_ASSET_NAME)?,
139 illiquid_circulation_supply_validator_address: load_config_field(
140 c,
141 &config_fields::ILLIQUID_SUPPLY_ADDRESS,
142 )?,
143 governed_map_validator_address: config_fields::GOVERNED_MAP_VALIDATOR_ADDRESS
144 .load_from_file(c),
145 governed_map_asset_policy_id: config_fields::GOVERNED_MAP_POLICY_ID.load_from_file(c),
146 })
147 }
148
149 pub fn pallet_sidechain_config<T: pallet_sidechain::Config>(
151 &self,
152 slots_per_epoch: sidechain_slots::SlotsPerEpoch,
153 ) -> pallet_sidechain::GenesisConfig<T> {
154 pallet_sidechain::GenesisConfig {
155 genesis_utxo: self.genesis_utxo,
156 slots_per_epoch,
157 _config: PhantomData,
158 }
159 }
160
161 pub fn pallet_partner_chains_session_config<T: pallet_partner_chains_session::Config>(
164 &self,
165 ) -> pallet_partner_chains_session::GenesisConfig<T>
166 where
167 T::ValidatorId: From<AccountId32>,
168 T::Keys: From<Keys>,
169 {
170 pallet_partner_chains_session::GenesisConfig {
171 initial_validators: self
172 .initial_permissioned_candidates_parsed
173 .iter()
174 .map(|c| (c.account_id_32().into(), c.keys.clone().into()))
175 .collect::<Vec<_>>(),
176 }
177 }
178
179 pub fn pallet_session_validator_management_config<
182 T: pallet_session_validator_management::Config,
183 >(
184 &self,
185 ) -> pallet_session_validator_management::GenesisConfig<T>
186 where
187 T::AuthorityId: From<ecdsa::Public>,
188 T::AuthorityKeys: From<Keys>,
189 T::CommitteeMember:
190 From<authority_selection_inherents::CommitteeMember<T::AuthorityId, T::AuthorityKeys>>,
191 {
192 pallet_session_validator_management::GenesisConfig {
193 initial_authorities: self
194 .initial_permissioned_candidates_parsed
195 .iter()
196 .map(|c| {
197 authority_selection_inherents::CommitteeMember::permissioned(
198 c.sidechain.into(),
199 c.keys.clone().into(),
200 )
201 .into()
202 })
203 .collect::<Vec<_>>(),
204 main_chain_scripts: sp_session_validator_management::MainChainScripts {
205 committee_candidate_address: self.committee_candidate_address.clone(),
206 d_parameter_policy_id: self.d_parameter_policy_id.clone(),
207 permissioned_candidates_policy_id: self.permissioned_candidates_policy_id.clone(),
208 },
209 }
210 }
211
212 pub fn bridge_config<T: pallet_partner_chains_bridge::Config>(
214 &self,
215 ) -> pallet_partner_chains_bridge::GenesisConfig<T> {
216 pallet_partner_chains_bridge::GenesisConfig {
217 main_chain_scripts: Some(sp_partner_chains_bridge::MainChainScripts {
218 token_policy_id: self.bridge_token_policy.clone(),
219 token_asset_name: self.bridge_token_asset_name.clone(),
220 illiquid_circulation_supply_validator_address: self
221 .illiquid_circulation_supply_validator_address
222 .clone(),
223 }),
224 initial_checkpoint: Some(self.genesis_utxo),
225 _marker: PhantomData,
226 }
227 }
228
229 pub fn governed_map_config<T: pallet_governed_map::Config>(
231 &self,
232 ) -> pallet_governed_map::GenesisConfig<T> {
233 pallet_governed_map::GenesisConfig {
234 main_chain_scripts: self.governed_map_validator_address.as_ref().and_then(|addr| {
235 self.governed_map_asset_policy_id.as_ref().map(|policy| {
236 sp_governed_map::MainChainScriptsV1 {
237 validator_address: addr.clone(),
238 asset_policy_id: policy.clone(),
239 }
240 })
241 }),
242 _marker: PhantomData,
243 }
244 }
245}
246
247impl<T> Default for CreateChainSpecConfig<T> {
248 fn default() -> Self {
249 Self {
250 genesis_utxo: Default::default(),
251 initial_permissioned_candidates_raw: Default::default(),
252 initial_permissioned_candidates_parsed: Default::default(),
253 committee_candidate_address: Default::default(),
254 d_parameter_policy_id: Default::default(),
255 permissioned_candidates_policy_id: Default::default(),
256 bridge_token_policy: Default::default(),
257 bridge_token_asset_name: Default::default(),
258 illiquid_circulation_supply_validator_address: Default::default(),
259 governed_map_validator_address: Default::default(),
260 governed_map_asset_policy_id: Default::default(),
261 }
262 }
263}
264
265fn load_config_field<C: IOContext, T: DeserializeOwned>(
266 context: &C,
267 field: &ConfigFieldDefinition<T>,
268) -> Result<T, anyhow::Error> {
269 field.load_from_file(context).ok_or_else(|| {
270 context.eprint(format!("The '{}' configuration file is missing or invalid.\nIf you are the governance authority, please make sure you have run the `prepare-configuration` command to generate the chain configuration file.\nIf you are a validator, you can obtain the chain configuration file from the governance authority.", context.config_file_path(field.config_file)).as_str());
271 anyhow!("failed to read '{}'", field.path.join("."))
272 })
273}
274
275pub const INITIAL_PERMISSIONED_CANDIDATES_EXAMPLE: &str = r#"Example of 'initial_permissioned_candidates' field with 2 permissioned candidates:
276"initial_permissioned_candidates": [
277 {
278 "partner_chains_key": "0x020a1091341fe5664bfa1782d5e0477968906ac916b04cb365ec3153755684d9a1",
279 "keys": {
280 "aura": "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde49a5684e7a56da27d",
281 "gran": "0x88dc3417d5058ec4b4503e0c12ea1a0a89be200f498922423d4334014fa6b0ee"
282 }
283 },
284 {
285 "partner_chains_key": "0x0390084fdbf27d2b79d26a4f13f0cdd982cb755a661969143c37cbc49ef5b91f27",
286 "keys": {
287 "aura": "0x8eaf04151687736326c9fea17e25fc5287613698c912909cb226aa4794f26a48",
288 "gran": "0xd17c2d7823ebf260fd138f2d7e27d114cb145d968b5ff5006125f2414fadae69"
289 }
290 }
291]"#;