Queries

There are some functions can be used to query the Vault information and state.

getTokenAddresses

/// @notice Return token addresses of the Vault
function getTokenAddresses() external view returns (address[2] memory)

getLstParams

Function interface:

/// @notice Returns the LP parameters
/// @return The array of LP parameters
function getLstParams() external view returns (LstParam[] memory)

getLpParams returns the current parameters of the Vault as an array of LstParam. The below is the structure of the LstParam:

struct LstParam {
  /// upperTick of the Knockout position
  int24 upperTick;
  /// lowerTick of the Knockout position
  int24 lowerTick;
  /// pivot time of the Knockout position 
  uint32 pivot;
}

getLpWeights

/// @notice Returns the LP weights
/// @return The array of LP weights
function getLpWeights() external view returns (uint16[] memory)

LpWeights is the weight of each LstParam when providing liquidity.

getPosition

/// @notice Returns the position information for the specified LP parameter
/// @param lstParam The LP parameter
/// @return The position information (liquidity, amount0, amount1, isKnockedOut)
function getPosition(LstParam memory lstParam) external view returns (uint128, uint128, uint128, bool)

LstParam can be fetched by calling getLstParams

getAllPositions

/// @notice Returns the position information for all LP parameters
/// @return The total position information (liquidity, amount0, amount1)
function getAllPositions() external view returns (uint128, uint128, uint128)

getPositions

/// @notice Gets the current token amounts of the Vault
/// @return amount0Invested Amount of token 0 was invested to the Ambient's underlying pool
/// @return amount1Invested Amount of token 1 was invested to the Ambient's underlying pool
/// @return amount0Idle Amount of token 0 was not invested to the Ambient's underlying pool (the dust after providing liquidity or swapping))
/// @return amount1Idle Amount of token 1 was not invested to the Ambient's underlying pool (the dust after providing liquidity or swapping)
/// @return amountInQueue Amount of token which is withdrawn and is being in withdrawal queue of LST/LRT protocol
/// @return amountUnwrappedToken Amount of unwrapped token but has not been withdrawn yet. This value is always zero if the token addresses does not contains any wrap token
  function getPositions()
    external
    view
    returns (
      uint256 amount0Invested,
      uint256 amount1Invested,
      uint256 amount0Idle,
      uint256 amount1Idle,
      uint256 amountInQueue,
      uint256 amountUnwrappedToken
    )

totalAssets

/// @notice Returns the approximate total assets held by the Vault
/// @return The total assets
function totalAssets() public view returns (uint256)

currentTick

/// @notice Returns the current tick of the Ambient's underlying pool
/// @return The current tick
function currentTick() public view returns (int24)

previewDeposit

/// @notice Calculates the number of shares for the given amount of assets
/// @param assets The amount of assets
/// @return The number of shares
function previewDeposit(uint256 assets) external view returns (uint256)

previewWithdraw

/// @notice Calculates the number of shares for the given amount of assets to withdraw
/// @param assets The amount of assets
/// @return The number of shares
function previewWithdraw(uint256 assets) external view returns (uint256)

convertToShares

/// @notice Converts a given amount to shares
/// @param amount The amount to convert
/// @return The number of shares corresponding to the amount
function convertToShares(uint256 amount) external view returns (uint256)

convertToAssets

/// @notice Converts a given number of shares to assets
/// @param shares The number of shares
/// @return The amount of assets corresponding to the shares
function convertToAssets(uint256 shares) external view returns (uint256)