# IMetaSwap

## Functions:

* [`getA()`](#IMetaSwap-getA--)
* [`getToken(uint8 index)`](#IMetaSwap-getToken-uint8-)
* [`getTokenIndex(address tokenAddress)`](#IMetaSwap-getTokenIndex-address-)
* [`getTokenBalance(uint8 index)`](#IMetaSwap-getTokenBalance-uint8-)
* [`getVirtualPrice()`](#IMetaSwap-getVirtualPrice--)
* [`isGuarded()`](#IMetaSwap-isGuarded--)
* [`calculateSwap(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx)`](#IMetaSwap-calculateSwap-uint8-uint8-uint256-)
* [`calculateSwapUnderlying(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx)`](#IMetaSwap-calculateSwapUnderlying-uint8-uint8-uint256-)
* [`calculateTokenAmount(uint256[] amounts, bool deposit)`](#IMetaSwap-calculateTokenAmount-uint256---bool-)
* [`calculateRemoveLiquidity(uint256 amount)`](#IMetaSwap-calculateRemoveLiquidity-uint256-)
* [`calculateRemoveLiquidityOneToken(uint256 tokenAmount, uint8 tokenIndex)`](#IMetaSwap-calculateRemoveLiquidityOneToken-uint256-uint8-)
* [`initialize(contract IERC20[] _pooledTokens, uint8[] decimals, string lpTokenName, string lpTokenSymbol, uint256 _a, uint256 _fee, uint256 _adminFee, address lpTokenTargetAddress)`](#IMetaSwap-initialize-contract-IERC20---uint8---string-string-uint256-uint256-uint256-address-)
* [`initializeMetaSwap(contract IERC20[] _pooledTokens, uint8[] decimals, string lpTokenName, string lpTokenSymbol, uint256 _a, uint256 _fee, uint256 _adminFee, address lpTokenTargetAddress, contract ISwap baseSwap)`](#IMetaSwap-initializeMetaSwap-contract-IERC20---uint8---string-string-uint256-uint256-uint256-address-contract-ISwap-)
* [`swap(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy, uint256 deadline)`](#IMetaSwap-swap-uint8-uint8-uint256-uint256-uint256-)
* [`swapUnderlying(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy, uint256 deadline)`](#IMetaSwap-swapUnderlying-uint8-uint8-uint256-uint256-uint256-)
* [`addLiquidity(uint256[] amounts, uint256 minToMint, uint256 deadline)`](#IMetaSwap-addLiquidity-uint256---uint256-uint256-)
* [`removeLiquidity(uint256 amount, uint256[] minAmounts, uint256 deadline)`](#IMetaSwap-removeLiquidity-uint256-uint256---uint256-)
* [`removeLiquidityOneToken(uint256 tokenAmount, uint8 tokenIndex, uint256 minAmount, uint256 deadline)`](#IMetaSwap-removeLiquidityOneToken-uint256-uint8-uint256-uint256-)
* [`removeLiquidityImbalance(uint256[] amounts, uint256 maxBurnAmount, uint256 deadline)`](#IMetaSwap-removeLiquidityImbalance-uint256---uint256-uint256-)

## Function `getA() → uint256` <a href="#imetaswap-geta" id="imetaswap-geta"></a>

No description

## Function `getToken(uint8 index) → contract IERC20` <a href="#imetaswap-gettoken-uint8" id="imetaswap-gettoken-uint8"></a>

No description

## Function `getTokenIndex(address tokenAddress) → uint8` <a href="#imetaswap-gettokenindex-address" id="imetaswap-gettokenindex-address"></a>

No description

## Function `getTokenBalance(uint8 index) → uint256` <a href="#imetaswap-gettokenbalance-uint8" id="imetaswap-gettokenbalance-uint8"></a>

No description

## Function `getVirtualPrice() → uint256` <a href="#imetaswap-getvirtualprice" id="imetaswap-getvirtualprice"></a>

No description

## Function `isGuarded() → bool` <a href="#imetaswap-isguarded" id="imetaswap-isguarded"></a>

No description

## Function `calculateSwap(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx) → uint256` <a href="#imetaswap-calculateswap-uint8-uint8-uint256" id="imetaswap-calculateswap-uint8-uint8-uint256"></a>

No description

## Function `calculateSwapUnderlying(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx) → uint256` <a href="#imetaswap-calculateswapunderlying-uint8-uint8-uint256" id="imetaswap-calculateswapunderlying-uint8-uint8-uint256"></a>

No description

## Function `calculateTokenAmount(uint256[] amounts, bool deposit) → uint256` <a href="#imetaswap-calculatetokenamount-uint256-bool" id="imetaswap-calculatetokenamount-uint256-bool"></a>

No description

## Function `calculateRemoveLiquidity(uint256 amount) → uint256[]` <a href="#imetaswap-calculateremoveliquidity-uint256" id="imetaswap-calculateremoveliquidity-uint256"></a>

No description

## Function `calculateRemoveLiquidityOneToken(uint256 tokenAmount, uint8 tokenIndex) → uint256 availableTokenAmount` <a href="#imetaswap-calculateremoveliquidityonetoken-uint256-uint8" id="imetaswap-calculateremoveliquidityonetoken-uint256-uint8"></a>

No description

## Function `initialize(contract IERC20[] _pooledTokens, uint8[] decimals, string lpTokenName, string lpTokenSymbol, uint256 _a, uint256 _fee, uint256 _adminFee, address lpTokenTargetAddress)` <a href="#imetaswap-initialize-contract-ierc20-uint8-string-string-uint256-uint256-uint256-address" id="imetaswap-initialize-contract-ierc20-uint8-string-string-uint256-uint256-uint256-address"></a>

No description

## Function `initializeMetaSwap(contract IERC20[] _pooledTokens, uint8[] decimals, string lpTokenName, string lpTokenSymbol, uint256 _a, uint256 _fee, uint256 _adminFee, address lpTokenTargetAddress, contract ISwap baseSwap)` <a href="#imetaswap-initializemetaswap-contract-ierc20-uint8-string-string-uint256-uint256-uint256-address-con" id="imetaswap-initializemetaswap-contract-ierc20-uint8-string-string-uint256-uint256-uint256-address-con"></a>

No description

## Function `swap(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy, uint256 deadline) → uint256` <a href="#imetaswap-swap-uint8-uint8-uint256-uint256-uint256" id="imetaswap-swap-uint8-uint8-uint256-uint256-uint256"></a>

No description

## Function `swapUnderlying(uint8 tokenIndexFrom, uint8 tokenIndexTo, uint256 dx, uint256 minDy, uint256 deadline) → uint256` <a href="#imetaswap-swapunderlying-uint8-uint8-uint256-uint256-uint256" id="imetaswap-swapunderlying-uint8-uint8-uint256-uint256-uint256"></a>

No description

## Function `addLiquidity(uint256[] amounts, uint256 minToMint, uint256 deadline) → uint256` <a href="#imetaswap-addliquidity-uint256-uint256-uint256" id="imetaswap-addliquidity-uint256-uint256-uint256"></a>

No description

## Function `removeLiquidity(uint256 amount, uint256[] minAmounts, uint256 deadline) → uint256[]` <a href="#imetaswap-removeliquidity-uint256-uint256-uint256" id="imetaswap-removeliquidity-uint256-uint256-uint256"></a>

No description

## Function `removeLiquidityOneToken(uint256 tokenAmount, uint8 tokenIndex, uint256 minAmount, uint256 deadline) → uint256` <a href="#imetaswap-removeliquidityonetoken-uint256-uint8-uint256-uint256" id="imetaswap-removeliquidityonetoken-uint256-uint8-uint256-uint256"></a>

No description

## Function `removeLiquidityImbalance(uint256[] amounts, uint256 maxBurnAmount, uint256 deadline) → uint256` <a href="#imetaswap-removeliquidityimbalance-uint256-uint256-uint256" id="imetaswap-removeliquidityimbalance-uint256-uint256-uint256"></a>

No description


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.saddle.finance/solidity-docs/interfaces/imetaswap.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.