Struct VaultState

Source
pub struct VaultState {
    pub total_assets: u128,
    pub total_shares: u128,
    pub idle_assets: u128,
    pub external_assets: u128,
    pub fee_anchor: FeeAccrualAnchor,
    pub op_state: OpState,
    pub withdraw_queue: WithdrawQueue,
    pub next_op_id: u64,
}
Expand description

Core kernel vault state.

This struct contains all the state managed by the kernel. Chain-specific executors are responsible for:

  • Persisting this state to storage
  • Handling share/asset token balances

§Invariants

  • total_assets == idle_assets + external_assets
  • withdraw_queue.check_invariants()
  • next_op_id is monotonically increasing
  • Operations can only proceed when op_state allows them

Fields§

§total_assets: u128§total_shares: u128§idle_assets: u128§external_assets: u128§fee_anchor: FeeAccrualAnchor§op_state: OpState§withdraw_queue: WithdrawQueue§next_op_id: u64

Implementations§

Source§

impl VaultState

Source

pub fn new() -> Self

Source

pub fn with_initial( total_assets: u128, total_shares: u128, idle_assets: u128, external_assets: u128, timestamp_ns: TimestampNs, ) -> Self

Source

pub fn check_invariant(&self) -> bool

Check the fundamental accounting invariant.

Returns true if total_assets == idle_assets + external_assets.

Source

pub fn allocate_op_id(&mut self) -> u64

Allocate and return the next operation ID.

Increments next_op_id and returns the previous value.

Source

pub fn is_idle(&self) -> bool

Check if the vault is idle (no operation in progress).

Source

pub fn current_op_id(&self) -> Option<u64>

Get the current operation ID if an operation is in progress.

Source

pub fn sync_total_assets(&mut self)

Recompute total_assets from idle_assets + external_assets.

Call this after any mutation of idle_assets or external_assets to restore the fundamental accounting invariant.

Source

pub fn restore_to_idle(&mut self, amount: u128)

Add amount back to idle assets and recompute totals.

Common pattern during abort / emergency-reset paths where in-flight assets are returned to idle.

Trait Implementations§

Source§

impl BorshDeserialize for VaultState

Source§

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,

Source§

impl BorshSerialize for VaultState

Source§

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

Source§

impl Clone for VaultState

Source§

fn clone(&self) -> VaultState

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VaultState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VaultState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for VaultState

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for VaultState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for VaultState

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for VaultState

Source§

impl StructuralPartialEq for VaultState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,