Constant Product Pools

Overview

The constant product pool uses the widely known xy=k formula. More details around how the pool functions can be found here.

InstantiateMsg

Initializes a new x*y=k pair.

json

pair.rs

{
  "asset_infos": [
    {
      "token": {
        "contract_addr": "..."
      }
    },
    {
      "native_token": {
        "denom": "..."
      }
    }
  ],
  "token_code_id": 123,
  "factory_addr": "terra...",
  "init_params": "<base64_encoded_json_string>"
}

Params	Type	Description
`asset_infos`	`Vec<AssetInfo>`	Information about assets in the pool
`token_code_id`	`u64`	The token contract code ID used for the tokens in the pool
`factory_addr`	`String`	The factory contract address
`init_params`	`Option<Binary>`	Optional binary serialised parameters for custom pool types

NOTE

The contract's configuration cannot be updated for constant product pairs.

ExecuteMsg

`receive`

Withdraws liquidity or assets that were swapped to (ask assets in a swap operation).

json

pair.rs

{
  "receive": {
    "sender": "terra...",
    "amount": "123",
    "msg": "<base64_encoded_json_string>"
  }
}

Params	Type	Description
`receive`	`Cw20ReceiveMsg`	CW20 receive message

`provide_liquidity`

Provides liquidity by sending a user's native or token assets to the pool.

You should increase your token allowance for the pool before providing liquidity!

json

pair.rs

{
  "provide_liquidity": {
    "assets": [
      {
        "info": {
          "token": {
            "contract_addr": "terra..."
          }
        },
        "amount": "1000000"
      },
      {
        "info": {
          "native_token": {
            "denom": "..."
          }
        },
        "amount": "1000000"
      }
    ],
    "slippage_tolerance": "0.01",
    "auto_stake": false,
    "receiver": "terra..."
  }
}

Params	Type	Description
`assets`	`Vec<Asset>`	Describes a native or CW20 asset
`slippage_tolerance`	`Option<Decimal>`	The slippage tolerance that allows liquidity provision only if the price in the pool doesn't move too much
`auto_stake`	`Option<bool>`	Determines whether the LP tokens minted for the user is auto_staked in the Generator contract
`receiver`	`Option<String>`	The receiver of LP tokens

`withdraw_liquidity`

Burns LP tokens and withdraws liquidity from a pool.

NOTE

This call must be sent to the LP token contract associated with the pool from which you want to withdraw liquidity from.

json

pair.rs

{
    "withdraw_liquidity": {}
}

`swap`

Swap performs a swap in the pool.

json

pair.rs

{
  "swap": {
    "offer_asset": {
      "info": {
        "token": {
          "contract_addr": "..."
        }
      }, 
      "amount": "10000000"
    }, 
    "ask_asset_info": {
      "native_token": {
        "denom": "..."
      }
    },
    "belief_price": "1234567", 
    "max_spread": "10000000",
    "to": "...."
  }
}

Params	Type	Description
`offer_asset`	`Asset`	Offer asset
`ask_asset_info`	`Option<AssetInfo>`	Information about an asset stored in a [`AssetInfo`] struct
`belief_price`	`Option<Decimal>`	Belief price
`max_spread`	`Option<Decimal>`	The difference between the ask amount before and after the swap operation. If the swap spread exceeds the provided max limit, the swap will fail. If `belief_price` is provided in combination with `max_spread`, the pool will check the difference between the return amount (using `belief_price`) and the real pool price.
`to`	`Option<String>`	Address receiving tokens (if different from sender)

QueryMsg

`pair`

Queries information about a pair.

json

pair.rs

{
  "pair": {}
}

Returns a PairInfo response struct.

`pool`

Queries information about a pool.

json

pair.rs

{
  "pool": {}
}

`PoolResponse`

This struct is used to return a query result with the total amount of LP tokens and assets in a specific pool.

json

pair.rs

{
    "assets": [
        {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        },
        {
            "info": {
                "native_token": {
                    "denom": "..."
                }
            },
            "amount": "100000"
        }
    ], 
    "total_share": "1234567"
}

Params	Type	Description
`assets`	`Vec<Asset>`	The assets in the pool together with asset amounts
`total_share`	`Uint128`	The total amount of LP tokens currently issued

`config`

Queries contract configuration settings.

json

pair.rs

{
  "config": {}
}

`ConfigResponse`

This struct is used to return a query result with the general contract configuration.

json

pair.rs

{
    "block_time_last": 1234567, 
    "params": "<base64_encoded_json_string>",
    "owner": "..."
}

Params	Type	Description
`block_time_last`	`u64`	The assets in the pool together with asset amounts
`params`	`Option<Binary>`	The pool's parameters
`owner`	`Option<Addr>`	The contract owner

`share`

Queries information about the share of a pool.

json

pair.rs

{
  "share": {
    "amount": "1000000"
  }
}

Params	Type	Description
`amount`	`Uint128`	Share of the pool

Returns a vector that contains objects of type Asset.

`simulation`

Queries information about a swap simulation.

json

pair.rs

{
    "simulation": {
        "offer_asset": {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        }, 
        "ask_asset_info": {
            "native_token": {
                "denom": "..."
            }
        }
    }
}

Params	Type	Description
`offer_asset`	`Asset`	Offer asset
`ask_asset_info`	`Option<AssetInfo>`	Ask asset info

`SimulationResponse`

This structure holds the parameters that are returned from a swap simulation response.

json

pair.rs

{
  "return_amount": "123456",
  "spread_amount": "0",
  "commission_amount": "123"
}

Params	Type	Description
`return_amount`	`Uint128`	The amount of ask assets returned by the swap
`spread_amount`	`Uint128`	The spread used in the swap operation
`commission_amount`	`Uint128`	The amount of fees charged by the transaction

`reverse_simulation`

Queries information about a reverse swap simulation.

json

pair.rs

{
    "reverse_simulation": {
        "offer_asset_info": {
            "native_token": {
                "denom": "..."
            }
        },
        "ask_asset": {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        }
    }
}

Params	Type	Description
`offer_asset_info`	`Option<AssetInfo>`	Offer asset info
`ask_asset`	`Asset`	Ask asset

`ReverseSimulationResponse`

This structure holds the parameters that are returned from a reverse swap simulation response.

json

pair.rs

{
  "offer_amount": "12345",
  "spread_amount": "0",
  "commission_amount": "123"
}

Params	Type	Description
`offer_amount`	`Uint128`	The amount of offer assets returned by the reverse swap
`spread_amount`	`Uint128`	The spread used in the swap operation
`commission_amount`	`Uint128`	The amount of fees charged by the transaction

`cumulative_prices`

Queries information about cumulative prices in a pool.

json

pair.rs

{
  "cumulative_prices": {}
}

`CumulativePricesResponse`

This structure is used to return a cumulative prices query response.

json

pair.rs

{
    "assets": [
        {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        },
        {
            "info": {
                "native_token": {
                    "denom": "..."
                }
            },
            "amount": "100000"
        }
    ], 
    "total_share": "12345667", 
    "price0_cumulative_last": "12345667",
    "price1_cumulative_last": "12345667"
}

Params	Type	Description
`assets`	`Vec<Asset>`	The assets in the pool to query
`total_share`	`Uint128`	The total amount of LP tokens currently issued
`cumulative_prices`	`Vec<(AssetInfo, AssetInfo, Uint128)>`	The vector contains cumulative prices for each pair of assets in the pool

Constant Product Pools

Overview​

Links​

InstantiateMsg​

ExecuteMsg​

receive​

provide_liquidity​

withdraw_liquidity​

swap​

QueryMsg​

pair​

pool​

PoolResponse​

config​

ConfigResponse​

share​

simulation​

SimulationResponse​

reverse_simulation​

ReverseSimulationResponse​

cumulative_prices​

CumulativePricesResponse​

Overview

Links

InstantiateMsg

ExecuteMsg

`receive`

`provide_liquidity`

`withdraw_liquidity`

`swap`

QueryMsg

`pair`

`pool`

`PoolResponse`

`config`

`ConfigResponse`

`share`

`simulation`

`SimulationResponse`

`reverse_simulation`

`ReverseSimulationResponse`

`cumulative_prices`

`CumulativePricesResponse`