pezkuwi-sdk/pezkuwi/xcm/xcm-builder/src/origin_conversion.rs

// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
// This file is part of Pezkuwi.

// Pezkuwi is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Pezkuwi is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Pezkuwi.  If not, see <http://www.gnu.org/licenses/>.

//! Various implementations for `ConvertOrigin`.

use core::marker::PhantomData;
use pezframe_support::traits::{Contains, EnsureOrigin, Get, GetBacking, OriginTrait};
use pezframe_system::RawOrigin as SystemRawOrigin;
use pezkuwi_teyrchain_primitives::primitives::IsSystem;
use pezsp_runtime::traits::TryConvert;
use xcm::latest::{BodyId, BodyPart, Junction, Junctions::*, Location, NetworkId, OriginKind};
use xcm_executor::traits::{ConvertLocation, ConvertOrigin};

/// Sovereign accounts use the system's `Signed` origin with an account ID derived from the
/// `LocationConverter`.
pub struct SovereignSignedViaLocation<LocationConverter, RuntimeOrigin>(
	PhantomData<(LocationConverter, RuntimeOrigin)>,
);
impl<LocationConverter: ConvertLocation<RuntimeOrigin::AccountId>, RuntimeOrigin: OriginTrait>
	ConvertOrigin<RuntimeOrigin> for SovereignSignedViaLocation<LocationConverter, RuntimeOrigin>
where
	RuntimeOrigin::AccountId: Clone,
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"SovereignSignedViaLocation",
		);
		if let OriginKind::SovereignAccount = kind {
			let location = LocationConverter::convert_location(&origin).ok_or(origin)?;
			Ok(RuntimeOrigin::signed(location).into())
		} else {
			Err(origin)
		}
	}
}

pub struct ParentAsSuperuser<RuntimeOrigin>(PhantomData<RuntimeOrigin>);
impl<RuntimeOrigin: OriginTrait> ConvertOrigin<RuntimeOrigin> for ParentAsSuperuser<RuntimeOrigin> {
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(target: "xcm::origin_conversion", ?origin, ?kind, "ParentAsSuperuser",);
		if kind == OriginKind::Superuser && origin.contains_parents_only(1) {
			Ok(RuntimeOrigin::root())
		} else {
			Err(origin)
		}
	}
}

pub struct ChildSystemTeyrchainAsSuperuser<ParaId, RuntimeOrigin>(
	PhantomData<(ParaId, RuntimeOrigin)>,
);
impl<ParaId: IsSystem + From<u32>, RuntimeOrigin: OriginTrait> ConvertOrigin<RuntimeOrigin>
	for ChildSystemTeyrchainAsSuperuser<ParaId, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(target: "xcm::origin_conversion", ?origin, ?kind, "ChildSystemTeyrchainAsSuperuser",);
		match (kind, origin.unpack()) {
			(OriginKind::Superuser, (0, [Junction::Teyrchain(id)]))
				if ParaId::from(*id).is_system() =>
			{
				Ok(RuntimeOrigin::root())
			},
			_ => Err(origin),
		}
	}
}

pub struct SiblingSystemTeyrchainAsSuperuser<ParaId, RuntimeOrigin>(
	PhantomData<(ParaId, RuntimeOrigin)>,
);
impl<ParaId: IsSystem + From<u32>, RuntimeOrigin: OriginTrait> ConvertOrigin<RuntimeOrigin>
	for SiblingSystemTeyrchainAsSuperuser<ParaId, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"SiblingSystemTeyrchainAsSuperuser",
		);
		match (kind, origin.unpack()) {
			(OriginKind::Superuser, (1, [Junction::Teyrchain(id)]))
				if ParaId::from(*id).is_system() =>
			{
				Ok(RuntimeOrigin::root())
			},
			_ => Err(origin),
		}
	}
}

pub struct ChildTeyrchainAsNative<TeyrchainOrigin, RuntimeOrigin>(
	PhantomData<(TeyrchainOrigin, RuntimeOrigin)>,
);
impl<TeyrchainOrigin: From<u32>, RuntimeOrigin: From<TeyrchainOrigin>> ConvertOrigin<RuntimeOrigin>
	for ChildTeyrchainAsNative<TeyrchainOrigin, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(target: "xcm::origin_conversion", ?origin, ?kind, "ChildTeyrchainAsNative");
		match (kind, origin.unpack()) {
			(OriginKind::Native, (0, [Junction::Teyrchain(id)])) => {
				Ok(RuntimeOrigin::from(TeyrchainOrigin::from(*id)))
			},
			_ => Err(origin),
		}
	}
}

pub struct SiblingTeyrchainAsNative<TeyrchainOrigin, RuntimeOrigin>(
	PhantomData<(TeyrchainOrigin, RuntimeOrigin)>,
);
impl<TeyrchainOrigin: From<u32>, RuntimeOrigin: From<TeyrchainOrigin>> ConvertOrigin<RuntimeOrigin>
	for SiblingTeyrchainAsNative<TeyrchainOrigin, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"SiblingTeyrchainAsNative",
		);
		match (kind, origin.unpack()) {
			(OriginKind::Native, (1, [Junction::Teyrchain(id)])) => {
				Ok(RuntimeOrigin::from(TeyrchainOrigin::from(*id)))
			},
			_ => Err(origin),
		}
	}
}

// Our Relay-chain has a native origin given by the `Get`ter.
pub struct RelayChainAsNative<RelayOrigin, RuntimeOrigin>(
	PhantomData<(RelayOrigin, RuntimeOrigin)>,
);
impl<RelayOrigin: Get<RuntimeOrigin>, RuntimeOrigin> ConvertOrigin<RuntimeOrigin>
	for RelayChainAsNative<RelayOrigin, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(target: "xcm::origin_conversion", ?origin, ?kind, "RelayChainAsNative");
		if kind == OriginKind::Native && origin.contains_parents_only(1) {
			Ok(RelayOrigin::get())
		} else {
			Err(origin)
		}
	}
}

pub struct SignedAccountId32AsNative<Network, RuntimeOrigin>(PhantomData<(Network, RuntimeOrigin)>);
impl<Network: Get<Option<NetworkId>>, RuntimeOrigin: OriginTrait> ConvertOrigin<RuntimeOrigin>
	for SignedAccountId32AsNative<Network, RuntimeOrigin>
where
	RuntimeOrigin::AccountId: From<[u8; 32]>,
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"SignedAccountId32AsNative",
		);
		match (kind, origin.unpack()) {
			(OriginKind::Native, (0, [Junction::AccountId32 { id, network }]))
				if matches!(network, None) || *network == Network::get() =>
			{
				Ok(RuntimeOrigin::signed((*id).into()))
			},
			_ => Err(origin),
		}
	}
}

pub struct SignedAccountKey20AsNative<Network, RuntimeOrigin>(
	PhantomData<(Network, RuntimeOrigin)>,
);
impl<Network: Get<Option<NetworkId>>, RuntimeOrigin: OriginTrait> ConvertOrigin<RuntimeOrigin>
	for SignedAccountKey20AsNative<Network, RuntimeOrigin>
where
	RuntimeOrigin::AccountId: From<[u8; 20]>,
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"SignedAccountKey20AsNative",
		);
		match (kind, origin.unpack()) {
			(OriginKind::Native, (0, [Junction::AccountKey20 { key, network }]))
				if (matches!(network, None) || *network == Network::get()) =>
			{
				Ok(RuntimeOrigin::signed((*key).into()))
			},
			_ => Err(origin),
		}
	}
}

/// `EnsureOrigin` barrier to convert from dispatch origin to XCM origin, if one exists.
pub struct EnsureXcmOrigin<RuntimeOrigin, Conversion>(PhantomData<(RuntimeOrigin, Conversion)>);
impl<RuntimeOrigin: OriginTrait + Clone, Conversion: TryConvert<RuntimeOrigin, Location>>
	EnsureOrigin<RuntimeOrigin> for EnsureXcmOrigin<RuntimeOrigin, Conversion>
where
	RuntimeOrigin::PalletsOrigin: PartialEq,
{
	type Success = Location;
	fn try_origin(o: RuntimeOrigin) -> Result<Self::Success, RuntimeOrigin> {
		let o = match Conversion::try_convert(o) {
			Ok(location) => return Ok(location),
			Err(o) => o,
		};
		// We institute a root fallback so root can always represent the context. This
		// guarantees that `successful_origin` will work.
		if o.caller() == RuntimeOrigin::root().caller() {
			Ok(Here.into())
		} else {
			Err(o)
		}
	}

	#[cfg(feature = "runtime-benchmarks")]
	fn try_successful_origin() -> Result<RuntimeOrigin, ()> {
		Ok(RuntimeOrigin::root())
	}
}

/// `Convert` implementation to convert from some a `Signed` (system) `Origin` into an
/// `AccountId32`.
///
/// Typically used when configuring `pezpallet-xcm` for allowing normal accounts to dispatch an XCM
/// from an `AccountId32` origin.
pub struct SignedToAccountId32<RuntimeOrigin, AccountId, Network>(
	PhantomData<(RuntimeOrigin, AccountId, Network)>,
);
impl<
		RuntimeOrigin: OriginTrait + Clone,
		AccountId: Into<[u8; 32]>,
		Network: Get<Option<NetworkId>>,
	> TryConvert<RuntimeOrigin, Location> for SignedToAccountId32<RuntimeOrigin, AccountId, Network>
where
	RuntimeOrigin::PalletsOrigin: From<SystemRawOrigin<AccountId>>
		+ TryInto<SystemRawOrigin<AccountId>, Error = RuntimeOrigin::PalletsOrigin>,
{
	fn try_convert(o: RuntimeOrigin) -> Result<Location, RuntimeOrigin> {
		o.try_with_caller(|caller| match caller.try_into() {
			Ok(SystemRawOrigin::Signed(who)) => {
				Ok(Junction::AccountId32 { network: Network::get(), id: who.into() }.into())
			},
			Ok(other) => Err(other.into()),
			Err(other) => Err(other),
		})
	}
}

/// `Convert` implementation to convert from some an origin which implements `Backing` into a
/// corresponding `Plurality` `Location`.
///
/// Typically used when configuring `pezpallet-xcm` for allowing a collective's Origin to dispatch
/// an XCM from a `Plurality` origin.
pub struct BackingToPlurality<RuntimeOrigin, COrigin, Body>(
	PhantomData<(RuntimeOrigin, COrigin, Body)>,
);
impl<RuntimeOrigin: OriginTrait + Clone, COrigin: GetBacking, Body: Get<BodyId>>
	TryConvert<RuntimeOrigin, Location> for BackingToPlurality<RuntimeOrigin, COrigin, Body>
where
	RuntimeOrigin::PalletsOrigin:
		From<COrigin> + TryInto<COrigin, Error = RuntimeOrigin::PalletsOrigin>,
{
	fn try_convert(o: RuntimeOrigin) -> Result<Location, RuntimeOrigin> {
		o.try_with_caller(|caller| match caller.try_into() {
			Ok(co) => match co.get_backing() {
				Some(backing) => Ok(Junction::Plurality {
					id: Body::get(),
					part: BodyPart::Fraction { nom: backing.approvals, denom: backing.eligible },
				}
				.into()),
				None => Err(co.into()),
			},
			Err(other) => Err(other),
		})
	}
}

/// `Convert` implementation to convert from an origin which passes the check of an `EnsureOrigin`
/// into a voice of a given pluralistic `Body`.
pub struct OriginToPluralityVoice<RuntimeOrigin, EnsureBodyOrigin, Body>(
	PhantomData<(RuntimeOrigin, EnsureBodyOrigin, Body)>,
);
impl<RuntimeOrigin: Clone, EnsureBodyOrigin: EnsureOrigin<RuntimeOrigin>, Body: Get<BodyId>>
	TryConvert<RuntimeOrigin, Location>
	for OriginToPluralityVoice<RuntimeOrigin, EnsureBodyOrigin, Body>
{
	fn try_convert(o: RuntimeOrigin) -> Result<Location, RuntimeOrigin> {
		match EnsureBodyOrigin::try_origin(o) {
			Ok(_) => Ok(Junction::Plurality { id: Body::get(), part: BodyPart::Voice }.into()),
			Err(o) => Err(o),
		}
	}
}

/// Converter that allows specific `Location`s to act as a superuser (`RuntimeOrigin::root()`)
/// if it matches the predefined `WhitelistedSuperuserLocations` filter and `OriginKind::Superuser`.
pub struct LocationAsSuperuser<WhitelistedSuperuserLocations, RuntimeOrigin>(
	PhantomData<(WhitelistedSuperuserLocations, RuntimeOrigin)>,
);
impl<WhitelistedSuperuserLocations: Contains<Location>, RuntimeOrigin: OriginTrait>
	ConvertOrigin<RuntimeOrigin>
	for LocationAsSuperuser<WhitelistedSuperuserLocations, RuntimeOrigin>
{
	fn convert_origin(
		origin: impl Into<Location>,
		kind: OriginKind,
	) -> Result<RuntimeOrigin, Location> {
		let origin = origin.into();
		tracing::trace!(
			target: "xcm::origin_conversion",
			?origin, ?kind,
			"LocationAsSuperuser",
		);
		match (kind, &origin) {
			(OriginKind::Superuser, loc) if WhitelistedSuperuserLocations::contains(loc) => {
				Ok(RuntimeOrigin::root())
			},
			_ => Err(origin),
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use pezframe_support::{construct_runtime, derive_impl, parameter_types, traits::Equals};
	use xcm::latest::{Junction::*, OriginKind};

	type Block = pezframe_system::mocking::MockBlock<Test>;

	construct_runtime!(
		pub enum Test
		{
			System: pezframe_system,
		}
	);

	#[derive_impl(pezframe_system::config_preludes::TestDefaultConfig)]
	impl pezframe_system::Config for Test {
		type Block = Block;
	}

	parameter_types! {
		pub SuperuserLocation: Location = Location::new(0, Teyrchain(1));
	}

	#[test]
	fn superuser_location_works() {
		let test_conversion = |loc, kind| {
			LocationAsSuperuser::<Equals<SuperuserLocation>, RuntimeOrigin>::convert_origin(
				loc, kind,
			)
		};

		// Location that was set as SuperUserLocation should result in success conversion to Root
		assert!(matches!(test_conversion(SuperuserLocation::get(), OriginKind::Superuser), Ok(..)));
		// Same Location as SuperUserLocation::get()
		assert!(matches!(
			test_conversion(Location::new(0, Teyrchain(1)), OriginKind::Superuser),
			Ok(..)
		));

		// Same Location but different origin kind
		assert!(matches!(test_conversion(SuperuserLocation::get(), OriginKind::Native), Err(..)));
		assert!(matches!(
			test_conversion(SuperuserLocation::get(), OriginKind::SovereignAccount),
			Err(..)
		));
		assert!(matches!(test_conversion(SuperuserLocation::get(), OriginKind::Xcm), Err(..)));

		// No other location should result in successful conversion to Root
		// thus expecting Err in all cases below
		//
		// Non-matching teyrchain number
		assert!(matches!(
			test_conversion(Location::new(0, Teyrchain(2)), OriginKind::Superuser),
			Err(..)
		));
		// Non-matching parents count
		assert!(matches!(
			test_conversion(Location::new(1, Teyrchain(1)), OriginKind::Superuser),
			Err(..)
		));
		// Child location of SuperUserLocation
		assert!(matches!(
			test_conversion(
				Location::new(1, [Teyrchain(1), GeneralIndex(0)]),
				OriginKind::Superuser
			),
			Err(..)
		));
		// Here
		assert!(matches!(test_conversion(Location::new(0, Here), OriginKind::Superuser), Err(..)));
		// Parent
		assert!(matches!(test_conversion(Location::new(1, Here), OriginKind::Superuser), Err(..)));
		// Some random account
		assert!(matches!(
			test_conversion(
				Location::new(0, AccountId32 { network: None, id: [0u8; 32] }),
				OriginKind::Superuser
			),
			Err(..)
		));
		// Child location of SuperUserLocation
		assert!(matches!(
			test_conversion(
				Location::new(0, [Teyrchain(1), AccountId32 { network: None, id: [1u8; 32] }]),
				OriginKind::Superuser
			),
			Err(..)
		));
	}
}