pub struct PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>(/* private fields */);Expand description
PGAS-backed payment backend. Charges prefer PGAS and fall back to the native currency;
refunds return native first (capped by [NativeDepositOf]) then RefundPercent of the
PGAS portion, burning the rest.
Trait Implementations§
Source§impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Deposit<T> for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>where
T: Config,
Mutator: Mutate<T::AccountId, Balance = BalanceOf<T>>,
Holder: MutateHold<T::AccountId, Balance = BalanceOf<T>, AssetId = <Mutator as Inspect<T::AccountId>>::AssetId>,
<Holder as InspectHold<T::AccountId>>::Reason: From<HoldReason>,
Freezer: Mutate<T::AccountId, Balance = BalanceOf<T>, AssetId = <Mutator as Inspect<T::AccountId>>::AssetId>,
<Freezer as Inspect<T::AccountId>>::Id: From<FreezeReason>,
Id: Get<<Mutator as Inspect<T::AccountId>>::AssetId>,
RefundPercent: Get<Perbill>,
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Deposit<T> for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>where
T: Config,
Mutator: Mutate<T::AccountId, Balance = BalanceOf<T>>,
Holder: MutateHold<T::AccountId, Balance = BalanceOf<T>, AssetId = <Mutator as Inspect<T::AccountId>>::AssetId>,
<Holder as InspectHold<T::AccountId>>::Reason: From<HoldReason>,
Freezer: Mutate<T::AccountId, Balance = BalanceOf<T>, AssetId = <Mutator as Inspect<T::AccountId>>::AssetId>,
<Freezer as Inspect<T::AccountId>>::Id: From<FreezeReason>,
Id: Get<<Mutator as Inspect<T::AccountId>>::AssetId>,
RefundPercent: Get<Perbill>,
Source§fn init_contract(to: &T::AccountId) -> DispatchResult
fn init_contract(to: &T::AccountId) -> DispatchResult
Mints one native ED and one PGAS ED into to, so the account can subsequently receive
deposits in either asset without tripping existential-deposit checks. The minted native
ED is deactivated so it stays
outside active issuance. The minted PGAS ED is frozen under
FreezeReason::PGasMinBalance so the contract cannot transfer or burn it:
pallet-assets’ reducible_balance treats any frozen amount as untouchable, regardless
of Preservation / Fortitude.
Source§fn destroy_contract(contract: &T::AccountId) -> DispatchResult
fn destroy_contract(contract: &T::AccountId) -> DispatchResult
Thaws and burns the PGAS ED frozen by Self::init_contract, plus the native ED.
Source§fn charge_and_hold(
reason: HoldReason,
src: Funds<'_, T::AccountId>,
to: &T::AccountId,
amount: BalanceOf<T>,
) -> DispatchResult
fn charge_and_hold( reason: HoldReason, src: Funds<'_, T::AccountId>, to: &T::AccountId, amount: BalanceOf<T>, ) -> DispatchResult
Charges a deposit and places it on hold.
Uses PGAS when the payer has enough reducible PGAS, otherwise falls back to the native
currency and records the contribution in [NativeDepositOf] so refunds return native up
to the contributed amount. The native fallback honours [Funds::TxFee] by withdrawing
from the txfee pool instead of the payer’s free balance.
Source§fn refund_on_hold(
reason: HoldReason,
from: &T::AccountId,
dst: Funds<'_, T::AccountId>,
amount: BalanceOf<T>,
) -> DispatchResult
fn refund_on_hold( reason: HoldReason, from: &T::AccountId, dst: Funds<'_, T::AccountId>, amount: BalanceOf<T>, ) -> DispatchResult
Refunds native currency first (capped by [NativeDepositOf]); any shortfall is taken from
PGAS with RefundPercent refunded and the rest burned. When dst is [Funds::TxFee],
the native portion is routed into the tx fee pool instead of the embedded account’s
free balance. The PGAS portion (if any) is always settled to the account embedded in
dst.
Note: callers must run inside a storage layer so partial state rolls back on error.
Source§fn total_on_hold(reason: HoldReason, who: &T::AccountId) -> BalanceOf<T>
fn total_on_hold(reason: HoldReason, who: &T::AccountId) -> BalanceOf<T>
Sum of who’s native and PGAS balances on hold for reason.
Source§fn refund_all(
from: &T::AccountId,
dst: Funds<'_, T::AccountId>,
) -> Result<BalanceOf<T>, DispatchError>
fn refund_all( from: &T::AccountId, dst: Funds<'_, T::AccountId>, ) -> Result<BalanceOf<T>, DispatchError>
Refunds the full native hold to dst ignoring the per-contributor cap, then settles the
PGAS hold via Self::settle_pgas_refund (refunding RefundPercent to dst and burning
the rest). The native cap only makes sense for partial refunds on a live contract; at
termination there is one recipient and the contract is gone.
Note: callers must run inside a storage layer so partial state rolls back on error.
Source§fn migrate_native_to_pgas(
reason: HoldReason,
contract: &T::AccountId,
amount: BalanceOf<T>,
) -> DispatchResult
fn migrate_native_to_pgas( reason: HoldReason, contract: &T::AccountId, amount: BalanceOf<T>, ) -> DispatchResult
Bring a pre-existing contract up to the post-Self::init_contract invariant:
mint and freeze the PGAS ED if missing, then burn the native hold under reason and
replace it with the same amount of PGAS held on contract.
Source§const SUPPORTS_PGAS: bool = true
const SUPPORTS_PGAS: bool = true
Auto Trait Implementations§
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Freeze for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> RefUnwindSafe for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>where
T: RefUnwindSafe,
Mutator: RefUnwindSafe,
Holder: RefUnwindSafe,
Freezer: RefUnwindSafe,
Id: RefUnwindSafe,
RefundPercent: RefUnwindSafe,
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Send for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Sync for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> Unpin for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>
impl<T, Mutator, Holder, Freezer, Id, RefundPercent> UnwindSafe for PGasDeposit<T, Mutator, Holder, Freezer, Id, RefundPercent>where
T: UnwindSafe,
Mutator: UnwindSafe,
Holder: UnwindSafe,
Freezer: UnwindSafe,
Id: UnwindSafe,
RefundPercent: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
§fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self>where
Self: TryFrom<T>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T, U> DefensiveTruncateInto<U> for Twhere
U: DefensiveTruncateFrom<T>,
impl<T, U> DefensiveTruncateInto<U> for Twhere
U: DefensiveTruncateFrom<T>,
§fn defensive_truncate_into(self) -> U
fn defensive_truncate_into(self) -> U
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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§impl<Src, Dest> IntoTuple<Dest> for Srcwhere
Dest: FromTuple<Src>,
impl<Src, Dest> IntoTuple<Dest> for Srcwhere
Dest: FromTuple<Src>,
fn into_tuple(self) -> Dest
§impl<T> IsType<T> for T
impl<T> IsType<T> for T
§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T. Read more§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
type Error = <U as TryFromKey<T>>::Error
fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T.