Struct PayoutState

pub struct PayoutState {
    pub op_id: u64,
    pub receiver: AccountId,
    pub amount: u128,
    pub owner: AccountId,
    pub escrow_shares: u128,
    pub burn_shares: u128,
}

Final step that transfers assets to the receiver and settles the share escrow.

Transitions:

• On success or failure: Idle.

Invariant hooks:

• idle_balance decreases only on payout success by amount.
• On success, burn_shares are burned from escrow_shares; any remainder is refunded.
• On failure, all escrow_shares are refunded.

Fields

op_id: u64

Unique operation id used to correlate async callbacks and detect drift.

receiver: AccountId

Receiver of the asset payout.

amount: u128

Amount of assets to transfer out from idle_balance.

owner: AccountId

The owner whose shares were escrowed for this payout.

escrow_shares: u128

Total shares currently held in escrow for this operation.

burn_shares: u128

Portion of escrow_shares that will be burned on successful payout.

Trait Implementations

impl AsRef<PayoutState> for OpState

fn as_ref(&self) -> &PayoutState

Converts this type into a shared reference of the (usually inferred) input type.

impl BorshDeserialize for PayoutState

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for PayoutState

fn serialize<__W: Write>(&self, writer: &mut __W) -> Result<(), Error>

impl Clone for PayoutState

fn clone(&self) -> PayoutState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayoutState

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

Formats the value using the given formatter.

impl From<PayoutState> for OpState

fn from(s: PayoutState) -> Self

Converts to this type from the input type.

impl PartialEq for PayoutState

fn eq(&self, other: &PayoutState) -> 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 PayoutState

impl StructuralPartialEq for PayoutState