assets-common 0.27.0

Assets common utilities
Documentation
// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0

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

use codec::{Decode, DecodeWithMemTracking, Encode, MaxEncodedLen};
use core::marker::PhantomData;
use frame_support::traits::Get;
use sp_runtime::{
	traits::{Convert, MaybeEquivalence},
	Either,
	Either::{Left, Right},
};
use xcm::latest::Location;

/// Information about reserve locations for Foreign Assets.
#[derive(
	Clone,
	Debug,
	Encode,
	Decode,
	DecodeWithMemTracking,
	PartialEq,
	Eq,
	scale_info::TypeInfo,
	MaxEncodedLen,
	serde::Serialize,
	serde::Deserialize,
)]
pub struct ForeignAssetReserveData {
	/// A location acting as trusted reserve.
	pub reserve: Location,
	/// Whether asset is teleportable between local chain and `reserve`.
	pub teleportable: bool,
}

impl From<(Location, bool)> for ForeignAssetReserveData {
	fn from((reserve, teleportable): (Location, bool)) -> Self {
		ForeignAssetReserveData { reserve, teleportable }
	}
}

/// Converts a given [`Location`] to [`Either::Left`] when equal to `Target`, or
/// [`Either::Right`] otherwise.
///
/// Suitable for use as a `Criterion` with [`frame_support::traits::tokens::fungible::UnionOf`].
pub struct TargetFromLeft<Target, L = Location>(PhantomData<(Target, L)>);
impl<Target: Get<L>, L: PartialEq + Eq> Convert<L, Either<(), L>> for TargetFromLeft<Target, L> {
	fn convert(l: L) -> Either<(), L> {
		Target::get().eq(&l).then(|| Left(())).map_or(Right(l), |n| n)
	}
}

/// Converts a given [`Location`] to [`Either::Left`] based on the `Equivalence` criteria.
/// Returns [`Either::Right`] if not equivalent.
///
/// Suitable for use as a `Criterion` with [`frame_support::traits::tokens::fungibles::UnionOf`].
pub struct LocalFromLeft<Equivalence, AssetId, L = Location>(
	PhantomData<(Equivalence, AssetId, L)>,
);
impl<Equivalence, AssetId, L> Convert<L, Either<AssetId, L>>
	for LocalFromLeft<Equivalence, AssetId, L>
where
	Equivalence: MaybeEquivalence<L, AssetId>,
{
	fn convert(l: L) -> Either<AssetId, L> {
		match Equivalence::convert(&l) {
			Some(id) => Left(id),
			None => Right(l),
		}
	}
}