Skip to main content

WeightFeeHandler

Struct WeightFeeHandler 

Source
pub struct WeightFeeHandler<AccountId, C, W, T, const POLICY: bool>(/* private fields */);
Expand description

A weight-based fee handler implementation that calculates and charges fees based on message processing weight.

This implementation computes the weight consumed by a batch of messages, converts this weight into a fee, and charges the fee to the message originator’s account. The behavior is configurable through a ChargePolicy.

§Type Parameters

  • AccountId - The account identifier type used to identify fee payers.
  • C - The Currency trait implementation for handling balances.
  • W - A type implementing WeightToFee to convert computational Weight into a Balance.
  • T - A Get<AccountId> implementation that returns the Treasury’s account ID.
  • Policy - A type implementing ChargePolicy to determine if fees should be charged.

§Examples

This handler is typically configured in a runtime to establish a weight-based fee model.

// In the runtime configuration
use pallet_ismp::fee_handler::{self, WeightToFee};
use frame_support::weights::WeightToFee as SubstrateWeightToFee;

// An adapter to use the runtime's default WeightToFee implementation
pub struct IsmpWeightToFee;
impl WeightToFee for IsmpWeightToFee {
    type Balance = Balance;
    fn convert(weight: Weight) -> Self::Balance {
        <Runtime as pallet_transaction_payment::Config>::WeightToFee::weight_to_fee(&weight)
    }
}

// Define the fee handler type
type FeeHandler = fee_handler::WeightFeeHandler<
    AccountId,
    Balances,
    IsmpWeightToFee,
	TreasuryPalletId.
	true
>;

Trait Implementations§

Source§

impl<AccountId, C, W, T, const POLICY: bool> FeeHandler for WeightFeeHandler<AccountId, C, W, T, POLICY>
where AccountId: Member + MaybeDisplay + Decode + Encode, C: Currency<AccountId>, W: WeightToFee<Balance = <C as Currency<AccountId>>::Balance>, T: Get<PalletId>,

Source§

fn on_executed( messages: Vec<MessageWithWeight>, _events: Vec<Event>, ) -> DispatchResultWithPostInfo

Process a batch of successfully executed messages and calculate appropriate fees. Read more

Auto Trait Implementations§

§

impl<AccountId, C, W, T, const POLICY: bool> Freeze for WeightFeeHandler<AccountId, C, W, T, POLICY>

§

impl<AccountId, C, W, T, const POLICY: bool> RefUnwindSafe for WeightFeeHandler<AccountId, C, W, T, POLICY>

§

impl<AccountId, C, W, T, const POLICY: bool> Send for WeightFeeHandler<AccountId, C, W, T, POLICY>
where AccountId: Send, C: Send, W: Send, T: Send,

§

impl<AccountId, C, W, T, const POLICY: bool> Sync for WeightFeeHandler<AccountId, C, W, T, POLICY>
where AccountId: Sync, C: Sync, W: Sync, T: Sync,

§

impl<AccountId, C, W, T, const POLICY: bool> Unpin for WeightFeeHandler<AccountId, C, W, T, POLICY>
where AccountId: Unpin, C: Unpin, W: Unpin, T: Unpin,

§

impl<AccountId, C, W, T, const POLICY: bool> UnsafeUnpin for WeightFeeHandler<AccountId, C, W, T, POLICY>

§

impl<AccountId, C, W, T, const POLICY: bool> UnwindSafe for WeightFeeHandler<AccountId, C, W, T, POLICY>
where AccountId: UnwindSafe, C: UnwindSafe, W: UnwindSafe, T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CheckedConversion for T

Source§

fn checked_from<T>(t: T) -> Option<Self>
where Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more
Source§

fn checked_into<T>(self) -> Option<T>
where Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more
Source§

impl<T, U> DefensiveTruncateInto<U> for T

Source§

fn defensive_truncate_into(self) -> U

Defensively truncate a value and convert it into its bounded form.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> IntoKey<U> for T
where U: FromKey<T>,

Source§

fn into_key(self) -> U

Source§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

Source§

fn into_tuple(self) -> Dest

Source§

impl<T> IsType<T> for T

Source§

fn from_ref(t: &T) -> &T

Cast reference.
Source§

fn into_ref(&self) -> &T

Cast reference.
Source§

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.
Source§

fn into_mut(&mut self) -> &mut T

Cast mutable reference.
Source§

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

Source§

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

Source§

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SaturatedConversion for T

Source§

fn saturated_from<T>(t: T) -> Self
where Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more
Source§

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoKey<U> for T
where U: TryFromKey<T>,

Source§

type Error = <U as TryFromKey<T>>::Error

Source§

fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>

Source§

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

Source§

fn unchecked_into(self) -> T

The counterpart to unchecked_from.
Source§

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<T>,

Source§

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> JsonSchemaMaybe for T

Source§

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,