Skip to content

Latest commit

 

History

History
77 lines (52 loc) · 3.81 KB

README.md

File metadata and controls

77 lines (52 loc) · 3.81 KB

White Whale

A novel decentralised arbitrage platform built on the Terra blockchain.

Documentation link: https://white-whale-defi-platform.github.io/docs/

Attention: The contracts that we wish to be audited are flagged with AUDIT

Contracts

Name Description
stablecoin-vault UST vault contract
stable-arb-terra UST arbitrage contract (using Terraswap LPs)
stable-arb-astro UST arbitrage contract (using Terraswap LPs)
profit-check Profit checker for the UST vault
vesting $WHALE vesting contract

Treasury contracts

Relative path: ../contracts/treasury

Name Description
treasury Treasury contract, acts as proxy
memory address store for address translation

DApp contracts

Relative path: ../contracts/treasury/dapps

Name Description
dapp-template Template dapp that tests all the base_dapp functionality
terraswap-dapp Terraswap message generator contract
astroport-dapp Astroport message generator contract
vault-dapp Vault contract, allows depositing and withdrawing on treasury contract

Tokenomics contracts

Relative path: ../contracts/tokenomics

Name Description
airdrop Airdrop contract
lp_emissions_proxy Rewards generator proxy for liquidity providers
lp_emissions $WHALE LP emissions contract

Running this contract

You will need Rust 1.44.1+ with wasm32-unknown-unknown target installed.

You can run unit tests on this on each contracts directory via :

cargo test

Or for a production-ready (compressed) build, run the following from the repository root:

docker run --rm -v "$(pwd)":/code \
  --mount type=volume,source="$(basename "$(pwd)")_cache",target=/code/target \
  --mount type=volume,source=registry_cache,target=/usr/local/cargo/registry \
  cosmwasm/workspace-optimizer:0.12.3

The optimized contracts are generated in the artifacts/ directory.

Contributing to this repo

It's great you want to contribute to the development of White Whale! To make sure we are on the same page, make sure to add the git pre-commit hook, which will format the code and do some static analysis checks on it.

To install the hook, run scripts/git_hooks/pre-commit.sh --install