Struct pallet_payment::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn balance_to_u128_option(input: BalanceOf<T>) -> Option<u128>

pub fn u128_to_balance_option(input: u128) -> Option<BalanceOf<T>>

impl<T: Config> Pallet<T>

pub fn check_task(now: T::BlockNumber, remaining_weight: Weight) -> Weight

impl<T: Config> Pallet<T>

pub fn pay(
    origin: OriginFor<T>,
    recipient: T::AccountId,
    amount: BalanceOf<T>,
    remark: Option<BoundedDataOf<T>>
) -> DispatchResultWithPostInfo

This allows any user to create a new payment, that releases only to specified recipient The only action is to store the details of this payment in storage and reserve the specified amount. User also has the option to add a remark, this remark can then be used to run custom logic and trigger alternate payment flows. the specified amount.

pub fn release(
    origin: OriginFor<T>,
    to: T::AccountId
) -> DispatchResultWithPostInfo

Release any created payment, this will transfer the reserved amount from the creator of the payment to the assigned recipient

pub fn cancel(
    origin: OriginFor<T>,
    creator: T::AccountId
) -> DispatchResultWithPostInfo

Cancel a payment in created state, this will release the reserved back to creator of the payment. This extrinsic can only be called by the recipient of the payment

pub fn resolve_payment(
    origin: OriginFor<T>,
    from: T::AccountId,
    recipient: T::AccountId,
    recipient_share: Percent
) -> DispatchResultWithPostInfo

This extrinsic is used to resolve disputes between the creator and recipient of the payment. This extrinsic allows the assigned judge to cancel/release/partial_release the payment.

pub fn request_refund(
    origin: OriginFor<T>,
    recipient: T::AccountId
) -> DispatchResultWithPostInfo

Allow the creator of a payment to initiate a refund that will return the funds after a configured amount of time that the reveiver has to react and opose the request

pub fn dispute_refund(
    origin: OriginFor<T>,
    creator: T::AccountId
) -> DispatchResultWithPostInfo

Allow payment recipient to dispute the refund request from the payment creator This does not cancel the request, instead sends the payment to a NeedsReview state The assigned resolver account can then change the state of the payment after review.

pub fn request_payment(
    origin: OriginFor<T>,
    from: T::AccountId,
    amount: BalanceOf<T>
) -> DispatchResultWithPostInfo

pub fn accept_and_pay(
    origin: OriginFor<T>,
    to: T::AccountId
) -> DispatchResultWithPostInfo

impl<T: Config> Pallet<T>

pub fn payment<KArg1, KArg2>(k1: KArg1, k2: KArg2) -> Option<PaymentDetail<T>>where
    KArg1: EncodeLike<T::AccountId>,
    KArg2: EncodeLike<T::AccountId>,

Payments created by a user, this method of storageDoubleMap is chosen since there is no usecase for listing payments by provider/currency. The payment will only be referenced by the creator in any transaction of interest. The storage map keys are the creator and the recipient, this also ensures that for any (sender,recipient) combo, only a single payment is active. The history of payment is not stored.

impl<T: Config> Pallet<T>

pub fn tasks() -> ScheduledTaskList<T>

Store the list of tasks to be executed in the on_idle function

Trait Implementations

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

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> 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_idle(now: T::BlockNumber, remaining_weight: Weight) -> Weight

Hook that execute when there is leftover space in a block This function will look for any pending scheduled tasks that can be executed and will process them.

fn on_finalize(_n: BlockNumber)

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

fn on_initialize(_n: BlockNumber) -> Weight

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

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> 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> PaymentHandler<T> for Pallet<T>

fn create_payment(
    from: &T::AccountId,
    recipient: &T::AccountId,
    amount: BalanceOf<T>,
    payment_state: PaymentState<T>,
    incentive_percentage: Percent,
    remark: Option<&[u8]>
) -> Result<PaymentDetail<T>, DispatchError>

The function will create a new payment. The fee and incentive amounts will be calculated and the PaymentDetail will be added to storage.

fn reserve_payment_amount(
    from: &T::AccountId,
    to: &T::AccountId,
    payment: PaymentDetail<T>
) -> DispatchResult

The function will reserve the fees+transfer amount from the from account. After reserving the payment.amount will be transferred to the recipient but will stay in Reserve state.

fn settle_payment(
    from: &T::AccountId,
    to: &T::AccountId,
    recipient_share: Percent
) -> DispatchResult

This function allows the caller to settle the payment by specifying a recipient_share this will unreserve the fee+incentive to sender and unreserve transferred amount to recipient if the settlement is a release (ie recipient_share=100), the fee is transferred to fee_recipient For cancelling a payment, recipient_share = 0 For releasing a payment, recipient_share = 100 In other cases, the custom recipient_share can be specified

fn get_payment_details(
    from: &T::AccountId,
    to: &T::AccountId
) -> Option<PaymentDetail<T>>

Attempt to fetch the details of a payment from the given payment_id Possible reasons for failure include:

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

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>