Enum VaultExecuteMsg

pub enum VaultExecuteMsg {
    DepositFor(RecipientAmount),
    WithdrawTo(RecipientAmount),
    QueueWithdrawalTo(RecipientAmount),
    RedeemWithdrawalTo(Recipient),
    SlashLocked(Amount),
}

Vault ExecuteMsg, to be implemented by the vault contract. Callable by any sender, redeemable by any recipient. The sender can be the same as the recipient in some cases.

Variants

DepositFor(RecipientAmount)

ExecuteMsg DepositFor assets into the vault. Sender must transfer the assets to the vault contract (this is implementation agnostic). The vault contract must mint shares to the recipient. Vault must be whitelisted in the vault-router to accept deposits.

WithdrawTo(RecipientAmount)

ExecuteMsg WithdrawTo assets from the vault. Sender must have enough shares to withdraw the requested amount to the recipient. If the Vault is delegated to an operator, withdrawals must be queued. Operator must not be validating any services for instant withdrawals.

QueueWithdrawalTo(RecipientAmount)

ExecuteMsg QueueWithdrawalTo assets from the vault. Sender must have enough shares to queue the requested amount to the recipient. Once the withdrawal is queued, the recipient can redeem the withdrawal after the lock period. Once the withdrawal is locked, the sender cannot cancel the withdrawal. The time-lock is enforced by the vault and cannot be changed retroactively.

Lock Period Extension

New withdrawals will extend the lock period of any existing withdrawals. You can queue the withdrawal to a different recipient than the sender to avoid this.

RedeemWithdrawalTo(Recipient)

ExecuteMsg RedeemWithdrawalTo all queued shares into assets from the vault for withdrawal. After the lock period, the sender (must be the recipient of the original withdrawal) can redeem the withdrawal.

SlashLocked(Amount)

ExecuteMsg SlashLocked moves the assets from the vault to the vault-router contract for custody. Part of the [https://build.satlayer.xyz/getting-started/slashing](Programmable Slashing) lifecycle. This function can only be called by vault-router, and takes an absolute amount of assets to be moved. The amount is calculated and enforced by the router. Further utility of the assets, post-locked, is implemented and enforced on the router level.

Trait Implementations

impl Clone for VaultExecuteMsg

fn clone(&self) -> VaultExecuteMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VaultExecuteMsg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VaultExecuteMsg

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VaultExecuteMsg

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

Formats the value using the given formatter.

impl JsonSchema for VaultExecuteMsg

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for VaultExecuteMsg

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VaultExecuteMsg