partner_chains_demo_runtime/

lib.rs

#![cfg_attr(not(feature = "std"), no_std)]
// `construct_runtime!` does a lot of recursion and requires us to increase the limit to 256.
#![recursion_limit = "256"]
#![allow(deprecated)]

#[cfg(feature = "runtime-benchmarks")]
#[macro_use]
extern crate frame_benchmarking;

extern crate alloc;

use alloc::collections::BTreeMap;
use alloc::string::String;
use authority_selection_inherents::{
	PermissionedCandidateDataError, RegistrationDataError, StakeError, select_authorities,
	validate_permissioned_candidate_data,
};
use frame_support::dynamic_params::{dynamic_pallet_params, dynamic_params};
use frame_support::genesis_builder_helper::{build_state, get_preset};
use frame_support::inherent::ProvideInherent;
use frame_support::traits::LinearStoragePrice;
use frame_support::traits::fungible::HoldConsideration;
use frame_support::weights::constants::RocksDbWeight as RuntimeDbWeight;
use frame_support::{
	BoundedVec, construct_runtime, parameter_types,
	traits::{ConstBool, ConstU8, ConstU16, ConstU32, ConstU64, ConstU128},
	weights::{IdentityFee, constants::WEIGHT_REF_TIME_PER_SECOND},
};
use frame_system::EnsureRoot;
use opaque::SessionKeys;
use pallet_block_producer_metadata;
use pallet_block_production_log::{FromFindAuthorIndex, FromStorage};
use pallet_grandpa::AuthorityId as GrandpaId;
use pallet_session_validator_management::CommitteeMemberOf;
use pallet_transaction_payment::{ConstFeeMultiplier, FungibleAdapter, Multiplier};
use parity_scale_codec::{Decode, DecodeWithMemTracking, Encode, MaxEncodedLen};
use scale_info::TypeInfo;
use serde::{Deserialize, Serialize};
use sidechain_domain::byte_string::{BoundedString, ByteString, SizedByteString};
use sidechain_domain::{
	CrossChainPublicKey, DelegatorKey, MainchainKeyHash, PermissionedCandidateData,
	RegistrationData, ScEpochNumber, StakeDelegation, StakePoolPublicKey, UtxoId,
};
use sp_api::impl_runtime_apis;
use sp_block_participation::AsCardanoSPO;
use sp_consensus_aura::sr25519::AuthorityId as AuraId;
use sp_consensus_slots::Slot;
use sp_core::{OpaqueMetadata, crypto::KeyTypeId};
use sp_governed_map::MainChainScriptsV1;
use sp_inherents::InherentIdentifier;
use sp_partner_chains_bridge::{BridgeDataCheckpoint, MainChainScripts as BridgeMainChainScripts};
use sp_runtime::traits::ConvertInto;
use sp_runtime::{
	ApplyExtrinsicResult, MultiSignature, Perbill, generic, impl_opaque_keys,
	traits::{
		AccountIdLookup, BlakeTwo256, Block as BlockT, IdentifyAccount, NumberFor, One, OpaqueKeys,
		Verify,
	},
	transaction_validity::{TransactionSource, TransactionValidity},
};
use sp_session_validator_management::{AuthoritySelectionInputs, CommitteeMember};
use sp_sidechain::SidechainStatus;
use sp_std::prelude::*;
use sp_version::RuntimeVersion;
use sp_weights::Weight;

// Make the WASM binary available.
#[cfg(feature = "std")]
include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));

pub mod genesis_config_presets;

#[cfg(test)]
mod mock;

#[cfg(test)]
mod header_tests;

mod test_helper_pallet;

/// An index to a block.
pub type BlockNumber = u32;

/// Alias to 512-bit hash when used in the context of a transaction signature on the chain.
pub type Signature = MultiSignature;

/// Some way of identifying an account on the chain. We intentionally make it equivalent
/// to the public key of our transaction signing scheme.
pub type AccountId = <<Signature as Verify>::Signer as IdentifyAccount>::AccountId;

/// Balance of an account.
pub type Balance = u128;

/// Index of a transaction in the chain.
pub type Nonce = u32;

/// A hash of some data used by the chain.
pub type Hash = sp_core::H256;

/// Opaque types. These are used by the CLI to instantiate machinery that don't need to know
/// the specifics of the runtime. They can then be made to be agnostic over specific formats
/// of data like extrinsics, allowing for them to continue syncing the network through upgrades
/// to even the core data structures.
pub mod opaque {
	use super::*;
	use authority_selection_inherents::MaybeFromCandidateKeys;
	use parity_scale_codec::MaxEncodedLen;
	use sp_core::{ed25519, sr25519};
	pub use sp_runtime::OpaqueExtrinsic as UncheckedExtrinsic;

	/// Opaque block header type.
	pub type Header = generic::Header<BlockNumber, BlakeTwo256>;
	/// Opaque block type.
	pub type Block = generic::Block<Header, UncheckedExtrinsic>;
	/// Opaque block identifier type.
	pub type BlockId = generic::BlockId<Block>;

	impl_opaque_keys! {
		#[derive(MaxEncodedLen, PartialOrd, Ord)]
		pub struct SessionKeys {
			pub aura: Aura,
			pub grandpa: Grandpa,
		}
	}
	impl From<(sr25519::Public, ed25519::Public)> for SessionKeys {
		fn from((aura, grandpa): (sr25519::Public, ed25519::Public)) -> Self {
			Self { aura: aura.into(), grandpa: grandpa.into() }
		}
	}

	impl MaybeFromCandidateKeys for SessionKeys {}

	impl_opaque_keys! {
		pub struct CrossChainKey {
			pub account: CrossChainPublic,
		}
	}
}

pub type CrossChainPublic = sidechain_domain::cross_chain_app::Public;

// To learn more about runtime versioning, see:
// https://docs.substrate.io/main-docs/build/upgrade#runtime-versioning
#[sp_version::runtime_version]
pub const VERSION: RuntimeVersion = RuntimeVersion {
	spec_name: alloc::borrow::Cow::Borrowed("cardano-sidechain"),
	impl_name: alloc::borrow::Cow::Borrowed("cardano-sidechain"),
	authoring_version: 1,
	// The version of the runtime specification. A full node will not attempt to use its native
	//   runtime in substitute for the on-chain Wasm runtime unless all of `spec_name`,
	//   `spec_version`, and `authoring_version` are the same between Wasm and native.
	// This value is set to 100 to notify Polkadot-JS App (https://polkadot.js.org/apps) to use
	//   the compatible custom types.
	spec_version: 181,
	impl_version: 1,
	apis: RUNTIME_API_VERSIONS,
	transaction_version: 1,
	system_version: 1,
};

/// This determines the average expected block time that we are targeting.
/// Blocks will be produced at a minimum duration defined by `SLOT_DURATION`.
/// `SLOT_DURATION` is picked up by `pallet_timestamp` which is in turn picked
/// up by `pallet_aura` to implement `fn slot_duration()`.
///
/// Change this to adjust the block time.
pub const MILLISECS_PER_BLOCK: u64 = 6000;

// NOTE: Currently it is not possible to change the slot duration after the chain has started.
//       Attempting to do so will brick block production.
pub const SLOT_DURATION: u64 = MILLISECS_PER_BLOCK;

// Time is measured by number of blocks.
pub const MINUTES: BlockNumber = 60_000 / (MILLISECS_PER_BLOCK as BlockNumber);
pub const HOURS: BlockNumber = MINUTES * 60;
pub const DAYS: BlockNumber = HOURS * 24;

const NORMAL_DISPATCH_RATIO: Perbill = Perbill::from_percent(75);

/// We allow for 2 seconds of compute with a 6 second average block time.
pub const MAXIMUM_BLOCK_WEIGHT: Weight =
	Weight::from_parts(WEIGHT_REF_TIME_PER_SECOND.saturating_mul(2), u64::MAX);
pub const MAXIMUM_BLOCK_LENGTH: u32 = 5 * 1024 * 1024;

parameter_types! {
	pub const BlockHashCount: BlockNumber = 2400;
	pub const Version: RuntimeVersion = VERSION;
	pub BlockWeights: frame_system::limits::BlockWeights = frame_system::limits::BlockWeights
		::with_sensible_defaults(MAXIMUM_BLOCK_WEIGHT, NORMAL_DISPATCH_RATIO);
	pub BlockLength: frame_system::limits::BlockLength = frame_system::limits::BlockLength
		::max_with_normal_ratio(MAXIMUM_BLOCK_LENGTH, NORMAL_DISPATCH_RATIO);
	pub const SS58Prefix: u8 = 42;
}

// Configure FRAME pallets to include in runtime.

impl frame_system::Config for Runtime {
	/// The basic call filter to use in dispatchable.
	type BaseCallFilter = frame_support::traits::Everything;
	/// The block type for the runtime.
	type Block = Block;
	/// The type for storing how many extrinsics an account has signed.
	type Nonce = Nonce;
	/// Block & extrinsics weights: base values and limits.
	type BlockWeights = BlockWeights;
	/// The maximum length of a block (in bytes).
	type BlockLength = BlockLength;
	/// The identifier used to distinguish between accounts.
	type AccountId = AccountId;
	/// The aggregated dispatch type that is available for extrinsics.
	type RuntimeCall = RuntimeCall;
	/// The lookup mechanism to get account ID from whatever is passed in dispatchers.
	type Lookup = AccountIdLookup<AccountId, ()>;
	/// The type for hashing blocks and tries.
	type Hash = Hash;
	/// The hashing algorithm used.
	type Hashing = BlakeTwo256;
	/// The ubiquitous event type.
	type RuntimeEvent = RuntimeEvent;
	/// The ubiquitous origin type.
	type RuntimeOrigin = RuntimeOrigin;
	/// Maximum number of block number to block hash mappings to keep (oldest pruned first).
	type BlockHashCount = BlockHashCount;
	/// The weight of database operations that the runtime can invoke.
	type DbWeight = RuntimeDbWeight;
	/// Version of the runtime.
	type Version = Version;
	/// Converts a module to the index of the module in `construct_runtime!`.
	///
	/// This type is being generated by `construct_runtime!`.
	type PalletInfo = PalletInfo;
	/// What to do if a new account is created.
	type OnNewAccount = ();
	/// What to do if an account is fully reaped from the system.
	type OnKilledAccount = ();
	/// The data to be stored in an account.
	type AccountData = pallet_balances::AccountData<Balance>;
	/// Weight information for the extrinsics of this pallet.
	type SystemWeightInfo = frame_system::weights::SubstrateWeight<Runtime>;
	// WeightInfo for extensions is present but not accessible in polkadot-stable2412-1, because of that we are using () in our demo runtime
	type ExtensionsWeightInfo = ();
	/// This is used as an identifier of the chain. 42 is the generic substrate prefix.
	type SS58Prefix = SS58Prefix;
	/// The set code logic, just the default since we're not a parachain.
	type OnSetCode = ();
	type MaxConsumers = frame_support::traits::ConstU32<16>;
	type RuntimeTask = RuntimeTask;
	type SingleBlockMigrations = ();
	type MultiBlockMigrator = ();
	type PreInherents = ();
	type PostInherents = ();
	type PostTransactions = ();
}

impl pallet_aura::Config for Runtime {
	type AuthorityId = AuraId;
	type DisabledValidators = ();
	type MaxAuthorities = MaxValidators;
	type AllowMultipleBlocksPerSlot = ConstBool<false>;
	type SlotDuration = ConstU64<SLOT_DURATION>;
}

impl pallet_session::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;
	type ValidatorId = AccountId;
	type ValidatorIdOf = ConvertInto;
	type ShouldEndSession = SessionCommitteeManagement;
	type NextSessionRotation = ();
	type SessionManager = SessionCommitteeManagement;
	type SessionHandler = <SessionKeys as OpaqueKeys>::KeyTypeIdProviders;
	type Keys = SessionKeys;
	type DisablingStrategy = pallet_session::disabling::UpToLimitWithReEnablingDisablingStrategy;
	type Currency = Balances;
	type KeyDeposit = ();

	type WeightInfo = pallet_session::weights::SubstrateWeight<Runtime>;
}

impl pallet_grandpa::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;

	type WeightInfo = ();
	type MaxAuthorities = MaxValidators;
	type MaxNominators = ConstU32<0>;
	type MaxSetIdSessionEntries = ConstU64<0>;

	type KeyOwnerProof = sp_core::Void;
	type EquivocationReportSystem = ();
}

impl pallet_timestamp::Config for Runtime {
	/// A timestamp: milliseconds since the unix epoch.
	type Moment = u64;
	type OnTimestampSet = Aura;
	type MinimumPeriod = ConstU64<{ SLOT_DURATION / 2 }>;
	type WeightInfo = pallet_timestamp::weights::SubstrateWeight<Runtime>;
}

/// Existential deposit.
pub const EXISTENTIAL_DEPOSIT: u128 = 500;
pub const UNITS: Balance = 1_000_000_000_000;
pub const fn deposit(items: u32, bytes: u32) -> Balance {
	items as Balance * UNITS + (bytes as Balance) * UNITS / 10
}

impl pallet_balances::Config for Runtime {
	type MaxLocks = ConstU32<50>;
	type MaxReserves = ();
	type ReserveIdentifier = [u8; 8];
	/// The type for recording an account's balance.
	type Balance = Balance;
	/// The ubiquitous event type.
	type RuntimeEvent = RuntimeEvent;
	type DustRemoval = ();
	type ExistentialDeposit = ConstU128<EXISTENTIAL_DEPOSIT>;
	type AccountStore = System;
	type WeightInfo = pallet_balances::weights::SubstrateWeight<Runtime>;
	type FreezeIdentifier = ();
	type MaxFreezes = ();
	type RuntimeHoldReason = RuntimeHoldReason;
	type RuntimeFreezeReason = RuntimeFreezeReason;
	type DoneSlashHandler = ();
}

parameter_types! {
	pub FeeMultiplier: Multiplier = Multiplier::one();
}

impl pallet_transaction_payment::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;
	type OnChargeTransaction = FungibleAdapter<Balances, ()>;
	type OperationalFeeMultiplier = ConstU8<5>;
	type WeightToFee = IdentityFee<Balance>;
	type LengthToFee = IdentityFee<Balance>;
	type FeeMultiplierUpdate = ConstFeeMultiplier<FeeMultiplier>;
	type WeightInfo = pallet_transaction_payment::weights::SubstrateWeight<Runtime>;
}

impl pallet_sudo::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;
	type RuntimeCall = RuntimeCall;
	type WeightInfo = pallet_sudo::weights::SubstrateWeight<Runtime>;
}

parameter_types! {
	pub const MaxValidators: u32 = 1024;
}

impl pallet_session_validator_management::Config for Runtime {
	type MaxValidators = MaxValidators;
	type AuthorityId = CrossChainPublic;
	type AuthorityKeys = SessionKeys;
	type WeightInfo = pallet_session_validator_management::weights::SubstrateWeight<Runtime>;
	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;

	fn select_authorities(
		input: AuthoritySelectionInputs,
		sidechain_epoch: ScEpochNumber,
	) -> Option<BoundedVec<CommitteeMemberOf<Self>, Self::MaxValidators>> {
		select_authorities::<sidechain_domain::cross_chain_app::Public, SessionKeys, MaxValidators>(
			Sidechain::genesis_utxo(),
			input,
			sidechain_epoch,
		)
	}

	fn current_epoch_number() -> ScEpochNumber {
		Sidechain::current_epoch_number()
	}

	#[cfg(feature = "runtime-benchmarks")]
	type BenchmarkHelper = ();
}

parameter_types! {
	pub const TokenConversionRate: u128 = 1_000_000_000u128;
	pub const MaxTransactions: u32 = 256u32;
}

impl pallet_sidechain::Config for Runtime {
	fn reference_timestamp_millis() -> u64 {
		*pallet_aura::CurrentSlot::<Runtime>::get() * SLOT_DURATION
	}
	type OnNewEpoch = TestHelperPallet;
}

pub type BeneficiaryId = sidechain_domain::byte_string::SizedByteString<32>;

#[derive(
	MaxEncodedLen,
	Encode,
	Decode,
	DecodeWithMemTracking,
	Clone,
	TypeInfo,
	PartialEq,
	Eq,
	Debug,
	Hash,
	PartialOrd,
	Ord,
)]
pub enum BlockAuthor {
	Incentivized(CrossChainPublic, StakePoolPublicKey),
	ProBono(CrossChainPublic),
}
impl BlockAuthor {
	pub fn id(&self) -> &CrossChainPublic {
		match self {
			Self::Incentivized(id, _) => id,
			Self::ProBono(id) => id,
		}
	}
}
impl From<CommitteeMember<CrossChainPublic, SessionKeys>> for BlockAuthor {
	fn from(value: CommitteeMember<CrossChainPublic, SessionKeys>) -> Self {
		match value {
			CommitteeMember::Permissioned { id, .. } => BlockAuthor::ProBono(id),
			CommitteeMember::Registered { id, stake_pool_pub_key, .. } => {
				BlockAuthor::Incentivized(id, stake_pool_pub_key)
			},
		}
	}
}

impl AsCardanoSPO for BlockAuthor {
	fn as_cardano_spo(&self) -> Option<MainchainKeyHash> {
		match self {
			BlockAuthor::Incentivized(_, key) => Some(key.hash()),
			BlockAuthor::ProBono(_) => None,
		}
	}
}

pub const MAX_METADATA_URL_LENGTH: u32 = 512;

#[derive(
	Clone,
	Debug,
	MaxEncodedLen,
	Encode,
	Decode,
	DecodeWithMemTracking,
	Serialize,
	Deserialize,
	PartialEq,
	Eq,
	TypeInfo,
)]
pub struct BlockProducerMetadataType {
	pub url: BoundedString<ConstU32<MAX_METADATA_URL_LENGTH>>,
	pub hash: SizedByteString<32>,
}

#[cfg(feature = "runtime-benchmarks")]
pub struct PalletBlockProducerMetadataBenchmarkHelper;

#[cfg(feature = "runtime-benchmarks")]
impl
	pallet_block_producer_metadata::benchmarking::BenchmarkHelper<
		BlockProducerMetadataType,
		AccountId,
	> for PalletBlockProducerMetadataBenchmarkHelper
{
	fn genesis_utxo() -> UtxoId {
		Sidechain::genesis_utxo()
	}

	fn metadata() -> BlockProducerMetadataType {
		BlockProducerMetadataType {
			url: "https://cool.stuff/spo.json".try_into().unwrap(),
			hash: SizedByteString::from([0; 32]),
		}
	}

	fn cross_chain_pub_key() -> sidechain_domain::CrossChainPublicKey {
		sidechain_domain::CrossChainPublicKey(
			hex_literal::hex!("020a1091341fe5664bfa1782d5e04779689068c916b04cb365ec3153755684d9a1")
				.to_vec(),
		)
	}

	fn cross_chain_sign_key() -> pallet_block_producer_metadata::benchmarking::SecretKey {
		pallet_block_producer_metadata::benchmarking::SecretKey::from_slice(&hex_literal::hex!(
			"cb6df9de1efca7a3998a8ead4e02159d5fa99c3e0d4fd6432667390bb4726854"
		))
		.unwrap()
	}

	fn upsert_valid_before() -> u64 {
		11751276163
	}

	fn delete_valid_before() -> u64 {
		11751276230
	}
}

impl pallet_block_production_log::Config for Runtime {
	type BlockProducerId = BlockAuthor;

	type Moment = Slot;

	type GetMoment = FromStorage<pallet_aura::CurrentSlot<Runtime>>;
	type GetAuthor = FromFindAuthorIndex<Runtime, Aura, u32>;
}

parameter_types! {
	/// Amount of tokens to burn when making irreversible, forever association
	pub const AddressAssociationBurnAmount: Balance = 1_000_000;
}

impl pallet_address_associations::Config for Runtime {
	type WeightInfo = pallet_address_associations::weights::SubstrateWeight<Runtime>;

	type PartnerChainAddress = AccountId;
	type Currency = Balances;
	type BurnAmount = AddressAssociationBurnAmount;

	fn genesis_utxo() -> UtxoId {
		Sidechain::genesis_utxo()
	}

	type OnNewAssociation = TestHelperPallet;
}

#[cfg(feature = "runtime-benchmarks")]
pub struct PalletBlockProducerFeesBenchmarkHelper;

#[cfg(feature = "runtime-benchmarks")]
impl pallet_block_producer_fees::benchmarking::BenchmarkHelper<AccountId>
	for PalletBlockProducerFeesBenchmarkHelper
{
	fn account_id(i: u8) -> AccountId {
		sp_core::sr25519::Public::from_raw([i; 32]).into()
	}
}

impl pallet_block_producer_fees::Config for Runtime {
	type WeightInfo = ();

	type HistoricalChangesPerProducer = ConstU16<5>;

	type Moment = Slot;

	fn current_moment() -> Slot {
		let slot: u64 = pallet_aura::CurrentSlot::<Runtime>::get().into();
		sp_consensus_slots::Slot::from(slot)
	}

	#[cfg(feature = "runtime-benchmarks")]
	type BenchmarkHelper = PalletBlockProducerFeesBenchmarkHelper;
}

parameter_types! {
	/// Amount of tokens to hold when upserting block producer metadata.
	pub const MetadataHoldAmount: Balance = 1_000_000;
}

impl pallet_block_producer_metadata::Config for Runtime {
	type WeightInfo = pallet_block_producer_metadata::weights::SubstrateWeight<Runtime>;

	type BlockProducerMetadata = BlockProducerMetadataType;

	fn genesis_utxo() -> UtxoId {
		Sidechain::genesis_utxo()
	}

	fn current_time() -> u64 {
		pallet_timestamp::Now::<Runtime>::get() / 1000
	}

	type Currency = Balances;
	type HoldAmount = MetadataHoldAmount;
	type RuntimeHoldReason = RuntimeHoldReason;

	#[cfg(feature = "runtime-benchmarks")]
	type BenchmarkHelper = PalletBlockProducerMetadataBenchmarkHelper;
}

impl pallet_block_participation::Config for Runtime {
	type WeightInfo = pallet_block_participation::weights::SubstrateWeight<Runtime>;
	type DelegatorId = DelegatorKey;
	type BlockAuthor = BlockAuthor;

	type Moment = Slot;

	type BlockParticipationProvider = TestHelperPallet;

	const TARGET_INHERENT_ID: InherentIdentifier = TestHelperPallet::INHERENT_IDENTIFIER;
}

parameter_types! {
	pub const MaxChanges: u32 = 16;
	pub const MaxKeyLength: u32 = 64;
	pub const MaxValueLength: u32 = 512;
}

impl pallet_governed_map::Config for Runtime {
	type MaxChanges = MaxChanges;
	type MaxKeyLength = MaxKeyLength;
	type MaxValueLength = MaxValueLength;
	type WeightInfo = pallet_governed_map::weights::SubstrateWeight<Runtime>;

	type OnGovernedMappingChange = TestHelperPallet;
	type MainChainScriptsOrigin = EnsureRoot<Self::AccountId>;

	#[cfg(feature = "runtime-benchmarks")]
	type BenchmarkHelper = ();
}

parameter_types! {
	pub const ReserveAccount: AccountId = AccountId::new([1;32]);
}

impl crate::test_helper_pallet::Config for Runtime {
	type ReserveAccount = ReserveAccount;
}

parameter_types! {
pub const MaxTransfersPerBlock: u32 = 256;}

impl pallet_partner_chains_bridge::Config for Runtime {
	type GovernanceOrigin = EnsureRoot<Runtime>;
	type Recipient = AccountId;
	type TransferHandler = TestHelperPallet;
	type MaxTransfersPerBlock = MaxTransfersPerBlock;
	type WeightInfo = ();

	#[cfg(feature = "runtime-benchmarks")]
	type BenchmarkHelper = ();
}

impl pallet_parameters::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;
	type RuntimeParameters = RuntimeParameters;
	type AdminOrigin = EnsureRoot<AccountId>;
	type WeightInfo = ();
}

parameter_types! {
	pub MaximumSchedulerWeight: Weight = Perbill::from_percent(80) *
		BlockWeights::get().max_block;
	pub const MaxScheduledPerBlock: u32 = 50;
}

impl pallet_scheduler::Config for Runtime {
	type RuntimeOrigin = RuntimeOrigin;
	type RuntimeEvent = RuntimeEvent;
	type PalletsOrigin = OriginCaller;
	type RuntimeCall = RuntimeCall;
	type MaximumWeight = MaximumSchedulerWeight;
	type ScheduleOrigin = EnsureRoot<AccountId>;
	type MaxScheduledPerBlock = MaxScheduledPerBlock;
	type WeightInfo = ();
	type OriginPrivilegeCmp = frame_support::traits::EqualPrivilegeOnly;
	type Preimages = Preimage;
	type BlockNumberProvider = frame_system::Pallet<Runtime>;
}

parameter_types! {
	pub const PreimageHoldReason: RuntimeHoldReason = RuntimeHoldReason::Preimage(pallet_preimage::HoldReason::Preimage);
}

impl pallet_preimage::Config for Runtime {
	type WeightInfo = ();
	type RuntimeEvent = RuntimeEvent;
	type Currency = Balances;
	type ManagerOrigin = EnsureRoot<AccountId>;
	type Consideration = HoldConsideration<
		AccountId,
		Balances,
		PreimageHoldReason,
		LinearStoragePrice<
			dynamic_params::preimage::BaseDeposit,
			dynamic_params::preimage::ByteDeposit,
			Balance,
		>,
	>;
}

#[dynamic_params(RuntimeParameters, pallet_parameters::Parameters::<Runtime>)]
pub mod dynamic_params {
	use super::*;

	#[dynamic_pallet_params]
	#[codec(index = 0)]
	pub mod preimage {
		use super::*;

		#[codec(index = 0)]
		pub static BaseDeposit: Balance = deposit(2, 64);

		#[codec(index = 1)]
		pub static ByteDeposit: Balance = deposit(0, 1);
	}
}

// Create the runtime by composing the FRAME pallets that were previously configured.
construct_runtime!(
	pub struct Runtime {
		System: frame_system,
		Timestamp: pallet_timestamp,
		Aura: pallet_aura,
		Grandpa: pallet_grandpa,
		Balances: pallet_balances,
		TransactionPayment: pallet_transaction_payment,
		Sudo: pallet_sudo,
		// Custom Pallets
		// Sidechain pallet must come after the Aura pallet, since it gets the slot number from it
		Sidechain: pallet_sidechain,
		SessionCommitteeManagement: pallet_session_validator_management,
		AddressAssociations: pallet_address_associations,
		BlockProducerFees: pallet_block_producer_fees,
		BlockProducerMetadata: pallet_block_producer_metadata,
		BlockProductionLog: pallet_block_production_log,
		BlockParticipation: pallet_block_participation,
		// We exclude pallet's extrinsics to make them unavailable to users to submit.
		// This is to ensure that registrations on Cardano coming in throught the
		// `SessionCommitteeManagement` pallet are the only source of truth about keys
		// and accounts of block producers.
		Session: pallet_session exclude_parts { Call },
		GovernedMap: pallet_governed_map,
		Bridge: pallet_partner_chains_bridge,
		Parameters: pallet_parameters,
		Preimage: pallet_preimage,
		Scheduler: pallet_scheduler,
		TestHelperPallet: crate::test_helper_pallet,
	}
);

/// The address format for describing accounts.
pub type Address = sp_runtime::MultiAddress<AccountId, ()>;
/// Block header type as expected by this runtime.
pub type Header = generic::Header<BlockNumber, BlakeTwo256>;
/// Block type as expected by this runtime.
pub type Block = generic::Block<Header, UncheckedExtrinsic>;
/// The SignedExtension to the basic transaction logic.
pub type SignedExtra = (
	frame_system::CheckNonZeroSender<Runtime>,
	frame_system::CheckSpecVersion<Runtime>,
	frame_system::CheckTxVersion<Runtime>,
	frame_system::CheckGenesis<Runtime>,
	frame_system::CheckEra<Runtime>,
	frame_system::CheckNonce<Runtime>,
	frame_system::CheckWeight<Runtime>,
	pallet_transaction_payment::ChargeTransactionPayment<Runtime>,
);

/// Unchecked extrinsic type as expected by this runtime.
pub type UncheckedExtrinsic =
	generic::UncheckedExtrinsic<Address, RuntimeCall, Signature, SignedExtra>;
/// The payload being signed in transactions.
pub type SignedPayload = generic::SignedPayload<RuntimeCall, SignedExtra>;
pub type Migrations = (
	pallet_session_validator_management::migrations::v1::LegacyToV1Migration<Runtime>,
	pallet_sidechain::migrations::v1::LegacyToV1Migration<Runtime, SLOT_DURATION>,
	// More migrations can be added here
);
/// Executive: handles dispatch to the various modules.
pub type Executive = frame_executive::Executive<
	Runtime,
	Block,
	frame_system::ChainContext<Runtime>,
	Runtime,
	AllPalletsWithSystem,
	Migrations,
>;

#[cfg(feature = "runtime-benchmarks")]
mod benches {
	define_benchmarks!(
		[frame_benchmarking, BaselineBench::<Runtime>]
		[frame_system, SystemBench::<Runtime>]
		[pallet_balances, Balances]
		[pallet_timestamp, Timestamp]
		[pallet_sudo, Sudo]
		[pallet_address_associations, AddressAssociations]
		[pallet_block_producer_fees, BlockProducerFees]
		[pallet_block_producer_metadata, BlockProducerMetadata]
		[pallet_block_participation, BlockParticipation]
		[pallet_governed_map, GovernedMap]
		[pallet_partner_chains_bridge, Bridge]
		[pallet_session_validator_management, SessionCommitteeManagement]
	);
}

impl_runtime_apis! {
	impl sp_genesis_builder::GenesisBuilder<Block> for Runtime {
		fn build_state(config: Vec<u8>) -> sp_genesis_builder::Result {
			build_state::<RuntimeGenesisConfig>(config)
		}

		fn get_preset(id: &Option<sp_genesis_builder::PresetId>) -> Option<Vec<u8>> {
			get_preset::<RuntimeGenesisConfig>(id, crate::genesis_config_presets::get_preset)
		}

		fn preset_names() -> Vec<sp_genesis_builder::PresetId> {
			crate::genesis_config_presets::preset_names()
		}
	}

	impl sp_api::Core<Block> for Runtime {
		fn version() -> RuntimeVersion {
			VERSION
		}

		fn execute_block(block: Block) {
			Executive::execute_block(block);
		}

		fn initialize_block(header: &<Block as BlockT>::Header) -> sp_runtime::ExtrinsicInclusionMode {
			Executive::initialize_block(header)
		}
	}

	impl sp_api::Metadata<Block> for Runtime {
		fn metadata() -> OpaqueMetadata {
			OpaqueMetadata::new(Runtime::metadata().into())
		}

		fn metadata_at_version(version: u32) -> Option<OpaqueMetadata> {
			Runtime::metadata_at_version(version)
		}

		fn metadata_versions() -> sp_std::vec::Vec<u32> {
			Runtime::metadata_versions()
		}
	}

	impl sp_block_builder::BlockBuilder<Block> for Runtime {
		fn apply_extrinsic(extrinsic: <Block as BlockT>::Extrinsic) -> ApplyExtrinsicResult {
			Executive::apply_extrinsic(extrinsic)
		}

		fn finalize_block() -> <Block as BlockT>::Header {
			Executive::finalize_block()
		}

		fn inherent_extrinsics(data: sp_inherents::InherentData) -> Vec<<Block as BlockT>::Extrinsic> {
			data.create_extrinsics()
		}

		fn check_inherents(
			block: Block,
			data: sp_inherents::InherentData,
		) -> sp_inherents::CheckInherentsResult {
			data.check_extrinsics(&block)
		}
	}

	impl sp_transaction_pool::runtime_api::TaggedTransactionQueue<Block> for Runtime {
		fn validate_transaction(
			source: TransactionSource,
			tx: <Block as BlockT>::Extrinsic,
			block_hash: <Block as BlockT>::Hash,
		) -> TransactionValidity {
			Executive::validate_transaction(source, tx, block_hash)
		}
	}

	impl sp_offchain::OffchainWorkerApi<Block> for Runtime {
		fn offchain_worker(header: &<Block as BlockT>::Header) {
			Executive::offchain_worker(header)
		}
	}

	impl sp_consensus_aura::AuraApi<Block, AuraId> for Runtime {
		fn slot_duration() -> sp_consensus_aura::SlotDuration {
			sp_consensus_aura::SlotDuration::from_millis(Aura::slot_duration())
		}

		fn authorities() -> Vec<AuraId> {
			pallet_aura::Authorities::<Runtime>::get().into_inner()
		}
	}

	impl sp_session::SessionKeys<Block> for Runtime {
		fn generate_session_keys(seed: Option<Vec<u8>>) -> Vec<u8> {
			// despite being named "generate" this function also adds generated keys to local keystore
			opaque::CrossChainKey::generate(seed.clone());
			opaque::SessionKeys::generate(seed)
		}

		fn decode_session_keys(
			encoded: Vec<u8>,
		) -> Option<Vec<(Vec<u8>, KeyTypeId)>> {
			opaque::SessionKeys::decode_into_raw_public_keys(&encoded)
		}
	}

	impl sp_consensus_grandpa::GrandpaApi<Block> for Runtime {
		fn grandpa_authorities() -> sp_consensus_grandpa::AuthorityList {
			Grandpa::grandpa_authorities()
		}

		fn current_set_id() -> sp_consensus_grandpa::SetId {
			Grandpa::current_set_id()
		}

		fn submit_report_equivocation_unsigned_extrinsic(
			_equivocation_proof: sp_consensus_grandpa::EquivocationProof<
				<Block as BlockT>::Hash,
				NumberFor<Block>,
			>,
			_key_owner_proof: sp_consensus_grandpa::OpaqueKeyOwnershipProof,
		) -> Option<()> {
			None
		}

		fn generate_key_ownership_proof(
			_set_id: sp_consensus_grandpa::SetId,
			_authority_id: GrandpaId,
		) -> Option<sp_consensus_grandpa::OpaqueKeyOwnershipProof> {
			// NOTE: this is the only implementation possible since we've
			// defined our key owner proof type as a bottom type (i.e. a type
			// with no values).
			None
		}
	}

	impl frame_system_rpc_runtime_api::AccountNonceApi<Block, AccountId, Nonce> for Runtime {
		fn account_nonce(account: AccountId) -> Nonce {
			System::account_nonce(account)
		}
	}

	impl pallet_transaction_payment_rpc_runtime_api::TransactionPaymentApi<Block, Balance> for Runtime {
		fn query_info(
			uxt: <Block as BlockT>::Extrinsic,
			len: u32,
		) -> pallet_transaction_payment_rpc_runtime_api::RuntimeDispatchInfo<Balance> {
			TransactionPayment::query_info(uxt, len)
		}
		fn query_fee_details(
			uxt: <Block as BlockT>::Extrinsic,
			len: u32,
		) -> pallet_transaction_payment::FeeDetails<Balance> {
			TransactionPayment::query_fee_details(uxt, len)
		}
		fn query_weight_to_fee(weight: sp_weights::Weight) -> Balance {
			TransactionPayment::weight_to_fee(weight)
		}
		fn query_length_to_fee(length: u32) -> Balance {
			TransactionPayment::length_to_fee(length)
		}
	}

	impl pallet_transaction_payment_rpc_runtime_api::TransactionPaymentCallApi<Block, Balance, RuntimeCall>
		for Runtime
	{
		fn query_call_info(
			call: RuntimeCall,
			len: u32,
		) -> pallet_transaction_payment::RuntimeDispatchInfo<Balance> {
			TransactionPayment::query_call_info(call, len)
		}
		fn query_call_fee_details(
			call: RuntimeCall,
			len: u32,
		) -> pallet_transaction_payment::FeeDetails<Balance> {
			TransactionPayment::query_call_fee_details(call, len)
		}
		fn query_weight_to_fee(weight: sp_weights::Weight) -> Balance {
			TransactionPayment::weight_to_fee(weight)
		}
		fn query_length_to_fee(length: u32) -> Balance {
			TransactionPayment::length_to_fee(length)
		}
	}

	#[cfg(feature = "runtime-benchmarks")]
	impl frame_benchmarking::Benchmark<Block> for Runtime {
		fn benchmark_metadata(extra: bool) -> (
			Vec<frame_benchmarking::BenchmarkList>,
			Vec<frame_support::traits::StorageInfo>,
		) {
			use frame_benchmarking::{baseline, BenchmarkList};
			use frame_support::traits::StorageInfoTrait;
			use frame_system_benchmarking::Pallet as SystemBench;
			use baseline::Pallet as BaselineBench;

			let mut list = Vec::<BenchmarkList>::new();
			list_benchmarks!(list, extra);

			let storage_info = AllPalletsWithSystem::storage_info();

			(list, storage_info)
		}

		fn dispatch_benchmark(
			config: frame_benchmarking::BenchmarkConfig
		) -> Result<Vec<frame_benchmarking::BenchmarkBatch>, alloc::string::String> {
			use frame_benchmarking::{baseline, BenchmarkBatch};
			use sp_storage::TrackedStorageKey;
			use frame_system_benchmarking::Pallet as SystemBench;
			use baseline::Pallet as BaselineBench;
			use frame_support::traits::WhitelistedStorageKeys;

			#[allow(non_local_definitions)]
			impl frame_system_benchmarking::Config for Runtime {}
			#[allow(non_local_definitions)]
			impl frame_benchmarking::baseline::Config for Runtime {}

			let whitelist: Vec<TrackedStorageKey> = AllPalletsWithSystem::whitelisted_storage_keys();

			let mut batches = Vec::<BenchmarkBatch>::new();
			let params = (&config, &whitelist);
			add_benchmarks!(params, batches);

			Ok(batches)
		}
	}

	#[cfg(feature = "try-runtime")]
	impl frame_try_runtime::TryRuntime<Block> for Runtime {
		fn on_runtime_upgrade(checks: frame_try_runtime::UpgradeCheckSelect) -> (Weight, Weight) {
			// NOTE: intentional unwrap: we don't want to propagate the error backwards, and want to
			// have a backtrace here. If any of the pre/post migration checks fail, we shall stop
			// right here and right now.
			let weight = Executive::try_runtime_upgrade(checks).unwrap();
			(weight, BlockWeights::get().max_block)
		}

		fn execute_block(
			block: Block,
			state_root_check: bool,
			signature_check: bool,
			select: frame_try_runtime::TryStateSelect
		) -> Weight {
			// NOTE: intentional unwrap: we don't want to propagate the error backwards, and want to
			// have a backtrace here.
			Executive::try_execute_block(block, state_root_check, signature_check, select).expect("execute-block failed")
		}
	}

	impl sp_sidechain::GetGenesisUtxo<Block> for Runtime {
		fn genesis_utxo() -> UtxoId {
			Sidechain::genesis_utxo()
		}
	}

	impl sp_sidechain::GetSidechainStatus<Block> for Runtime {
		fn get_sidechain_status() -> SidechainStatus {
			SidechainStatus {
				epoch: Sidechain::current_epoch_number(),
				slot: *pallet_aura::CurrentSlot::<Runtime>::get(),
				slots_per_epoch: (Sidechain::epoch_duration_millis() / SLOT_DURATION) as u32,
			}
		}
	}

	impl sp_sidechain::GetEpochDurationApi<Block> for Runtime {
		fn get_epoch_duration_millis() -> u64 {
			Sidechain::epoch_duration_millis()
		}
	}

	impl sp_block_producer_metadata::BlockProducerMetadataApi<Block, BlockProducerMetadataType> for Runtime
	{
		fn get_metadata_for(
			cross_chain_pub_key: &CrossChainPublicKey,
		) -> Option<BlockProducerMetadataType> {
			BlockProducerMetadata::get_metadata_for(&cross_chain_pub_key)
		}
	}

	impl sp_block_producer_fees::BlockProducerFeesApi<Block, AccountId> for Runtime
	{
		fn get_all_fees() -> Vec<(AccountId, sp_block_producer_fees::PerTenThousands)> {
			BlockProducerFees::get_all_latest().map(|(account_id, (_slot, fee))| (account_id, fee)).collect()
		}
	}

	#[api_version(3)]
	impl sp_session_validator_management::SessionValidatorManagementApi<
		Block,
		CrossChainPublic,
		SessionKeys,
		sidechain_domain::ScEpochNumber
	> for Runtime {
		fn get_current_committee() -> (ScEpochNumber, Vec<CommitteeMember<CrossChainPublic, SessionKeys>>) {
			SessionCommitteeManagement::current_committee_storage().as_pair()
		}
		fn get_next_committee() -> Option<(ScEpochNumber, Vec<CommitteeMember<CrossChainPublic, SessionKeys>>)> {
			Some(SessionCommitteeManagement::next_committee_storage()?.as_pair())
		}
		fn get_next_unset_epoch_number() -> sidechain_domain::ScEpochNumber {
			SessionCommitteeManagement::get_next_unset_epoch_number()
		}
		fn calculate_committee(authority_selection_inputs: AuthoritySelectionInputs, sidechain_epoch: ScEpochNumber) -> Option<Vec<CommitteeMember<CrossChainPublic, SessionKeys>>> {
			SessionCommitteeManagement::calculate_committee(authority_selection_inputs, sidechain_epoch)
		}
		fn get_main_chain_scripts() -> sp_session_validator_management::MainChainScripts {
			SessionCommitteeManagement::get_main_chain_scripts()
		}
	}

	impl authority_selection_inherents::CandidateValidationApi<Block> for Runtime {
		fn validate_registered_candidate_data(stake_pool_public_key: &StakePoolPublicKey, registration_data: &RegistrationData) -> Option<RegistrationDataError> {
			authority_selection_inherents::validate_registration_data::<SessionKeys>(stake_pool_public_key, registration_data, Sidechain::genesis_utxo()).err()
		}
		fn validate_stake(stake: Option<StakeDelegation>) -> Option<StakeError> {
			authority_selection_inherents::validate_stake(stake).err()
		}
		fn validate_permissioned_candidate_data(candidate: PermissionedCandidateData) -> Option<PermissionedCandidateDataError> {
			validate_permissioned_candidate_data::<SessionKeys>(candidate).err()
		}
	}

	impl sp_block_participation::BlockParticipationApi<Block, BlockAuthor, Slot> for Runtime {
		fn blocks_to_process(slot: &Slot) -> Vec<(Slot, BlockAuthor)> {
			BlockParticipation::blocks_to_process(slot)
		}
		fn target_inherent_id() -> InherentIdentifier {
			BlockParticipation::target_inherent_id()
		}
		fn moment_to_timestamp_millis(moment: Slot) -> u64 {
			let slot_duration_millis = <Self as sp_consensus_aura::runtime_decl_for_aura_api::AuraApi<Block, AuraId>>::slot_duration().as_millis();
			*moment * slot_duration_millis
		}
	}

	impl sp_governed_map::GovernedMapIDPApi<Block> for Runtime {
		fn is_initialized() -> bool {
			GovernedMap::is_initialized()
		}
		fn get_current_state() -> BTreeMap<String, ByteString> {
			GovernedMap::get_all_key_value_pairs_unbounded().collect()
		}
		fn get_main_chain_scripts() -> Option<MainChainScriptsV1> {
			GovernedMap::get_main_chain_scripts()
		}
		fn get_pallet_version() -> u32 {
			GovernedMap::get_version()
		}
	}

	impl sp_partner_chains_bridge::TokenBridgeIDPRuntimeApi<Block> for Runtime {
		fn get_pallet_version() -> u32 {
			Bridge::get_pallet_version()
		}
		fn get_main_chain_scripts() -> Option<BridgeMainChainScripts> {
			Bridge::get_main_chain_scripts()
		}
		fn get_max_transfers_per_block() -> u32 {
			Bridge::get_max_transfers_per_block()
		}
		fn get_last_data_checkpoint() -> Option<BridgeDataCheckpoint> {
			Bridge::get_data_checkpoint()
		}
	}
}

#[cfg(test)]
mod tests;