Trait pallet_payment::PaymentHandler

pub trait PaymentHandler<T: Config> {
    fn create_payment(
        from: &T::AccountId,
        to: &T::AccountId,
        amount: BalanceOf<T>,
        payment_state: PaymentState<T>,
        incentive_percentage: Percent,
        remark: Option<&[u8]>
    ) -> Result<PaymentDetail<T>, DispatchError>;
    fn reserve_payment_amount(
        from: &T::AccountId,
        to: &T::AccountId,
        payment: PaymentDetail<T>
    ) -> DispatchResult;
    fn settle_payment(
        from: &T::AccountId,
        to: &T::AccountId,
        recipient_share: Percent
    ) -> DispatchResult;
    fn get_payment_details(
        from: &T::AccountId,
        to: &T::AccountId
    ) -> Option<PaymentDetail<T>>;
}

trait that defines how to create/release payments for users

Required Methods

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

Create a PaymentDetail from the given payment details Calculate the fee amount and store PaymentDetail in storage Possible reasons for failure include:

• Payment already exists and cannot be overwritten

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

Attempt to reserve the amount from the caller If not possible then return Error. Possible reasons for failure include:

• User does not have enough balance.

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

• The payment does not exist
• The unreserve operation fails
• The transfer operation fails

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:

• The payment does not exist

Implementors

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