Merge pull request #109 from BitGo/WIN-666-upgrade-solidity-version

chore(contracts): upgrade solidity version to 0.8.20
BitGo · Oct 6, 2023 · bebf6c7 · bebf6c7
2 parents 47976e3 + d032ea1
commit bebf6c7
Show file tree

Hide file tree

Showing 37 changed files with 957 additions and 396 deletions.
diff --git a/.github/workflows/deploy_and_release.yml b/.github/workflows/deploy_and_release.yml
@@ -16,8 +16,10 @@ jobs:
     - run: npm run lint
     - run: npm run test
       env:
-        PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
-        ALCHEMY_ETHER_API_KEY: ${{ secrets.ALCHEMY_ETHER_API_KEY }}
+        MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+        TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+        QUICKNODE_ETH_MAINNET_API_KEY: ${{ secrets.QUICKNODE_ETH_MAINNET_API_KEY }}
+        QUICKNODE_ETH_HOLESKY_API_KEY: ${{ secrets.QUICKNODE_ETH_HOLESKY_API_KEY }}
         ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
         ALCHEMY_POLYGON_API_KEY: ${{ secrets.ALCHEMY_POLYGON_API_KEY }}
         POLYGONSCAN_API_KEY: ${{ secrets.POLYGONSCAN_API_KEY }}
@@ -36,26 +38,28 @@ jobs:
           result-encoding: string
           script: | 
             const tag = process.env.GITHUB_REF_NAME;
-            const regex = /v.*\-(eth|gteth|matic|tmatic|bsc|tbsc)$/;
+            const regex = /v.*\-(eth|hteth|matic|tmatic|bsc|tbsc)$/;
             const network = tag.match(regex);
-            return network ? network[1] : "gteth";
+            return network ? network[1] : "hteth";
   deploy-to-test:
     runs-on: ubuntu-latest
     needs: [lint-and-test, get-network]
-    if:  ${{ (needs.get-network.outputs.network == 'gteth' ) || (needs.get-network.outputs.network == 'tmatic' ) || (needs.get-network.outputs.network == 'tbsc' ) }}
+    if:  ${{ (needs.get-network.outputs.network == 'hteth' ) || (needs.get-network.outputs.network == 'tmatic' ) || (needs.get-network.outputs.network == 'tbsc' ) }}
     environment: testnet
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
           cache: 'npm'
       - run: npm install
       - run: npm run deploy-test --network ${{ needs.get-network.outputs.network }}
         env:
-          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
-          ALCHEMY_ETHER_API_KEY: ${{ secrets.ALCHEMY_ETHER_API_KEY }}
+          MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          QUICKNODE_ETH_MAINNET_API_KEY: ${{ secrets.QUICKNODE_ETH_MAINNET_API_KEY }}
+          QUICKNODE_ETH_HOLESKY_API_KEY: ${{ secrets.QUICKNODE_ETH_HOLESKY_API_KEY }}
           ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
           ALCHEMY_POLYGON_API_KEY: ${{ secrets.ALCHEMY_POLYGON_API_KEY }}
           POLYGONSCAN_API_KEY: ${{ secrets.POLYGONSCAN_API_KEY }}
@@ -98,13 +102,15 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14.x
+          node-version: 16.x
           cache: 'npm'
       - run: npm install
       - run: npm run deploy-prod --network ${{ needs.get-network.outputs.network }}
         env:
-          PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
-          ALCHEMY_ETHER_API_KEY: ${{ secrets.ALCHEMY_ETHER_API_KEY }}
+          MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+          QUICKNODE_ETH_MAINNET_API_KEY: ${{ secrets.QUICKNODE_ETH_MAINNET_API_KEY }}
+          QUICKNODE_ETH_HOLESKY_API_KEY: ${{ secrets.QUICKNODE_ETH_HOLESKY_API_KEY }}
           ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
           ALCHEMY_POLYGON_API_KEY: ${{ secrets.ALCHEMY_POLYGON_API_KEY }}
           POLYGONSCAN_API_KEY: ${{ secrets.POLYGONSCAN_API_KEY }}

diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}
@@ -24,9 +24,12 @@ jobs:
     - run: npm install
     - run: npm run test
       env:
-        PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
-        ALCHEMY_ETHER_API_KEY: ${{ secrets.ALCHEMY_ETHER_API_KEY }}
+        MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.MAINNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+        TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT: ${{ secrets.TESTNET_PRIVATE_KEY_FOR_CONTRACT_DEPLOYMENT }}
+        QUICKNODE_ETH_MAINNET_API_KEY: ${{ secrets.QUICKNODE_ETH_MAINNET_API_KEY }}
+        QUICKNODE_ETH_HOLESKY_API_KEY: ${{ secrets.QUICKNODE_ETH_HOLESKY_API_KEY }}
         ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
         ALCHEMY_POLYGON_API_KEY: ${{ secrets.ALCHEMY_POLYGON_API_KEY }}
         POLYGONSCAN_API_KEY: ${{ secrets.POLYGONSCAN_API_KEY }}
+        BSCSCAN_API_KEY: ${{ secrets.BSCSCAN_API_KEY }}
     - run: npm run lint
diff --git a/.solhint.json b/.solhint.json
@@ -4,7 +4,7 @@
   "rules": {
     "func-visibility": ["warn", { "ignoreConstructors": true }],
     "avoid-low-level-calls": "off",
-    "compiler-version": ["error", "0.8.10"],
+    "compiler-version": ["error", "0.8.20"],
     "const-name-snakecase": "off",
     "not-rely-on-time": "off",
     "quotes": ["error", "single"]

diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ Transfer batcher. Takes a list of recipients and amounts, and distributes ETH to
 
 ## Installation
 
-NodeJS 14 is required.
+NodeJS 16 is required.
 
 ```shell
 yarn

diff --git a/contracts/Batcher.sol b/contracts/Batcher.sol
@@ -1,4 +1,4 @@
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 // SPDX-License-Identifier: Apache-2.0
 

diff --git a/contracts/CloneFactory.sol b/contracts/CloneFactory.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MIT
 // from https://github.com/optionality/clone-factory
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 /*
     The MIT License (MIT)

diff --git a/contracts/ERC20Interface.sol b/contracts/ERC20Interface.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: UNLICENSED
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 /**
  * Contract that exposes the needed erc20 token functions
@@ -15,7 +15,7 @@ abstract contract ERC20Interface {
   // Get the account balance of another account with address _owner
   function balanceOf(address _owner)
     public
-    virtual
     view
+    virtual
     returns (uint256 balance);
 }
diff --git a/contracts/Forwarder.sol b/contracts/Forwarder.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '@openzeppelin/contracts/token/ERC1155/IERC1155.sol';
 import '@openzeppelin/contracts/token/ERC721/IERC721.sol';
 import '@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol';
@@ -52,15 +52,15 @@ contract Forwarder is IERC721Receiver, ERC1155Receiver, IForwarder {
   /**
    * Modifier that will execute internal code block only if the sender is the parent address
    */
-  modifier onlyParent {
+  modifier onlyParent() {
     require(msg.sender == parentAddress, 'Only Parent');
     _;
   }
 
   /**
    * Modifier that will execute internal code block only if the contract has not been initialized yet
    */
-  modifier onlyUninitialized {
+  modifier onlyUninitialized() {
     require(parentAddress == address(0x0), 'Already initialized');
     _;
   }
@@ -313,9 +313,9 @@ contract Forwarder is IERC721Receiver, ERC1155Receiver, IForwarder {
    */
   function supportsInterface(bytes4 interfaceId)
     public
+    view
     virtual
     override(ERC1155Receiver, IERC165)
-    view
     returns (bool)
   {
     return

diff --git a/contracts/ForwarderFactory.sol b/contracts/ForwarderFactory.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import './Forwarder.sol';
 import './CloneFactory.sol';
 

diff --git a/contracts/IForwarder.sol b/contracts/IForwarder.sol
@@ -1,4 +1,5 @@
-pragma solidity ^0.8.0;
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.20;
 
 import '@openzeppelin/contracts/utils/introspection/IERC165.sol';
 

diff --git a/contracts/TransferHelper.sol b/contracts/TransferHelper.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-3.0-or-later
 // source: https://github.com/Uniswap/solidity-lib/blob/master/contracts/libraries/TransferHelper.sol
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '@openzeppelin/contracts/utils/Address.sol';
 

diff --git a/contracts/WalletFactory.sol b/contracts/WalletFactory.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import './WalletSimple.sol';
 import './CloneFactory.sol';
 

diff --git a/contracts/WalletSimple.sol b/contracts/WalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import './TransferHelper.sol';
 import './ERC20Interface.sol';
 import './IForwarder.sol';
@@ -93,7 +93,7 @@ contract WalletSimple is IERC721Receiver, ERC1155Receiver {
    *    to allow this contract to be used by proxy with delegatecall, which will
    *    not pick up on state variables
    */
-  function getNetworkId() internal virtual pure returns (string memory) {
+  function getNetworkId() internal pure virtual returns (string memory) {
     return 'ETHER';
   }
 
@@ -105,7 +105,7 @@ contract WalletSimple is IERC721Receiver, ERC1155Receiver {
    *    to allow this contract to be used by proxy with delegatecall, which will
    *    not pick up on state variables
    */
-  function getTokenNetworkId() internal virtual pure returns (string memory) {
+  function getTokenNetworkId() internal pure virtual returns (string memory) {
     return 'ERC20';
   }
 
@@ -117,7 +117,7 @@ contract WalletSimple is IERC721Receiver, ERC1155Receiver {
    *    to allow this contract to be used by proxy with delegatecall, which will
    *    not pick up on state variables
    */
-  function getBatchNetworkId() internal virtual pure returns (string memory) {
+  function getBatchNetworkId() internal pure virtual returns (string memory) {
     return 'ETHER-Batch';
   }
 
@@ -133,15 +133,15 @@ contract WalletSimple is IERC721Receiver, ERC1155Receiver {
   /**
    * Modifier that will execute internal code block only if the sender is an authorized signer on this wallet
    */
-  modifier onlySigner {
+  modifier onlySigner() {
     require(isSigner(msg.sender), 'Non-signer in onlySigner method');
     _;
   }
 
   /**
    * Modifier that will execute internal code block only if the contract has not been initialized yet
    */
-  modifier onlyUninitialized {
+  modifier onlyUninitialized() {
     require(!initialized, 'Contract already initialized');
     _;
   }
@@ -557,9 +557,8 @@ contract WalletSimple is IERC721Receiver, ERC1155Receiver {
     uint256 lowestValueIndex = 0;
     // fetch recentSequenceIds into memory for function context to avoid unnecessary sloads
 
-
-      uint256[SEQUENCE_ID_WINDOW_SIZE] memory _recentSequenceIds
-     = recentSequenceIds;
+    uint256[SEQUENCE_ID_WINDOW_SIZE]
+      memory _recentSequenceIds = recentSequenceIds;
     for (uint256 i = 0; i < SEQUENCE_ID_WINDOW_SIZE; i++) {
       require(_recentSequenceIds[i] != sequenceId, 'Sequence ID already used');
 

diff --git a/contracts/coins/CeloWalletSimple.sol b/contracts/coins/CeloWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '../Forwarder.sol';
 import '../ERC20Interface.sol';
 import '../WalletSimple.sol';

diff --git a/contracts/coins/EtcWalletSimple.sol b/contracts/coins/EtcWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '../Forwarder.sol';
 import '../ERC20Interface.sol';
 import '../WalletSimple.sol';

diff --git a/contracts/coins/PolygonWalletSimple.sol b/contracts/coins/PolygonWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '../Forwarder.sol';
 import '../ERC20Interface.sol';
 import '../WalletSimple.sol';

diff --git a/contracts/coins/RskWalletSimple.sol b/contracts/coins/RskWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '../Forwarder.sol';
 import '../ERC20Interface.sol';
 import '../WalletSimple.sol';

diff --git a/contracts/recoveryContracts/RecoveryWalletFactory.sol b/contracts/recoveryContracts/RecoveryWalletFactory.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import './RecoveryWalletSimple.sol';
 import '../CloneFactory.sol';
 

diff --git a/contracts/recoveryContracts/RecoveryWalletSimple.sol b/contracts/recoveryContracts/RecoveryWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 import '../IForwarder.sol';
 
 /** ERC721, ERC1155 imports */

diff --git a/contracts/test/AlwaysFalseERC165.sol b/contracts/test/AlwaysFalseERC165.sol
@@ -1,4 +1,5 @@
-pragma solidity 0.8.10;
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.20;
 
 import '@openzeppelin/contracts/interfaces/IERC165.sol';
 import '@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol';

diff --git a/contracts/test/Fail.sol b/contracts/test/Fail.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 contract Fail {
   fallback() external payable {

diff --git a/contracts/test/FixedSupplyToken.sol b/contracts/test/FixedSupplyToken.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 // ----------------------------------------------------------------------------------------------
 // Sample fixed supply token contract

diff --git a/contracts/test/ForwarderTarget.sol b/contracts/test/ForwarderTarget.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '../Forwarder.sol';
 

diff --git a/contracts/test/GasGuzzler.sol b/contracts/test/GasGuzzler.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 contract GasGuzzler {
   uint256 public x = 1;

diff --git a/contracts/test/GasHeavy.sol b/contracts/test/GasHeavy.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 contract GasHeavy {
   uint256 public x = 1;

diff --git a/contracts/test/MockERC1155.sol b/contracts/test/MockERC1155.sol
@@ -1,5 +1,6 @@
+// SPDX-License-Identifier: Apache-2.0
 // Created with: https://wizard.openzeppelin.com/#erc1155
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '@openzeppelin/contracts/token/ERC1155/ERC1155.sol';
 import '@openzeppelin/contracts/access/Ownable.sol';

diff --git a/contracts/test/MockERC721.sol b/contracts/test/MockERC721.sol
@@ -1,4 +1,5 @@
-pragma solidity 0.8.10;
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.20;
 
 import '@openzeppelin/contracts/token/ERC721/ERC721.sol';
 

diff --git a/contracts/test/Reentry.sol b/contracts/test/Reentry.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '../Batcher.sol';
 

diff --git a/contracts/test/ReentryForwarder.sol b/contracts/test/ReentryForwarder.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 // import "./MockERC1155.sol";
 

diff --git a/contracts/test/ReentryWalletSimple.sol b/contracts/test/ReentryWalletSimple.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '../WalletSimple.sol';
 

diff --git a/contracts/test/TestBatcherDriver.sol b/contracts/test/TestBatcherDriver.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity 0.8.10;
+pragma solidity 0.8.20;
 
 import '../Batcher.sol';