pezkuwi-omni-node-lib 0.1.0

// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
// This file is part of Pezcumulus.
// SPDX-License-Identifier: Apache-2.0

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Chain spec primitives.

pub use pezsc_chain_spec::ChainSpec;
use pezsc_chain_spec::ChainSpecExtension;
use serde::{Deserialize, Serialize};
use std::fmt::Debug;

/// Helper trait used for loading/building a chain spec starting from the chain ID.
pub trait LoadSpec {
	/// Load/Build a chain spec starting from the chain ID.
	fn load_spec(&self, id: &str) -> Result<Box<dyn ChainSpec>, String>;
}

/// Default implementation for `LoadSpec` that just reads a chain spec from the disk.
pub struct DiskChainSpecLoader;

impl LoadSpec for DiskChainSpecLoader {
	fn load_spec(&self, path: &str) -> Result<Box<dyn ChainSpec>, String> {
		Ok(Box::new(GenericChainSpec::from_json_file(path.into())?))
	}
}

/// Generic extensions for Teyrchain ChainSpecs used for extracting the extensions from chain specs.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, ChainSpecExtension)]
pub struct Extensions {
	/// The relay chain of the Teyrchain. It is kept here only for compatibility reasons until
	/// people migrate to using the new `Extensions` struct and associated logic in the node
	/// corresponding to pulling the teyrchain id from the runtime.
	#[serde(alias = "relayChain", alias = "RelayChain")]
	relay_chain: String,
	/// The id of the Teyrchain.
	#[serde(alias = "paraId", alias = "ParaId")]
	para_id: Option<u32>,
}

impl Extensions {
	/// Try to get the extension from the given `ChainSpec`.
	pub fn try_get(chain_spec: &dyn pezsc_service::ChainSpec) -> Option<&Self> {
		pezsc_chain_spec::get_extension(chain_spec.extensions())
	}

	/// Create the extensions only with the relay_chain.
	pub fn new_with_relay_chain(relay_chain: String) -> Self {
		Extensions { relay_chain, para_id: None }
	}

	/// Initialize extensions based on given parameters.
	pub fn new(relay_chain: String, para_id: u32) -> Self {
		Extensions { relay_chain, para_id: Some(para_id) }
	}

	/// Para id field getter
	pub fn para_id(&self) -> Option<u32> {
		self.para_id
	}

	/// Relay chain field getter
	pub fn relay_chain(&self) -> String {
		self.relay_chain.clone()
	}
}

/// Generic chain spec for all pezkuwi-teyrchain runtimes
pub type GenericChainSpec = pezsc_service::GenericChainSpec<Extensions>;

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn can_decode_extension_camel_and_snake_case() {
		let camel_case = r#"{"relayChain":"relay","paraId":1}"#;
		let snake_case = r#"{"relay_chain":"relay","para_id":1}"#;
		let pascal_case = r#"{"RelayChain":"relay","ParaId":1}"#;
		let para_id_missing = r#"{"RelayChain":"zagros"}"#;

		let camel_case_extension: Extensions = serde_json::from_str(camel_case).unwrap();
		let snake_case_extension: Extensions = serde_json::from_str(snake_case).unwrap();
		let pascal_case_extension: Extensions = serde_json::from_str(pascal_case).unwrap();
		let missing_paraid_extension: Extensions = serde_json::from_str(para_id_missing).unwrap();
		assert_eq!(camel_case_extension, snake_case_extension);
		assert_eq!(snake_case_extension, pascal_case_extension);
		assert_eq!(missing_paraid_extension.relay_chain, "zagros".to_string());
		assert!(missing_paraid_extension.para_id.is_none());
	}
}