Skip to content

InjectiveLabs/swap-contract

Repository files navigation

Atomic Order Token Swap Contract

The Swap contract allows instant swap between two different tokens. Under the hood, it is using atomic orders to place market orders in one or more spot markets.

Getting started

Anyone can instantiate an instance of the Swap contract. There is version of this contract uploaded to the Injective Mainnet already and can be found on https://explorer.injective.network/code/67/.

Before instantiating your contract, as the contract owner, you have three questions to answer.

1. Which address should be the fee recipient?

Since orders placed by the Swap contract are order in the Injective Exchange Module, that means each order can have a fee recipient which can receive 40% of the trading fee. Typically, Exchange dApps would set the fee recipient as their own addresses.

2. What tokens should this contract support?

Each token available in the contract must have a route defined. Route means which markets should token A go through in order to get token B. For example, if you would like to support swapping between ATOM and INJ, then you would have to set route by providing the contract the market IDs of ATOM/USDT and INJ/USDT, so that the it knows the route of swapping ATOM and INJ would be ATOM <> USDT <> INJ.

At this moment, the contract can only support markets quoted in USDT.

3. How much buffer should be provided to this contract?

As the contract owner, you also have to provide funds to the contract which will be used when the swap happens. The buffer is used by the contract when it place orders. If the user wants to swap a big amount or swap in an illiquid market, then more buffer is required. An error will occur when the contract buffer cannot satisfy the user's input amount.

At this moment, the buffer should only be in USDT.

Messages

Instantiate

Initializes the contract state with the contract version and configuration details. The config includes an administrator address and a fee recipient address.

pub fn instantiate(
    deps: DepsMut<InjectiveQueryWrapper>,
    env: Env,
    info: MessageInfo,
    msg: InstantiateMsg,
) -> Result<Response<InjectiveMsgWrapper>, ContractError>

Execute

Handles different types of transactions and admin functions:

  • SwapMinOutput: Swap with the minimum output quantity.
  • SwapExactOutput: Swap with an exact output quantity.
  • SetRoute: Set a swap route.
  • DeleteRoute: Delete a swap route.
  • UpdateConfig: Update the contract configuration.
  • WithdrawSupportFunds: Withdraw the support funds from the contract.
pub fn execute(
    deps: DepsMut<InjectiveQueryWrapper>,
    env: Env,
    info: MessageInfo,
    msg: ExecuteMsg,
) -> Result<Response<InjectiveMsgWrapper>, ContractError>

Reply

Handles the replies from other contracts or transactions.

pub fn reply(
    deps: DepsMut<InjectiveQueryWrapper>,
    env: Env,
    msg: Reply,
) -> Result<Response<InjectiveMsgWrapper>, ContractError>

Query

Handles various queries to the contract:

  • GetRoute: Get a specific swap route.
  • GetOutputQuantity: Get the output quantity for a given input quantity.
  • GetInputQuantity: Get the input quantity for a given output quantity.
  • GetAllRoutes: Get all available swap routes.
pub fn query(deps: Deps<InjectiveQueryWrapper>, env: Env, msg: QueryMsg) -> StdResult<Binary>

Authz Permission

Example how to allow the contract admin to authorize other addresses to make contract calls on their behalf.

 injectived tx grant contract execution <grantee_addr> <contract_addr> --allow-raw-msgs set_routes --max-calls 5 --max-funds 100000uwasm --expiration 1667979596  --from=sgt-account --gas=auto --gas-prices 500000000inj --gas-adjustment 1.3 --output=json --node=https://testnet.sentry.tm.injective.network:443 --chain-id='injective-888'

Disclaimer

This contract is designed for educational purposes only. Your use of this contract constitutes your agreement to the terms of the License below. In addition, your use of this contract constitutes your agreement to defend, indemnify, and hold harmless the contributors to this codebase from all claims of any kind related to your use of this contract.

License

Contents of this repository are open source under GNU Affero General Public License v3 or later.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published