Struct pallet_transaction_multi_payment::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>where
    <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance: FixedPointOperand,

pub fn set_currency(
    origin: OriginFor<T>,
    currency: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId
) -> DispatchResult

Set selected currency for given account.

This allows to set a currency for an account in which all transaction fees will be paid. Account balance cannot be zero.

Chosen currency must be in the list of accepted currencies.

When currency is set, fixed fee is withdrawn from the account to pay for the currency change

Emits CurrencySet event when successful.

pub fn add_currency(
    origin: OriginFor<T>,
    currency: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId,
    price: Price
) -> DispatchResult

Add a currency to the list of accepted currencies.

Only member can perform this action.

Currency must not be already accepted. Core asset id cannot be explicitly added.

Emits CurrencyAdded event when successful.

pub fn remove_currency(
    origin: OriginFor<T>,
    currency: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId
) -> DispatchResult

Remove currency from the list of supported currencies Only selected members can perform this action

Core asset cannot be removed.

Emits CurrencyRemoved when successful.

impl<T: Config> Pallet<T>

pub fn get_currency<KArg>(
    k: KArg
) -> Option<<<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>where
    KArg: EncodeLike<T::AccountId>,

Account currency map

impl<T: Config> Pallet<T>

pub fn currencies<KArg>(k: KArg) -> Option<Price>where
    KArg: EncodeLike<<<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>,

Curated list of currencies which fees can be paid mapped to corresponding fallback price

impl<T: Config> Pallet<T>

pub fn currency_price<KArg>(k: KArg) -> Option<Price>where
    KArg: EncodeLike<<<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId>,

Asset prices from the spot price provider or the fallback price if the price is not available. Updated at the beginning of every block.

impl<T: Config> Pallet<T>where
    <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance: FixedPointOperand,

pub fn transfer_set_fee(who: &T::AccountId) -> DispatchResult

Transfer fee without executing an AMM trade

pub fn withdraw_fee_non_native(
    who: &T::AccountId,
    fee: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance
) -> Result<PaymentWithdrawResult, DispatchError>

Execute a trade to buy HDX and sell selected currency.

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>where
    <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance: FixedPointOperand,

type Call = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config> CurrencyWithdraw<<T as Config>::AccountId, <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance> for Pallet<T>where
    <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance: FixedPointOperand,

fn withdraw(
    who: &T::AccountId,
    fee: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance
) -> Result<PaymentWithdrawResult, DispatchError>

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(_n: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(_n: T::BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> NativePriceOracle<<<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId, FixedU128> for Pallet<T>

We provide an oracle for the price of all currencies accepted as fee payment.

fn price(
    currency: <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId
) -> Option<Price>

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TransactionMultiPaymentDataProvider<<T as Config>::AccountId, <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId, FixedU128> for Pallet<T>where
    <<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::Balance: FixedPointOperand,

fn get_currency_and_price(
    who: &<T as Config>::AccountId
) -> Result<(<<T as Config>::Currencies as MultiCurrency<<T as Config>::AccountId>>::CurrencyId, Option<Price>), DispatchError>

Get a fee currency set by an account and its price

fn get_fee_receiver() -> <T as Config>::AccountId

Returns the account where fees are deposited

impl<T: Config> TryState<<T as Config>::BlockNumber> for Pallet<T>

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T> Eq for Pallet<T>