Router

Overview

The Router contract contains logic to facilitate multi-hop swaps for Cosmos native & CW20 tokens.

InstantiateMsg

Initializes the Router contract with the Astroport factory contract address.

json

router.rs

{
    "astroport_factory": "terra..."
}

ExecuteMsg

`receive`

CW20 receive msg.

json

router.rs

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

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

`execute_swap_operations`

Performs multi-hop swap operations for native Cosmos & CW20 tokens. Swaps execute one-by-one and the last swap will return the ask token. This function is public (can be called by anyone).

json

router.rs

{
    "execute_swap_operations": {
        "operations": [
            {
                "native_swap": {
                    "offer_denom": "...", 
                    "ask_denom": "..."
                }
            },
            {
                "astro_swap": {
                    "offer_asset_info": {
                        "native_token": {
                            "denom": "..."
                        }
                    },
                    "ask_asset_info": {
                        "token": {
                            "contract_addr": "..."
                        }
                    }
                }
            }
        ],
        "minimum_receive": "123",
        "to": "...", 
        "max_spread": "0.05"
    }
}

Params	Type	Description
`operations`	`Vec<SwapOperation>`	A vector of swap operations
`minimum_receive`	`Option<Uint128>`	The minimum amount of tokens to get from a swap
`to`	`Option<String>`	Addess receving tokens (if different from sender)
`max_spread`	`Option<Decimal>`	Max spread

`SwapOperation`

router.rs

#[cw_serde]
pub enum SwapOperation {
    NativeSwap {
        offer_denom: String,
        ask_denom: String,
    },
    AstroSwap {
        offer_asset_info: AssetInfo,
        ask_asset_info: AssetInfo,
    },
}

Variants	Description
`NativeSwap`	Native swap
`AstroSwap`	ASTRO swap

`execute_swap_operation`

Executes a single swap operation. This message is for internal use.

astro_swap.json

native_swap.json

router.rs

{
    "execute_swap_operation": {
        "operation": {
            "astro_swap": {
                "offer_asset_info": {
                    "native_token": {
                        "denom": "..."
                    }
                }, 
                "ask_asset_info": {
                    "token": {
                        "contract_addr": "..."
                    }
                }
            }
        },
        "to": "...",
        "max_spread": "0.05",
        "single": false
    }
}

Params	Type	Description
`operation`	`<SwapOperation>`	Native or Astro swap operation
`to`	`Option<String>`	Addess receving tokens (if different from sender)
`max_spread`	`Option<Decimal>`	Max spread
`single`	`bool`	Defines whether this swap is single or part of a multi hop route

`assert_minimum_receive`

Checks that an amount of ask tokens exceeds minimum_receive. This message is for internal use.

json

router.rs

{
    "asset_info": {
        "token": {
            "contract_addr": "..."
        }
    },
    "prev_balance": "123",
    "minimum_receive": "123",
    "receiver": "..."
}

Params	Type	Description
`asset_info`	`AssetInfo`	Information about an asset stored in an `AssetInfo` struct
`prev_balance`	`Uint128`	Previous balance
`minimum_receive`	`Uint128`	The minimum amount of tokens to get from a swap
`receiver`	`String`	Addess receving tokens

QueryMsg

`config`

Queries the general configuration for the router contract.

json

router.rs

{
    "config": {}
}

`ConfigResponse`

This structure describes a custom struct to return a query response containing the base contract configuration.

json

router.rs

{
    "astroport_factory": "terra..."
}

Params	Type	Description
`astroport_factory`	`String`	The Astroport factory contract address

`simulate_swap_operations`

Simulates multi-hop swap operations.

json

router.rs

{
    "simulate_swap_operations": {
        "offer_amount": "123",
        "operations": [
            {
                "native_swap": {
                    "offer_denom": "...", 
                    "ask_denom": "..."
                }
            },
            {
                "astro_swap": {
                    "offer_asset_info": {
                        "native_token": {
                            "denom": "..."
                        }
                    },
                    "ask_asset_info": {
                        "token": {
                            "contract_addr": "..."
                        }
                    }
                }
            }
        ]
    }
}

Params	Type	Description
`offer_amount`	`Uint128`	The amount of tokens to swap
`operations`	`Vec<SwapOperation>`	The swap operations to perform, each swap involving a specific pool

`SimulateSwapOperationsResponse`

This structure describes a custom struct to return a query response containing the end amount of a swap simulation.

json

router.rs

{
    "amount": "123"
}

Params	Type	Description
`amount`	`Uint128`	The amount of tokens received in a swap simulation

Router

Overview​

Links​

InstantiateMsg​

ExecuteMsg​

receive​

execute_swap_operations​

SwapOperation​

execute_swap_operation​

assert_minimum_receive​

QueryMsg​

config​

ConfigResponse​

simulate_swap_operations​

SimulateSwapOperationsResponse​

Overview

Links

InstantiateMsg

ExecuteMsg

`receive`

`execute_swap_operations`

`SwapOperation`

`execute_swap_operation`

`assert_minimum_receive`

QueryMsg

`config`

`ConfigResponse`

`simulate_swap_operations`

`SimulateSwapOperationsResponse`