Enum HandleRefundMode

pub enum HandleRefundMode {
    Burn {
        limit: U512,
        cost: U512,
        consumed: U512,
        gas_price: u8,
        source: Box<BalanceIdentifier>,
        ratio: Ratio<u64>,
    },
    Refund {
        initiator_addr: Box<InitiatorAddr>,
        limit: U512,
        cost: U512,
        consumed: U512,
        gas_price: u8,
        ratio: Ratio<u64>,
        source: Box<BalanceIdentifier>,
        target: Box<BalanceIdentifier>,
    },
    RefundNoFeeCustomPayment {
        initiator_addr: Box<InitiatorAddr>,
        limit: U512,
        cost: U512,
        gas_price: u8,
    },
    CalculateAmount {
        limit: U512,
        cost: U512,
        consumed: U512,
        gas_price: u8,
        ratio: Ratio<u64>,
        source: Box<BalanceIdentifier>,
    },
    SetRefundPurse {
        target: Box<BalanceIdentifier>,
    },
    ClearRefundPurse,
}

Selects refund operation.

Variants

Burn

This variant will cause the refund amount to be calculated and then burned.

Fields

limit: U512

Refund limit.

cost: U512

Refund cost.

consumed: U512

Refund consumed.

gas_price: u8

Refund gas price.

source: Box<BalanceIdentifier>

Refund source.

ratio: Ratio<u64>

Refund ratio.

Refund

This variant will cause the refund amount to be calculated and the refund to be executed.

Fields

initiator_addr: Box<InitiatorAddr>

Refund initiator.

limit: U512

Refund limit.

cost: U512

Refund cost.

consumed: U512

Refund consumed.

gas_price: u8

Refund gas price.

ratio: Ratio<u64>

Refund ratio.

source: Box<BalanceIdentifier>

Refund source.

target: Box<BalanceIdentifier>

Target for refund.

RefundNoFeeCustomPayment

This variant handles the edge case of custom payment plus no fee plus no refund. This ultimately turns into a hold on the initiator, but it takes extra steps to get there because the payment has already been fully processed up front and must first be unwound.

Fields

initiator_addr: Box<InitiatorAddr>

Refund initiator.

limit: U512

Refund limit.

cost: U512

Refund cost.

gas_price: u8

Refund gas price.

CalculateAmount

This variant only calculates and returns the refund amount. It does not execute a refund.

Fields

limit: U512

Refund limit.

cost: U512

Refund cost.

consumed: U512

Refund consumed.

gas_price: u8

Refund gas price.

ratio: Ratio<u64>

Refund ratio.

source: Box<BalanceIdentifier>

Refund source.

SetRefundPurse

This variant will cause the refund purse tracked by handle_payment to be set.

Fields

target: Box<BalanceIdentifier>

Target for refund, which will receive any refunded token while set.

ClearRefundPurse

This variant will cause the refund purse tracked by handle_payment to be cleared.

Implementations

impl HandleRefundMode

pub fn phase(&self) -> Phase

Returns the appropriate phase for the mode.

Trait Implementations

impl Clone for HandleRefundMode

fn clone(&self) -> HandleRefundMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HandleRefundMode

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

Formats the value using the given formatter.

impl PartialEq for HandleRefundMode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for HandleRefundMode

impl StructuralPartialEq for HandleRefundMode