Aldex Contracts

Get Started

Environment setup

Running Unit Test

• To generate testcases from csv's, run unit tests and run multitests: make test
• Skip multitest generation and just run already compiled tests: make testfast
• Checking sizes of contracts: yarn run sizes

Code coverage

Codestyle

• Codestyle

Workflow guide

• Workflow and conventions

Details of implementation that may be considered

• adding a liquidity without borrowing vAUSD (uses extra gas)

Versioning

• x.y.z.YYMMDD
  • x - Major (protocol api significant change, for example when a roadmap milestone acomplished)
  • y - Minor (may have some minor api changes and deployment script changes)
  • z - Patch (bugfix/optimization that doesn't affect deployment script/api)

NOTE: In an agile development we will do at least one Patch-level release each sprint.

How to Deploy Aldex Contracts on FORK

important

use .mainnet.empty.json as initial file to update contracts information while deploy

define env value

FORK_RPC_URL=<fork rpc url>
IMPERSONATE_ACCOUNT=<impersonate address>

note

if found `failed ProviderError: resource not found` try remove `.mainnet.json` in `.openzeppelin`

1. run yarn compile if contracts is already compiled with stabled code, you can skip this step
2. run yarn deploy:aldex-core
   deploy Libraries, AldexDeployer, AldexBank, Ausd, AldexBankConfig, ConcentratedLiquidityPoolFactory, etc..
3. run yarn deploy:oracle
   deploy ChainlinkPriceOracle, OracleChecker, setChainlinkPriceOracle on AldexBankConfig, setOracleChecker on AldexBank
4. run yarn deploy:strategy-outside-swap
   deploy UniswapV3StrategyOutsideSwap and whitelist on AldexBank
5. run yarn deploy:concentrated-pool
   deploy cl pools with custom inputs variable inside concentrated-liquidity-pool.ts
6. run yarn deploy:concentrated-pool-helper

How to set config on contract

7. run yarn config:set-oracle-checker-config
   set expired time and tolerance bps per token
8. run yarn config:set-oracle-prices
   set price via chainlink address per token
9. run yarn config:update-ausd-max-debt-limit set max debt per token on AldexBank