first commit

test/utils/Context.ts

@@ -0,0 +1,127 @@
+/*
+
+    Copyright 2020 DODO ZOO.
+    SPDX-License-Identifier: Apache-2.0
+
+*/
+
+import { EVM, getDefaultWeb3 } from "./EVM";
+import Web3 from "web3";
+import { Contract } from "web3-eth-contract";
+import BigNumber from "bignumber.js";
+import * as contracts from "./Contracts";
+import { decimalStr, gweiStr, MAX_UINT256 } from "./Converter";
+import * as log from "./Log";
+
+BigNumber.config({
+  EXPONENTIAL_AT: 1000,
+  DECIMAL_PLACES: 80,
+});
+
+export interface DODOContextInitConfig {
+  lpFeeRate: string,
+  mtFeeRate: string,
+  k: string,
+  gasPriceLimit: string,
+}
+
+/*
+  price curve when k=0.1
+  +──────────────────────+───────────────+
+  | purchase percentage  | avg slippage  |
+  +──────────────────────+───────────────+
+  | 1%                   | 0.1%         |
+  | 5%                   | 0.5%         |
+  | 10%                  | 1.1%         |
+  | 20%                  | 2.5%         |
+  | 50%                  | 10%          |
+  | 70%                  | 23.3%        |
+  +──────────────────────+───────────────+
+*/
+export let DefaultDODOContextInitConfig = {
+  lpFeeRate: decimalStr("0.002"),
+  mtFeeRate: decimalStr("0.001"),
+  k: decimalStr("0.1"),
+  gasPriceLimit: gweiStr("100"),
+}
+
+export class DODOContext {
+  EVM: EVM
+  Web3: Web3
+  DODO: Contract
+  DODOZoo: Contract
+  BASE: Contract
+  BaseCapital: Contract
+  QUOTE: Contract
+  QuoteCapital: Contract
+  ORACLE: Contract
+  Deployer: string
+  Supervisor: string
+  Maintainer: string
+  spareAccounts: string[]
+
+  constructor() { }
+
+  async init(config: DODOContextInitConfig) {
+    this.EVM = new EVM
+    this.Web3 = getDefaultWeb3()
+    this.DODOZoo = await contracts.newContract(contracts.DODO_ZOO_CONTRACT_NAME)
+    this.BASE = await contracts.newContract(contracts.TEST_ERC20_CONTRACT_NAME)
+    this.QUOTE = await contracts.newContract(contracts.TEST_ERC20_CONTRACT_NAME)
+    this.ORACLE = await contracts.newContract(contracts.NAIVE_ORACLE_CONTRACT_NAME)
+
+    const allAccounts = await this.Web3.eth.getAccounts();
+    this.Deployer = allAccounts[0]
+    this.Supervisor = allAccounts[1]
+    this.Maintainer = allAccounts[2]
+    this.spareAccounts = allAccounts.slice(3, 10)
+
+    await this.DODOZoo.methods.breedDODO(
+      this.Supervisor,
+      this.Maintainer,
+      this.BASE.options.address,
+      this.QUOTE.options.address,
+      this.ORACLE.options.address,
+      config.lpFeeRate,
+      config.mtFeeRate,
+      config.k,
+      config.gasPriceLimit
+    ).send(this.sendParam(this.Deployer))
+
+    this.DODO = contracts.getContractWithAddress(contracts.DODO_CONTRACT_NAME, await this.DODOZoo.methods.getDODO(this.BASE.options.address, this.QUOTE.options.address).call())
+
+    this.BaseCapital = contracts.getContractWithAddress(contracts.DODO_LP_TOKEN_CONTRACT_NAME, await this.DODO.methods._BASE_CAPITAL_TOKEN_().call())
+    this.QuoteCapital = contracts.getContractWithAddress(contracts.DODO_LP_TOKEN_CONTRACT_NAME, await this.DODO.methods._QUOTE_CAPITAL_TOKEN_().call())
+
+    console.log(log.blueText("[Init dodo context]"))
+  }
+
+  sendParam(sender, value = "0") {
+    return {
+      from: sender,
+      gas: process.env["COVERAGE"] ? 10000000000 : 7000000,
+      gasPrice: process.env.GAS_PRICE,
+      value: decimalStr(value)
+    }
+  }
+
+  async setOraclePrice(price: string) {
+    await this.ORACLE.methods.setPrice(price).send(this.sendParam(this.Deployer))
+  }
+
+  async mintTestToken(to: string, base: string, quote: string) {
+    await this.BASE.methods.mint(to, base).send(this.sendParam(this.Deployer))
+    await this.QUOTE.methods.mint(to, quote).send(this.sendParam(this.Deployer))
+  }
+
+  async approveDODO(account: string) {
+    await this.BASE.methods.approve(this.DODO.options.address, MAX_UINT256).send(this.sendParam(account))
+    await this.QUOTE.methods.approve(this.DODO.options.address, MAX_UINT256).send(this.sendParam(account))
+  }
+}
+
+export async function getDODOContext(config: DODOContextInitConfig = DefaultDODOContextInitConfig): Promise<DODOContext> {
+  var context = new DODOContext()
+  await context.init(config)
+  return context
+}

test/utils/Contracts.ts

@@ -0,0 +1,112 @@
+/*
+
+    Copyright 2020 DODO ZOO.
+    SPDX-License-Identifier: Apache-2.0
+
+*/
+var jsonPath: string = "../../build/contracts/"
+if (process.env["COVERAGE"]) {
+  console.log("[Coverage mode]")
+  jsonPath = "../../.coverage_artifacts/contracts/"
+}
+
+const DODO = require(`${jsonPath}DODO.json`)
+const DODOZoo = require(`${jsonPath}DODOZoo.json`)
+const DODOEthProxy = require(`${jsonPath}DODOEthProxy.json`)
+const WETH = require(`${jsonPath}WETH9.json`)
+const TestERC20 = require(`${jsonPath}TestERC20.json`)
+const NaiveOracle = require(`${jsonPath}NaiveOracle.json`)
+const DODOLpToken = require(`${jsonPath}DODOLpToken.json`)
+
+import { getDefaultWeb3 } from './EVM';
+import { Contract } from 'web3-eth-contract';
+
+export const DODO_CONTRACT_NAME = "DODO"
+export const TEST_ERC20_CONTRACT_NAME = "TestERC20"
+export const NAIVE_ORACLE_CONTRACT_NAME = "NaiveOracle"
+export const DODO_LP_TOKEN_CONTRACT_NAME = "DODOLpToken"
+export const DODO_ZOO_CONTRACT_NAME = "DOOZoo"
+export const DODO_ETH_PROXY_CONTRACT_NAME = "DODOEthProxy"
+export const WETH_CONTRACT_NAME = "WETH"
+
+interface ContractJson {
+  abi: any;
+  networks: { [network: number]: any };
+  byteCode: string;
+}
+
+function _getContractJSON(contractName: string): ContractJson {
+  switch (contractName) {
+    case DODO_CONTRACT_NAME:
+      return {
+        abi: DODO.abi,
+        networks: DODO.networks,
+        byteCode: DODO.bytecode
+      };
+    case TEST_ERC20_CONTRACT_NAME:
+      return {
+        abi: TestERC20.abi,
+        networks: TestERC20.networks,
+        byteCode: TestERC20.bytecode
+      };
+    case NAIVE_ORACLE_CONTRACT_NAME:
+      return {
+        abi: NaiveOracle.abi,
+        networks: NaiveOracle.networks,
+        byteCode: NaiveOracle.bytecode
+      };
+    case DODO_LP_TOKEN_CONTRACT_NAME:
+      return {
+        abi: DODOLpToken.abi,
+        networks: DODOLpToken.networks,
+        byteCode: DODOLpToken.bytecode
+      };
+    case DODO_ZOO_CONTRACT_NAME:
+      return {
+        abi: DODOZoo.abi,
+        networks: DODOZoo.networks,
+        byteCode: DODOZoo.bytecode
+      };
+    case DODO_ETH_PROXY_CONTRACT_NAME:
+      return {
+        abi: DODOEthProxy.abi,
+        networks: DODOEthProxy.networks,
+        byteCode: DODOEthProxy.bytecode
+      };
+    case WETH_CONTRACT_NAME:
+      return {
+        abi: WETH.abi,
+        networks: WETH.networks,
+        byteCode: WETH.bytecode
+      };
+    default:
+      throw "CONTRACT_NAME_NOT_FOUND";
+  }
+}
+
+export function getContractWithAddress(contractName: string, address: string) {
+  var Json = _getContractJSON(contractName)
+  var web3 = getDefaultWeb3()
+  return new web3.eth.Contract(Json.abi, address)
+}
+
+export function getDepolyedContract(contractName: string): Contract {
+  var Json = _getContractJSON(contractName)
+  var networkId = process.env.NETWORK_ID
+  var deployedAddress = _getContractJSON(contractName).networks[networkId].address
+  var web3 = getDefaultWeb3()
+  return new web3.eth.Contract(Json.abi, deployedAddress)
+}
+
+export async function newContract(contractName: string, args: any[] = []): Promise<Contract> {
+  var web3 = getDefaultWeb3()
+  var Json = _getContractJSON(contractName)
+  var contract = new web3.eth.Contract(Json.abi)
+  var adminAccount = (await web3.eth.getAccounts())[0]
+  let parameter = {
+    from: adminAccount,
+    gas: process.env["COVERAGE"] ? 10000000000 : 7000000,
+    gasPrice: web3.utils.toHex(web3.utils.toWei('1', 'wei'))
+  }
+  return await contract.deploy({ data: Json.byteCode, arguments: args }).send(parameter)
+}

test/utils/Converter.ts

@@ -0,0 +1,11 @@
+import BigNumber from "bignumber.js";
+
+export const MAX_UINT256 = "0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"
+
+export function decimalStr(value: string): string {
+  return new BigNumber(value).multipliedBy(10 ** 18).toFixed(0, BigNumber.ROUND_DOWN)
+}
+
+export function gweiStr(gwei: string): string {
+  return new BigNumber(gwei).multipliedBy(10 ** 9).toFixed(0, BigNumber.ROUND_DOWN)
+}

test/utils/EVM.ts

@@ -0,0 +1,83 @@
+/*
+
+    Copyright 2020 DODO ZOO.
+    SPDX-License-Identifier: Apache-2.0
+
+*/
+
+// require('dotenv-flow').config();
+
+import { JsonRpcPayload, JsonRpcResponse } from 'web3-core-helpers';
+import Web3 from 'web3';
+
+export function getDefaultWeb3() {
+  return new Web3(process.env.RPC_NODE_URI)
+}
+
+export class EVM {
+  private provider = new Web3.providers.HttpProvider(process.env.RPC_NODE_URI);
+
+  public async reset(id: string): Promise<string> {
+    if (!id) {
+      throw new Error('id must be set');
+    }
+
+    await this.callJsonrpcMethod('evm_revert', [id]);
+
+    return this.snapshot();
+  }
+
+  public async snapshot(): Promise<string> {
+    return this.callJsonrpcMethod('evm_snapshot');
+  }
+
+  public async evmRevert(id: string): Promise<string> {
+    return this.callJsonrpcMethod('evm_revert', [id]);
+  }
+
+  public async stopMining(): Promise<string> {
+    return this.callJsonrpcMethod('miner_stop');
+  }
+
+  public async startMining(): Promise<string> {
+    return this.callJsonrpcMethod('miner_start');
+  }
+
+  public async mineBlock(): Promise<string> {
+    return this.callJsonrpcMethod('evm_mine');
+  }
+
+  public async increaseTime(duration: number): Promise<string> {
+    return this.callJsonrpcMethod('evm_increaseTime', [duration]);
+  }
+
+  public async callJsonrpcMethod(method: string, params?: (any[])): Promise<string> {
+    const args: JsonRpcPayload = {
+      method,
+      params,
+      jsonrpc: '2.0',
+      id: new Date().getTime(),
+    };
+
+    const response = await this.send(args);
+
+    return response.result;
+  }
+
+  private async send(args: JsonRpcPayload): Promise<any> {
+    return new Promise((resolve, reject) => {
+      const callback: any = (error: Error, val: JsonRpcResponse): void => {
+        if (error) {
+          reject(error);
+        } else {
+          resolve(val);
+        }
+      };
+
+      this.provider.send(
+        args,
+        callback,
+      );
+    });
+  }
+}

test/utils/Log.ts

@@ -0,0 +1,29 @@
+/*
+
+    Copyright 2020 DODO ZOO.
+    SPDX-License-Identifier: Apache-2.0
+
+*/
+
+import { TransactionReceipt } from "web3-core"
+
+export const blueText = x => `\x1b[36m${x}\x1b[0m`;
+export const yellowText = x => `\x1b[33m${x}\x1b[0m`;
+export const greenText = x => `\x1b[32m${x}\x1b[0m`;
+export const redText = x => `\x1b[31m${x}\x1b[0m`;
+export const numberWithCommas = x => x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',');
+
+export function logGas(receipt: TransactionReceipt, desc: string) {
+  const gasUsed = receipt.gasUsed;
+  let colorFn;
+
+  if (gasUsed < 80000) {
+    colorFn = greenText;
+  } else if (gasUsed < 200000) {
+    colorFn = yellowText;
+  } else {
+    colorFn = redText;
+  }
+
+  console.log(("Gas used:").padEnd(60, '.'), blueText(desc) + "  ", colorFn(numberWithCommas(gasUsed).padStart(5)));
+}

test/utils/SlippageFormula.ts

@@ -0,0 +1,11 @@
+function calculateSlippage(buyPercentage: number) {
+  const k = 0.1
+  console.log(buyPercentage, ":", ((1 / (1 - buyPercentage)) * k - k) * 100, "%")
+}
+
+// calculateSlippage(0.01)
+// calculateSlippage(0.05)
+// calculateSlippage(0.1)
+// calculateSlippage(0.2)
+// calculateSlippage(0.5)
+// calculateSlippage(0.7)