Struct PayoutState

pub struct PayoutState {
    pub op_id: u64,
    pub receiver: Address,
    pub amount: u128,
    pub owner: Address,
    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

receiver: Address

amount: u128

owner: Address

escrow_shares: u128

burn_shares: u128

Trait Implementations

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 BorshSchema for PayoutState

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

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<'de> Deserialize<'de> for PayoutState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PayoutState> for OpState

fn from(value: 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 Serialize for PayoutState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PayoutState

impl StructuralPartialEq for PayoutState