Fetch upstream updates

.env.template

@@ -0,0 +1,12 @@
+ALCHEMY_API_KEY=
+DEPLOYER_PRIVATE_KEY=
+CROSS_CHAIN_DEPLOYER_PRIVATE_KEY=
+FUND_FORK_NETWORK=true
+FORK_BLOCK_NUMBER=
+MNEMONIC_TEST_ACCOUNT=
+ETHERSCAN_API=
+ETHERSCAN_ARB_API=
+ETHERSCAN_OPT_API=
+ETHERSCAN_FTM_API=
+ETHERSCAN_AURORA_API=
+REPORT_GAS=true

.eslintrc

@@ -1,13 +1,15 @@
 {
-  "plugins": ["unused-imports"],
-  "extends":  [
+  "plugins": [
+    "unused-imports"
+  ],
+  "extends": [
     "plugin:@typescript-eslint/recommended",
     "plugin:prettier/recommended",
     "plugin:json/recommended"
   ],
-  "parser":  "@typescript-eslint/parser",
+  "parser": "@typescript-eslint/parser",
   "parserOptions": {
-    "ecmaVersion":  2018,
+    "ecmaVersion": 2018,
     "sourceType": "module"
   },
   "env": {
@@ -16,6 +18,17 @@
   },
   "rules": {
     "@typescript-eslint/no-explicit-any": "off",
-    "unused-imports/no-unused-imports": "error"
+    "@typescript-eslint/no-unused-vars": "off",
+    "no-unused-vars": "off",
+    "unused-imports/no-unused-imports": "error",
+    "unused-imports/no-unused-vars": [
+      "warn",
+      {
+        "vars": "all",
+        "varsIgnorePattern": "^_",
+        "args": "after-used",
+        "argsIgnorePattern": "^_"
+      }
+    ]
   }
-}
+}

.github/workflows/ci-dev.yml

@@ -10,8 +10,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
     steps:
     - uses: actions/checkout@v2
@@ -23,18 +22,17 @@ jobs:
           ${{ runner.os }}-node-
     - uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '16'
     # fix for forcing git to use https when pulling deps
     - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm run build --if-present
     - run: npm run lint
 
   test:
     runs-on: ubuntu-latest
     env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
     steps:
     - uses: actions/checkout@v2
@@ -46,9 +44,9 @@ jobs:
           ${{ runner.os }}-node-
     - uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '16'
     # fix for forcing git to use https when pulling deps
     - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm run build --if-present
     - run: npm test

.github/workflows/ci.yml

@@ -10,8 +10,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
     steps:
     - uses: actions/checkout@v2
@@ -23,18 +22,17 @@ jobs:
           ${{ runner.os }}-node-
     - uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '16'
     # fix for forcing git to use https when pulling deps
     - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm run build --if-present
     - run: npm run lint
 
   test:
     runs-on: ubuntu-latest
     env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
     steps:
     - uses: actions/checkout@v2
@@ -46,18 +44,17 @@ jobs:
           ${{ runner.os }}-node-
     - uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '16'
     # fix for forcing git to use https when pulling deps
     - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm run build --if-present
     - run: npm test
 
   coverage:
     runs-on: ubuntu-latest
     env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
+      ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
       MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
     steps:
     - uses: actions/checkout@v2
@@ -69,39 +66,40 @@ jobs:
           ${{ runner.os }}-node-
     - uses: actions/setup-node@v2
       with:
-        node-version: '12'
+        node-version: '16'
     # fix for forcing git to use https when pulling deps
     - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
+    - run: npm ci --legacy-peer-deps
     - run: npm run build --if-present
-    - run: npm run coverage
+    - env:
+        NODE_OPTIONS: "--max_old_space_size=4096"
+      run: npm run coverage
     - uses: codecov/codecov-action@v1
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
 
-  slither:
-    runs-on: ubuntu-latest
-    env:
-      ALCHEMY_API: ${{ secrets.ALCHEMY_API }}
-      ALCHEMY_API_ROPSTEN: ${{ secrets.ALCHEMY_API_ROPSTEN }}
-      MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
-    steps:
-    - uses: actions/checkout@v2
-    - uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - uses: actions/setup-node@v2
-      with:
-        node-version: '12'
-    # fix for forcing git to use https when pulling deps
-    - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
-    - run: npm ci
-    - uses: actions/setup-python@v2
-      with:
-        python-version: '3.x'
-    - run: python -m pip install --upgrade pip
-    - run: pip3 install slither-analyzer
-    - run: slither . --exclude-informational --exclude-low --exclude-medium --exclude-optimization
+  # slither:
+  #   runs-on: ubuntu-latest
+  #   env:
+  #     ALCHEMY_API_KEY: ${{ secrets.ALCHEMY_API_KEY }}
+  #     MNEMONIC_TEST_ACCOUNT: ${{ secrets.MNEMONIC_TEST_ACCOUNT }}
+  #   steps:
+  #   - uses: actions/checkout@v2
+  #   - uses: actions/cache@v2
+  #     with:
+  #       path: ~/.npm
+  #       key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+  #       restore-keys: |
+  #         ${{ runner.os }}-node-
+  #   - uses: actions/setup-node@v2
+  #     with:
+  #       node-version: '16'
+  #   # fix for forcing git to use https when pulling deps
+  #   - run: 'git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/'
+  #   - run: npm ci --legacy-peer-deps
+  #   - uses: actions/setup-python@v2
+  #     with:
+  #       python-version: '3.x'
+  #   - run: python -m pip install --upgrade pip
+  #   - run: pip3 install slither-analyzer
+  #   - run: slither . --exclude-informational --exclude-low --exclude-medium --exclude-optimization

.gitignore

@@ -8,6 +8,12 @@ node_modules/*
 .eslintcache
 docs
 
+# Certora
+.certora*
+.last_confs
+certora_*
+resource_errors.json
+
 ### macOS ###
 # General
 .DS_Store
@@ -41,4 +47,11 @@ Temporary Items
 .env
 deployments/localhost/
 deployments/optimistic/
-.vscode/
+
+# VS Code
+.vscode/
+
+# Forge
+forge-cache
+forge-out
+output

.gitmodules

@@ -0,0 +1,5 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+	branch = v1
+

.nvmrc

@@ -0,0 +1 @@
+v16.15.1

.solcover.js

@@ -1,12 +1,6 @@
 const shell = require('shelljs'); // This module is already a solidity-coverage dep
 
 module.exports = {
-  onCompileComplete: async function(config){
-    shell.exec("typechain --target ethers-v5 --outDir ./build/typechain './build/artifacts/*.json'");
-  },
-  onIstanbulComplete: async function(config){
-    shell.rm('-rf', './build/typechain'); // Clean up at the end
-  },
   // TODO: remove VirtualSwap from skipFiles once coverage is added
   // TODO: add coverage for older contracts
   skipFiles: [
@@ -17,7 +11,8 @@ module.exports = {
     'AmplificationUtilsV1.sol',
     'SwapFlashLoanV1.sol',
     'SwapUtilsV1.sol',
-    'SwapV1.sol'
+    'SwapV1.sol',
+    'xchainGauges/mock'
   ],
   mocha: {
     grep: "@skip-on-coverage", // Find everything with this tag

Dockerfile

@@ -1,24 +1,25 @@
 # Adapted from https://nodejs.org/en/docs/guides/nodejs-docker-webapp/
-
-FROM node:12.22.1-alpine3.10
+FROM node:16-bullseye
 
 ENV ALCHEMY_API="https://mainnet.infura.io/v3/5f79dfc1f8194c07bf7806064bb16bf9"
 ENV ALCHEMY_API_ROPSTEN="https://ropsten.infura.io/v3/5f79dfc1f8194c07bf7806064bb16bf9"
 ENV MNEMONIC_TEST_ACCOUNT="abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about"
+ENV LANG C.UTF-8
 
 # Create app directory
-WORKDIR /usr/src/app
+ENV ROOT /usr/src/app
+WORKDIR ${ROOT}
+
+# Copy all files and config
+COPY . .
 
-COPY package*.json ./
-RUN apk add --update --no-cache git
+RUN apt-get install make python3 gcc g++ libc6
 RUN git config --global --replace-all url."https://github.com/".insteadOf ssh://git@github.com/
-RUN npm ci
+RUN npm ci --legacy-peer-deps
 
 # Bundle app source
 COPY . .
 
-RUN npm run build
-
 EXPOSE 8545
 
 CMD [ "npm", "run", "start" ]

PULL_REQUEST_TEMPLATE/deploy.md

@@ -0,0 +1,30 @@
+# Deploy Pull Request Template
+
+## Description
+
+Please include a summary of the new deploy scripts. If this PR includes any imports of externally deployed contract addresses, provide sources from official docs or trustworthy references.
+
+Fixes # (issue)
+
+## Deployment checklist
+
+List any new deployments that is expected to be saved after running the deploy task. After running the scripts, check off each item if they are successfully deployed.
+
+- [ ] PoolA
+- [ ] PoolALPToken
+
+## Deployment verification
+
+Please provide explorer links to the deployed contracts and verify them using either standard solcInputs json or manually flattened contracts using `npx hardhat flatten`. After verifying them, check off each item.
+
+- [ ] Link to PoolA on etherscan
+- [ ] Link to PoolALPToken on etherscan
+
+## Checklist:
+
+- [ ] Any imported tokens's addresses are verified against official docs
+- [ ] If any existing contracts are changed, ensure the saved deployments are removed before running the deploy scripts
+- [ ] If deploying a new pool on a testnet, ensure there is liquidity by providing the test tokens to a DEX.
+- [ ] If possible, the deploy scripts are tested against forked mainnet or local hardhat node.
+- [ ] Newly deployed contracts match the expected list of new deployments
+- [ ] All newly deployed contracts are verified on explorers

README.md

@@ -10,7 +10,7 @@ The contracts are compiled with [Hardhat](https://hardhat.org/getting-started/),
 ## Installation
 
 ```bash
-$ npm i
+$ npm ci --legacy-peer-deps
 ```
 
 ## Usage
@@ -36,21 +36,23 @@ $ npm run coverage
 ### Deploying contracts to localhost Hardhat EVM
 
 ```bash
-$ npm run start
+$ npx hardhat node
 ```
 You can connect to this RPC server via `http://localhost:8545` with chain ID of 31337
 
-### Deploying contracts to local fork of Mainnet
+### Deploying contracts to local fork of a network
 
-In order to successfully fork the mainnet, `ALCHEMY_API` must be set to a valid URL in the `.env` file.
+In order to successfully fork a network, the networks have to be defined in hardhat.config.ts with valid RPC URLs. In case of mainnet, `ALCHEMY_API` must be set to a valid URL in the `.env` file. 
 ```
 ALCHEMY_API="https://eth-mainnet.alchemyapi.io/v2/XXXXXXXXXXXX"
 ```
 
 ```bash
-$ npm run fork
+$ npm run fork --network=mainnet
 ```
-You can connect to this RPC server via `http://localhost:8545` with chain ID of 1.
+You can connect to this RPC server via `http://localhost:8545` with chain ID of the network.
+
+Additionally, you can choose a block number to fork from by setting `FORK_BLOCK_NUMBER` env variable.
 
 ### Deploying contracts to Ropsten
 

certora/.gitignore

@@ -0,0 +1,3 @@
+.**
+resource_errors.json
+!.gitignore

certora/ComplexityCheck/DummyERC20A.sol

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: agpl-3.0
+pragma solidity ^0.6.0;
+import "./DummyERC20Impl.sol";
+
+contract DummyERC20A is DummyERC20Impl {}