consolidate deploy confirms; delegates report; consistent swapERC20Co…

…ntract (#1334) * consolidate deploy confirms; add delegates report; consistent swapERC20Contract * update delegate test with swapERC20Contract * prettify delegate test * deploy confirm formatting
airswap · Sep 27, 2024 · c590604 · c590604
1 parent 526f41f
commit c590604
Show file tree

Hide file tree

Showing 15 changed files with 163 additions and 150 deletions.
diff --git a/package.json b/package.json
@@ -13,6 +13,7 @@
     "check:owners": "node ./scripts/owners-report.js",
     "check:receivers": "node ./scripts/receivers-report.js",
     "check:wrappers": "node ./scripts/wrappers-report.js",
+    "check:delegates": "node ./scripts/delegates-report.js",
     "clean": "lerna run clean",
     "compile": "lerna run compile",
     "linter": "yarn eslint . --ext .js,.ts --fix",

diff --git a/scripts/delegates-report.js b/scripts/delegates-report.js
@@ -0,0 +1,59 @@
+require('dotenv').config({ path: './.env' })
+const { ethers } = require('ethers')
+const { mainnets, chainNames, apiUrls } = require('@airswap/utils')
+const swapERC20Deploys = require('@airswap/swap-erc20/deploys.js')
+
+async function main() {
+  console.log()
+  for (const chainId of mainnets) {
+    const apiUrl = apiUrls[chainId]
+    const provider = new ethers.providers.JsonRpcProvider(apiUrl)
+    const deployer = new ethers.Wallet(process.env.PRIVATE_KEY, provider)
+
+    const deploys = require('../source/delegate/deploys.js')
+    const {
+      Delegate__factory,
+    } = require('@airswap/delegate/typechain/factories/contracts')
+    if (deploys[chainId]) {
+      const contract = Delegate__factory.connect(deploys[chainId], deployer)
+      const currentSwapERC20 = await contract.swapERC20Contract()
+
+      const intendedSwapERC20 = swapERC20Deploys[chainId]
+
+      if (intendedSwapERC20) {
+        console.log(
+          chainNames[chainId].toUpperCase(),
+          `(${chainId})`,
+          '· Intended SwapERC20: ',
+          intendedSwapERC20
+        )
+
+        let label = 'Delegate has correct SwapERC20'
+        if (currentSwapERC20 !== intendedSwapERC20) {
+          label = `Delegate has incorrect SwapERC20: ${currentSwapERC20}`
+        }
+        console.log(currentSwapERC20 === intendedSwapERC20 ? '✔' : '✘', label)
+      } else {
+        console.log(
+          chainNames[chainId].toUpperCase(),
+          `(${chainId})`,
+          '✘ SwapERC20 not deployed'
+        )
+      }
+    } else {
+      console.log(
+        chainNames[chainId].toUpperCase(),
+        `(${chainId})`,
+        '✘ Delegate not deployed'
+      )
+    }
+    console.log()
+  }
+}
+
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error(error)
+    process.exit(1)
+  })
diff --git a/scripts/deployer-info.js b/scripts/deployer-info.js
@@ -1,27 +1,35 @@
+const Confirm = require('prompt-confirm')
 const {
   chainNames,
   chainCurrencies,
   EVM_NATIVE_TOKEN_DECIMALS,
 } = require('@airswap/utils')
 
 module.exports = {
-  displayDeployerInfo: async function (deployer) {
+  confirmDeployment: async function (deployer, targetAddress) {
     const gasPrice = await deployer.getGasPrice()
     const chainId = await deployer.getChainId()
     const balance = ethers.utils.formatUnits(
       (await deployer.getBalance()).toString(),
       EVM_NATIVE_TOKEN_DECIMALS
     )
-    console.log(`\nNetwork: ${chainNames[chainId].toUpperCase()}`)
-    console.log(`Gas price: ${gasPrice / 10 ** 9} gwei`)
-    console.log(`\nDeployer: ${deployer.address}`)
-    console.log(`Balance: ${balance} ${chainCurrencies[chainId]}`)
+    console.log(`To ${chainNames[chainId].toUpperCase()}`)
+    console.log(`· Gas price         ${gasPrice / 10 ** 9} gwei`)
+    console.log(`· Deployer wallet   ${deployer.address}`)
+    console.log(`· Deployer balance  ${balance} ${chainCurrencies[chainId]}`)
 
-    console.log(
-      `\nNext contract address will be:\n${ethers.utils.getContractAddress({
-        from: deployer.address,
-        nonce: await deployer.provider.getTransactionCount(deployer.address),
-      })}\n`
+    const nextAddress = ethers.utils.getContractAddress({
+      from: deployer.address,
+      nonce: await deployer.provider.getTransactionCount(deployer.address),
+    })
+
+    console.log(`· Contract address  ${nextAddress}\n`)
+
+    const prompt = new Confirm(
+      nextAddress === targetAddress || !targetAddress
+        ? 'Proceed to deploy?'
+        : 'Address would not match mainnet. Proceed anyway?'
     )
+    return await prompt.run()
   },
 }
diff --git a/scripts/wrappers-report.js b/scripts/wrappers-report.js
@@ -1,14 +1,11 @@
 require('dotenv').config({ path: './.env' })
 const { ethers } = require('ethers')
-const { mainnets, testnets, chainNames, apiUrls } = require('@airswap/utils')
+const { mainnets, chainNames, apiUrls } = require('@airswap/utils')
 const swapERC20Deploys = require('@airswap/swap-erc20/deploys.js')
 
-const chains = mainnets.concat(testnets)
-
 async function main() {
   console.log()
-  for (let c = 0; c < chains.length; c++) {
-    const chainId = chains[c]
+  for (const chainId of mainnets) {
     const apiUrl = apiUrls[chainId]
     const provider = new ethers.providers.JsonRpcProvider(apiUrl)
     const deployer = new ethers.Wallet(process.env.PRIVATE_KEY, provider)
@@ -40,11 +37,17 @@ async function main() {
         console.log(
           chainNames[chainId].toUpperCase(),
           `(${chainId})`,
-          '✘ Not deployed'
+          '✘ SwapERC20 not deployed'
         )
       }
-      console.log()
+    } else {
+      console.log(
+        chainNames[chainId].toUpperCase(),
+        `(${chainId})`,
+        '✘ Wrapper not deployed'
+      )
     }
+    console.log()
   }
 }
 

diff --git a/source/batch-call/scripts/deploy.js b/source/batch-call/scripts/deploy.js
@@ -1,14 +1,13 @@
 /* eslint-disable no-console */
 const fs = require('fs')
 const prettier = require('prettier')
-const Confirm = require('prompt-confirm')
 const { ethers, run } = require('hardhat')
 const { ChainIds, chainLabels } = require('@airswap/utils')
 const { getReceiptUrl } = require('@airswap/utils')
 const batchCallDeploys = require('../deploys.js')
 const batchCallBlocks = require('../deploys-blocks.js')
 const batchCallCommits = require('../deploys-commits.js')
-const { displayDeployerInfo } = require('../../../scripts/deployer-info')
+const { confirmDeployment } = require('../../../scripts/deployer-info')
 
 async function main() {
   await run('compile')
@@ -19,14 +18,9 @@ async function main() {
     console.log('Value for --network flag is required')
     return
   }
-  const targetAddress = await displayDeployerInfo(deployer)
-  const mainnetAddress = batchCallDeploys['1']
-  const prompt = new Confirm(
-    targetAddress === mainnetAddress
-      ? 'Proceed to deploy?'
-      : 'Contract address would not match current mainnet address. Proceed anyway?'
-  )
-  if (await prompt.run()) {
+  console.log(`\nDeploy BATCHCALL\n`)
+
+  if (await confirmDeployment(deployer, batchCallDeploys)) {
     const batchFactory = await ethers.getContractFactory('BatchCall')
     const batchCallContract = await batchFactory.deploy()
     console.log(

diff --git a/source/delegate/contracts/Delegate.sol b/source/delegate/contracts/Delegate.sol
@@ -14,7 +14,7 @@ import { SafeTransferLib } from "solady/src/utils/SafeTransferLib.sol";
  */
 contract Delegate is IDelegate, Ownable {
   // The SwapERC20 contract to be used to execute orders
-  ISwapERC20 public swapERC20;
+  ISwapERC20 public swapERC20Contract;
 
   // Mapping of sender to senderToken to to signerToken to Rule
   mapping(address => mapping(address => mapping(address => Rule))) public rules;
@@ -25,9 +25,9 @@ contract Delegate is IDelegate, Ownable {
   /**
    * @notice Contract Constructor
    */
-  constructor(ISwapERC20 _swapERC20) {
+  constructor(ISwapERC20 _swapERC20Contract) {
     _initializeOwner(msg.sender);
-    swapERC20 = _swapERC20;
+    swapERC20Contract = _swapERC20Contract;
   }
 
   /**
@@ -153,12 +153,12 @@ contract Delegate is IDelegate, Ownable {
 
     SafeTransferLib.safeApprove(
       _senderToken,
-      address(swapERC20),
+      address(swapERC20Contract),
       _senderAmount
     );
 
     // Execute the swap
-    swapERC20.swapLight(
+    swapERC20Contract.swapLight(
       _nonce,
       _expiry,
       _signerWallet,
@@ -203,10 +203,12 @@ contract Delegate is IDelegate, Ownable {
 
   /**
    * @notice Sets the SwapERC20 contract
-   * @param _swapERC20 ISwapERC20 The SwapERC20 contract
+   * @param _swapERC20Contract ISwapERC20 The SwapERC20 contract
    */
-  function setSwapERC20Contract(ISwapERC20 _swapERC20) external onlyOwner {
-    if (address(_swapERC20) == address(0)) revert AddressInvalid();
-    swapERC20 = _swapERC20;
+  function setSwapERC20Contract(
+    ISwapERC20 _swapERC20Contract
+  ) external onlyOwner {
+    if (address(_swapERC20Contract) == address(0)) revert AddressInvalid();
+    swapERC20Contract = _swapERC20Contract;
   }
 }
diff --git a/source/delegate/scripts/deploy.js b/source/delegate/scripts/deploy.js
@@ -1,15 +1,15 @@
 /* eslint-disable no-console */
 const fs = require('fs')
 const prettier = require('prettier')
-const Confirm = require('prompt-confirm')
+
 const { ethers, run } = require('hardhat')
 const swapERC20Deploys = require('@airswap/swap-erc20/deploys.js')
 const { ChainIds, chainLabels } = require('@airswap/utils')
 const { getReceiptUrl } = require('@airswap/utils')
 const delegateDeploys = require('../deploys.js')
 const delegateBlocks = require('../deploys-blocks.js')
 const delegateCommits = require('../deploys-commits.js')
-const { displayDeployerInfo } = require('../../../scripts/deployer-info')
+const { confirmDeployment } = require('../../../scripts/deployer-info')
 
 async function main() {
   await run('compile')
@@ -20,18 +20,12 @@ async function main() {
     console.log('Value for --network flag is required')
     return
   }
-  await displayDeployerInfo(deployer)
 
-  console.log(`swapERC20Contract: ${swapERC20Deploys[chainId]}\n`)
+  console.log(`\nDeploy DELEGATE`)
+
+  console.log(`· swapERC20Contract  ${swapERC20Deploys[chainId]}\n`)
 
-  const targetAddress = await displayDeployerInfo(deployer)
-  const mainnetAddress = delegateDeploys['1']
-  const prompt = new Confirm(
-    targetAddress === mainnetAddress
-      ? 'Proceed to deploy?'
-      : 'Contract address would not match current mainnet address. Proceed anyway?'
-  )
-  if (await prompt.run()) {
+  if (await confirmDeployment(deployer, delegateDeploys[ChainIds.MAINNET])) {
     const delegateFactory = await ethers.getContractFactory('Delegate')
     const delegateContract = await delegateFactory.deploy(
       swapERC20Deploys[chainId]

diff --git a/source/delegate/test/Delegate.js b/source/delegate/test/Delegate.js
@@ -135,12 +135,14 @@ describe('Delegate Unit', () => {
 
   describe('Constructor and admin functions', async () => {
     it('swap ERC20 address is set', async () => {
-      expect(await delegate.swapERC20()).to.equal(swapERC20.address)
+      expect(await delegate.swapERC20Contract()).to.equal(swapERC20.address)
     })
 
     it('sets the swapERC20Contract address', async () => {
       await delegate.setSwapERC20Contract(UPDATE_SWAP_ERC20_ADDRESS)
-      expect(await delegate.swapERC20()).to.equal(UPDATE_SWAP_ERC20_ADDRESS)
+      expect(await delegate.swapERC20Contract()).to.equal(
+        UPDATE_SWAP_ERC20_ADDRESS
+      )
     })
 
     it('the swapERC20Contract address cannot be address(0)', async () => {

diff --git a/source/pool/scripts/deploy.js b/source/pool/scripts/deploy.js
@@ -1,14 +1,13 @@
 /* eslint-disable no-console */
 const fs = require('fs')
 const prettier = require('prettier')
-const Confirm = require('prompt-confirm')
 const { ethers, run } = require('hardhat')
 const { chainLabels, ChainIds } = require('@airswap/utils')
 const { getReceiptUrl } = require('@airswap/utils')
 const poolDeploys = require('../deploys.js')
 const poolBlocks = require('../deploys-blocks.js')
 const poolCommits = require('../deploys-commits.js')
-const { displayDeployerInfo } = require('../../../scripts/deployer-info')
+const { confirmDeployment } = require('../../../scripts/deployer-info')
 
 async function main() {
   await run('compile')
@@ -19,22 +18,16 @@ async function main() {
     console.log('Value for --network flag is required')
     return
   }
-  await displayDeployerInfo(deployer)
 
   const scale = 10
   const max = 100
 
-  console.log(`scale: ${scale}`)
-  console.log(`max: ${max}`)
+  console.log(`\nDeploy POOL`)
 
-  const targetAddress = await displayDeployerInfo(deployer)
-  const mainnetAddress = poolDeploys['1']
-  const prompt = new Confirm(
-    targetAddress === mainnetAddress
-      ? 'Proceed to deploy?'
-      : 'Contract address would not match current mainnet address. Proceed anyway?'
-  )
-  if (await prompt.run()) {
+  console.log(`· max    ${max}`)
+  console.log(`· scale  ${scale}\n`)
+
+  if (await confirmDeployment(deployer, poolDeploys[ChainIds.MAINNET])) {
     const poolFactory = await ethers.getContractFactory('Pool')
     const poolContract = await poolFactory.deploy(scale, max)
     console.log(

diff --git a/source/registry/scripts/deploy.js b/source/registry/scripts/deploy.js
@@ -1,15 +1,14 @@
 /* eslint-disable no-console */
 const fs = require('fs')
 const prettier = require('prettier')
-const Confirm = require('prompt-confirm')
 const { ethers, run } = require('hardhat')
 const { ChainIds, chainLabels } = require('@airswap/utils')
 const { getReceiptUrl } = require('@airswap/utils')
 const registryDeploys = require('../deploys.js')
 const registryBlocks = require('../deploys-blocks.js')
 const registryCommits = require('../deploys-commits.js')
 const config = require('./config.js')
-const { displayDeployerInfo } = require('../../../scripts/deployer-info')
+const { confirmDeployment } = require('../../../scripts/deployer-info')
 
 async function main() {
   await run('compile')
@@ -20,7 +19,6 @@ async function main() {
     console.log('Value for --network flag is required')
     return
   }
-  await displayDeployerInfo(deployer)
 
   let stakingToken
   let stakingCost
@@ -32,18 +30,13 @@ async function main() {
     ;({ stakingToken, stakingCost, supportCost } = config[ChainIds.MAINNET])
   }
 
-  console.log(`stakingToken: ${stakingToken}`)
-  console.log(`stakingCost: ${stakingCost}`)
-  console.log(`supportCost: ${supportCost}\n`)
+  console.log(`\nDeploy REGISTRY`)
 
-  const targetAddress = await displayDeployerInfo(deployer)
-  const mainnetAddress = registryDeploys['1']
-  const prompt = new Confirm(
-    targetAddress === mainnetAddress
-      ? 'Proceed to deploy?'
-      : 'Contract address would not match current mainnet address. Proceed anyway?'
-  )
-  if (await prompt.run()) {
+  console.log(`· stakingCost   ${stakingCost}`)
+  console.log(`· supportCost   ${supportCost}`)
+  console.log(`· stakingToken  ${stakingToken}\n`)
+
+  if (await confirmDeployment(deployer, registryDeploys)) {
     const registryFactory = await ethers.getContractFactory('Registry')
     const registryContract = await registryFactory.deploy(
       stakingToken,