flow rate initial port complete

flow rate ported, intergration tests for rootBridge switched over to rootBridgeFlowRate. flowRate controls not yet in effect
immutable · Nov 8, 2023 · d0326eb · d0326eb
1 parent c5bef71
commit d0326eb
Show file tree

Hide file tree

Showing 36 changed files with 11,513 additions and 453 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/child/ChildAxelarBridgeAdaptor.sol b/src/child/ChildAxelarBridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {AxelarExecutable} from "@axelar-gmp-sdk-solidity/contracts/executable/AxelarExecutable.sol";
 import {IAxelarGasService} from "@axelar-cgp-solidity/contracts/interfaces/IAxelarGasService.sol";

diff --git a/src/child/ChildERC20.sol b/src/child/ChildERC20.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache 2.0
 // Adapted from OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts-upgradeable/token/ERC20/ERC20Upgradeable.sol";
 import "../lib/EIP712MetaTransaction.sol";

diff --git a/src/child/ChildERC20Bridge.sol b/src/child/ChildERC20Bridge.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

diff --git a/src/child/WIMX.sol b/src/child/WIMX.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-3.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IWIMX} from "../interfaces/child/IWIMX.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";

diff --git a/src/interfaces/child/IChildAxelarBridgeAdaptor.sol b/src/interfaces/child/IChildAxelarBridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 interface IChildAxelarBridgeAdaptorErrors {
     /// @notice Error when a zero address is given when not valid.

diff --git a/src/interfaces/child/IChildERC20.sol b/src/interfaces/child/IChildERC20.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache 2.0
 // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)
 
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IERC20MetadataUpgradeable} from
     "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";

diff --git a/src/interfaces/child/IChildERC20Bridge.sol b/src/interfaces/child/IChildERC20Bridge.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 

diff --git a/src/interfaces/child/IChildERC20BridgeAdaptor.sol b/src/interfaces/child/IChildERC20BridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 interface IChildERC20BridgeAdaptor {
     /**

diff --git a/src/interfaces/child/IWIMX.sol b/src/interfaces/child/IWIMX.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 

diff --git a/src/interfaces/root/IRootAxelarBridgeAdaptor.sol b/src/interfaces/root/IRootAxelarBridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 interface IRootAxelarBridgeAdaptorErrors {
     /// @notice Error when a zero address is given when not valid.

diff --git a/src/interfaces/root/IRootERC20Bridge.sol b/src/interfaces/root/IRootERC20Bridge.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 

diff --git a/src/interfaces/root/IRootERC20BridgeAdaptor.sol b/src/interfaces/root/IRootERC20BridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 // TODO: This is likely able to become a generic bridge adaptor, not just for ERC20 tokens.
 interface IRootERC20BridgeAdaptor {

diff --git a/src/interfaces/root/IWETH.sol b/src/interfaces/root/IWETH.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 

diff --git a/src/interfaces/root/flowrate/IRootERC20BridgeFlowRate.sol b/src/interfaces/root/flowrate/IRootERC20BridgeFlowRate.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 interface IRootERC20BridgeFlowRate {
 

diff --git a/src/lib/EIP712MetaTransaction.sol b/src/lib/EIP712MetaTransaction.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import "./EIP712Upgradeable.sol";
 

diff --git a/src/lib/EIP712Upgradeable.sol b/src/lib/EIP712Upgradeable.sol
@@ -2,7 +2,7 @@
 // slither-disable-start naming-convention
 // Adapted from OpenZeppelin Contracts (last updated v4.8.0) (utils/cryptography/EIP712.sol)
 
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 

diff --git a/src/root/RootAxelarBridgeAdaptor.sol b/src/root/RootAxelarBridgeAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {AxelarExecutable} from "@axelar-gmp-sdk-solidity/contracts/executable/AxelarExecutable.sol";
 import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";

diff --git a/src/root/RootERC20Bridge.sol b/src/root/RootERC20Bridge.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {Clones} from "@openzeppelin/contracts/proxy/Clones.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
-import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
-import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+// import {Ownable2Step} from "@openzeppelin/contracts/access/Ownable2Step.sol";
+import "@openzeppelin/contracts-upgradeable/security/PausableUpgradeable.sol";
 import {IAxelarGateway} from "@axelar-cgp-solidity/contracts/interfaces/IAxelarGateway.sol";
 import {IRootERC20Bridge, IERC20Metadata} from "../interfaces/root/IRootERC20Bridge.sol";
 import {IRootERC20BridgeEvents, IRootERC20BridgeErrors} from "../interfaces/root/IRootERC20Bridge.sol";
@@ -25,8 +25,8 @@ import {IWETH} from "../interfaces/root/IWETH.sol";
  */
 
 contract RootERC20Bridge is
-    Ownable2Step,
     Initializable,
+    PausableUpgradeable,
     IRootERC20Bridge,
     IRootERC20BridgeEvents,
     IRootERC20BridgeErrors
@@ -137,7 +137,7 @@ contract RootERC20Bridge is
      * @param newRootBridgeAdaptor Address of new root bridge adaptor.
      * @dev Can only be called by owner.
      */
-    function updateRootBridgeAdaptor(address newRootBridgeAdaptor) external onlyOwner {
+    function updateRootBridgeAdaptor(address newRootBridgeAdaptor) external { // @TODO needs access control
         if (newRootBridgeAdaptor == address(0)) {
             revert ZeroAddress();
         }
@@ -153,7 +153,7 @@ contract RootERC20Bridge is
      * @dev Can only be called by owner.
      * @dev The limit can decrease, but it can never decrease to below the contract's IMX balance.
      */
-    function updateImxCumulativeDepositLimit(uint256 newImxCumulativeDepositLimit) external onlyOwner {
+    function updateImxCumulativeDepositLimit(uint256 newImxCumulativeDepositLimit) external { // @TODO needs access control
         if (
             newImxCumulativeDepositLimit != NO_DEPOSIT_LIMIT
                 && newImxCumulativeDepositLimit < IERC20Metadata(rootIMXToken).balanceOf(address(this))

diff --git a/src/root/flowrate/FlowRateDetection.sol b/src/root/flowrate/FlowRateDetection.sol
@@ -1,6 +1,6 @@
 // Copyright Immutable Pty Ltd 2018 - 2023
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 /**
  * @title  Flow Rate Detection

diff --git a/src/root/flowrate/FlowRateWithdrawalQueue.sol b/src/root/flowrate/FlowRateWithdrawalQueue.sol
@@ -1,6 +1,6 @@
 // Copyright Immutable Pty Ltd 2018 - 2023
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 /**
  * @title  Flow Rate Withdrawal Queue

diff --git a/src/root/flowrate/RootERC20BridgeFlowRate.sol b/src/root/flowrate/RootERC20BridgeFlowRate.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/security/ReentrancyGuardUpgradeable.sol";
@@ -34,7 +34,7 @@ contract RootERC20BridgeFlowRate is
         address newRootIMXToken, 
         address newRootWETHToken, 
         string memory newChildChain, 
-        address newImxCumulativeDepositLimit,
+        uint256 newImxCumulativeDepositLimit,
         address rateAdmin
         ) external initializer {
 
@@ -153,14 +153,18 @@ contract RootERC20BridgeFlowRate is
      * @dev Called by the ExitHelper.
      *      Only when not paused.
      */
-    function _withdraw(bytes calldata data) internal override {
+    function _withdraw(bytes memory data) internal override {
         (address rootToken, address withdrawer, address receiver, uint256 amount) =
             abi.decode(data, (address, address, address, uint256));
-        address childToken = rootTokenToChildToken[rootToken];
-        if (childToken == address(0)) {
-            revert NotMapped();
+        address childToken;
+        if (address(rootToken) == rootIMXToken) {
+            childToken = NATIVE_IMX;
+        } else {
+            childToken = rootTokenToChildToken[rootToken];
+            if (childToken == address(0)) {
+                revert NotMapped();
+            }
         }
-
         _executeTransfer(rootToken, childToken, withdrawer, receiver, amount);
     }
 

diff --git a/src/test/child/ChildERC20FailOnBurn.sol b/src/test/child/ChildERC20FailOnBurn.sol
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: Apache 2.0
 // Adapted from OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/ERC20.sol)
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import "../../child/ChildERC20.sol";
 

diff --git a/src/test/child/MockChildAxelarGasService.sol b/src/test/child/MockChildAxelarGasService.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 contract MockChildAxelarGasService {
     function payNativeGasForContractCall(

diff --git a/src/test/child/MockChildAxelarGateway.sol b/src/test/child/MockChildAxelarGateway.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 contract MockChildAxelarGateway {
     function validateContractCall(bytes32, string calldata, string calldata, bytes32) external pure returns (bool) {

diff --git a/src/test/child/MockChildERC20Bridge.sol b/src/test/child/MockChildERC20Bridge.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 contract MockChildERC20Bridge {
     function onMessageReceive(string calldata, string calldata, bytes calldata) external {}

diff --git a/src/test/root/MockAdaptor.sol b/src/test/root/MockAdaptor.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 // @dev A contract for ensuring the Axelar Bridge Adaptor is called correctly during unit tests.
 contract MockAdaptor {

diff --git a/src/test/root/MockAxelarGasService.sol b/src/test/root/MockAxelarGasService.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 // @dev A contract for ensuring the Axelar gas service is called correctly during unit tests.
 contract MockAxelarGasService {

diff --git a/src/test/root/MockAxelarGateway.sol b/src/test/root/MockAxelarGateway.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 // @dev A contract for ensuring the Axelar Gateway is called correctly during unit tests.
 contract MockAxelarGateway {

diff --git a/src/test/root/StubRootBridge.sol b/src/test/root/StubRootBridge.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache 2.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 

diff --git a/src/test/root/WETH.sol b/src/test/root/WETH.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-3.0
-pragma solidity ^0.8.21;
+pragma solidity ^0.8.19;
 
 import {IWETH} from "../../interfaces/root/IWETH.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";