Mints a specific amount of vault shares to the receiver by depositing the required amount of underlying assets, returning the amount of assets deposited.
e - Access to the Soroban environment.shares - The amount of vault shares to mint.receiver - The address that will receive the minted vault shares.from - The address that will provide the underlying assets.operator - The address performing the mint operation.crate::vault::VaultTokenError::VaultExceededMaxMint] - When
attempting to mint more shares than the maximum allowed for the
receiver.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.["deposit", operator: Address, from: Address, receiver: Address][assets: i128, shares: i128]⚠️ SECURITY RISK: This function has NO AUTHORIZATION CONTROLS ⚠️
Authorization
fn mint(
env: soroban_sdk::Env,
shares: i128,
receiver: soroban_sdk::Address,
from: soroban_sdk::Address,
operator: soroban_sdk::Address,
) -> i128Returns the name for this token.
e - Access to Soroban environment.fn name(env: soroban_sdk::Env) -> soroban_sdk::StringRedeems a specific amount of vault shares for underlying assets, returning the amount of underlying assets received.
e - Access to the Soroban environment.shares - The amount of vault shares to redeem.receiver - The address that will receive the underlying assets.owner - The address that owns the vault shares to be burned.operator - The address performing the redemption operation.crate::vault::VaultTokenError::VaultExceededMaxRedeem] - When
attempting to redeem more shares than the maximum allowed for the
owner.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.["withdraw", operator: Address, receiver: Address, owner: Address][assets: i128, shares: i128]⚠️ SECURITY RISK: This function has NO AUTHORIZATION CONTROLS ⚠️
Authorization for the operator must be ha
fn redeem(
env: soroban_sdk::Env,
shares: i128,
receiver: soroban_sdk::Address,
owner: soroban_sdk::Address,
operator: soroban_sdk::Address,
) -> i128Returns the symbol for this token.
e - Access to Soroban environment.fn symbol(env: soroban_sdk::Env) -> soroban_sdk::StringSets the amount of tokens a spender is allowed to spend on behalf of
an owner. Overrides any existing allowance set between spender and
owner.
e - Access to Soroban environment.owner - The address holding the tokens.spender - The address authorized to spend the tokens.amount - The amount of tokens made available to spender.live_until_ledger - The ledger number at which the allowance
expires.FungibleTokenError::InvalidLiveUntilLedger] - Occurs when
attempting to set live_until_ledger that is less than the current
ledger number and greater than 0.FungibleTokenError::LessThanZero] - Occurs when amount < 0.["approve", from: Address, spender: Address][amount: i128, live_until_ledger: u32]fn approve(
env: soroban_sdk::Env,
owner: soroban_sdk::Address,
spender: soroban_sdk::Address,
amount: i128,
live_until_ledger: u32,
)Returns the amount of tokens held by account.
e - Access to the Soroban environment.account - The address for which the balance is being queried.fn balance(env: soroban_sdk::Env, account: soroban_sdk::Address) -> i128Deposits underlying assets into the vault and mints vault shares to the receiver, returning the amount of vault shares minted.
e - Access to the Soroban environment.assets - The amount of underlying assets to deposit.receiver - The address that will receive the minted vault shares.from - The address that will provide the underlying assets.operator - The address performing the deposit operation.crate::vault::VaultTokenError::VaultExceededMaxDeposit] - When
attempting to deposit more assets than the maximum allowed for the
receiver.crate::vault::VaultTokenError::VaultInvalidAssetsAmount] - When
assets < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.["deposit", operator: Address, from: Address, receiver: Address][assets: i128, shares: i128]⚠️ SECURITY RISK: This function has NO AUTHORIZATION CONTROLS ⚠️
Authorization for the op
fn deposit(
env: soroban_sdk::Env,
assets: i128,
receiver: soroban_sdk::Address,
from: soroban_sdk::Address,
operator: soroban_sdk::Address,
) -> i128fn upgrade(
env: soroban_sdk::Env,
new_wasm_hash: soroban_sdk::BytesN<32>,
operator: soroban_sdk::Address,
)fn decimals(env: soroban_sdk::Env) -> u32Returns the maximum amount of vault shares that can be minted
for the given receiver address (currently i128::MAX).
e - Access to the Soroban environment.receiver - The address that would receive the vault shares.fn max_mint(env: soroban_sdk::Env, receiver: soroban_sdk::Address) -> i128Transfers amount of tokens from from to to.
e - Access to Soroban environment.from - The address holding the tokens.to - The address receiving the transferred tokens.amount - The amount of tokens to be transferred.FungibleTokenError::InsufficientBalance] - When attempting to
transfer more tokens than from current balance.FungibleTokenError::LessThanZero] - When amount < 0.["transfer", from: Address, to: Address][to_muxed_id: Option<u64>, amount: i128]fn transfer(
env: soroban_sdk::Env,
from: soroban_sdk::Address,
to: soroban_sdk::MuxedAddress,
amount: i128,
)Withdraws a specific amount of underlying assets from the vault by burning the required amount of vault shares from the owner, returning the amount of vault shares burned.
e - Access to the Soroban environment.assets - The amount of underlying assets to withdraw.receiver - The address that will receive the underlying assets.owner - The address that owns the vault shares to be burned.operator - The address performing the withdrawal operation.crate::vault::VaultTokenError::VaultExceededMaxWithdraw] - When
attempting to withdraw more assets than the maximum allowed for the
owner.["withdraw", operator: Address, receiver: Address, owner: Address][assets: i128, shares: i128]⚠️ SECURITY RISK: This function has NO AUTHORIZATION CONTROLS ⚠️
Authorization for the operator must be handled at a higher level.
fn withdraw(
env: soroban_sdk::Env,
assets: i128,
receiver: soroban_sdk::Address,
owner: soroban_sdk::Address,
operator: soroban_sdk::Address,
) -> i128Returns the amount of tokens a spender is allowed to spend on behalf
of an owner.
e - Access to Soroban environment.owner - The address holding the tokens.spender - The address authorized to spend the tokens.fn allowance(
env: soroban_sdk::Env,
owner: soroban_sdk::Address,
spender: soroban_sdk::Address,
) -> i128Returns Some(Address) if ownership is set, or None if ownership has
been renounced.
e - Access to the Soroban environment.fn get_owner(env: soroban_sdk::Env) -> OptionReturns the maximum amount of vault shares that can be redeemed by the given owner (equal to their vault share balance).
e - Access to the Soroban environment.owner - The address that owns the vault shares.fn max_redeem(env: soroban_sdk::Env, owner: soroban_sdk::Address) -> i128Returns the maximum amount of underlying assets that can be deposited
for the given receiver address (currently i128::MAX).
e - Access to the Soroban environment.receiver - The address that would receive the vault shares.fn max_deposit(env: soroban_sdk::Env, receiver: soroban_sdk::Address) -> i128Returns the address of the underlying asset that the vault manages.
e - Access to the Soroban environment.crate::vault::VaultTokenError::VaultAssetAddressNotSet] - When the
vault's underlying asset address has not been initialized.fn query_asset(env: soroban_sdk::Env) -> soroban_sdk::AddressReturns the maximum amount of underlying assets that can be withdrawn by the given owner, limited by their vault share balance.
e - Access to the Soroban environment.owner - The address that owns the vault shares.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn max_withdraw(env: soroban_sdk::Env, owner: soroban_sdk::Address) -> i128Simulates and returns the amount of underlying assets required to mint a given amount of vault shares (rounded up).
e - Access to the Soroban environment.shares - The amount of vault shares to simulate minting.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn preview_mint(env: soroban_sdk::Env, shares: i128) -> i128Returns the total amount of underlying assets held by the vault.
This represents the vault's balance of the underlying asset, which determines the conversion rate between shares and assets.
e - Access to the Soroban environment.crate::vault::VaultTokenError::VaultAssetAddressNotSet] - When the
vault's underlying asset address has not been initialized.fn total_assets(env: soroban_sdk::Env) -> i128Returns the total amount of tokens in circulation.
e - Access to the Soroban environment.fn total_supply(env: soroban_sdk::Env) -> i128fn __constructor(
env: soroban_sdk::Env,
name: soroban_sdk::String,
symbol: soroban_sdk::String,
asset: soroban_sdk::Address,
decimals_offset: u32,
owner: soroban_sdk::Address,
)Transfers amount of tokens from from to to using the
allowance mechanism. amount is then deducted from spender
allowance.
e - Access to Soroban environment.spender - The address authorizing the transfer, and having its
allowance consumed during the transfer.from - The address holding the tokens which will be transferred.to - The address receiving the transferred tokens.amount - The amount of tokens to be transferred.FungibleTokenError::InsufficientBalance] - When attempting to
transfer more tokens than from current balance.FungibleTokenError::LessThanZero] - When amount < 0.FungibleTokenError::InsufficientAllowance] - When attempting to
transfer more tokens than spender current allowance.["transfer", from: Address, to: Address][amount: i128]fn transfer_from(
env: soroban_sdk::Env,
spender: soroban_sdk::Address,
from: soroban_sdk::Address,
to: soroban_sdk::Address,
amount: i128,
)Simulates and returns the amount of underlying assets that would be received for redeeming a given amount of vault shares (rounded down).
e - Access to the Soroban environment.shares - The amount of vault shares to simulate redeeming.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn preview_redeem(env: soroban_sdk::Env, shares: i128) -> i128Simulates and returns the amount of vault shares that would be minted for a given deposit of underlying assets (rounded down).
e - Access to the Soroban environment.assets - The amount of underlying assets to simulate depositing.crate::vault::VaultTokenError::VaultInvalidAssetsAmount] - When
assets < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn preview_deposit(env: soroban_sdk::Env, assets: i128) -> i128Accepts a pending ownership transfer.
e - Access to the Soroban environment.crate::role_transfer::RoleTransferError::NoPendingTransfer] - If
there is no pending transfer to accept.["ownership_transfer_completed"][new_owner: Address]fn accept_ownership(env: soroban_sdk::Env)Simulates and returns the amount of vault shares that would be burned to withdraw a given amount of underlying assets (rounded up).
e - Access to the Soroban environment.assets - The amount of underlying assets to simulate withdrawing.crate::vault::VaultTokenError::VaultInvalidAssetsAmount] - When
assets < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn preview_withdraw(env: soroban_sdk::Env, assets: i128) -> i128Converts an amount of vault shares to the equivalent amount of underlying assets (rounded down).
e - Access to the Soroban environment.shares - The amount of vault shares to convert.crate::vault::VaultTokenError::VaultInvalidSharesAmount] - When
shares < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn convert_to_assets(env: soroban_sdk::Env, shares: i128) -> i128Converts an amount of underlying assets to the equivalent amount of vault shares (rounded down).
e - Access to the Soroban environment.assets - The amount of underlying assets to convert.crate::vault::VaultTokenError::VaultInvalidAssetsAmount] - When
assets < 0.crate::vault::VaultTokenError::MathOverflow] - When mathematical
operations result in overflow.fn convert_to_shares(env: soroban_sdk::Env, assets: i128) -> i128Renounces ownership of the contract.
Permanently removes the owner, disabling all functions gated by
#[only_owner].
e - Access to the Soroban environment.OwnableError::TransferInProgress] - If there is a pending ownership
transfer.OwnableError::OwnerNotSet] - If the owner is not set.fn renounce_ownership(env: soroban_sdk::Env)Initiates a 2-step ownership transfer to a new address.
Requires authorization from the current owner. The new owner must later
call accept_ownership() to complete the transfer.
e - Access to the Soroban environment.new_owner - The proposed new owner.live_until_ledger - Ledger number until which the new owner can
accept. A value of 0 cancels any pending transfer.OwnableError::OwnerNotSet] - If the owner is not set.crate::role_transfer::RoleTransferError::NoPendingTransfer] - If
trying to cancel a transfer that doesn't exist.crate::role_transfer::RoleTransferError::InvalidLiveUntilLedger] -
If the specified ledger is in the past.crate::role_transfer::RoleTransferError::InvalidPendingAccount] -
If the specified pending account is not the same as the provided new
address.fn transfer_ownership(
env: soroban_sdk::Env,
new_owner: soroban_sdk::Address,
live_until_ledger: u32,
)