Enum OpState

pub enum OpState {
    Idle,
    Allocating(AllocatingState),
    Withdrawing(WithdrawingState),
    Payout(PayoutState),
}

Operation state machine for asynchronous allocation, withdrawal, and payout flows.

State machine:

• Allocating -> Withdrawing (or Idle via stop)
• Withdrawing -> Withdrawing (advance) | Payout | Idle (refund)
• Payout -> Idle (success or failure)

Invariants:

• idle_balance increases only when funds are received and decreases only on payout success.
• escrow_shares are refunded on stop/failure or partially burned/refunded on payout success.

Variants

Idle

No operation in-flight. The vault is ready to start a new allocation or withdrawal.

Allocating(AllocatingState)

Supplying idle underlying to markets according to a plan or queue.

Transitions:

• On completion of allocation: Withdrawing (to satisfy pending user requests) or Idle (if stopped).
• On stop/failure: Idle.

Withdrawing(WithdrawingState)

Collecting liquidity from markets to satisfy a user withdrawal/redeem request.

Transitions:

• Advance within queue: Withdrawing (index increments) while collecting funds.
• When enough is collected to satisfy the request: Payout.
• If the op is stopped or cannot proceed and needs to refund: Idle (escrow_shares refunded).

Payout(PayoutState)

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.

Trait Implementations

impl AsRef<AllocatingState> for OpState

fn as_ref(&self) -> &AllocatingState

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

impl AsRef<IdleState> for OpState

fn as_ref(&self) -> &IdleState

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

impl AsRef<PayoutState> for OpState

fn as_ref(&self) -> &PayoutState

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

impl AsRef<WithdrawingState> for OpState

fn as_ref(&self) -> &WithdrawingState

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

impl BorshDeserialize for OpState

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 OpState

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

impl Clone for OpState

fn clone(&self) -> OpState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpState

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

Formats the value using the given formatter.

impl EnumExt for OpState

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

Deserialises given variant of an enum from the reader.

impl From<AllocatingState> for OpState

fn from(s: AllocatingState) -> Self

Converts to this type from the input type.

impl From<IdleState> for OpState

fn from(_: IdleState) -> Self

Converts to this type from the input type.

impl From<PayoutState> for OpState

fn from(s: PayoutState) -> Self

Converts to this type from the input type.

impl From<WithdrawingState> for OpState

fn from(s: WithdrawingState) -> Self

Converts to this type from the input type.

impl PartialEq for OpState

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

impl StructuralPartialEq for OpState