Enum OpState

pub enum OpState {
    Idle,
    Allocating(AllocatingState),
    Withdrawing(WithdrawingState),
    Refreshing(RefreshingState),
    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)
• Refreshing -> Idle
• 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 targets 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 targets 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).

Refreshing(RefreshingState)

Read-only refresh of target principals to update stored AUM.

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.

Implementations

impl OpState

pub const fn is_idle(&self) -> bool

Returns true if this value is of type Idle. Returns false otherwise

pub const fn is_allocating(&self) -> bool

Returns true if this value is of type Allocating. Returns false otherwise

pub const fn is_withdrawing(&self) -> bool

Returns true if this value is of type Withdrawing. Returns false otherwise

pub const fn is_refreshing(&self) -> bool

Returns true if this value is of type Refreshing. Returns false otherwise

pub const fn is_payout(&self) -> bool

Returns true if this value is of type Payout. Returns false otherwise

impl OpState

pub const fn kind_code(&self) -> u32

Returns a numeric code for the current op state.

pub const fn kind_name(&self) -> &'static str

Returns a human-readable name for the current op state.

pub const fn as_idle(&self) -> Option<&IdleState>

Returns a reference to the idle state if this is Idle, otherwise None.

pub const fn as_allocating(&self) -> Option<&AllocatingState>

Returns a reference to the allocating state if this is Allocating, otherwise None.

pub const fn as_withdrawing(&self) -> Option<&WithdrawingState>

Returns a reference to the withdrawing state if this is Withdrawing, otherwise None.

pub const fn as_refreshing(&self) -> Option<&RefreshingState>

Returns a reference to the refreshing state if this is Refreshing, otherwise None.

pub const fn as_payout(&self) -> Option<&PayoutState>

Returns a reference to the payout state if this is Payout, otherwise None.

pub const fn op_id(&self) -> Option<u64>

Returns the operation ID if this state has one, otherwise None.

Trait Implementations

impl BorshDeserialize for OpState

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

where __R: Read,

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 OpState

fn declaration() -> String

Get the name of the type without brackets.

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

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

impl BorshSerialize for OpState

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

where __W: Write,

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<(), Error>

Formats the value using the given formatter.

impl Default for OpState

fn default() -> OpState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpState

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnumExt for OpState

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

where __R: Read,

Deserialises given variant of an enum from the reader.

impl From<AllocatingState> for OpState

fn from(value: AllocatingState) -> OpState

Converts to this type from the input type.

impl From<IdleState> for OpState

fn from(_: IdleState) -> OpState

Converts to this type from the input type.

impl From<PayoutState> for OpState

fn from(value: PayoutState) -> OpState

Converts to this type from the input type.

impl From<RefreshingState> for OpState

fn from(value: RefreshingState) -> OpState

Converts to this type from the input type.

impl From<WithdrawingState> for OpState

fn from(value: WithdrawingState) -> OpState

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 Serialize for OpState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OpState

impl StructuralPartialEq for OpState