3 stable releases
1.2.1 | Mar 26, 2024 |
---|---|
1.2.0 | Nov 27, 2023 |
1.1.1 | Jul 20, 2023 |
#9 in #astroport
735 downloads per month
Used in 4 crates
(via cw-it)
260KB
5.5K
SLoC
Astroport Router
The Router contract contains logic to facilitate multi-hop swaps for Terra native & Astroport tokens.
Operations Assertion
For every swap, the contract checks if the resulting token is the one that was asked for and whether the receiving amount exceeds the minimum to receive.
InstantiateMsg
Initializes the contract with the Astroport factory contract address.
{
"astroport_factory": "terra..."
}
ExecuteMsg
receive
CW20 receive msg.
{
"receive": {
"sender": "terra...",
"amount": "123",
"msg": "<base64_encoded_json_string>"
}
}
execute_swap_operation
Swaps one token to another. single defines whether this swap is single or part of a multi hop route. This message is for internal use.
Example
Swap UST => mABNB
{
"execute_swap_operation": {
"operation": {
"astro_swap": {
"offer_asset_info": {
"native_token": {
"denom": "uusd"
}
},
"ask_asset_info": {
"token": {
"contract_addr": "terra..."
}
}
}
},
"to": "terra...",
"max_spread": "0.05",
"single": false
}
}
execute_swap_operations
Performs multi-hop swap operations for native & Astroport tokens. Swaps execute one-by-one and the last swap will return the ask token. This function is public (can be called by anyone).
Contract sets total 'return_amount' in response data after all routes are processed. See SwapResponseData
type for more info.
Note: Response data makes sense ONLY if the first token in multi-hop swap is native. Otherwise, cw20::send message resets response data.
Example
Swap KRT => UST => mABNB
{
"execute_swap_operations": {
"operations": [
{
"native_swap":{
"offer_denom":"ukrw",
"ask_denom":"uusd"
}
},
{
"astro_swap": {
"offer_asset_info": {
"native_token": {
"denom": "uusd"
}
},
"ask_asset_info": {
"token": {
"contract_addr": "terra..."
}
}
}
}
],
"minimum_receive": "123",
"to": "terra...",
"max_spread": "0.05"
}
}
assert_minimum_receive
Checks that an amount of ask tokens exceeds minimum_receive
. This message is for internal use.
{
"assert_minimum_receive": {
"asset_info": {
"token": {
"contract_addr": "terra..."
}
},
"prev_balance": "123",
"minimum_receive": "123",
"receiver": "terra..."
}
}
QueryMsg
All query messages are described below. A custom struct is defined for each query response.
config
Returns the general configuration for the router contract.
{
"config": {}
}
simulate_swap_operations
Simulates multi-hop swap operations. Examples:
- KRT => UST => mABNB
{
"simulate_swap_operations" : {
"offer_amount": "123",
"operations": [
{
"native_swap": {
"offer_denom": "ukrw",
"ask_denom": "uusd"
}
},
{
"astro_swap": {
"offer_asset_info": {
"native_token": {
"denom": "uusd"
}
},
"ask_asset_info": {
"token": {
"contract_addr": "terra..."
}
}
}
}
]
}
}
- mABNB => UST => KRT
{
"simulate_swap_operations" : {
"offer_amount": "123",
"operations": [
{
"native_swap": {
"offer_denom": "uusd",
"ask_denom": "ukrw"
}
},
{
"astro_swap": {
"offer_asset_info": {
"token": {
"contract_addr": "terra..."
}
},
"ask_asset_info": {
"native_token": {
"denom": "uusd"
}
}
}
}
]
}
}
Dependencies
~4.5–6.5MB
~138K SLoC