staging-xcm-executor 28.0.1

// Copyright (C) Parity Technologies (UK) Ltd.
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

use crate::AssetsInHolding;
use core::result::Result;
use xcm::latest::{prelude::*, Weight};

/// Determine the weight of an XCM message.
pub trait WeightBounds<RuntimeCall> {
	/// Return the maximum amount of weight that an attempted execution of this message could
	/// consume.
	fn weight(
		message: &mut Xcm<RuntimeCall>,
		weight_limit: Weight,
	) -> Result<Weight, InstructionError>;

	/// Return the maximum amount of weight that an attempted execution of this instruction could
	/// consume.
	fn instr_weight(instruction: &mut Instruction<RuntimeCall>) -> Result<Weight, XcmError>;
}

/// Charge for weight in order to execute XCM.
///
/// A `WeightTrader` may also be put into a tuple, in which case the default behavior of
/// `buy_weight` and `refund_weight` would be to attempt to call each tuple element's own
/// implementation of these two functions, in the order of which they appear in the tuple,
/// returning early when a successful result is returned.
pub trait WeightTrader: Sized {
	/// Create a new trader instance.
	fn new() -> Self;

	/// Purchase execution weight credit in return for up to a given `payment`. If less of the
	/// payment is required then the surplus is returned. If the `payment` cannot be used to pay
	/// for the `weight`, then an error is returned.
	fn buy_weight(
		&mut self,
		weight: Weight,
		payment: AssetsInHolding,
		context: &XcmContext,
	) -> Result<AssetsInHolding, (AssetsInHolding, XcmError)>;

	/// Attempt a refund of `weight` into some asset. The caller does not guarantee that the weight
	/// was purchased using `buy_weight`.
	///
	/// Default implementation refunds nothing.
	fn refund_weight(&mut self, _weight: Weight, _context: &XcmContext) -> Option<AssetsInHolding> {
		None
	}

	/// Quote `weight` price in `given` asset id. Returns the full `Asset` that would be charged for
	/// given `weight`.
	fn quote_weight(
		&mut self,
		_weight: Weight,
		_given: AssetId,
		_context: &XcmContext,
	) -> Result<Asset, XcmError> {
		Err(XcmError::TooExpensive)
	}
}

#[impl_trait_for_tuples::impl_for_tuples(30)]
impl WeightTrader for Tuple {
	fn new() -> Self {
		for_tuples!( ( #( Tuple::new() ),* ) )
	}

	fn buy_weight(
		&mut self,
		weight: Weight,
		mut payment: AssetsInHolding,
		context: &XcmContext,
	) -> Result<AssetsInHolding, (AssetsInHolding, XcmError)> {
		let mut too_expensive_error_found = false;
		let mut last_error = None;
		for_tuples!( #(
			let weight_trader = core::any::type_name::<Tuple>();

			match Tuple.buy_weight(weight, payment, context) {
				Ok(assets) => {
					tracing::trace!(
						target: "xcm::buy_weight",
						%weight_trader,
						"Buy weight succeeded",
					);

					return Ok(assets)
				},
				Err((unused, error)) => {
					payment = unused;
					if let XcmError::TooExpensive = error {
						too_expensive_error_found = true;
					}
					last_error = Some(error);

					tracing::trace!(
						target: "xcm::buy_weight",
						?error,
						%weight_trader,
						"Weight trader failed",
					);
				}
			}
		)* );

		tracing::trace!(
			target: "xcm::buy_weight",
			"Buy weight failed",
		);

		// if we have multiple traders, and first one returns `TooExpensive` and others fail e.g.
		// `AssetNotFound` then it is more accurate to return `TooExpensive` then `AssetNotFound`
		Err((
			payment,
			if too_expensive_error_found {
				XcmError::TooExpensive
			} else {
				last_error.unwrap_or(XcmError::TooExpensive)
			},
		))
	}

	fn refund_weight(&mut self, weight: Weight, context: &XcmContext) -> Option<AssetsInHolding> {
		for_tuples!( #(
			if let Some(asset) = Tuple.refund_weight(weight, context) {
				return Some(asset);
			}
		)* );
		None
	}

	fn quote_weight(
		&mut self,
		weight: Weight,
		given: AssetId,
		context: &XcmContext,
	) -> Result<Asset, XcmError> {
		for_tuples!( #(
			if let Ok(asset) = Tuple.quote_weight(weight, given.clone(), context) {
				return Ok(asset);
			}
		)* );
		Err(XcmError::TooExpensive)
	}
}