8 releases (1 stable)
1.0.0 | Aug 1, 2024 |
---|---|
0.13.0 | Jun 26, 2024 |
0.12.0 | Jun 3, 2024 |
0.8.0 | Mar 18, 2024 |
0.0.0 |
|
#14 in #marketplaces
44 downloads per month
88KB
2K
SLoC
Payments Pallet
This pallet allows users to create secure reversible payments that keep funds locked in a merchant's account until the off-chain goods are confirmed to be received. Each payment gets assigned its own judge that can help resolve any disputes between the two parties.
Terminology
- Created: A payment has been created and the amount arrived to its destination but it's locked.
- NeedsReview: The payment has bee disputed and is awaiting settlement by a judge.
- IncentivePercentage: A small share of the payment amount is held in escrow until a payment is completed/cancelled. The Incentive Percentage represents this value.
- Resolver Account: A resolver account is assigned to every payment created, this account has the privilege to cancel/release a payment that has been disputed.
- Remark: The pallet allows to create payments by optionally providing some extra(limited) amount of bytes, this is referred to as Remark. This can be used by a marketplace to separate/tag payments.
- CancelBufferBlockLength: This is the time window where the recipient can dispute a cancellation request from the payment creator.
Interface
Events
PaymentCreated { from: T::AccountId, asset: AssetIdOf<T>, amount: BalanceOf<T> },
,PaymentReleased { from: T::AccountId, to: T::AccountId }
,PaymentCancelled { from: T::AccountId, to: T::AccountId }
,PaymentCreatorRequestedRefund { from: T::AccountId, to: T::AccountId, expiry: BlockNumberFor<T>}
PaymentRefundDisputed { from: T::AccountId, to: T::AccountId }
PaymentRequestCreated { from: T::AccountId, to: T::AccountId }
PaymentRequestCompleted { from: T::AccountId, to: T::AccountId }
Extrinsics
pay
- Create an payment for the given currencyid/amountpay_with_remark
- Create a payment with a remark, can be used to tag paymentsrelease
- Release the payment amount to recipentcancel
- Allows the recipient to cancel the payment and release the payment amount to creatorresolve_release_payment
- Allows assigned judge to release a paymentresolve_cancel_payment
- Allows assigned judge to cancel a paymentrequest_refund
- Allows the creator of the payment to trigger cancel with a buffer time.claim_refund
- Allows the creator to claim payment refund after buffer timedispute_refund
- Allows the recipient to dispute the payment request of senderrequest_payment
- Create a payment that can be completed by the sender using theaccept_and_pay
extrinsic.accept_and_pay
- Allows the sender to fulfill a payment request created by a recipient
Implementations
The RatesProvider module provides implementations for the following traits.
Types
The PaymentDetail
struct stores information about the payment/escrow. A "payment" in virto network is similar to an escrow, it is used to guarantee proof of funds and can be released once an agreed upon condition has reached between the payment creator and recipient. The payment lifecycle is tracked using the state field.
pub struct PaymentDetail<T: pallet::Config> {
/// type of asset used for payment
pub asset: AssetIdOf<T>,
/// amount of asset used for payment
pub amount: BalanceOf<T>,
/// incentive amount that is credited to creator for resolving
pub incentive_amount: BalanceOf<T>,
/// enum to track payment lifecycle [Created, NeedsReview]
pub state: PaymentState<BlockNumberFor<T>>,
/// account that can settle any disputes created in the payment
pub resolver_account: T::AccountId,
/// fee charged and recipient account details
pub fee_detail: Option<(T::AccountId, BalanceOf<T>)>,
/// remarks to give context to payment
pub remark: Option<BoundedDataOf<T>>,
}
The PaymentState
enum tracks the possible states that a payment can be in. When a payment is 'completed' or 'cancelled' it is removed from storage and hence not tracked by a state.
pub enum PaymentState<BlockNumber> {
/// Amounts have been reserved and waiting for release/cancel
Created,
/// A judge needs to review and release manually
NeedsReview,
/// The user has requested refund and will be processed by `BlockNumber`
RefundRequested(BlockNumber),
}
GenesisConfig
The rates_provider pallet does not depend on the GenesisConfig
License: Apache-2.0
Dependencies
~21–35MB
~584K SLoC