Tokenized Vaults

asset_contract_id(): string

total_asset_amount(): string

convert_to_shares(asset_amount: string): string

convert_to_asset_amount(shares: string): string

max_deposit_amount(receiver_id: string): string

preview_deposit_shares(asset_amount: string): string

max_mint_shares(receiver_id: string): string

preview_asset_amount_required_to_mint_shares(shares: string): string

max_redeem_shares(owner_id: string): string

preview_redeem_amount(shares: string): string

max_withdraw_amount(owner_id: string): string

preview_shares_deducted_for_withdraw(asset_amount: string): string

ft_on_transfer(sender_id: string, amount: string, msg: string): string

pub struct DepositMessage {
    /// Minimum shares that must be received for the deposit to succeed (slippage control).
    min_shares: Option<U128>,
    /// Maximum shares that can be minted, used for `mint` operations.
    max_shares: Option<U128>,
    /// Account that should receive the minted shares.
    receiver_id: Option<AccountId>,
    /// Optional memo for logging or off-chain indexing.
    memo: Option<String>,
    /// If `true`, the transfer is treated as a donation and no shares are minted.
    donate: Option<bool>,
}

redeem(shares: string, min_amount_out: string, receiver_id: string?): string

withdraw(asset_amount: string, max_shares_deducted: string?, receiver_id: string?): string

/// Emitted when a deposit is received by the vault and shares are minted to `owner_id`.
pub struct VaultDeposit {
    /// Account that sends the deposit (payer of the assets).
    pub sender_id: AccountId,
    /// Account that receives the minted shares.
    pub owner_id: AccountId,
    /// Amount of underlying assets deposited into the vault.
    pub asset_amount: U128,
    /// Amount of shares minted and issued to `owner_id`.
    pub shares: U128,
    /// Optional memo provided by the sender for off-chain use.
    pub memo: Option<String>,
}

/// Emitted when shares are redeemed: the vault burns shares from `owner_id`
/// and transfers the equivalent assets to `receiver_id`.
pub struct VaultWithdraw {
    /// Account that owns the shares being redeemed (burned).
    pub owner_id: AccountId,
    /// Account receiving the underlying assets.
    pub receiver_id: AccountId,
    /// Amount of shares redeemed (burned from the vault).
    pub shares: U128,
    /// Amount of underlying assets withdrawn from the vault.
    pub asset_amount: U128,
    /// Optional memo provided by the redeemer for off-chain use.
    pub memo: Option<String>,
}