Contracts

The protocol works with several contracts, each designed to handle a specific set of features. The core contracts are the factory, router and the paircontract. Although we also have to consider the cw-20 contract.

Both the factory and router contract are each a single instance, meaning there will only be one valid address for each, but the pair contract is different. This will have many instances, all of them created by the factory contract and one of them will be created for each token pair pool reserves.

The interaction flow is shown below:

The contracts can be found in our GitHub repository.

Deployments

All HaloTrade contracts are deployed and verified in Aura Mainnet as well as Aura Euphoria Staging Network and Aura Serenity Testnet.

Mainnet

• Factory:
  • Code ID: 18
  • Address: aura18qwll06qjgkfl5s5ym4rtpz8jy2tl849ghgx402tm4w9v55wu5asn0mqhv
• Router:
  • Code ID: 16
  • Address: aura10lfagekpspw59za99x98tuxfsegx3v5sxycntqnfd4vj7e6xzq0skguqty

Euphoria

• Factory:
  • Code ID: 783
  • Address: aura14qhdeck9xapnf28suvlsxwphqvcw9j5s6y3sgfudhfjf6yx9mvmqtewl5z
• Router:
  • Code ID: 785
  • Address: aura1gud6mupw5cg255yk84xc4xd0dcxggpa48m58vrakam96xgaz6xvq7kwsmf

Serenity

• Factory:
  • Code ID: 1316
  • Address: aura1l4zygr9kagac97yeu886u4emavdnvs6jq5muckjup73l9xpcrg3qa6wazv
• Router:
  • Code ID: 1318
  • Address: aura1dly0rxs3k6gwe2mlkskfelg25a5nucp80qk79ehypjexupmjkzgs395hn7

Requirements

To build the contracts and run the tests shown on this section, you must have the following installed:

• Rust
• Cosmos SDK
• CosmWasm

Building

All contracts are writen in CosmWasm and can be compiled with Rust 1.66.0+ with wasm32-unknown-unknown target installed properly. You can learn more about this subject in the official Aura Network Documentation.

You can compile the contracts using cargo as shown below.

cargo build

The optimizer version utilized to build it is optimizer_version = '0.12.11', and the built .wasm file is stored in target/wasm32-unknown-unknown/release/<CONTRACT_NAME>.wasm. We recommend using --no-wasm-opt for development purposes.

Tests

A full suite of tests for the contracts are defined in the ./tests directory in the repository, and it can be run with the following command:

RUST_BACKTRACE=1 cargo unit-test

This will build the contracts and run the defined unit tests to ensure everything is working as expected.

Overview

Reference for the core HaloTrade contracts are disclosed in detail in the content of this section, you can take a look here:

📄️ Pair

Each pair contract contains a reserve pair of the two assets from the liquidity providers who deposited and they mint the corresponding Liquidity Provider (LP) tokens to the providers. It is also the main handler of any swaps within the pair of assets held, and is usually called by the router contract.

📄️ Router

The router contract contains the logic to facilitate multi-hop swap operations. It is the entry point for all swaps in the interface. The swaps, while facilitated by the router contract, in reality happen on each pair contract.

📄️ Factory

The factory contract handles the creation and management of the pair contract. You can think of it as its parent contract. It will spawn new pairs for every new pair.

📄️ Farm

Each farm contract allows users to deposit, withdraw their LP token to earn rewards. The rewards are distributed to the users based on the amount of LP token they have deposited and the duration of the deposit.