pallet_msa/

lib.rs

//! Message Source Account Management
//!
//! ## Quick Links
//! - [Configuration: `Config`](Config)
//! - [Extrinsics: `Call`](Call)
//! - [Runtime API: `MsaRuntimeApi`](../pallet_msa_runtime_api/trait.MsaRuntimeApi.html)
//! - [Custom RPC API: `MsaApiServer`](../pallet_msa_rpc/trait.MsaApiServer.html)
//! - [Event Enum: `Event`](Event)
//! - [Error Enum: `Error`](Error)
#![doc = include_str!("../README.md")]
//!
//! ## Implementations
//!
//! - [`MsaLookup`](../common_primitives/msa/trait.MsaLookup.html): Functions for accessing MSAs.
//! - [`MsaValidator`](../common_primitives/msa/trait.MsaValidator.html): Functions for validating MSAs.
//! - [`ProviderLookup`](../common_primitives/msa/trait.ProviderLookup.html): Functions for accessing Provider info.
//! - [`DelegationValidator`](../common_primitives/msa/trait.DelegationValidator.html): Functions for validating delegations.
//! - [`SchemaGrantValidator`](../common_primitives/msa/trait.SchemaGrantValidator.html): Functions for validating schema grants.
//!
//! ## Assumptions
//!
//! - Total MSA keys should be less than the constant `Config::MSA::MaxPublicKeysPerMsa`.
//! - Maximum schemas, for which any single provider has publishing rights on behalf of a single user, must be less than `Config::MSA::MaxSchemaGrantsPerDelegation`
#![allow(clippy::expect_used)]
#![cfg_attr(not(feature = "std"), no_std)]
// Strong Documentation Lints
#![deny(
	rustdoc::broken_intra_doc_links,
	rustdoc::missing_crate_level_docs,
	rustdoc::invalid_codeblock_attributes,
	missing_docs
)]

extern crate alloc;
use cid::Cid;
use core::fmt::Debug;
use frame_support::{
	dispatch::{DispatchInfo, DispatchResult, PostDispatchInfo},
	pallet_prelude::*,
	traits::{
		tokens::{
			fungible::{Inspect as InspectFungible, Mutate},
			Fortitude, Preservation,
		},
		Get, IsSubType,
	},
};
use lazy_static::lazy_static;
use parity_scale_codec::{Decode, Encode};

use common_runtime::signature::check_signature;

#[cfg(feature = "runtime-benchmarks")]
use common_primitives::benchmarks::{MsaBenchmarkHelper, RegisterProviderBenchmarkHelper};

use alloc::{boxed::Box, vec, vec::Vec};
use common_primitives::{
	capacity::TargetValidator,
	cid::compute_cid_v1,
	handles::HandleProvider,
	msa::*,
	node::{EIP712Encode, ProposalProvider},
	schema::{SchemaId, SchemaValidator},
	signatures::{AccountAddressMapper, EthereumAddressMapper},
};
use frame_system::pallet_prelude::*;
pub use pallet::*;
use scale_info::TypeInfo;
use sp_core::crypto::AccountId32;
use sp_io::hashing::keccak_256;
#[allow(unused)]
use sp_runtime::{
	traits::{
		AsSystemOriginSigner, BlockNumberProvider, Convert, DispatchInfoOf, Dispatchable,
		PostDispatchInfoOf, TransactionExtension, ValidateResult, Zero,
	},
	ArithmeticError, DispatchError, MultiSignature, Weight,
};
pub use types::{
	AddKeyData, AddProvider, ApplicationIndex, AuthorizedKeyData, PermittedDelegationSchemas,
	RecoveryCommitment, RecoveryCommitmentPayload,
};
pub use weights::*;

/// Offchain storage for MSA pallet
pub mod offchain_storage;
use crate::types::{LogoCid, PayloadTypeDiscriminator, RecoveryHash};
pub use offchain_storage::*;

#[cfg(feature = "runtime-benchmarks")]
mod benchmarking;

#[cfg(test)]
mod tests;

pub mod types;

pub mod weights;

/// Migrations
#[allow(missing_docs)]
pub mod migration;

#[frame_support::pallet]
pub mod pallet {
	use crate::types::RecoveryHash;

	use super::*;

	#[pallet::config]
	pub trait Config: frame_system::Config {
		/// The overarching event type.
		#[allow(deprecated)]
		type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;

		/// Weight information for extrinsics in this pallet.
		type WeightInfo: WeightInfo;

		/// AccountId truncated to 32 bytes
		type ConvertIntoAccountId32: Convert<Self::AccountId, AccountId32>;

		/// Maximum count of keys allowed per MSA
		#[pallet::constant]
		type MaxPublicKeysPerMsa: Get<u8>;

		/// Maximum count of schemas granted for publishing data per Provider
		#[pallet::constant]
		type MaxSchemaGrantsPerDelegation: Get<u32>;

		/// Maximum provider name size allowed per MSA association
		#[pallet::constant]
		type MaxProviderNameSize: Get<u32> + Clone + Debug + PartialEq + Eq;

		/// A type that will supply schema related information.
		type SchemaValidator: SchemaValidator<SchemaId>;

		/// A type that will supply `Handle` related information.
		type HandleProvider: HandleProvider;

		/// The number of blocks before a signature can be ejected from the PayloadSignatureRegistryList
		#[pallet::constant]
		type MortalityWindowSize: Get<u32>;

		/// The maximum number of signatures that can be stored in PayloadSignatureRegistryList.
		#[pallet::constant]
		type MaxSignaturesStored: Get<Option<u32>>;

		/// The origin that is allowed to create providers via governance
		type CreateProviderViaGovernanceOrigin: EnsureOrigin<Self::RuntimeOrigin>;

		/// The origin that is allowed to approve recovery providers
		type RecoveryProviderApprovalOrigin: EnsureOrigin<Self::RuntimeOrigin>;

		/// The runtime call dispatch type.
		type Proposal: Parameter
			+ Dispatchable<RuntimeOrigin = Self::RuntimeOrigin, PostInfo = PostDispatchInfo>
			+ From<Call<Self>>;

		/// The Council proposal provider interface
		type ProposalProvider: ProposalProvider<Self::AccountId, Self::Proposal>;

		/// Currency type for managing MSA account balances
		type Currency: Mutate<Self::AccountId> + InspectFungible<Self::AccountId>;

		/// Maximum language code size for a locale
		#[pallet::constant]
		type MaxLanguageCodeSize: Get<u32> + Clone + Debug + PartialEq + Eq;

		/// Maximum logo size for a locale
		#[pallet::constant]
		type MaxLogoSize: Get<u32> + Clone + Debug + PartialEq + Eq;

		/// Maximum cid size for a locale
		#[pallet::constant]
		type MaxLogoCidSize: Get<u32> + Clone + Debug + PartialEq + Eq;

		/// Total number of locales supported
		#[pallet::constant]
		type MaxLocaleCount: Get<u32> + Clone + Debug + PartialEq + Eq;
	}

	/// Storage version for the MSA pallet.
	pub const STORAGE_VERSION: StorageVersion = StorageVersion::new(2);

	#[pallet::pallet]
	#[pallet::storage_version(STORAGE_VERSION)]
	pub struct Pallet<T>(_);

	/// Storage type for the current MSA identifier maximum.
	/// We need to track this value because the identifier maximum
	/// is incremented each time a new identifier is created.
	/// - Value: The current maximum MSA Id
	#[pallet::storage]
	pub type CurrentMsaIdentifierMaximum<T> = StorageValue<_, MessageSourceId, ValueQuery>;

	/// Storage type for mapping the relationship between a Delegator and its Provider.
	/// - Keys: Delegator MSA, Provider MSA
	/// - Value: [`Delegation`](common_primitives::msa::Delegation)
	#[pallet::storage]
	pub type DelegatorAndProviderToDelegation<T: Config> = StorageDoubleMap<
		_,
		Twox64Concat,
		DelegatorId,
		Twox64Concat,
		ProviderId,
		Delegation<SchemaId, BlockNumberFor<T>, T::MaxSchemaGrantsPerDelegation>,
		OptionQuery,
	>;

	/// Storage type for approved recovery providers
	/// - Key: Provider MSA Id
	/// - Value: [`bool`]
	#[pallet::storage]
	pub type RecoveryProviders<T: Config> =
		StorageMap<_, Twox64Concat, ProviderId, bool, OptionQuery>;

	/// Provider registration information
	/// - Key: Provider MSA Id
	/// - Value: [`ProviderRegistryEntry`](common_primitives::msa::ProviderRegistryEntry)
	#[deprecated(
		note = "Use ProviderToRegistryEntryV2 instead, this will removed from frequency version 1.17.6"
	)]
	#[pallet::storage]
	pub type ProviderToRegistryEntry<T: Config> = StorageMap<
		_,
		Twox64Concat,
		ProviderId,
		crate::migration::v1::ProviderRegistryEntry<T::MaxProviderNameSize>,
		OptionQuery,
	>;

	/// Provider registration information
	/// - Key: Provider MSA Id
	/// - Value: [`ProviderRegistryEntry`](common_primitives::msa::ProviderRegistryEntry)
	#[pallet::storage]
	pub type ProviderToRegistryEntryV2<T: Config> = StorageMap<
		_,
		Twox64Concat,
		ProviderId,
		ProviderRegistryEntry<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
		OptionQuery,
	>;

	/// Storage type for key to MSA information
	/// - Key: AccountId
	/// - Value: [`MessageSourceId`]
	#[pallet::storage]
	pub type PublicKeyToMsaId<T: Config> =
		StorageMap<_, Twox64Concat, T::AccountId, MessageSourceId, OptionQuery>;

	/// Storage type for a reference counter of the number of keys associated to an MSA
	/// - Key: MSA Id
	/// - Value: [`u8`] Counter of Keys associated with the MSA
	#[pallet::storage]
	pub(super) type PublicKeyCountForMsaId<T: Config> =
		StorageMap<_, Twox64Concat, MessageSourceId, u8, ValueQuery>;

	/// PayloadSignatureRegistryList is used to prevent replay attacks for extrinsics
	/// that take an externally-signed payload.
	/// For this to work, the payload must include a mortality block number, which
	/// is used in lieu of a monotonically increasing nonce.
	///
	/// The list is forwardly linked. (Example has a list size of 3)
	/// - signature, forward pointer -> n = new signature
	/// - 1,2 -> 2,3 (oldest)
	/// - 2,3 -> 3,4
	/// - 3,4 -> 4,5
	/// -   5 -> n (newest in pointer data)
	/// ### Storage
	/// - Key: Signature
	/// - Value: Tuple
	///     - `BlockNumber` when the keyed signature can be ejected from the registry
	///     - [`MultiSignature`] the forward linked list pointer. This pointer is the next "newest" value.
	#[pallet::storage]
	pub(super) type PayloadSignatureRegistryList<T: Config> = StorageMap<
		_,                                   // prefix
		Twox64Concat,                        // hasher for key1
		MultiSignature, // An externally-created Signature for an external payload, provided by an extrinsic
		(BlockNumberFor<T>, MultiSignature), // An actual flipping block number and the oldest signature at write time
		OptionQuery,                         // The type for the query
		GetDefault,                          // OnEmpty return type, defaults to None
		T::MaxSignaturesStored,              // Maximum total signatures to store
	>;

	/// This is the pointer for the Payload Signature Registry
	/// Contains the pointers to the data stored in the `PayloadSignatureRegistryList`
	/// - Value: [`SignatureRegistryPointer`]
	#[pallet::storage]
	pub(super) type PayloadSignatureRegistryPointer<T: Config> =
		StorageValue<_, SignatureRegistryPointer<BlockNumberFor<T>>>;

	/// A temporary storage for looking up relevant events from off-chain index
	/// At the start of the next block this storage is set to 0
	#[pallet::storage]
	#[pallet::whitelist_storage]
	pub(super) type OffchainIndexEventCount<T: Config> = StorageValue<_, u16, ValueQuery>;

	/// Storage type for mapping MSA IDs to their Recovery Commitments
	/// - Key: MessageSourceId
	/// - Value: Recovery Commitment (32 bytes)
	#[pallet::storage]
	pub type MsaIdToRecoveryCommitment<T: Config> =
		StorageMap<_, Twox64Concat, MessageSourceId, RecoveryCommitment, OptionQuery>;

	/// Storage type for ApprovedLogos
	/// - key: Logo Cid
	/// - value: Logo bytes
	#[pallet::storage]
	#[pallet::getter(fn approved_logos)]
	pub type ApprovedLogos<T: Config> =
		StorageMap<_, Twox64Concat, LogoCid<T>, BoundedVec<u8, T::MaxLogoSize>, OptionQuery>;

	/// Monotonically increasing index of applications for a given provider.
	/// Starts at 0 when provider first gets an application approved.
	#[pallet::storage]
	#[pallet::getter(fn next_application_index)]
	pub(super) type NextApplicationIndex<T: Config> =
		StorageMap<_, Twox64Concat, ProviderId, ApplicationIndex, ValueQuery>;

	/// Mapping of (ProviderId, ApplicationIndex) → Application details.
	/// This is where the actual application data is stored.
	#[pallet::storage]
	#[pallet::getter(fn provider_applications)]
	pub(super) type ProviderToApplicationRegistry<T: Config> = StorageDoubleMap<
		_,
		Twox64Concat,
		ProviderId,
		Twox64Concat,
		ApplicationIndex,
		ApplicationContext<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
		OptionQuery,
	>;

	#[pallet::event]
	#[pallet::generate_deposit(pub (super) fn deposit_event)]
	pub enum Event<T: Config> {
		/// A new Message Service Account was created with a new MessageSourceId
		MsaCreated {
			/// The MSA for the Event
			msa_id: MessageSourceId,

			/// The key added to the MSA
			key: T::AccountId,
		},
		/// An AccountId has been associated with a MessageSourceId
		PublicKeyAdded {
			/// The MSA for the Event
			msa_id: MessageSourceId,

			/// The key added to the MSA
			key: T::AccountId,
		},
		/// An AccountId had all permissions revoked from its MessageSourceId
		PublicKeyDeleted {
			/// The key no longer approved for the associated MSA
			key: T::AccountId,
		},
		/// A delegation relationship was added with the given provider and delegator
		DelegationGranted {
			/// The Provider MSA Id
			provider_id: ProviderId,

			/// The Delegator MSA Id
			delegator_id: DelegatorId,
		},
		/// A Provider-MSA relationship was registered
		ProviderCreated {
			/// The MSA id associated with the provider
			provider_id: ProviderId,
		},
		/// The Delegator revoked its delegation to the Provider
		DelegationRevoked {
			/// The Provider MSA Id
			provider_id: ProviderId,

			/// The Delegator MSA Id
			delegator_id: DelegatorId,
		},
		/// The MSA has been retired.
		MsaRetired {
			/// The MSA id for the Event
			msa_id: MessageSourceId,
		},
		/// A an update to the delegation occurred (ex. schema permissions where updated).
		DelegationUpdated {
			/// The Provider MSA Id
			provider_id: ProviderId,

			/// The Delegator MSA Id
			delegator_id: DelegatorId,
		},
		/// A Recovery Commitment was added to an MSA
		RecoveryCommitmentAdded {
			/// The MSA owner key that added the commitment
			who: T::AccountId,

			/// The MSA id for the Event
			msa_id: MessageSourceId,

			/// The Recovery Commitment that was added
			recovery_commitment: RecoveryCommitment,
		},
		/// A recovery provider has been approved.
		RecoveryProviderApproved {
			/// The provider account ID
			provider_id: ProviderId,
		},
		/// A recovery provider has been removed.
		RecoveryProviderRemoved {
			/// The provider account ID
			provider_id: ProviderId,
		},
		/// An account was recovered with a new control key
		AccountRecovered {
			/// The MSA id that was recovered
			msa_id: MessageSourceId,
			/// The recovery provider that performed the recovery
			recovery_provider: ProviderId,
			/// The new control key added to the MSA
			new_control_key: T::AccountId,
		},
		/// A Recovery Commitment was invalidated after use or removal
		RecoveryCommitmentInvalidated {
			/// The MSA id for which the commitment was invalidated
			msa_id: MessageSourceId,
			/// The Recovery Commitment that was invalidated
			recovery_commitment: RecoveryCommitment,
		},
		/// Application for provider created
		ApplicationCreated {
			/// The MSA id associated with the provider
			provider_id: ProviderId,
			/// The application id for the created application
			application_id: ApplicationIndex,
		},
		/// Application updated for provider
		ApplicationContextUpdated {
			/// The MSA id associated with the provider
			provider_id: ProviderId,
			/// The application id for the updated application
			application_id: Option<ApplicationIndex>,
		},
		/// Provider registry is updated
		ProviderUpdated {
			/// The MSA id associated with the provider
			provider_id: ProviderId,
		},
	}

	#[pallet::error]
	pub enum Error<T> {
		/// Tried to add a key that was already registered to an MSA
		KeyAlreadyRegistered,

		/// MsaId values have reached the maximum
		MsaIdOverflow,

		/// Cryptographic signature verification failed
		MsaOwnershipInvalidSignature,

		/// Ony the MSA Owner may perform the operation
		NotMsaOwner,

		/// Cryptographic signature failed verification
		InvalidSignature,

		/// Only the KeyOwner may perform the operation
		NotKeyOwner,

		/// An operation was attempted with an unknown Key
		NoKeyExists,

		/// The number of key values has reached its maximum
		KeyLimitExceeded,

		/// A transaction's Origin (AccountId) may not remove itself
		InvalidSelfRemoval,

		/// An MSA may not be its own delegate
		InvalidSelfProvider,

		/// An invalid schema Id was provided
		InvalidSchemaId,

		/// The delegation relationship already exists for the given MSA Ids
		DuplicateProvider,

		/// Cryptographic signature verification failed for adding the Provider as delegate
		AddProviderSignatureVerificationFailed,

		/// Origin attempted to add a delegate for someone else's MSA
		UnauthorizedDelegator,

		/// Origin attempted to add a different delegate than what was in the payload
		UnauthorizedProvider,

		/// The operation was attempted with a revoked delegation
		DelegationRevoked,

		/// The operation was attempted with an unknown delegation
		DelegationNotFound,

		/// The MSA id submitted for provider creation has already been associated with a provider
		DuplicateProviderRegistryEntry,

		/// The maximum length for a provider name has been exceeded
		ExceedsMaxProviderNameSize,

		/// The maximum number of schema grants has been exceeded
		ExceedsMaxSchemaGrantsPerDelegation,

		/// Provider is not permitted to publish for given schema_id
		SchemaNotGranted,

		/// The operation was attempted with a non-provider MSA
		ProviderNotRegistered,

		/// The submitted proof has expired; the current block is less the expiration block
		ProofHasExpired,

		/// The submitted proof expiration block is too far in the future
		ProofNotYetValid,

		/// Attempted to add a signature when the signature is already in the registry
		SignatureAlreadySubmitted,

		/// Cryptographic signature verification failed for proving ownership of new public-key.
		NewKeyOwnershipInvalidSignature,

		/// Attempted to request validity of schema permission or delegation in the future.
		CannotPredictValidityPastCurrentBlock,

		/// Attempted to add a new signature to a full signature registry
		SignatureRegistryLimitExceeded,

		/// Attempted to add a new signature to a corrupt signature registry
		SignatureRegistryCorrupted,

		/// Account has no/insufficient balance to withdraw
		InsufficientBalanceToWithdraw,

		/// Fund transfer error
		UnexpectedTokenTransferError,

		/// The caller is not authorized as a recovery provider
		NotAuthorizedRecoveryProvider,

		/// The provided recovery commitment does not match the stored one
		InvalidRecoveryCommitment,

		/// No recovery commitment exists for the given MSA
		NoRecoveryCommitment,

		/// Invalid cid provided for the provider
		InvalidCid,

		/// Unsupported CID version
		UnsupportedCidVersion,

		/// Invalid Language Code provided for the provider
		InvalidBCP47LanguageCode,

		/// Duplicate application registry entry
		DuplicateApplicationRegistryEntry,

		/// Logo cid not approved
		LogoCidNotApproved,

		/// Invalid logo bytes that do not match the approved logo
		InvalidLogoBytes,

		/// Application not found for given application_id
		ApplicationNotFound,
	}

	impl<T: Config> BlockNumberProvider for Pallet<T> {
		type BlockNumber = BlockNumberFor<T>;

		fn current_block_number() -> Self::BlockNumber {
			frame_system::Pallet::<T>::block_number()
		}
	}

	#[pallet::hooks]
	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
		fn on_initialize(_block_number: BlockNumberFor<T>) -> Weight {
			<OffchainIndexEventCount<T>>::set(0u16);
			let migration_weight = crate::migration::v2::on_initialize_migration::<T>(); // allocates 1 read and 1 write for any access of `MSAEventCount` in every block
			T::DbWeight::get().reads_writes(1u64, 1u64).saturating_add(migration_weight)
		}

		fn offchain_worker(block_number: BlockNumberFor<T>) {
			log::info!("Running offchain workers! {block_number:?}");
			do_offchain_worker::<T>(block_number)
		}
	}

	#[pallet::call]
	impl<T: Config> Pallet<T> {
		/// Creates an MSA for the Origin (sender of the transaction).  Origin is assigned an MSA ID.
		///
		/// # Events
		/// * [`Event::MsaCreated`]
		///
		/// # Errors
		///
		/// * [`Error::KeyAlreadyRegistered`] - MSA is already registered to the Origin.
		///
		#[pallet::call_index(0)]
		#[pallet::weight(T::WeightInfo::create())]
		pub fn create(origin: OriginFor<T>) -> DispatchResult {
			let public_key = ensure_signed(origin)?;

			let (new_msa_id, new_public_key) = Self::create_account(public_key)?;

			let event = Event::MsaCreated { msa_id: new_msa_id, key: new_public_key };
			offchain_index_event::<T>(Some(&event), new_msa_id);
			Self::deposit_event(event);
			Ok(())
		}

		/// `Origin` MSA creates an MSA on behalf of `delegator_key`, creates a Delegation with the `delegator_key`'s MSA as the Delegator and `origin` as `Provider`. Deposits events [`MsaCreated`](Event::MsaCreated) and [`DelegationGranted`](Event::DelegationGranted).
		///
		/// # Remarks
		/// * Origin MUST be the provider
		/// * Signatures should be over the [`AddProvider`] struct
		///
		/// # Events
		/// * [`Event::MsaCreated`]
		/// * [`Event::DelegationGranted`]
		///
		/// # Errors
		///
		/// * [`Error::UnauthorizedProvider`] - payload's MSA does not match given provider MSA.
		/// * [`Error::InvalidSignature`] - `proof` verification fails; `delegator_key` must have signed `add_provider_payload`
		/// * [`Error::NoKeyExists`] - there is no MSA for `origin`.
		/// * [`Error::KeyAlreadyRegistered`] - there is already an MSA for `delegator_key`.
		/// * [`Error::ProviderNotRegistered`] - the a non-provider MSA is used as the provider
		/// * [`Error::ProofNotYetValid`] - `add_provider_payload` expiration is too far in the future
		/// * [`Error::ProofHasExpired`] - `add_provider_payload` expiration is in the past
		/// * [`Error::SignatureAlreadySubmitted`] - signature has already been used
		///
		#[pallet::call_index(1)]
		#[pallet::weight(T::WeightInfo::create_sponsored_account_with_delegation(
		add_provider_payload.schema_ids.len() as u32
		))]
		pub fn create_sponsored_account_with_delegation(
			origin: OriginFor<T>,
			delegator_key: T::AccountId,
			proof: MultiSignature,
			add_provider_payload: AddProvider,
		) -> DispatchResult {
			let provider_key = ensure_signed(origin)?;

			ensure!(
				Self::verify_signature(&proof, &delegator_key, &add_provider_payload),
				Error::<T>::InvalidSignature
			);

			Self::register_signature(&proof, add_provider_payload.expiration.into())?;

			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			ensure!(
				add_provider_payload.authorized_msa_id == provider_msa_id,
				Error::<T>::UnauthorizedProvider
			);

			// Verify that the provider is a registered provider
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);

			let (new_delegator_msa_id, new_delegator_public_key) =
				Self::create_account(delegator_key)?;
			Self::add_provider(
				ProviderId(provider_msa_id),
				DelegatorId(new_delegator_msa_id),
				add_provider_payload.schema_ids,
			)?;
			let event =
				Event::MsaCreated { msa_id: new_delegator_msa_id, key: new_delegator_public_key };
			offchain_index_event::<T>(Some(&event), new_delegator_msa_id);
			Self::deposit_event(event);
			Self::deposit_event(Event::DelegationGranted {
				delegator_id: DelegatorId(new_delegator_msa_id),
				provider_id: ProviderId(provider_msa_id),
			});
			Ok(())
		}

		/// Adds an association between MSA id and ProviderRegistryEntry. As of now, the
		/// only piece of metadata we are recording is provider name.
		///
		/// # Events
		/// * [`Event::ProviderCreated`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - origin does not have an MSA
		/// * [`Error::ExceedsMaxProviderNameSize`] - Too long of a provider name
		/// * [`Error::DuplicateProviderRegistryEntry`] - a ProviderRegistryEntry associated with the given MSA id already exists.
		#[pallet::call_index(2)]
		#[pallet::weight(T::WeightInfo::create_provider())]
		pub fn create_provider(origin: OriginFor<T>, provider_name: Vec<u8>) -> DispatchResult {
			let provider_key = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			let bounded_name: BoundedVec<u8, T::MaxProviderNameSize> =
				provider_name.try_into().map_err(|_| Error::<T>::ExceedsMaxProviderNameSize)?;

			let entry = ProviderRegistryEntry { default_name: bounded_name, ..Default::default() };
			Self::ensure_correct_cids(&entry)?;
			Self::upsert_provider_for(provider_msa_id, entry, false)?;
			Self::deposit_event(Event::ProviderCreated {
				provider_id: ProviderId(provider_msa_id),
			});
			Ok(())
		}

		/// Creates a new Delegation for an existing MSA, with `origin` as the Provider and `delegator_key` is the delegator.
		/// Since it is being sent on the Delegator's behalf, it requires the Delegator to authorize the new Delegation.
		///
		/// # Remarks
		/// * Origin MUST be the provider
		/// * Signatures should be over the [`AddProvider`] struct
		///
		/// # Events
		/// * [`Event::DelegationGranted`]
		///
		/// # Errors
		/// * [`Error::AddProviderSignatureVerificationFailed`] - `origin`'s MSA ID does not equal `add_provider_payload.authorized_msa_id`.
		/// * [`Error::DuplicateProvider`] - there is already a Delegation for `origin` MSA and `delegator_key` MSA.
		/// * [`Error::UnauthorizedProvider`] - `add_provider_payload.authorized_msa_id`  does not match MSA ID of `delegator_key`.
		/// * [`Error::InvalidSelfProvider`] - Cannot delegate to the same MSA
		/// * [`Error::InvalidSignature`] - `proof` verification fails; `delegator_key` must have signed `add_provider_payload`
		/// * [`Error::NoKeyExists`] - there is no MSA for `origin` or `delegator_key`.
		/// * [`Error::ProviderNotRegistered`] - the a non-provider MSA is used as the provider
		/// * [`Error::UnauthorizedDelegator`] - Origin attempted to add a delegate for someone else's MSA
		///
		#[pallet::call_index(3)]
		#[pallet::weight(T::WeightInfo::grant_delegation(add_provider_payload.schema_ids.len() as u32))]
		pub fn grant_delegation(
			origin: OriginFor<T>,
			delegator_key: T::AccountId,
			proof: MultiSignature,
			add_provider_payload: AddProvider,
		) -> DispatchResult {
			let provider_key = ensure_signed(origin)?;

			ensure!(
				Self::verify_signature(&proof, &delegator_key, &add_provider_payload),
				Error::<T>::AddProviderSignatureVerificationFailed
			);

			Self::register_signature(&proof, add_provider_payload.expiration.into())?;
			let (provider_id, delegator_id) =
				Self::ensure_valid_registered_provider(&delegator_key, &provider_key)?;

			ensure!(
				add_provider_payload.authorized_msa_id == provider_id.0,
				Error::<T>::UnauthorizedDelegator
			);

			Self::upsert_schema_permissions(
				provider_id,
				delegator_id,
				add_provider_payload.schema_ids,
			)?;
			Self::deposit_event(Event::DelegationGranted { delegator_id, provider_id });

			Ok(())
		}

		/// Delegator (Origin) MSA terminates a delegation relationship with the `Provider` MSA. Deposits event[`DelegationRevoked`](Event::DelegationRevoked).
		///
		/// # Events
		/// * [`Event::DelegationRevoked`]
		///
		/// # Errors
		///
		/// * [`Error::NoKeyExists`] - origin does not have an MSA
		/// * [`Error::DelegationRevoked`] - the delegation has already been revoked.
		/// * [`Error::DelegationNotFound`] - there is not delegation relationship between Origin and Delegator or Origin and Delegator are the same.
		///
		#[pallet::call_index(4)]
		#[pallet::weight((T::WeightInfo::revoke_delegation_by_delegator(), DispatchClass::Normal, Pays::No))]
		pub fn revoke_delegation_by_delegator(
			origin: OriginFor<T>,
			#[pallet::compact] provider_msa_id: MessageSourceId,
		) -> DispatchResult {
			let who = ensure_signed(origin)?;

			match PublicKeyToMsaId::<T>::get(&who) {
				Some(delegator_msa_id) => {
					let delegator_id = DelegatorId(delegator_msa_id);
					let provider_id = ProviderId(provider_msa_id);
					Self::revoke_provider(provider_id, delegator_id)?;
					Self::deposit_event(Event::DelegationRevoked { delegator_id, provider_id });
				},
				None => {
					log::error!(
						"TransactionExtension did not catch invalid MSA for account {who:?}, "
					);
				},
			}

			Ok(())
		}

		/// Adds a new public key to an existing Message Source Account (MSA). This functionality enables the MSA owner to manage multiple keys
		/// for their account or rotate keys for enhanced security.
		///
		/// The `origin` parameter represents the account from which the function is called and can be either the MSA owner's account or a delegated provider's account,
		/// depending on the intended use.
		///
		/// The function requires two signatures: `msa_owner_proof` and `new_key_owner_proof`, which serve as proofs of ownership for the existing MSA
		/// and the new public key account, respectively.  This ensures that a new key cannot be added without permission of both the MSA owner and the owner of the new key.
		///
		/// The necessary information for the key addition, the new public key and the MSA ID, is contained in the `add_key_payload` parameter of type [AddKeyData].
		/// It also contains an expiration block number for both proofs, ensuring they are valid and must be greater than the current block.
		///
		/// # Events
		/// * [`Event::PublicKeyAdded`]
		///
		/// # Errors
		///
		/// * [`Error::MsaOwnershipInvalidSignature`] - `key` is not a valid signer of the provided `add_key_payload`.
		/// * [`Error::NewKeyOwnershipInvalidSignature`] - `key` is not a valid signer of the provided `add_key_payload`.
		/// * [`Error::NoKeyExists`] - the MSA id for the account in `add_key_payload` does not exist.
		/// * [`Error::NotMsaOwner`] - Origin's MSA is not the same as 'add_key_payload` MSA. Essentially you can only add a key to your own MSA.
		/// * [`Error::ProofHasExpired`] - the current block is less than the `expired` block number set in `AddKeyData`.
		/// * [`Error::ProofNotYetValid`] - the `expired` block number set in `AddKeyData` is greater than the current block number plus mortality_block_limit().
		/// * [`Error::SignatureAlreadySubmitted`] - signature has already been used.
		///
		#[pallet::call_index(5)]
		#[pallet::weight(T::WeightInfo::add_public_key_to_msa())]
		pub fn add_public_key_to_msa(
			origin: OriginFor<T>,
			msa_owner_public_key: T::AccountId,
			msa_owner_proof: MultiSignature,
			new_key_owner_proof: MultiSignature,
			add_key_payload: AddKeyData<T>,
		) -> DispatchResult {
			let _ = ensure_signed(origin)?;

			ensure!(
				Self::verify_signature(&msa_owner_proof, &msa_owner_public_key, &add_key_payload),
				Error::<T>::MsaOwnershipInvalidSignature
			);

			ensure!(
				Self::verify_signature(
					&new_key_owner_proof,
					&add_key_payload.new_public_key,
					&add_key_payload
				),
				Error::<T>::NewKeyOwnershipInvalidSignature
			);

			Self::register_signature(&msa_owner_proof, add_key_payload.expiration)?;
			Self::register_signature(&new_key_owner_proof, add_key_payload.expiration)?;

			let msa_id = add_key_payload.msa_id;

			Self::ensure_msa_owner(&msa_owner_public_key, msa_id)?;

			Self::add_key(msa_id, &add_key_payload.new_public_key.clone())?;

			let event =
				Event::PublicKeyAdded { msa_id, key: add_key_payload.new_public_key.clone() };
			offchain_index_event::<T>(Some(&event), msa_id);
			Self::deposit_event(event);

			Ok(())
		}

		/// Remove a key associated with an MSA by expiring it at the current block.
		///
		/// # Remarks
		/// * Removal of key deletes the association of the key with the MSA.
		/// * The key can be re-added to same or another MSA if needed.
		///
		/// # Events
		/// * [`Event::PublicKeyDeleted`]
		///
		/// # Errors
		/// * [`Error::InvalidSelfRemoval`] - `origin` and `key` are the same.
		/// * [`Error::NotKeyOwner`] - `origin` does not own the MSA ID associated with `key`.
		/// * [`Error::NoKeyExists`] - `origin` or `key` are not associated with `origin`'s MSA ID.
		///
		#[pallet::call_index(6)]
		#[pallet::weight((T::WeightInfo::delete_msa_public_key(), DispatchClass::Normal, Pays::No))]
		pub fn delete_msa_public_key(
			origin: OriginFor<T>,
			public_key_to_delete: T::AccountId,
		) -> DispatchResult {
			let who = ensure_signed(origin)?;

			match PublicKeyToMsaId::<T>::get(&who) {
				Some(who_msa_id) => {
					Self::delete_key_for_msa(who_msa_id, &public_key_to_delete)?;

					// Deposit the event
					let event = Event::PublicKeyDeleted { key: public_key_to_delete };
					offchain_index_event::<T>(Some(&event), who_msa_id);
					Self::deposit_event(event);
				},
				None => {
					log::error!(
						"TransactionExtension did not catch invalid MSA for account {who:?}"
					);
				},
			}
			Ok(())
		}

		/// Provider MSA terminates Delegation with a Delegator MSA by expiring the Delegation at the current block.
		///
		/// # Events
		/// * [`Event::DelegationRevoked`]
		///
		/// # Errors
		///
		/// * [`Error::NoKeyExists`] - `provider_key` does not have an MSA key.
		/// * [`Error::DelegationRevoked`] - delegation is already revoked
		/// * [`Error::DelegationNotFound`] - no Delegation found between origin MSA and delegator MSA.
		///
		#[pallet::call_index(7)]
		#[pallet::weight((T::WeightInfo::revoke_delegation_by_provider(), DispatchClass::Normal, Pays::No))]
		pub fn revoke_delegation_by_provider(
			origin: OriginFor<T>,
			#[pallet::compact] delegator: MessageSourceId,
		) -> DispatchResult {
			let who = ensure_signed(origin)?;

			// Revoke delegation relationship entry in the delegation registry by expiring it
			// at the current block
			// validity checks are in TransactionExtension so in theory this should never error.
			match PublicKeyToMsaId::<T>::get(&who) {
				Some(msa_id) => {
					let provider_id = ProviderId(msa_id);
					let delegator_id = DelegatorId(delegator);
					Self::revoke_provider(provider_id, delegator_id)?;
					Self::deposit_event(Event::DelegationRevoked { provider_id, delegator_id })
				},
				None => {
					log::error!(
						"TransactionExtension did not catch invalid MSA for account {who:?}"
					);
				},
			}

			Ok(())
		}

		// REMOVED grant_schema_permissions() at call index 8
		// REMOVED revoke_schema_permissions() at call index 9

		/// Retires a MSA
		///
		/// When a user wants to disassociate themselves from Frequency, they can retire their MSA for free provided that:
		///  (1) They own the MSA
		///  (2) The MSA is not a registered provider.
		///  (3) They retire their user handle (if they have one)
		///  (4) There is only one account key
		///  (5) The user has already deleted all delegations to providers
		///
		/// This does not currently remove any messages related to the MSA.
		///
		/// # Events
		/// * [`Event::PublicKeyDeleted`]
		/// * [`Event::MsaRetired`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - `delegator` does not have an MSA key.
		///
		#[pallet::call_index(10)]
		#[pallet::weight((T::WeightInfo::retire_msa(), DispatchClass::Normal, Pays::No))]
		pub fn retire_msa(origin: OriginFor<T>) -> DispatchResult {
			// Check and get the account id from the origin
			let who = ensure_signed(origin)?;

			// Delete the last and only account key and deposit the "PublicKeyDeleted" event
			// check for valid MSA is in TransactionExtension.
			match PublicKeyToMsaId::<T>::get(&who) {
				Some(msa_id) => {
					Self::delete_key_for_msa(msa_id, &who)?;
					let event = Event::PublicKeyDeleted { key: who };
					offchain_index_event::<T>(Some(&event), msa_id);
					Self::deposit_event(event);
					Self::deposit_event(Event::MsaRetired { msa_id });
				},
				None => {
					log::error!(
						"TransactionExtension did not catch invalid MSA for account {who:?}"
					);
				},
			}
			Ok(())
		}

		/// Propose to be a provider.  Creates a proposal for council approval to create a provider from a MSA
		///
		/// # Errors
		/// - [`NoKeyExists`](Error::NoKeyExists) - If there is not MSA for `origin`.
		/// - [`Error::ExceedsMaxProviderNameSize`] - Too long of a provider name
		#[pallet::call_index(11)]
		#[pallet::weight(T::WeightInfo::propose_to_be_provider_v2())]
		#[allow(deprecated)]
		#[deprecated(
			note = "please use `propose_to_be_provider_v2`, which supports additional provider metadata"
		)]
		pub fn propose_to_be_provider(
			origin: OriginFor<T>,
			provider_name: Vec<u8>,
		) -> DispatchResult {
			let bounded_name: BoundedVec<u8, T::MaxProviderNameSize> =
				provider_name.try_into().map_err(|_| Error::<T>::ExceedsMaxProviderNameSize)?;

			let entry = ProviderRegistryEntry { default_name: bounded_name, ..Default::default() };

			Self::propose_to_be_provider_v2(origin, entry)
		}

		/// Create a provider by means of governance approval
		///
		/// # Events
		/// * [`Event::ProviderCreated`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - account does not have an MSA
		/// * [`Error::ExceedsMaxProviderNameSize`] - Too long of a provider name
		/// * [`Error::DuplicateProviderRegistryEntry`] - a ProviderRegistryEntry associated with the given MSA id already exists.
		#[pallet::call_index(12)]
		#[pallet::weight(T::WeightInfo::create_provider_via_governance_v2(0u32, 0u32))]
		#[allow(deprecated)]
		#[deprecated(
			note = "please use `create_provider_via_governance_v2`, which supports additional provider metadata"
		)]
		pub fn create_provider_via_governance(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
			provider_name: Vec<u8>,
		) -> DispatchResult {
			let bounded_name: BoundedVec<u8, T::MaxProviderNameSize> =
				provider_name.try_into().map_err(|_| Error::<T>::ExceedsMaxProviderNameSize)?;

			let entry = ProviderRegistryEntry { default_name: bounded_name, ..Default::default() };

			Self::create_provider_via_governance_v2(origin, provider_key, entry)
		}

		/// A generic endpoint to replay any offchain related event to fix any potential issues
		#[pallet::call_index(13)]
		#[pallet::weight(T::WeightInfo::reindex_offchain())]
		pub fn reindex_offchain(
			origin: OriginFor<T>,
			event: OffchainReplayEvent<T>,
		) -> DispatchResult {
			let _ = ensure_signed(origin)?;
			match event {
				OffchainReplayEvent::MsaPallet(MsaOffchainReplayEvent::KeyReIndex {
					msa_id,
					index_key,
				}) => {
					// don't need to check existence of msa_id since it would get checked on offchain side
					match index_key {
						Some(key) => {
							let event = Event::PublicKeyAdded { msa_id, key };
							offchain_index_event::<T>(Some(&event), msa_id);
						},
						None => {
							offchain_index_event::<T>(None, msa_id);
						},
					}
				},
			}

			Ok(())
		}

		/// Withdraw all available tokens from the account associated with the MSA, to the account of the caller.
		///
		/// The `origin` parameter represents the account from which the function is called and must be the account receiving the tokens.
		///
		/// The function requires one signature: `msa_owner_proof`, which serve as proof that the owner of the MSA authorizes the transaction.
		///
		/// The necessary information for the withdrawal authorization, the destination account and the MSA ID, are contained in the `authorization_payload` parameter of type [AddKeyData].
		/// It also contains an expiration block number for the proof, ensuring it is valid and must be greater than the current block.
		///
		/// # Events
		/// * [`pallet_balances::Event::<T,I>::Transfer`](https://docs.rs/pallet-balances/latest/pallet_balances/pallet/enum.Event.html#variant.Transfer) - Transfer token event
		///
		/// # Errors
		///
		/// * [`Error::ProofHasExpired`] - the current block is less than the `expired` block number set in `AddKeyData`.
		/// * [`Error::ProofNotYetValid`] - the `expired` block number set in `AddKeyData` is greater than the current block number plus mortality_block_limit().
		/// * [`Error::SignatureAlreadySubmitted`] - signature has already been used.
		/// * [`Error::InsufficientBalanceToWithdraw`] - the MSA account has not balance to withdraw
		/// * [`Error::UnexpectedTokenTransferError`] - the token transfer failed
		///
		#[pallet::call_index(14)]
		#[pallet::weight((T::WeightInfo::withdraw_tokens(), DispatchClass::Normal, Pays::No))]
		pub fn withdraw_tokens(
			origin: OriginFor<T>,
			_msa_owner_public_key: T::AccountId,
			msa_owner_proof: MultiSignature,
			authorization_payload: AuthorizedKeyData<T>,
		) -> DispatchResult {
			let public_key = ensure_signed(origin)?;

			Self::register_signature(&msa_owner_proof, authorization_payload.expiration)?;

			let msa_id = authorization_payload.msa_id;

			// - Get account address for MSA
			let msa_address = Self::msa_id_to_eth_address(msa_id);

			// - Convert to AccountId
			let mut bytes = &EthereumAddressMapper::to_bytes32(&msa_address.0)[..];
			let msa_account_id = T::AccountId::decode(&mut bytes).map_err(|_| {
				log::error!("Failed to decode MSA account ID from Ethereum address");
				Error::<T>::NoKeyExists
			})?;

			// Get balance to transfer
			let msa_balance = T::Currency::reducible_balance(
				&msa_account_id,
				Preservation::Expendable,
				Fortitude::Polite,
			);
			ensure!(msa_balance > Zero::zero(), Error::<T>::InsufficientBalanceToWithdraw);

			// Transfer balance to the caller
			let result = <T as pallet::Config>::Currency::transfer(
				&msa_account_id,
				&public_key,
				msa_balance,
				Preservation::Expendable,
			);
			ensure!(result.is_ok(), Error::<T>::UnexpectedTokenTransferError);

			Ok(())
		}

		/// Adds a Recovery Commitment to an MSA. The Recovery Commitment is a cryptographic commitment
		/// that can be used later in a recovery process to prove ownership or authorization.
		///
		/// This function allows the owner of an MSA to create a Recovery Commitment hash that is stored
		/// on-chain. The commitment must be signed by the MSA owner to prove authorization.
		///
		/// # Remarks
		/// * The `origin` can be any signed account but the `msa_owner_key` must be the actual owner
		/// * Signatures should be over the [`RecoveryCommitmentPayload`] struct
		/// * The Recovery Commitment is stored as a hash mapping from MSA ID to commitment value
		///
		/// # Events
		/// * [`Event::RecoveryCommitmentAdded`]
		///
		/// # Errors
		/// * [`Error::InvalidSignature`] - `proof` verification fails; `msa_owner_key` must have signed `payload`
		/// * [`Error::NoKeyExists`] - there is no MSA for `msa_owner_key`
		/// * [`Error::ProofNotYetValid`] - `payload` expiration is too far in the future
		/// * [`Error::ProofHasExpired`] - `payload` expiration is in the past
		/// * [`Error::SignatureAlreadySubmitted`] - signature has already been used
		///
		#[pallet::call_index(15)]
		#[pallet::weight(T::WeightInfo::add_recovery_commitment())]
		pub fn add_recovery_commitment(
			origin: OriginFor<T>,
			msa_owner_key: T::AccountId,
			proof: MultiSignature,
			payload: RecoveryCommitmentPayload<T>,
		) -> DispatchResult {
			let _origin_key = ensure_signed(origin)?;

			// Verify that the MsaId owner has signed the payload
			ensure!(
				Self::verify_signature(&proof, &msa_owner_key, &payload),
				Error::<T>::InvalidSignature
			);

			// Register the signature to prevent replay attacks
			Self::register_signature(&proof, payload.expiration)?;

			// Recover the MSA ID from the msa_owner_key
			let msa_id = Self::ensure_valid_msa_key(&msa_owner_key)?;

			// Store the new RecoveryCommitment
			MsaIdToRecoveryCommitment::<T>::insert(msa_id, payload.recovery_commitment);
			Self::deposit_event(Event::RecoveryCommitmentAdded {
				who: msa_owner_key,
				msa_id,
				recovery_commitment: payload.recovery_commitment,
			});

			Ok(())
		}

		/// Approves a recovery provider via governance.
		/// Only governance can approve recovery providers.
		///
		/// # Events
		/// * [`Event::RecoveryProviderApproved`]
		///
		/// # Errors
		/// * [`DispatchError::BadOrigin`] - Caller is not authorized to approve recovery providers.
		///
		#[pallet::call_index(16)]
		#[pallet::weight(T::WeightInfo::approve_recovery_provider())]
		pub fn approve_recovery_provider(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
		) -> DispatchResult {
			T::RecoveryProviderApprovalOrigin::ensure_origin(origin)?;

			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);

			// If the provider is already approved, do nothing
			if Self::is_approved_recovery_provider(&ProviderId(provider_msa_id)) {
				return Ok(());
			}

			RecoveryProviders::<T>::insert(ProviderId(provider_msa_id), true);

			Self::deposit_event(Event::RecoveryProviderApproved {
				provider_id: ProviderId(provider_msa_id),
			});

			Ok(())
		}

		/// Removes a recovery provider via governance.
		/// Only governance can remove recovery providers.
		///
		/// # Events
		/// * [`Event::RecoveryProviderRemoved`]
		///
		/// # Errors
		///
		/// * [`DispatchError::BadOrigin`] - Caller is not authorized to remove recovery providers.
		///
		#[pallet::call_index(17)]
		#[pallet::weight(T::WeightInfo::remove_recovery_provider())]
		pub fn remove_recovery_provider(
			origin: OriginFor<T>,
			provider: ProviderId,
		) -> DispatchResult {
			T::RecoveryProviderApprovalOrigin::ensure_origin(origin)?;

			RecoveryProviders::<T>::remove(provider);
			Self::deposit_event(Event::RecoveryProviderRemoved { provider_id: provider });
			Ok(())
		}

		/// Recover an MSA account with a new control key.
		/// This extrinsic is called by approved Recovery Providers after verifying
		/// the user's Recovery Intermediary Hashes and Authentication Contact.
		///
		/// # Events
		/// * [`Event::AccountRecovered`]
		/// * [`Event::RecoveryCommitmentInvalidated`]
		///
		/// # Errors
		/// * [`Error::NotAuthorizedRecoveryProvider`] - Caller is not an approved Recovery Provider.
		/// * [`Error::ProviderNotRegistered`] - Recovery Provider is not registered.
		/// * [`Error::NoRecoveryCommitment`] - No Recovery Commitment exists for the MSA.
		/// * [`Error::InvalidRecoveryCommitment`] - Recovery Commitment does not match.
		///
		#[pallet::call_index(18)]
		#[pallet::weight(T::WeightInfo::recover_account())]
		pub fn recover_account(
			origin: OriginFor<T>,
			intermediary_hash_a: RecoveryHash,
			intermediary_hash_b: RecoveryHash,
			new_control_key_proof: MultiSignature,
			add_key_payload: AddKeyData<T>,
		) -> DispatchResult {
			let provider_key = ensure_signed(origin)?;

			let provider_msa_id = Self::ensure_approved_recovery_provider(&provider_key)?;

			let recovery_commitment = Self::ensure_valid_recovery_commitment(
				intermediary_hash_a,
				intermediary_hash_b,
				add_key_payload.msa_id,
			)?;

			Self::ensure_valid_new_key_owner(&new_control_key_proof, &add_key_payload)?;

			Self::add_key(add_key_payload.msa_id, &add_key_payload.new_public_key.clone())?;

			let event = Event::PublicKeyAdded {
				msa_id: add_key_payload.msa_id,
				key: add_key_payload.new_public_key.clone(),
			};
			offchain_index_event::<T>(Some(&event), add_key_payload.msa_id);
			Self::deposit_event(event);

			// Invalidate the recovery commitment (single-use requirement)
			MsaIdToRecoveryCommitment::<T>::remove(add_key_payload.msa_id);

			// Emit events
			Self::deposit_event(Event::AccountRecovered {
				msa_id: add_key_payload.msa_id,
				recovery_provider: ProviderId(provider_msa_id),
				new_control_key: add_key_payload.new_public_key.clone(),
			});

			Self::deposit_event(Event::RecoveryCommitmentInvalidated {
				msa_id: add_key_payload.msa_id,
				recovery_commitment,
			});

			Ok(())
		}

		/// Propose to be a provider.  Creates a proposal for council approval to create a provider from a MSA
		///
		/// # Errors
		/// - [`NoKeyExists`](Error::NoKeyExists) - If there is not MSA for `origin`.
		#[pallet::call_index(19)]
		#[pallet::weight(T::WeightInfo::propose_to_be_provider_v2())]
		pub fn propose_to_be_provider_v2(
			origin: OriginFor<T>,
			payload: ProviderRegistryEntry<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			let proposer = ensure_signed(origin)?;
			Self::ensure_valid_msa_key(&proposer)?;

			let proposal: Box<T::Proposal> = Box::new(
				(Call::<T>::create_provider_via_governance_v2 {
					provider_key: proposer.clone(),
					payload,
				})
				.into(),
			);
			let threshold = 1;
			T::ProposalProvider::propose(proposer, threshold, proposal)?;
			Ok(())
		}

		/// Create a provider by means of governance approval
		///
		/// # Events
		/// * [`Event::ProviderCreated`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - account does not have an MSA
		/// * [`Error::DuplicateProviderRegistryEntry`] - a ProviderRegistryEntry associated with the given MSA id already exists.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(20)]
		#[pallet::weight(T::WeightInfo::create_provider_via_governance_v2(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn create_provider_via_governance_v2(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
			payload: ProviderRegistryEntry<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			T::CreateProviderViaGovernanceOrigin::ensure_origin(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			Self::ensure_correct_cids(&payload)?;
			Self::upsert_provider_for(provider_msa_id, payload, false)?;
			Self::deposit_event(Event::ProviderCreated {
				provider_id: ProviderId(provider_msa_id),
			});
			Ok(())
		}

		/// Propose to add application enable provider to add multiple applications on frequency.
		/// Provider initiates a governance proposal to add the application.
		///
		/// # Errors
		/// - [`NoKeyExists`](Error::NoKeyExists) - If there is not MSA for `origin`.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(21)]
		#[pallet::weight(T::WeightInfo::propose_to_add_application(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn propose_to_add_application(
			origin: OriginFor<T>,
			payload: ApplicationContext<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			let proposer = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&proposer)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			let proposal: Box<T::Proposal> = Box::new(
				(Call::<T>::create_application_via_governance {
					provider_key: proposer.clone(),
					payload,
				})
				.into(),
			);
			let threshold = 1;
			T::ProposalProvider::propose(proposer, threshold, proposal)?;
			Ok(())
		}

		/// Create application via governance approval
		///
		/// # Events
		/// * [`Event::ApplicationCreated`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - account does not have an MSA
		/// * [`Error::DuplicateApplicationRegistryEntry`] - an ApplicationRegistryEntry associated with the given MSA id already exists.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(22)]
		#[pallet::weight(T::WeightInfo::create_application_via_governance(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn create_application_via_governance(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
			payload: ApplicationContext<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			T::CreateProviderViaGovernanceOrigin::ensure_origin(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			Self::ensure_correct_cids(&payload)?;
			let application_id =
				Self::create_application_for(ProviderId(provider_msa_id), payload)?;
			Self::deposit_event(Event::ApplicationCreated {
				provider_id: ProviderId(provider_msa_id),
				application_id,
			});
			Ok(())
		}

		/// Upload logo bytes for a approved image in `ApprovedLogos`
		///
		/// * [`Error::NoKeyExists`] - If there is not MSA for `origin`.
		/// * [`Error::ProviderNotRegistered`] - If the provider is not registered.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid and not in approved logos.
		/// * [`Error::LogoCidNotApproved`] - If the logo CID is not in the approved logos list.
		///
		#[pallet::call_index(23)]
		#[pallet::weight(T::WeightInfo::upload_logo())]
		pub fn upload_logo(
			origin: OriginFor<T>,
			logo_cid: BoundedVec<u8, T::MaxLogoCidSize>,
			logo_bytes: BoundedVec<u8, T::MaxLogoSize>,
		) -> DispatchResult {
			let provider_key = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			ensure!(ApprovedLogos::<T>::contains_key(&logo_cid), Error::<T>::LogoCidNotApproved);

			let input_cid_binary = Self::validate_cid(&logo_cid)?;
			let computed_cid_binary =
				compute_cid_v1(logo_bytes.as_slice()).ok_or(Error::<T>::InvalidLogoBytes)?;
			ensure!(input_cid_binary == computed_cid_binary, Error::<T>::InvalidLogoBytes);
			ApprovedLogos::<T>::insert(&logo_cid, logo_bytes);

			Self::deposit_event(Event::ApplicationContextUpdated {
				provider_id: ProviderId(provider_msa_id),
				application_id: None,
			});
			Ok(())
		}

		/// Update a provider by means of governance approval
		///
		/// # Events
		/// * [`Event::ProviderUpdated`]
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - account does not have an MSA
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(24)]
		#[pallet::weight(T::WeightInfo::update_provider_via_governance(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		#[allow(clippy::useless_conversion)]
		pub fn update_provider_via_governance(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
			payload: ProviderRegistryEntry<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResultWithPostInfo {
			T::CreateProviderViaGovernanceOrigin::ensure_origin(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			Self::ensure_correct_cids(&payload)?;
			let base_weight = T::WeightInfo::update_provider_via_governance(
				payload.localized_names.len() as u32,
				payload.localized_logo_250_100_png_cids.len() as u32,
			);
			let total_logos_removed = Self::upsert_provider_for(provider_msa_id, payload, true)?;
			Self::deposit_event(Event::ProviderUpdated {
				provider_id: ProviderId(provider_msa_id),
			});
			Self::refund_logo_removal_weight_by_count(total_logos_removed, base_weight)
		}

		/// Propose to update provider registry via governance
		///
		/// # Arguments
		/// * `origin` - The origin of the call
		/// * `provider_key` - The key of the provider to update
		/// * `payload` - The new provider data
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - If there is not MSA for `origin`.
		/// * [`Error::ProviderNotRegistered`] - If the provider is not registered.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(25)]
		#[pallet::weight(T::WeightInfo::propose_to_update_provider(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn propose_to_update_provider(
			origin: OriginFor<T>,
			payload: ProviderRegistryEntry<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			let proposer = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&proposer)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			let proposal: Box<T::Proposal> = Box::new(
				(Call::<T>::update_provider_via_governance {
					provider_key: proposer.clone(),
					payload,
				})
				.into(),
			);
			let threshold = 1;
			T::ProposalProvider::propose(proposer, threshold, proposal)?;
			Ok(())
		}

		/// Update application via governance for given existing `ApplicationIndex`
		///
		/// # Arguments
		/// * `origin` - The origin of the call
		/// * `provider_key` - The key of the provider to update
		/// * `application_index` - The index of the application to update
		/// * `payload` - The new application data
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - If there is not MSA for `origin`.
		/// * [`Error::ApplicationNotFound`] - If the application is not registered.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		#[pallet::call_index(26)]
		#[pallet::weight(T::WeightInfo::update_application_via_governance(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		#[allow(clippy::useless_conversion)]
		pub fn update_application_via_governance(
			origin: OriginFor<T>,
			provider_key: T::AccountId,
			application_index: ApplicationIndex,
			payload: ApplicationContext<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResultWithPostInfo {
			T::CreateProviderViaGovernanceOrigin::ensure_origin(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_key)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			Self::ensure_correct_cids(&payload)?;
			let base_weight = T::WeightInfo::update_application_via_governance(
				payload.localized_names.len() as u32,
				payload.localized_logo_250_100_png_cids.len() as u32,
			);
			let total_logos_removed = Self::upsert_application_for(
				ProviderId(provider_msa_id),
				application_index,
				payload,
			)?;
			Self::deposit_event(Event::ApplicationContextUpdated {
				provider_id: ProviderId(provider_msa_id),
				application_id: Some(application_index),
			});
			Self::refund_logo_removal_weight_by_count(total_logos_removed, base_weight)
		}

		/// Propose to update application via governance for a given `ApplicationIndex`
		///
		/// # Arguments
		/// * `origin` - The origin of the call
		/// * `application_index` - The index of the application to update
		/// * `payload` - The new application data
		///
		/// # Errors
		/// * [`Error::NoKeyExists`] - If there is not MSA for `origin`.
		/// * [`Error::ApplicationNotFound`] - If the application is not registered.
		/// * [`Error::InvalidCid`] - If the provided CID is invalid.
		/// * [`Error::InvalidBCP47LanguageCode`] - If the provided BCP 47 language code is invalid.
		/// * [`Error::ApplicationNotFound`] - If the application is not registered.
		#[pallet::call_index(27)]
		#[pallet::weight(T::WeightInfo::propose_to_update_application(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn propose_to_update_application(
			origin: OriginFor<T>,
			application_index: ApplicationIndex,
			payload: ApplicationContext<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			let proposer = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&proposer)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			ensure!(
				ProviderToApplicationRegistry::<T>::contains_key(
					ProviderId(provider_msa_id),
					application_index
				),
				Error::<T>::ApplicationNotFound
			);
			Self::ensure_correct_cids(&payload)?;
			let proposal: Box<T::Proposal> = Box::new(
				(Call::<T>::update_application_via_governance {
					provider_key: proposer.clone(),
					application_index,
					payload,
				})
				.into(),
			);
			let threshold = 1;
			T::ProposalProvider::propose(proposer, threshold, proposal)?;
			Ok(())
		}

		/// Create application allows creating an application registry without governance
		/// This call is blocked in release mode
		#[pallet::call_index(28)]
		#[pallet::weight(T::WeightInfo::create_application_via_governance(
			payload.localized_names.len() as u32,
			payload.localized_logo_250_100_png_cids.len() as u32,
		))]
		pub fn create_application(
			origin: OriginFor<T>,
			payload: ApplicationContext<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		) -> DispatchResult {
			let provider_account = ensure_signed(origin)?;
			let provider_msa_id = Self::ensure_valid_msa_key(&provider_account)?;
			ensure!(
				Self::is_registered_provider(provider_msa_id),
				Error::<T>::ProviderNotRegistered
			);
			Self::ensure_correct_cids(&payload)?;
			let application_id =
				Self::create_application_for(ProviderId(provider_msa_id), payload)?;
			Self::deposit_event(Event::ApplicationCreated {
				provider_id: ProviderId(provider_msa_id),
				application_id,
			});
			Ok(())
		}
	}
}

impl<T: Config> Pallet<T> {
	/// Check if a recovery provider is approved
	///
	/// # Arguments
	/// * `provider`: The provider to check
	///
	/// # Returns
	/// * [`bool`] - True if the provider is approved, false otherwise
	pub fn is_approved_recovery_provider(provider: &ProviderId) -> bool {
		RecoveryProviders::<T>::get(provider).unwrap_or(false)
	}

	/// Compute the Recovery Commitment from Intermediary Hashes
	///
	/// # Arguments
	/// * `intermediary_hash_a`: Hash of the Recovery Secret
	/// * `intermediary_hash_b`: Hash of the Recovery Secret + Authentication Contact
	///
	/// # Returns
	/// * [`RecoveryCommitment`] - The computed Recovery Commitment
	pub fn compute_recovery_commitment(
		intermediary_hash_a: RecoveryHash,
		intermediary_hash_b: RecoveryHash,
	) -> RecoveryCommitment {
		let mut input = Vec::with_capacity(64);
		input.extend_from_slice(&intermediary_hash_a);
		input.extend_from_slice(&intermediary_hash_b);
		keccak_256(&input)
	}

	/// Ensure that the provider is approved for recovery operations
	///
	/// # Arguments
	/// * `provider_key`: The provider's account key
	///
	/// # Returns
	/// * [`MessageSourceId`] - The provider's MSA ID if approved
	///
	/// # Errors
	/// * [`Error::NoKeyExists`] - Provider key is not associated with an MSA
	/// * [`Error::NotAuthorizedRecoveryProvider`] - Provider is not approved for recovery
	fn ensure_approved_recovery_provider(
		provider_key: &T::AccountId,
	) -> Result<MessageSourceId, DispatchError> {
		let provider_msa_id = Self::ensure_valid_msa_key(provider_key)?;

		ensure!(
			Self::is_approved_recovery_provider(&ProviderId(provider_msa_id)),
			Error::<T>::NotAuthorizedRecoveryProvider
		);

		Ok(provider_msa_id)
	}

	/// Ensure that the recovery commitment is valid
	///
	/// # Arguments
	/// * `intermediary_hash_a`: Hash of the Recovery Secret
	/// * `intermediary_hash_b`: Hash of the Recovery Secret + Authentication Contact
	/// * `msa_id`: The MSA ID to verify the commitment for
	///
	/// # Returns
	/// * [`RecoveryCommitment`] - The validated recovery commitment
	///
	/// # Errors
	/// * [`Error::NoRecoveryCommitment`] - No Recovery Commitment exists for the MSA
	/// * [`Error::InvalidRecoveryCommitment`] - Recovery Commitment does not match
	fn ensure_valid_recovery_commitment(
		intermediary_hash_a: RecoveryHash,
		intermediary_hash_b: RecoveryHash,
		msa_id: MessageSourceId,
	) -> Result<RecoveryCommitment, DispatchError> {
		let recovery_commitment: RecoveryCommitment =
			Self::compute_recovery_commitment(intermediary_hash_a, intermediary_hash_b);

		let stored_commitment: RecoveryCommitment =
			MsaIdToRecoveryCommitment::<T>::get(msa_id).ok_or(Error::<T>::NoRecoveryCommitment)?;

		ensure!(recovery_commitment == stored_commitment, Error::<T>::InvalidRecoveryCommitment);

		Ok(recovery_commitment)
	}

	/// Ensure that the new key owner signature is valid
	///
	/// # Arguments
	/// * `new_control_key_proof`: Signature proof from the new control key
	/// * `add_key_payload`: Payload containing the new key and related data
	///
	/// # Errors
	/// * [`Error::NewKeyOwnershipInvalidSignature`] - Invalid signature from new key owner
	/// * [`Error::SignatureAlreadySubmitted`] - Signature has already been used
	fn ensure_valid_new_key_owner(
		new_control_key_proof: &MultiSignature,
		add_key_payload: &AddKeyData<T>,
	) -> DispatchResult {
		// The original MSA owner key is not available, therefore we cannot reuse the `add_public_key_to_msa` logic
		// to verify the signatures, only the new control key signature is verified.
		ensure!(
			Self::verify_signature(
				new_control_key_proof,
				&add_key_payload.new_public_key,
				add_key_payload
			),
			Error::<T>::NewKeyOwnershipInvalidSignature
		);
		Self::register_signature(new_control_key_proof, add_key_payload.expiration)?;

		Ok(())
	}

	/// Create the account for the `key`
	///
	/// # Errors
	/// * [`Error::MsaIdOverflow`]
	/// * [`Error::KeyLimitExceeded`]
	/// * [`Error::KeyAlreadyRegistered`]
	///
	pub fn create_account(
		key: T::AccountId,
	) -> Result<(MessageSourceId, T::AccountId), DispatchError> {
		let next_msa_id = Self::get_next_msa_id()?;
		Self::add_key(next_msa_id, &key)?;
		let _ = Self::set_msa_identifier(next_msa_id);

		Ok((next_msa_id, key))
	}

	/// Generate the next MSA Id
	///
	/// # Errors
	/// * [`Error::MsaIdOverflow`]
	///
	pub fn get_next_msa_id() -> Result<MessageSourceId, DispatchError> {
		let next = CurrentMsaIdentifierMaximum::<T>::get()
			.checked_add(1)
			.ok_or(Error::<T>::MsaIdOverflow)?;

		Ok(next)
	}

	/// Set the current identifier in storage
	pub fn set_msa_identifier(identifier: MessageSourceId) -> DispatchResult {
		CurrentMsaIdentifierMaximum::<T>::set(identifier);

		Ok(())
	}

	/// Create Register Provider
	pub fn create_registered_provider(
		provider_id: ProviderId,
		payload: ProviderRegistryEntry<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
	) -> DispatchResult {
		ProviderToRegistryEntryV2::<T>::try_mutate(
			provider_id,
			|maybe_metadata| -> DispatchResult {
				ensure!(
					maybe_metadata.take().is_none(),
					Error::<T>::DuplicateProviderRegistryEntry
				);
				*maybe_metadata = Some(payload);
				Ok(())
			},
		)
	}

	/// Adds a list of schema permissions to a delegation relationship.
	pub fn grant_permissions_for_schemas(
		delegator_id: DelegatorId,
		provider_id: ProviderId,
		schema_ids: Vec<SchemaId>,
	) -> DispatchResult {
		Self::try_mutate_delegation(delegator_id, provider_id, |delegation, is_new_delegation| {
			ensure!(!is_new_delegation, Error::<T>::DelegationNotFound);
			Self::ensure_all_schema_ids_are_valid(&schema_ids)?;

			PermittedDelegationSchemas::<T>::try_insert_schemas(delegation, schema_ids)?;

			Ok(())
		})
	}

	/// Revokes a list of schema permissions from a delegation relationship.
	pub fn revoke_permissions_for_schemas(
		delegator_id: DelegatorId,
		provider_id: ProviderId,
		schema_ids: Vec<SchemaId>,
	) -> DispatchResult {
		Self::try_mutate_delegation(delegator_id, provider_id, |delegation, is_new_delegation| {
			ensure!(!is_new_delegation, Error::<T>::DelegationNotFound);
			Self::ensure_all_schema_ids_are_valid(&schema_ids)?;

			let current_block = frame_system::Pallet::<T>::block_number();

			PermittedDelegationSchemas::<T>::try_get_mut_schemas(
				delegation,
				schema_ids,
				current_block,
			)?;

			Ok(())
		})
	}

	/// Add a new key to the MSA
	///
	/// # Errors
	/// * [`Error::KeyLimitExceeded`]
	/// * [`Error::KeyAlreadyRegistered`]
	///
	pub fn add_key(msa_id: MessageSourceId, key: &T::AccountId) -> DispatchResult {
		PublicKeyToMsaId::<T>::try_mutate(key, |maybe_msa_id| {
			ensure!(maybe_msa_id.is_none(), Error::<T>::KeyAlreadyRegistered);
			*maybe_msa_id = Some(msa_id);

			// Increment the key counter
			<PublicKeyCountForMsaId<T>>::try_mutate(msa_id, |key_count| {
				// key_count:u8 should default to 0 if it does not exist
				let incremented_key_count =
					key_count.checked_add(1).ok_or(ArithmeticError::Overflow)?;

				ensure!(
					incremented_key_count <= T::MaxPublicKeysPerMsa::get(),
					Error::<T>::KeyLimitExceeded
				);

				*key_count = incremented_key_count;
				Ok(())
			})
		})
	}

	/// Check that schema ids are all valid
	///
	/// # Errors
	/// * [`Error::InvalidSchemaId`]
	/// * [`Error::ExceedsMaxSchemaGrantsPerDelegation`]
	///
	pub fn ensure_all_schema_ids_are_valid(schema_ids: &[SchemaId]) -> DispatchResult {
		ensure!(
			schema_ids.len() <= T::MaxSchemaGrantsPerDelegation::get() as usize,
			Error::<T>::ExceedsMaxSchemaGrantsPerDelegation
		);

		let are_schemas_valid = T::SchemaValidator::are_all_schema_ids_valid(schema_ids);

		ensure!(are_schemas_valid, Error::<T>::InvalidSchemaId);

		Ok(())
	}

	/// Returns if provider is registered by checking if the [`ProviderToRegistryEntryV2`] contains the MSA id
	pub fn is_registered_provider(msa_id: MessageSourceId) -> bool {
		ProviderToRegistryEntryV2::<T>::contains_key(ProviderId(msa_id))
	}

	/// Checks that a provider and delegator keys are valid
	/// and that a provider and delegator are not the same
	/// and that a provider has authorized a delegator to create a delegation relationship.
	///
	/// # Errors
	/// * [`Error::ProviderNotRegistered`]
	/// * [`Error::InvalidSelfProvider`]
	/// * [`Error::NoKeyExists`]
	///
	pub fn ensure_valid_registered_provider(
		delegator_key: &T::AccountId,
		provider_key: &T::AccountId,
	) -> Result<(ProviderId, DelegatorId), DispatchError> {
		let provider_msa_id = Self::ensure_valid_msa_key(provider_key)?;
		let delegator_msa_id = Self::ensure_valid_msa_key(delegator_key)?;

		// Ensure that the delegator is not the provider.  You cannot delegate to yourself.
		ensure!(delegator_msa_id != provider_msa_id, Error::<T>::InvalidSelfProvider);

		// Verify that the provider is a registered provider
		ensure!(Self::is_registered_provider(provider_msa_id), Error::<T>::ProviderNotRegistered);

		Ok((provider_msa_id.into(), delegator_msa_id.into()))
	}

	/// Checks that the MSA for `who` is the same as `msa_id`
	///
	/// # Errors
	/// * [`Error::NotMsaOwner`]
	/// * [`Error::NoKeyExists`]
	///
	pub fn ensure_msa_owner(who: &T::AccountId, msa_id: MessageSourceId) -> DispatchResult {
		let provider_msa_id = Self::ensure_valid_msa_key(who)?;
		ensure!(provider_msa_id == msa_id, Error::<T>::NotMsaOwner);

		Ok(())
	}

	/// Verify the `signature` was signed by `signer` on `payload` by a wallet
	/// Note the `wrap_binary_data` follows the Polkadot wallet pattern of wrapping with `<Byte>` tags.
	///
	/// # Errors
	/// * [`Error::InvalidSignature`]
	///
	pub fn verify_signature<P>(
		signature: &MultiSignature,
		signer: &T::AccountId,
		payload: &P,
	) -> bool
	where
		P: Encode + EIP712Encode,
	{
		let key = T::ConvertIntoAccountId32::convert((*signer).clone());

		check_signature(signature, key, payload)
	}

	/// Add a provider to a delegator with the default permissions
	///
	/// # Errors
	/// * [`Error::ExceedsMaxSchemaGrantsPerDelegation`]
	///
	pub fn add_provider(
		provider_id: ProviderId,
		delegator_id: DelegatorId,
		schema_ids: Vec<SchemaId>,
	) -> DispatchResult {
		Self::try_mutate_delegation(delegator_id, provider_id, |delegation, is_new_delegation| {
			ensure!(is_new_delegation, Error::<T>::DuplicateProvider);
			Self::ensure_all_schema_ids_are_valid(&schema_ids)?;

			PermittedDelegationSchemas::<T>::try_insert_schemas(delegation, schema_ids)?;

			Ok(())
		})
	}

	/// Modify delegation's schema permissions
	///
	/// # Errors
	/// * [`Error::ExceedsMaxSchemaGrantsPerDelegation`]
	pub fn upsert_schema_permissions(
		provider_id: ProviderId,
		delegator_id: DelegatorId,
		schema_ids: Vec<SchemaId>,
	) -> DispatchResult {
		Self::try_mutate_delegation(delegator_id, provider_id, |delegation, _is_new_delegation| {
			Self::ensure_all_schema_ids_are_valid(&schema_ids)?;

			// Create revoke and insert lists
			let mut revoke_ids: Vec<SchemaId> = Vec::new();
			let mut update_ids: Vec<SchemaId> = Vec::new();
			let mut insert_ids: Vec<SchemaId> = Vec::new();

			let existing_keys = delegation.schema_permissions.keys();

			for existing_schema_id in existing_keys {
				if !schema_ids.contains(existing_schema_id) {
					if let Some(block) = delegation.schema_permissions.get(existing_schema_id) {
						if *block == BlockNumberFor::<T>::zero() {
							revoke_ids.push(*existing_schema_id);
						}
					}
				}
			}
			for schema_id in &schema_ids {
				if !delegation.schema_permissions.contains_key(schema_id) {
					insert_ids.push(*schema_id);
				} else {
					update_ids.push(*schema_id);
				}
			}

			let current_block = frame_system::Pallet::<T>::block_number();

			// Revoke any that are not in the new list that are not already revoked
			PermittedDelegationSchemas::<T>::try_get_mut_schemas(
				delegation,
				revoke_ids,
				current_block,
			)?;

			// Update any that are in the list but are not new
			PermittedDelegationSchemas::<T>::try_get_mut_schemas(
				delegation,
				update_ids,
				BlockNumberFor::<T>::zero(),
			)?;

			// Insert any new ones that are not in the existing list
			PermittedDelegationSchemas::<T>::try_insert_schemas(delegation, insert_ids)?;
			delegation.revoked_at = BlockNumberFor::<T>::zero();
			Ok(())
		})
	}

	/// Adds an association between MSA id and ProviderRegistryEntry. As of now, the
	/// only piece of metadata we are recording is provider name.
	///
	/// # Errors
	/// * [`Error::DuplicateProviderRegistryEntry`] - a ProviderRegistryEntry associated with the given MSA id already exists.
	///
	pub fn upsert_provider_for(
		provider_msa_id: MessageSourceId,
		payload: ProviderRegistryEntry<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
		is_update: bool,
	) -> Result<u32, DispatchError> {
		let mut total_logos_removed = 0;
		ProviderToRegistryEntryV2::<T>::try_mutate(
			ProviderId(provider_msa_id),
			|maybe_metadata| -> DispatchResult {
				if !is_update {
					ensure!(
						maybe_metadata.take().is_none(),
						Error::<T>::DuplicateProviderRegistryEntry
					);
				} else {
					total_logos_removed = Self::remove_logo_storage(maybe_metadata.as_ref())?;
				}
				Self::update_logo_storage(&payload)?;

				*maybe_metadata = Some(payload);
				Ok(())
			},
		)
		.map(|_| total_logos_removed)
	}

	/// Adds an association between Provider MSA id and ProviderToApplicationRegistryEntry
	///
	/// # Errors
	/// * [`Error::DuplicateApplicationRegistryEntry`] - a ProviderToApplicationRegistryEntry associated with the given Provider MSA id already exists.
	pub fn create_application_for(
		provider_msa_id: ProviderId,
		payload: ApplicationContext<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
	) -> Result<ApplicationIndex, DispatchError> {
		Self::update_logo_storage(&payload)?;
		let next_application_index = NextApplicationIndex::<T>::get(provider_msa_id);
		ensure!(
			!ProviderToApplicationRegistry::<T>::contains_key(
				provider_msa_id,
				next_application_index
			),
			Error::<T>::DuplicateApplicationRegistryEntry
		);
		ProviderToApplicationRegistry::<T>::insert(
			provider_msa_id,
			next_application_index,
			payload,
		);
		NextApplicationIndex::<T>::insert(provider_msa_id, next_application_index + 1);
		Ok(next_application_index)
	}

	/// Updates an existing application from `ProviderToApplicationRegistry`
	///
	/// # Errors
	/// * [`Error::ApplicationNotFound`]
	pub fn upsert_application_for(
		provider_msa_id: ProviderId,
		application_index: ApplicationIndex,
		payload: ApplicationContext<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
	) -> Result<u32, DispatchError> {
		ensure!(
			ProviderToApplicationRegistry::<T>::contains_key(provider_msa_id, application_index),
			Error::<T>::ApplicationNotFound
		);
		let mut total_logos_removed = 0;
		ProviderToApplicationRegistry::<T>::try_mutate(
			provider_msa_id,
			application_index,
			|maybe_metadata| -> DispatchResult {
				total_logos_removed = Self::remove_logo_storage(maybe_metadata.as_ref())?;
				Self::update_logo_storage(&payload)?;
				*maybe_metadata = Some(payload);
				Ok(())
			},
		)
		.map(|_| total_logos_removed)
	}

	/// Mutates the delegation relationship storage item only when the supplied function returns an 'Ok()' result.
	/// The callback function 'f' takes the value (a delegation) and a reference to a boolean variable. This callback
	/// sets the boolean variable to 'true' if the value is to be inserted and to 'false' if it is to be updated.
	pub fn try_mutate_delegation<R, E: From<DispatchError>>(
		delegator_id: DelegatorId,
		provider_id: ProviderId,
		f: impl FnOnce(
			&mut Delegation<SchemaId, BlockNumberFor<T>, T::MaxSchemaGrantsPerDelegation>,
			bool,
		) -> Result<R, E>,
	) -> Result<R, E> {
		DelegatorAndProviderToDelegation::<T>::try_mutate_exists(
			delegator_id,
			provider_id,
			|maybe_delegation_info| {
				let is_new = maybe_delegation_info.is_none();
				let mut delegation = maybe_delegation_info.take().unwrap_or_default();

				let result = f(&mut delegation, is_new)?;

				// only set the value if execution of 'f' is successful
				*maybe_delegation_info = Some(delegation);
				Ok(result)
			},
		)
	}

	/// Deletes a key associated with a given MSA
	///
	/// # Errors
	/// * [`Error::NoKeyExists`]
	///
	pub fn delete_key_for_msa(msa_id: MessageSourceId, key: &T::AccountId) -> DispatchResult {
		PublicKeyToMsaId::<T>::try_mutate_exists(key, |maybe_msa_id| {
			ensure!(maybe_msa_id.is_some(), Error::<T>::NoKeyExists);

			// Delete the key if it exists
			*maybe_msa_id = None;

			<PublicKeyCountForMsaId<T>>::try_mutate_exists(msa_id, |key_count| {
				match key_count {
					Some(1) => *key_count = None,
					Some(count) => *count = *count - 1u8,
					None => (),
				}

				Ok(())
			})
		})
	}

	/// Revoke the grant for permissions from the delegator to the provider
	///
	/// # Errors
	/// * [`Error::DelegationRevoked`]
	/// * [`Error::DelegationNotFound`]
	///
	pub fn revoke_provider(provider_id: ProviderId, delegator_id: DelegatorId) -> DispatchResult {
		DelegatorAndProviderToDelegation::<T>::try_mutate_exists(
			delegator_id,
			provider_id,
			|maybe_info| -> DispatchResult {
				let mut info = maybe_info.take().ok_or(Error::<T>::DelegationNotFound)?;

				ensure!(
					info.revoked_at == BlockNumberFor::<T>::default(),
					Error::<T>::DelegationRevoked
				);

				let current_block = frame_system::Pallet::<T>::block_number();
				info.revoked_at = current_block;
				*maybe_info = Some(info);
				Ok(())
			},
		)?;

		Ok(())
	}

	/// Retrieves the MSA Id for a given `AccountId`
	pub fn get_owner_of(key: &T::AccountId) -> Option<MessageSourceId> {
		PublicKeyToMsaId::<T>::get(key)
	}

	/// Retrieve MSA Id associated with `key` or return `NoKeyExists`
	pub fn ensure_valid_msa_key(key: &T::AccountId) -> Result<MessageSourceId, DispatchError> {
		let msa_id = PublicKeyToMsaId::<T>::get(key).ok_or(Error::<T>::NoKeyExists)?;
		Ok(msa_id)
	}

	/// Get a list of Schema Ids that a provider has been granted access to
	///
	/// # Errors
	/// * [`Error::DelegationNotFound`]
	/// * [`Error::SchemaNotGranted`]
	///
	pub fn get_granted_schemas_by_msa_id(
		delegator: DelegatorId,
		provider: Option<ProviderId>,
	) -> Result<Vec<DelegationResponse<SchemaId, BlockNumberFor<T>>>, DispatchError> {
		let delegations = match provider {
			Some(provider_id) => vec![(
				provider_id,
				Self::get_delegation_of(delegator, provider_id)
					.ok_or(Error::<T>::DelegationNotFound)?,
			)],
			None => DelegatorAndProviderToDelegation::<T>::iter_prefix(delegator).collect(),
		};

		let mut result = vec![];
		for (provider_id, provider_info) in delegations {
			let schema_permissions = provider_info.schema_permissions;
			// checking only if this is called for a specific provider
			if provider.is_some() && schema_permissions.is_empty() {
				return Err(Error::<T>::SchemaNotGranted.into());
			}

			let mut schema_list = Vec::new();
			for (schema_id, revoked_at) in schema_permissions {
				if provider_info.revoked_at > BlockNumberFor::<T>::zero() &&
					(revoked_at > provider_info.revoked_at ||
						revoked_at == BlockNumberFor::<T>::zero())
				{
					schema_list
						.push(SchemaGrant { schema_id, revoked_at: provider_info.revoked_at });
				} else {
					schema_list.push(SchemaGrant { schema_id, revoked_at });
				}
			}

			result.push(DelegationResponse { provider_id, permissions: schema_list });
		}

		Ok(result)
	}

	/// Converts an MSA ID into a synthetic Ethereum address (raw 20-byte format) by
	/// taking the last 20 bytes of the keccak256 hash of the following:
	/// [0..1]: 0xD9 (first byte of the keccak256 hash of the domain prefix "Frequency")
	/// [1..9]:   u64 (big endian)
	/// [9..41]:  keccack256("MSA Generated")
	pub fn msa_id_to_eth_address(id: MessageSourceId) -> H160 {
		/// First byte of the keccak256 hash of the domain prefix "Frequency"
		/// This "domain separator" ensures that the generated address will not collide with Ethereum addresses
		/// generated by the standard 'CREATE2' opcode.
		const DOMAIN_PREFIX: u8 = 0xD9;

		lazy_static! {
			/// Salt used to generate MSA addresses
			static ref MSA_ADDRESS_SALT: [u8; 32] = keccak_256(b"MSA Generated");
		}
		let input_value = id.to_be_bytes();

		let mut hash_input = [0u8; 41];
		hash_input[0] = DOMAIN_PREFIX;
		hash_input[1..9].copy_from_slice(&input_value);
		hash_input[9..].copy_from_slice(&(*MSA_ADDRESS_SALT));

		let hash = keccak_256(&hash_input);
		H160::from_slice(&hash[12..])
	}

	/// Returns a boolean indicating whether the given Ethereum address was generated from the given MSA ID.
	pub fn validate_eth_address_for_msa(address: &H160, msa_id: MessageSourceId) -> bool {
		let generated_address = Self::msa_id_to_eth_address(msa_id);
		*address == generated_address
	}

	/// Converts a 20-byte synthetic Ethereum address into a checksummed string format,
	/// using ERC-55 checksum rules.
	/// Formats a 20-byte address into an EIP-55 checksummed `0x...` string.
	pub fn eth_address_to_checksummed_string(address: &H160) -> alloc::string::String {
		let addr_bytes = address.0;
		let addr_hex = hex::encode(addr_bytes);
		let hash = keccak_256(addr_hex.as_bytes());

		let mut result = alloc::string::String::with_capacity(42);
		result.push_str("0x");

		for (i, c) in addr_hex.chars().enumerate() {
			let hash_byte = hash[i / 2];
			let bit = if i % 2 == 0 { (hash_byte >> 4) & 0xf } else { hash_byte & 0xf };

			result.push(if c.is_ascii_hexdigit() && c.is_ascii_alphabetic() {
				if bit >= 8 {
					c.to_ascii_uppercase()
				} else {
					c
				}
			} else {
				c
			});
		}

		result
	}

	/// Adds a signature to the `PayloadSignatureRegistryList`
	/// Check that mortality_block is within bounds. If so, proceed and add the new entry.
	/// Raises `SignatureAlreadySubmitted` if the signature exists in the registry.
	/// Raises `SignatureRegistryLimitExceeded` if the oldest signature of the list has not yet expired.
	///
	/// # Errors
	/// * [`Error::ProofNotYetValid`]
	/// * [`Error::ProofHasExpired`]
	/// * [`Error::SignatureAlreadySubmitted`]
	/// * [`Error::SignatureRegistryLimitExceeded`]
	///
	pub fn register_signature(
		signature: &MultiSignature,
		signature_expires_at: BlockNumberFor<T>,
	) -> DispatchResult {
		let current_block =
			Self::check_signature_against_registry(signature, signature_expires_at)?;

		Self::enqueue_signature(signature, signature_expires_at, current_block)
	}

	/// Check that mortality_block is within bounds.
	/// Raises `SignatureAlreadySubmitted` if the signature exists in the registry.
	///
	/// # Errors
	/// * [`Error::ProofNotYetValid`]
	/// * [`Error::ProofHasExpired`]
	/// * [`Error::SignatureAlreadySubmitted`]
	///
	pub fn check_signature_against_registry(
		signature: &MultiSignature,
		signature_expires_at: BlockNumberFor<T>,
	) -> Result<BlockNumberFor<T>, DispatchError> {
		let current_block: BlockNumberFor<T> = frame_system::Pallet::<T>::block_number();

		let max_lifetime = Self::mortality_block_limit(current_block);
		ensure!(max_lifetime > signature_expires_at, Error::<T>::ProofNotYetValid);
		ensure!(current_block < signature_expires_at, Error::<T>::ProofHasExpired);

		// Make sure it is not in the registry
		ensure!(
			!<PayloadSignatureRegistryList<T>>::contains_key(signature),
			Error::<T>::SignatureAlreadySubmitted
		);
		if let Some(signature_pointer) = PayloadSignatureRegistryPointer::<T>::get() {
			ensure!(signature_pointer.newest != *signature, Error::<T>::SignatureAlreadySubmitted);
		}

		Ok(current_block)
	}

	/// Do the actual enqueuing into the list storage and update the pointer
	///
	/// The signature registry consist of two storage items:
	/// - `PayloadSignatureRegistryList` - a linked list of signatures, in which each entry
	///   points to the next newest signature. The list is stored as a mapping of
	///   `MultiSignature` to a tuple of `(BlockNumberFor<T>, MultiSignature)`.
	///   The tuple contains the expiration block number and the next signature in the list.
	/// - `PayloadSignatureRegistryPointer` - a struct containing the newest signature,
	///   the oldest signature, the count of signatures, and the expiration block number of the newest signature.
	///
	/// NOTE: 'newest' and 'oldest' refer to the order in which the signatures were added to the list,
	/// which is not necessarily the order in which they expire.
	///
	/// Example: (key [signature], value [next newest signature])
	/// - `1,2 (oldest)`
	/// - `2,3`
	/// - `3,4`
	/// - 4 (newest in pointer storage)`
	///
	// DEVELOPER NOTE: As currently implemented, the signature registry list will continue to grow until it reaches
	// the maximum number of signatures, at which point it will remain at that size, only ever replacing the oldest
	// signature with the newest one. This is a trade-off between storage space and performance.
	fn enqueue_signature(
		signature: &MultiSignature,
		signature_expires_at: BlockNumberFor<T>,
		current_block: BlockNumberFor<T>,
	) -> DispatchResult {
		// Get the current pointer, or if this is the initialization, generate an empty pointer
		let pointer =
			PayloadSignatureRegistryPointer::<T>::get().unwrap_or(SignatureRegistryPointer {
				newest: signature.clone(),
				newest_expires_at: signature_expires_at,
				oldest: signature.clone(),
				count: 0,
			});

		// Make sure it is not sitting as the `newest` in the pointer
		ensure!(
			!(pointer.count != 0 && pointer.newest.eq(signature)),
			Error::<T>::SignatureAlreadySubmitted
		);

		// Default to the current oldest signature in case we are still filling up
		let mut oldest: MultiSignature = pointer.oldest.clone();

		// We are now wanting to overwrite prior signatures
		let is_registry_full: bool = pointer.count == T::MaxSignaturesStored::get().unwrap_or(0);

		// Maybe remove the oldest signature and update the oldest
		if is_registry_full {
			let (expire_block_number, next_oldest) =
				PayloadSignatureRegistryList::<T>::get(pointer.oldest.clone())
					.ok_or(Error::<T>::SignatureRegistryCorrupted)?;

			ensure!(
				current_block.gt(&expire_block_number),
				Error::<T>::SignatureRegistryLimitExceeded
			);

			// Move the oldest in the list to the next oldest signature
			oldest = next_oldest.clone();

			<PayloadSignatureRegistryList<T>>::remove(pointer.oldest);
		}

		// Add the newest signature if we are not the first
		if pointer.count != 0 {
			<PayloadSignatureRegistryList<T>>::insert(
				pointer.newest,
				(pointer.newest_expires_at, signature.clone()),
			);
		}

		// Update the pointer.newest to have the signature that just came in
		PayloadSignatureRegistryPointer::<T>::put(SignatureRegistryPointer {
			// The count doesn't change if list is full
			count: if is_registry_full { pointer.count } else { pointer.count + 1 },
			newest: signature.clone(),
			newest_expires_at: signature_expires_at,
			oldest,
		});

		Ok(())
	}

	/// The furthest in the future a mortality_block value is allowed
	/// to be for current_block
	/// This is calculated to be past the risk of a replay attack
	fn mortality_block_limit(current_block: BlockNumberFor<T>) -> BlockNumberFor<T> {
		let mortality_size = T::MortalityWindowSize::get();
		current_block + BlockNumberFor::<T>::from(mortality_size)
	}

	/// Validates a CID to conform to IPFS CIDv1 (or higher) formatting (does not validate decoded CID fields)
	///
	/// # Errors
	/// * [`Error::UnsupportedCidVersion`] - CID version is not supported (V0)
	/// * [`Error::InvalidCid`] - Unable to parse provided CID
	///
	fn validate_cid(in_cid: &[u8]) -> Result<Vec<u8>, DispatchError> {
		// Decode SCALE encoded CID into string slice
		let cid_str: &str = core::str::from_utf8(in_cid).map_err(|_| Error::<T>::InvalidCid)?;
		ensure!(cid_str.len() > 2, Error::<T>::InvalidCid);
		// starts_with handles Unicode multibyte characters safely
		ensure!(!cid_str.starts_with("Qm"), Error::<T>::UnsupportedCidVersion);

		// Assume it's a multibase-encoded string. Decode it to a byte array so we can parse the CID.
		let cid_b = multibase::decode(cid_str).map_err(|_| Error::<T>::InvalidCid)?.1;
		ensure!(Cid::read_bytes(&cid_b[..]).is_ok(), Error::<T>::InvalidCid);

		Ok(cid_b)
	}

	/// Insert default logo and localized logos into storage `ApprovedLogos`
	fn update_logo_storage(
		payload: &ProviderRegistryEntry<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
	) -> DispatchResult {
		// store default logo CID if any
		if !payload.default_logo_250_100_png_cid.is_empty() {
			ApprovedLogos::<T>::insert(
				payload.default_logo_250_100_png_cid.clone(),
				BoundedVec::new(),
			);
		}

		// store localized logos CIDs if any
		for (_, localized_cid) in &payload.localized_logo_250_100_png_cids {
			if !localized_cid.is_empty() {
				ApprovedLogos::<T>::insert(localized_cid, BoundedVec::new());
			}
		}

		Ok(())
	}

	/// Remove default logo and localized logos from storage `ApprovedLogos`
	fn remove_logo_storage(
		existing_payload: Option<
			&ProviderRegistryEntry<
				T::MaxProviderNameSize,
				T::MaxLanguageCodeSize,
				T::MaxLogoCidSize,
				T::MaxLocaleCount,
			>,
		>,
	) -> Result<u32, DispatchError> {
		let mut total_logo_removed = 0;
		if let Some(payload) = existing_payload {
			// remove default logo CID if any
			if !payload.default_logo_250_100_png_cid.is_empty() {
				total_logo_removed += 1;
				ApprovedLogos::<T>::remove(&payload.default_logo_250_100_png_cid);
			}
			// remove localized logos CIDs if any
			for (_, localized_cid) in &payload.localized_logo_250_100_png_cids {
				if !localized_cid.is_empty() {
					total_logo_removed += 1;
					ApprovedLogos::<T>::remove(localized_cid);
				}
			}
		}
		Ok(total_logo_removed)
	}

	/// Checks if cid for logo and localized logos is valid
	fn ensure_correct_cids(
		payload: &ProviderRegistryEntry<
			T::MaxProviderNameSize,
			T::MaxLanguageCodeSize,
			T::MaxLogoCidSize,
			T::MaxLocaleCount,
		>,
	) -> DispatchResult {
		// Validate default logo CID only if non-empty
		if !payload.default_logo_250_100_png_cid.is_empty() {
			Self::validate_cid(&payload.default_logo_250_100_png_cid)?;
		}

		// Validate each localized logo CID only if non-empty
		for (lang_code, localized_cid) in &payload.localized_logo_250_100_png_cids {
			// First validate the language code
			let code_str = core::str::from_utf8(lang_code)
				.map_err(|_| Error::<T>::InvalidBCP47LanguageCode)?;

			if !Self::is_valid_bcp47(code_str) {
				return Err(Error::<T>::InvalidBCP47LanguageCode.into());
			}

			// Then validate the CID if it's not empty
			if !localized_cid.is_empty() {
				Self::validate_cid(localized_cid)?;
			}
		}

		// Validate each localized name
		for (lang_code, _) in &payload.localized_names {
			// First validate the language code
			let code_str = core::str::from_utf8(lang_code)
				.map_err(|_| Error::<T>::InvalidBCP47LanguageCode)?;
			if !Self::is_valid_bcp47(code_str) {
				return Err(Error::<T>::InvalidBCP47LanguageCode.into());
			}
		}

		Ok(())
	}

	/// Checks if the provided BCP-47 language code is valid.
	fn is_valid_bcp47(code: &str) -> bool {
		// Must not be empty
		if code.is_empty() {
			return false;
		}
		// No leading, trailing, or consecutive dashes
		if code.starts_with('-') || code.ends_with('-') || code.contains("--") {
			return false;
		}
		for part in code.split('-') {
			let len = part.len();
			if len < 2 || !part.chars().all(|c| c.is_ascii_alphanumeric()) {
				return false;
			}
		}
		true
	}

	/// Retrieves the provider or application context including logos and localized name if any
	pub fn get_provider_application_context(
		provider_id: ProviderId,
		application_id: Option<ApplicationIndex>,
		locale: Option<Vec<u8>>,
	) -> Option<ProviderApplicationContext> {
		let bounded_locale = locale.and_then(|loc| BoundedVec::try_from(loc).ok());
		let provider_or_application_registry = match application_id {
			Some(app_id) => ProviderToApplicationRegistry::<T>::get(provider_id, app_id)?,
			None => ProviderToRegistryEntryV2::<T>::get(provider_id)?,
		};
		let default_name = provider_or_application_registry.default_name.to_vec();
		let default_logo_cid = provider_or_application_registry.default_logo_250_100_png_cid;
		// Default logo bytes
		let default_logo_250_100_png_bytes: Option<Vec<u8>> =
			ApprovedLogos::<T>::get(default_logo_cid).map(|bv| bv.to_vec());
		let mut localized_name: Option<Vec<u8>> = None;
		// Localized logo bytes if any
		let localized_logo_250_100_png_bytes: Option<Vec<u8>> = bounded_locale.and_then(|locale| {
			// Localized name if any
			localized_name = provider_or_application_registry
				.localized_names
				.get(&locale)
				.map(|bv| bv.to_vec());

			provider_or_application_registry
				.localized_logo_250_100_png_cids
				.get(&locale)
				.and_then(|cid| ApprovedLogos::<T>::get(cid).map(|bv| bv.to_vec()))
		});

		Some(ProviderApplicationContext {
			default_name,
			provider_id,
			application_id,
			default_logo_250_100_png_bytes,
			localized_logo_250_100_png_bytes,
			localized_name,
		})
	}

	/// Refund weights for logos not removed from worst case scenario
	fn refund_logo_removal_weight_by_count(
		total_logos_removed: u32,
		base_weight: Weight,
	) -> DispatchResultWithPostInfo {
		// Weight adjustment: refund weight for logos that were NOT removed
		let max_logos_benchmark_assumed = T::MaxLocaleCount::get();
		let removal_over_charged_by =
			max_logos_benchmark_assumed.saturating_sub(total_logos_removed);
		let weight_per_logo_removal = T::DbWeight::get().writes(1);
		let weight_to_refund =
			weight_per_logo_removal.saturating_mul(removal_over_charged_by as u64);
		let actual_weight_used = base_weight.saturating_sub(weight_to_refund);
		Ok(PostDispatchInfo { actual_weight: Some(actual_weight_used), pays_fee: Pays::Yes })
	}
}

#[cfg(feature = "runtime-benchmarks")]
impl<T: Config> MsaBenchmarkHelper<T::AccountId> for Pallet<T> {
	/// adds delegation relationship with permitted schema ids
	fn set_delegation_relationship(
		provider: ProviderId,
		delegator: DelegatorId,
		schemas: Vec<SchemaId>,
	) -> DispatchResult {
		Self::add_provider(provider, delegator, schemas)?;
		Ok(())
	}

	/// adds a new key to specified msa
	fn add_key(msa_id: MessageSourceId, key: T::AccountId) -> DispatchResult {
		Self::add_key(msa_id, &key)?;
		Ok(())
	}
}

#[cfg(feature = "runtime-benchmarks")]
impl<T: Config> RegisterProviderBenchmarkHelper for Pallet<T> {
	/// Create a registered provider for benchmarks
	fn create(provider_id: MessageSourceId, name: Vec<u8>) -> DispatchResult {
		let name = BoundedVec::<u8, T::MaxProviderNameSize>::try_from(name).expect("error");
		let payload = ProviderRegistryEntry {
			default_name: name,
			localized_names: BoundedBTreeMap::new(),
			default_logo_250_100_png_cid: BoundedVec::new(),
			localized_logo_250_100_png_cids: BoundedBTreeMap::new(),
		};
		Self::create_registered_provider(provider_id.into(), payload)?;

		Ok(())
	}
}

impl<T: Config> MsaLookup for Pallet<T> {
	type AccountId = T::AccountId;

	fn get_msa_id(key: &Self::AccountId) -> Option<MessageSourceId> {
		Self::get_owner_of(key)
	}
}

impl<T: Config> MsaValidator for Pallet<T> {
	type AccountId = T::AccountId;

	fn ensure_valid_msa_key(key: &T::AccountId) -> Result<MessageSourceId, DispatchError> {
		Self::ensure_valid_msa_key(key)
	}
}

impl<T: Config> ProviderLookup for Pallet<T> {
	type BlockNumber = BlockNumberFor<T>;
	type MaxSchemaGrantsPerDelegation = T::MaxSchemaGrantsPerDelegation;
	type SchemaId = SchemaId;

	fn get_delegation_of(
		delegator: DelegatorId,
		provider: ProviderId,
	) -> Option<Delegation<SchemaId, Self::BlockNumber, Self::MaxSchemaGrantsPerDelegation>> {
		DelegatorAndProviderToDelegation::<T>::get(delegator, provider)
	}
}

impl<T: Config> DelegationValidator for Pallet<T> {
	type BlockNumber = BlockNumberFor<T>;
	type MaxSchemaGrantsPerDelegation = T::MaxSchemaGrantsPerDelegation;
	type SchemaId = SchemaId;

	/// Check that the delegator has an active delegation to the provider.
	/// `block_number`: Provide `None` to know if the delegation is active at the current block.
	///                 Provide Some(N) to know if the delegation was or will be active at block N.
	///
	/// # Errors
	/// * [`Error::DelegationNotFound`]
	/// * [`Error::DelegationRevoked`]
	/// * [`Error::CannotPredictValidityPastCurrentBlock`]
	///
	fn ensure_valid_delegation(
		provider_id: ProviderId,
		delegator_id: DelegatorId,
		block_number: Option<BlockNumberFor<T>>,
	) -> Result<
		Delegation<SchemaId, BlockNumberFor<T>, T::MaxSchemaGrantsPerDelegation>,
		DispatchError,
	> {
		let info = DelegatorAndProviderToDelegation::<T>::get(delegator_id, provider_id)
			.ok_or(Error::<T>::DelegationNotFound)?;
		let current_block = frame_system::Pallet::<T>::block_number();
		let requested_block = match block_number {
			Some(block_number) => {
				ensure!(
					current_block >= block_number,
					Error::<T>::CannotPredictValidityPastCurrentBlock
				);
				block_number
			},
			None => current_block,
		};

		if info.revoked_at == BlockNumberFor::<T>::zero() {
			return Ok(info);
		}
		ensure!(info.revoked_at >= requested_block, Error::<T>::DelegationRevoked);

		Ok(info)
	}
}

impl<T: Config> TargetValidator for Pallet<T> {
	fn validate(target: MessageSourceId) -> bool {
		Self::is_registered_provider(target)
	}
}

impl<T: Config> SchemaGrantValidator<BlockNumberFor<T>> for Pallet<T> {
	/// Check if provider is allowed to publish for a given schema_id for a given delegator
	///
	/// # Errors
	/// * [`Error::DelegationNotFound`]
	/// * [`Error::DelegationRevoked`]
	/// * [`Error::SchemaNotGranted`]
	/// * [`Error::CannotPredictValidityPastCurrentBlock`]
	///
	fn ensure_valid_schema_grant(
		provider: ProviderId,
		delegator: DelegatorId,
		schema_id: SchemaId,
		block_number: BlockNumberFor<T>,
	) -> DispatchResult {
		let provider_info = Self::ensure_valid_delegation(provider, delegator, Some(block_number))?;

		let schema_permission_revoked_at_block_number = provider_info
			.schema_permissions
			.get(&schema_id)
			.ok_or(Error::<T>::SchemaNotGranted)?;

		if *schema_permission_revoked_at_block_number == BlockNumberFor::<T>::zero() {
			return Ok(());
		}

		ensure!(
			block_number <= *schema_permission_revoked_at_block_number,
			Error::<T>::SchemaNotGranted
		);

		Ok(())
	}
}

impl<T: Config> MsaKeyProvider for Pallet<T> {
	type AccountId = T::AccountId;
	// Returns true if ALL of the following are true:
	// - The new key is Ethereum-compatible
	// - Msa exists
	// - The stored msa_id for the key == `msa_id`
	// - It has only one key associated with it
	fn key_eligible_for_subsidized_addition(
		old_key: Self::AccountId,
		new_key: Self::AccountId,
		msa_id: MessageSourceId,
	) -> bool {
		let new_address32 = T::ConvertIntoAccountId32::convert((new_key).clone());
		if EthereumAddressMapper::is_ethereum_address(&new_address32) {
			if let Some(stored_msa_id) = Self::get_msa_id(&old_key) {
				return stored_msa_id == msa_id && PublicKeyCountForMsaId::<T>::get(msa_id).eq(&1u8);
			}
		}
		false
	}
}

/// The TransactionExtension trait is implemented on CheckFreeExtrinsicUse to validate that a provider
/// has not already been revoked if the calling extrinsic is revoking a provider to an MSA. The
/// purpose of this is to ensure that the revoke_delegation_by_delegator extrinsic cannot be
/// repeatedly called and flood the network.
#[derive(Encode, Decode, DecodeWithMemTracking, Clone, Eq, PartialEq, TypeInfo)]
#[scale_info(skip_type_params(T))]
pub struct CheckFreeExtrinsicUse<T: Config + Send + Sync>(PhantomData<T>);

impl<T: Config + Send + Sync> CheckFreeExtrinsicUse<T> {
	/// Validates the delegation by making sure that the MSA ids used are valid and the delegation is
	/// is still active. Returns a `ValidTransaction` or wrapped [`ValidityError`]
	/// # Arguments:
	/// * `account_id`: the account id of the delegator that is revoking the delegation relationship
	/// *  `provider_msa_id` the MSA ID of the provider (the "other end" of the delegation).
	///
	/// # Errors
	/// * [`ValidityError::InvalidMsaKey`] - if  `account_id` does not have an MSA
	/// * [`ValidityError::InvalidDelegation`] - if the delegation with `delegator_msa_id` is invalid
	///
	pub fn validate_delegation_by_delegator(
		account_id: &T::AccountId,
		provider_msa_id: &MessageSourceId,
	) -> TransactionValidity {
		const TAG_PREFIX: &str = "DelegatorDelegationRevocation";
		let delegator_msa_id: DelegatorId = Pallet::<T>::ensure_valid_msa_key(account_id)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?
			.into();
		let provider_msa_id = ProviderId(*provider_msa_id);

		Pallet::<T>::ensure_valid_delegation(provider_msa_id, delegator_msa_id, None)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidDelegation as u8))?;
		ValidTransaction::with_tag_prefix(TAG_PREFIX).and_provides(account_id).build()
	}

	/// Validates the delegation by making sure that the MSA ids used are valid and that the delegation
	/// is still active. Returns a `ValidTransaction` or wrapped [`ValidityError`]
	/// # Arguments:
	/// * `account_id`: the account id of the provider that is revoking the delegation relationship
	/// *  `delegator_msa_id` the MSA ID of the delegator (the "other end" of the delegation).
	///
	/// # Errors
	/// * [`ValidityError::InvalidMsaKey`] - if  `account_id` does not have an MSA
	/// * [`ValidityError::InvalidDelegation`] - if the delegation with `delegator_msa_id` is invalid
	///
	pub fn validate_delegation_by_provider(
		account_id: &T::AccountId,
		delegator_msa_id: &MessageSourceId,
	) -> TransactionValidity {
		const TAG_PREFIX: &str = "ProviderDelegationRevocation";

		let provider_msa_id: ProviderId = Pallet::<T>::ensure_valid_msa_key(account_id)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?
			.into();
		let delegator_msa_id = DelegatorId(*delegator_msa_id);

		// Verify the delegation exists and is active
		Pallet::<T>::ensure_valid_delegation(provider_msa_id, delegator_msa_id, None)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidDelegation as u8))?;
		ValidTransaction::with_tag_prefix(TAG_PREFIX).and_provides(account_id).build()
	}

	/// Validates that a key being revoked is both valid and owned by a valid MSA account.
	/// Returns a `ValidTransaction` or wrapped [`ValidityError::InvalidMsaKey`]
	/// Arguments:
	/// * `signing_public_key`: the account id calling for revoking the key, and which
	///   owns the msa also associated with `key`
	/// * `public_key_to_delete`: the account id to revoke as an access key for account_id's msa
	///
	/// # Errors
	/// * [`ValidityError::InvalidSelfRemoval`] - if `signing_public_key` and `public_key_to_delete` are the same.
	/// * [`ValidityError::InvalidMsaKey`] - if  `account_id` does not have an MSA or if
	///   'public_key_to_delete' does not have an MSA.
	/// * [`ValidityError::NotKeyOwner`] - if the `signing_public_key` and `public_key_to_delete` do not belong to the same MSA ID.
	pub fn validate_key_delete(
		signing_public_key: &T::AccountId,
		public_key_to_delete: &T::AccountId,
	) -> TransactionValidity {
		const TAG_PREFIX: &str = "KeyRevocation";

		ensure!(
			signing_public_key != public_key_to_delete,
			InvalidTransaction::Custom(ValidityError::InvalidSelfRemoval as u8)
		);

		let maybe_owner_msa_id: MessageSourceId =
			Pallet::<T>::ensure_valid_msa_key(signing_public_key)
				.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?;

		let msa_id_for_key_to_delete: MessageSourceId =
			Pallet::<T>::ensure_valid_msa_key(public_key_to_delete)
				.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?;

		ensure!(
			maybe_owner_msa_id == msa_id_for_key_to_delete,
			InvalidTransaction::Custom(ValidityError::NotKeyOwner as u8)
		);

		ValidTransaction::with_tag_prefix(TAG_PREFIX)
			.and_provides(signing_public_key)
			.build()
	}

	/// Validates that a MSA being retired exists, does not belong to a registered provider,
	/// that `account_id` is the only access key associated with the MSA,
	/// does not have a token balance associated with it,
	/// and that there are no delegations to providers.
	/// Returns a `ValidTransaction` or wrapped [`ValidityError]
	/// # Arguments:
	/// * account_id: the account id associated with the MSA to retire
	///
	/// # Errors
	/// * [`ValidityError::InvalidMsaKey`]
	/// * [`ValidityError::InvalidRegisteredProviderCannotBeRetired`]
	/// * [`ValidityError::InvalidMoreThanOneKeyExists`]
	/// * [`ValidityError::InvalidNonZeroProviderDelegations`]
	/// * [`ValidityError::InvalidMsaHoldingTokenCannotBeRetired`]
	///
	pub fn ensure_msa_can_retire(account_id: &T::AccountId) -> TransactionValidity {
		const TAG_PREFIX: &str = "MSARetirement";
		let msa_id = Pallet::<T>::ensure_valid_msa_key(account_id)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?;

		ensure!(
			!Pallet::<T>::is_registered_provider(msa_id),
			InvalidTransaction::Custom(
				ValidityError::InvalidRegisteredProviderCannotBeRetired as u8
			)
		);

		let msa_handle = T::HandleProvider::get_handle_for_msa(msa_id);
		ensure!(
			msa_handle.is_none(),
			InvalidTransaction::Custom(ValidityError::HandleNotRetired as u8)
		);

		let key_count = PublicKeyCountForMsaId::<T>::get(msa_id);
		ensure!(
			key_count == 1,
			InvalidTransaction::Custom(ValidityError::InvalidMoreThanOneKeyExists as u8)
		);

		let delegator_id = DelegatorId(msa_id);
		let has_active_delegations: bool = DelegatorAndProviderToDelegation::<T>::iter_key_prefix(
			delegator_id,
		)
		.any(|provider_id| {
			Pallet::<T>::ensure_valid_delegation(provider_id, delegator_id, None).is_ok()
		});

		ensure!(
			!has_active_delegations,
			InvalidTransaction::Custom(ValidityError::InvalidNonZeroProviderDelegations as u8)
		);

		// - Get account address for MSA
		let msa_address = Pallet::<T>::msa_id_to_eth_address(msa_id);

		// - Convert to AccountId
		let mut bytes = &EthereumAddressMapper::to_bytes32(&msa_address.0)[..];
		let msa_account_id = T::AccountId::decode(&mut bytes).map_err(|_| {
			log::error!("Failed to decode MSA account ID from Ethereum address");
			InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8)
		})?;

		// - Check that the MSA does not have a token balance
		let msa_balance = T::Currency::reducible_balance(
			&msa_account_id,
			Preservation::Expendable,
			Fortitude::Polite,
		);
		ensure!(
			msa_balance == Zero::zero(),
			InvalidTransaction::Custom(ValidityError::InvalidMsaHoldingTokenCannotBeRetired as u8)
		);

		ValidTransaction::with_tag_prefix(TAG_PREFIX).and_provides(account_id).build()
	}

	/// Validates that a request to withdraw tokens from an MSA passes the following checks:
	/// - Receiver (origin) is NOT a control key for any MSA
	/// - Signed payload matches MSA ID and signature validation
	/// - Signature is not a duplicate
	/// - MSA has tokens available to be withdrawn
	///
	/// # Errors
	///
	/// `[ValidityError::NotKeyOwner]` - transaction origin does not match the authorized public key
	/// `[ValidityError::MsaOwnershipInvalidSignature]` - payload verification failed (bad signature, duplicate signature, invalid payload, payload/signature mismatch)
	/// `[ValidityError::IneligibleOrigin]` - transaction origin is an MSA control key
	/// `[ValidityError::InsufficientBalanceToWithdraw]` - MSA balance is zero
	/// `[ValidityError::InvalidMsaKey]` - signing MSA control key does not match MSA ID in payload
	///
	pub fn validate_msa_token_withdrawal(
		receiver_account_id: &T::AccountId,
		msa_owner_public_key: &T::AccountId,
		msa_owner_proof: &MultiSignature,
		authorization_payload: &AuthorizedKeyData<T>,
	) -> TransactionValidity {
		const TAG_PREFIX: &str = "MsaTokenWithdrawal";

		ensure!(
			*receiver_account_id == authorization_payload.authorized_public_key,
			InvalidTransaction::Custom(ValidityError::NotKeyOwner as u8)
		);

		ensure!(
			authorization_payload.discriminant == PayloadTypeDiscriminator::AuthorizedKeyData,
			InvalidTransaction::Custom(ValidityError::MsaOwnershipInvalidSignature as u8)
		);
		ensure!(
			Pallet::<T>::verify_signature(
				msa_owner_proof,
				msa_owner_public_key,
				authorization_payload
			),
			InvalidTransaction::Custom(ValidityError::MsaOwnershipInvalidSignature as u8)
		);

		// Origin must NOT be an MSA control key
		ensure!(
			!PublicKeyToMsaId::<T>::contains_key(receiver_account_id),
			InvalidTransaction::Custom(ValidityError::IneligibleOrigin as u8)
		);

		Pallet::<T>::check_signature_against_registry(
			msa_owner_proof,
			authorization_payload.expiration,
		)
		.map_err(|_| {
			InvalidTransaction::Custom(ValidityError::MsaOwnershipInvalidSignature as u8)
		})?;

		let msa_id = authorization_payload.msa_id;

		Pallet::<T>::ensure_msa_owner(msa_owner_public_key, msa_id)
			.map_err(|_| InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8))?;

		// - Get account address for MSA
		let msa_address = Pallet::<T>::msa_id_to_eth_address(msa_id);

		// - Convert to AccountId
		let mut bytes = &EthereumAddressMapper::to_bytes32(&msa_address.0)[..];
		let msa_account_id = T::AccountId::decode(&mut bytes).map_err(|_| {
			log::error!("Failed to decode MSA account ID from Ethereum address");
			InvalidTransaction::Custom(ValidityError::InvalidMsaKey as u8)
		})?;

		// - Check that the MSA has a balance to withdraw
		let msa_balance = T::Currency::reducible_balance(
			&msa_account_id,
			Preservation::Expendable,
			Fortitude::Polite,
		);
		ensure!(
			msa_balance > Zero::zero(),
			InvalidTransaction::Custom(ValidityError::InsufficientBalanceToWithdraw as u8)
		);
		ValidTransaction::with_tag_prefix(TAG_PREFIX)
			.and_provides(receiver_account_id)
			.build()
	}
}

/// Errors related to the validity of the CheckFreeExtrinsicUse signed extension.
pub enum ValidityError {
	/// Delegation to provider is not found or expired.
	InvalidDelegation,
	/// MSA key as been revoked.
	InvalidMsaKey,
	/// Cannot retire a registered provider MSA
	InvalidRegisteredProviderCannotBeRetired,
	/// More than one account key exists for the MSA during retire attempt
	InvalidMoreThanOneKeyExists,
	/// A transaction's Origin (AccountId) may not remove itself
	InvalidSelfRemoval,
	/// NotKeyOwner
	NotKeyOwner,
	/// InvalidNonZeroProviderDelegations
	InvalidNonZeroProviderDelegations,
	/// HandleNotRetired
	HandleNotRetired,
	/// Cryptographic signature verification failed
	MsaOwnershipInvalidSignature,
	/// MSA balance is zero
	InsufficientBalanceToWithdraw,
	/// Origin is ineleligible for the current transaction
	IneligibleOrigin,
	/// Cannot retire an MSA that has a token balance
	InvalidMsaHoldingTokenCannotBeRetired,
}

impl<T: Config + Send + Sync> CheckFreeExtrinsicUse<T> {
	/// Create new `TransactionExtension` to check runtime version.
	pub fn new() -> Self {
		Self(PhantomData)
	}
}

impl<T: Config + Send + Sync> core::fmt::Debug for CheckFreeExtrinsicUse<T> {
	#[cfg(feature = "std")]
	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
		write!(f, "CheckFreeExtrinsicUse<{:?}>", self.0)
	}
	#[cfg(not(feature = "std"))]
	fn fmt(&self, _: &mut core::fmt::Formatter) -> core::fmt::Result {
		Ok(())
	}
}

/// The info passed between the validate and prepare steps for the `CheckFreeExtrinsicUse` extension.
#[derive(RuntimeDebugNoBound)]
pub enum Val {
	/// Valid transaction, no weight refund.
	Valid,
	/// Weight refund for the transaction.
	Refund(Weight),
}

/// The info passed between the prepare and post-dispatch steps for the `CheckFreeExtrinsicUse` extension.
#[derive(RuntimeDebugNoBound)]
pub enum Pre {
	/// Valid transaction, no weight refund.
	Valid,
	/// Weight refund for the transaction.
	Refund(Weight),
}

impl<T: Config + Send + Sync> TransactionExtension<T::RuntimeCall> for CheckFreeExtrinsicUse<T>
where
	T::RuntimeCall: Dispatchable<Info = DispatchInfo> + IsSubType<Call<T>>,
	<T as frame_system::Config>::RuntimeOrigin: AsSystemOriginSigner<T::AccountId> + Clone,
{
	const IDENTIFIER: &'static str = "CheckFreeExtrinsicUse";
	type Implicit = ();
	type Val = Val;
	type Pre = Pre;

	fn weight(&self, call: &T::RuntimeCall) -> Weight {
		match call.is_sub_type() {
			Some(Call::revoke_delegation_by_provider { .. }) =>
				T::WeightInfo::check_free_extrinsic_use_revoke_delegation_by_provider(),
			Some(Call::revoke_delegation_by_delegator { .. }) =>
				T::WeightInfo::check_free_extrinsic_use_revoke_delegation_by_delegator(),
			Some(Call::delete_msa_public_key { .. }) =>
				T::WeightInfo::check_free_extrinsic_use_delete_msa_public_key(),
			Some(Call::retire_msa { .. }) => T::WeightInfo::check_free_extrinsic_use_retire_msa(),
			Some(Call::withdraw_tokens { .. }) =>
				T::WeightInfo::check_free_extrinsic_use_withdraw_tokens(),
			_ => Weight::zero(),
		}
	}

	fn validate(
		&self,
		origin: <T as frame_system::Config>::RuntimeOrigin,
		call: &T::RuntimeCall,
		_info: &DispatchInfoOf<T::RuntimeCall>,
		_len: usize,
		_self_implicit: Self::Implicit,
		_inherited_implication: &impl Encode,
		_source: TransactionSource,
	) -> ValidateResult<Self::Val, T::RuntimeCall> {
		let weight = self.weight(call);
		let Some(who) = origin.as_system_origin_signer() else {
			return Ok((ValidTransaction::default(), Val::Refund(weight), origin));
		};
		let validity = match call.is_sub_type() {
			Some(Call::revoke_delegation_by_provider { delegator, .. }) =>
				Self::validate_delegation_by_provider(who, delegator),
			Some(Call::revoke_delegation_by_delegator { provider_msa_id, .. }) =>
				Self::validate_delegation_by_delegator(who, provider_msa_id),
			Some(Call::delete_msa_public_key { public_key_to_delete, .. }) =>
				Self::validate_key_delete(who, public_key_to_delete),
			Some(Call::retire_msa { .. }) => Self::ensure_msa_can_retire(who),
			Some(Call::withdraw_tokens {
				msa_owner_public_key,
				msa_owner_proof,
				authorization_payload,
			}) => Self::validate_msa_token_withdrawal(
				who,
				msa_owner_public_key,
				msa_owner_proof,
				authorization_payload,
			),
			_ => Ok(Default::default()),
		};
		validity.map(|v| (v, Val::Valid, origin))
	}

	fn prepare(
		self,
		val: Self::Val,
		_origin: &<T as frame_system::Config>::RuntimeOrigin,
		_call: &T::RuntimeCall,
		_info: &DispatchInfoOf<T::RuntimeCall>,
		_len: usize,
	) -> Result<Self::Pre, TransactionValidityError> {
		match val {
			Val::Valid => Ok(Pre::Valid),
			Val::Refund(w) => Ok(Pre::Refund(w)),
		}
	}

	fn post_dispatch_details(
		pre: Self::Pre,
		_info: &DispatchInfo,
		_post_info: &PostDispatchInfoOf<T::RuntimeCall>,
		_len: usize,
		_result: &sp_runtime::DispatchResult,
	) -> Result<Weight, TransactionValidityError> {
		match pre {
			Pre::Valid => Ok(Weight::zero()),
			Pre::Refund(w) => Ok(w),
		}
	}
}