0xPolygon · gretzke · Sep 6, 2023 · May 12, 2023 · May 15, 2023 · May 15, 2023
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -70,7 +70,6 @@ jobs:
         with:
           node-version: "18.x"
           cache: "npm"
-      - run: rm foundry.toml
       - uses: crytic/[email protected]
         with:
           node-version: 18
@@ -89,7 +88,7 @@ jobs:
       - name: solidity-coverage
         run: npx hardhat coverage
       - name: coveralls
-        uses: coverallsapp/github-action@1.1.3
+        uses: coverallsapp/github-action@v2.1.2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
   forge_coverage:
@@ -109,4 +108,4 @@ jobs:
           cache: "npm"
       - run: npm ci
       - name: Print coverage
-        run: forge coverage
+        run: forge b; forge coverage
diff --git a/README.md b/README.md
@@ -9,18 +9,24 @@ This repository contains the smart contract suite used in Polygon's ecosystems.
 
 ## Contents
 
-- [Repo Architecture](#repo-architecture)
-  - [Contracts](#contracts)
-  - [General Repo Layout](#general-repo-layout)
-- [Using This Repo](#using-this-repo)
-  - [Requirements](#requirements)
-  - [Installation](#installation)
-  - [Compiling Contracts](#compiling-contracts)
-  - [Running Tests](#running-tests)
-  - [Check Test Coverage](#check-test-coverage)
-  - [Run Slither](#run-slither)
-  - [Continuous Integration](#continuous-integration)
-  - [Documentation](#documentation)
+- [Core Contracts](#core-contracts)
+  - [Contents](#contents)
+  - [Repo Architecture](#repo-architecture)
+    - [Contracts](#contracts)
+    - [General Repo Layout](#general-repo-layout)
+  - [Using This Repo](#using-this-repo)
+    - [Requirements](#requirements)
+    - [General Repo Layout](#general-repo-layout-1)
+    - [Installation](#installation)
+    - [Deployment](#deployment)
+    - [Environment Setup](#environment-setup)
+    - [Compiling Contracts](#compiling-contracts)
+    - [Running tests](#running-tests)
+    - [Linting](#linting)
+    - [Check Test Coverage](#check-test-coverage)
+    - [Run Slither](#run-slither)
+    - [Continuous Integration](#continuous-integration)
+    - [Documentation](#documentation)
 
 ## Repo Architecture
 
@@ -152,6 +158,12 @@ Install Foundry libs:
 forge install
 ```
 
+### Deployment
+
+Deploying these contracts in the context of a production blockchain is out of the scope of this repo, as it requires a client that has support of the Edge specification integrated. At current, Edge maintains its own client [here](https://github.com/0xPolygon/polygon-edge), which can be consulted.
+
+One point that is worth emphasizing in this context is that from the perspective of launching a Supernet is understanding genesis contracts. Another is that for at least the time being, the decision has been made to proxify all genesis contracts in order to facilitate upgrades/updates without necessitating a hardfork or regenesis. All deployment scripts in `script/deployment` use OpenZeppelin's `TransparentUpgradeableProxy`.
+
 ### Environment Setup
 
 There are a few things that should be done to set up the repo once you've cloned it and installed the dependencies and libraries. An important step for various parts of the repo to work properly is to set up a `.env` file. There is an `.example.env` file provided, copy it and rename the copy `.env`.

diff --git a/contracts/child/ChildERC1155.sol b/contracts/child/ChildERC1155.sol
@@ -3,10 +3,10 @@

 pragma solidity ^0.8.19;

 import "@openzeppelin/contracts-upgradeable/token/ERC1155/ERC1155Upgradeable.sol";
 import "@openzeppelin/contracts-upgradeable/utils/StringsUpgradeable.sol";
 import "../lib/EIP712MetaTransaction.sol";
 import "../interfaces/child/IChildERC1155.sol";

 /**
    @title ChildERC1155
@@ -20,7 +20,7 @@
    address private _rootToken;

    modifier onlyPredicate() {
        require(msg.sender == _predicate, "ChildERC1155: Only predicate can call");
        _;
    }

@@ -28,7 +28,7 @@
     * @inheritdoc IChildERC1155
     */
    function initialize(address rootToken_, string calldata uri_) external initializer {
        require(rootToken_ != address(0), "ChildERC1155: BAD_INITIALIZATION");
        _rootToken = rootToken_;
        _predicate = msg.sender;
        __ERC1155_init(uri_);
@@ -67,7 +67,7 @@
        uint256[] calldata amounts
    ) external onlyPredicate returns (bool) {
        uint256 length = accounts.length;
        require(length == tokenIds.length && length == amounts.length, "ChildERC1155: array len mismatch");
        for (uint256 i = 0; i < length; ) {
            _mint(accounts[i], tokenIds[i], amounts[i], "");
            unchecked {
@@ -102,4 +102,7 @@
     function _msgSender() internal view virtual override(EIP712MetaTransaction, ContextUpgradeable) returns (address) {
         return EIP712MetaTransaction._msgSender();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC1155Predicate.sol b/contracts/child/ChildERC1155Predicate.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;

 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
 import "@openzeppelin/contracts/proxy/Clones.sol";
 import "../interfaces/child/IChildERC1155Predicate.sol";
 import "../interfaces/child/IChildERC1155.sol";
@@ -72,7 +72,7 @@
     }
 
     /**
-     * @notice Initilization function for ChildERC1155Predicate
+     * @notice Initialization function for ChildERC1155Predicate
      * @param newL2StateSender Address of L2StateSender to send exit information to
      * @param newStateReceiver Address of StateReceiver to receive deposit information from
      * @param newRootERC1155Predicate Address of root ERC1155 predicate to communicate with
@@ -157,7 +157,7 @@
     }
 
     /**
-     * @notice Internal initilization function for ChildERC1155Predicate
+     * @notice Internal initialization function for ChildERC1155Predicate
      * @param newL2StateSender Address of L2StateSender to send exit information to
      * @param newStateReceiver Address of StateReceiver to receive deposit information from
      * @param newRootERC1155Predicate Address of root ERC1155 predicate to communicate with
@@ -335,4 +335,7 @@
             return false;
         }
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC1155PredicateAccessList.sol b/contracts/child/ChildERC1155PredicateAccessList.sol
@@ -28,4 +28,7 @@ contract ChildERC1155PredicateAccessList is AccessList, ChildERC1155Predicate {
     function _beforeTokenWithdraw() internal virtual override {
         _checkAccessList();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC20.sol b/contracts/child/ChildERC20.sol
@@ -88,4 +88,7 @@ contract ChildERC20 is EIP712MetaTransaction, ERC20Upgradeable, IChildERC20 {
     function _msgSender() internal view virtual override(EIP712MetaTransaction, ContextUpgradeable) returns (address) {
         return EIP712MetaTransaction._msgSender();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC20Predicate.sol b/contracts/child/ChildERC20Predicate.sol
@@ -50,7 +50,7 @@ contract ChildERC20Predicate is IChildERC20Predicate, Initializable, System {
     event L2TokenMapped(address indexed rootToken, address indexed childToken);
 
     /**
-     * @notice Initilization function for ChildERC20Predicate
+     * @notice Initialization function for ChildERC20Predicate
      * @param newL2StateSender Address of L2StateSender to send exit information to
      * @param newStateReceiver Address of StateReceiver to receive deposit information from
      * @param newRootERC20Predicate Address of root ERC20 predicate to communicate with
@@ -226,4 +226,7 @@ contract ChildERC20Predicate is IChildERC20Predicate, Initializable, System {
         // slither-disable-next-line reentrancy-events
         emit L2TokenMapped(rootToken, address(childToken));
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC20PredicateAccessList.sol b/contracts/child/ChildERC20PredicateAccessList.sol
@@ -35,4 +35,7 @@ contract ChildERC20PredicateAccessList is AccessList, ChildERC20Predicate {
     function _beforeTokenWithdraw() internal virtual override {
         _checkAccessList();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC721.sol b/contracts/child/ChildERC721.sol
@@ -106,4 +106,7 @@ contract ChildERC721 is EIP712MetaTransaction, ERC721Upgradeable, IChildERC721 {
     function _msgSender() internal view virtual override(EIP712MetaTransaction, ContextUpgradeable) returns (address) {
         return EIP712MetaTransaction._msgSender();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC721Predicate.sol b/contracts/child/ChildERC721Predicate.sol
@@ -68,7 +68,7 @@ contract ChildERC721Predicate is IChildERC721Predicate, Initializable, System {
     }
 
     /**
-     * @notice Initilization function for ChildERC721Predicate
+     * @notice Initialization function for ChildERC721Predicate
      * @param newL2StateSender Address of L2StateSender to send exit information to
      * @param newStateReceiver Address of StateReceiver to receive deposit information from
      * @param newRootERC721Predicate Address of root ERC721 predicate to communicate with
@@ -149,7 +149,7 @@ contract ChildERC721Predicate is IChildERC721Predicate, Initializable, System {
     }
 
     /**
-     * @notice Initilization function for ChildERC721Predicate
+     * @notice Initialization function for ChildERC721Predicate
      * @param newL2StateSender Address of L2StateSender to send exit information to
      * @param newStateReceiver Address of StateReceiver to receive deposit information from
      * @param newRootERC721Predicate Address of root ERC721 predicate to communicate with
@@ -314,4 +314,7 @@ contract ChildERC721Predicate is IChildERC721Predicate, Initializable, System {
             return false;
         }
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/ChildERC721PredicateAccessList.sol b/contracts/child/ChildERC721PredicateAccessList.sol
@@ -28,4 +28,7 @@ contract ChildERC721PredicateAccessList is AccessList, ChildERC721Predicate {
     function _beforeTokenWithdraw() internal virtual override {
         _checkAccessList();
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/EIP1559Burn.sol b/contracts/child/EIP1559Burn.sol
@@ -13,15 +13,15 @@ import "../interfaces/child/IChildERC20Predicate.sol";
 contract EIP1559Burn is Initializable {
     IChildERC20Predicate public childERC20Predicate;
     address public burnDestination;
-    IChildERC20 private constant NATIVE_TOKEN = IChildERC20(0x0000000000000000000000000000000000001010);
+    IChildERC20 private constant _NATIVE_TOKEN = IChildERC20(0x0000000000000000000000000000000000001010);
 
     event NativeTokenBurnt(address indexed burner, uint256 amount);
 
     // slither-disable-next-line locked-ether
     receive() external payable {} // solhint-disable-line no-empty-blocks
 
     /**
-     * @notice Initilization function for EIP1559 burn contract
+     * @notice Initialization function for EIP1559 burn contract
      * @param newChildERC20Predicate Address of the ERC20 predicate on child chain
      * @param newBurnDestination Address on the root chain to burn the tokens and send to
      * @dev Can only be called once
@@ -42,7 +42,7 @@ contract EIP1559Burn is Initializable {
 
         uint256 balance = address(this).balance;
 
-        childERC20Predicate.withdrawTo(NATIVE_TOKEN, burnDestination, balance);
+        childERC20Predicate.withdrawTo(_NATIVE_TOKEN, burnDestination, balance);
         // slither-disable-next-line reentrancy-events
         emit NativeTokenBurnt(msg.sender, balance);
     }

diff --git a/contracts/child/ForkParams.sol b/contracts/child/ForkParams.sol
@@ -2,24 +2,25 @@
 pragma solidity 0.8.19;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 
 /**
     @title ForkParams
     @author Polygon Technology (@QEDK)
     @notice Configurable softfork features that are read by the client on each epoch
     @dev The contract allows for configurable softfork parameters without genesis updation
  */
-contract ForkParams is Ownable {
+contract ForkParams is Ownable, Initializable {
     mapping(bytes32 => uint256) public featureToBlockNumber; // keccak256("FEATURE_NAME") -> blockNumber
 
     event NewFeature(bytes32 indexed feature, uint256 indexed block);
     event UpdatedFeature(bytes32 indexed feature, uint256 indexed block);
 
     /**
-     * @notice constructor function to set the owner
+     * @notice initialize function to set the owner
      * @param newOwner address to transfer the ownership to
      */
-    constructor(address newOwner) {
+    function initialize(address newOwner) public initializer {
         _transferOwnership(newOwner);
     }
 

diff --git a/contracts/child/L2StateSender.sol b/contracts/child/L2StateSender.sol
@@ -29,4 +29,7 @@ contract L2StateSender is IStateSender {
 
         emit L2StateSynced(++counter, msg.sender, receiver, data);
     }
+
+    // slither-disable-next-line unused-state,naming-convention
+    uint256[50] private __gap;
 }
diff --git a/contracts/child/NativeERC20.sol b/contracts/child/NativeERC20.sol
@@ -43,8 +43,9 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
         address rootToken_,
         string calldata name_,
         string calldata symbol_,
-        uint8 decimals_
-    ) external initializer onlySystemCall {
+        uint8 decimals_,
+        uint256 tokenSupply_
+    ) external virtual initializer onlySystemCall {
         // slither-disable-next-line missing-zero-check,events-access
         _predicate = predicate_;
         // slither-disable-next-line missing-zero-check
@@ -53,6 +54,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
         _symbol = symbol_;
         // slither-disable-next-line events-maths
         _decimals = decimals_;
+        _totalSupply = tokenSupply_;
     }
 
     /**
@@ -63,7 +65,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - `to` cannot be the zero address.
      * - the caller must have a balance of at least `amount`.
      */
-    function transfer(address to, uint256 amount) external returns (bool) {
+    function transfer(address to, uint256 amount) external virtual returns (bool) {
         address owner = _msgSender();
         _transfer(owner, to, amount);
         return true;
@@ -79,7 +81,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      *
      * - `spender` cannot be the zero address.
      */
-    function approve(address spender, uint256 amount) external returns (bool) {
+    function approve(address spender, uint256 amount) external virtual returns (bool) {
         address owner = _msgSender();
         _approve(owner, spender, amount);
         return true;
@@ -101,7 +103,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - the caller must have allowance for ``from``'s tokens of at least
      * `amount`.
      */
-    function transferFrom(address from, address to, uint256 amount) external returns (bool) {
+    function transferFrom(address from, address to, uint256 amount) external virtual returns (bool) {
         address spender = _msgSender();
         _spendAllowance(from, spender, amount);
         _transfer(from, to, amount);
@@ -120,7 +122,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      *
      * - `spender` cannot be the zero address.
      */
-    function increaseAllowance(address spender, uint256 addedValue) external returns (bool) {
+    function increaseAllowance(address spender, uint256 addedValue) external virtual returns (bool) {
         address owner = _msgSender();
         _approve(owner, spender, allowance(owner, spender) + addedValue);
         return true;
@@ -140,7 +142,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - `spender` must have allowance for the caller of at least
      * `subtractedValue`.
      */
-    function decreaseAllowance(address spender, uint256 subtractedValue) external returns (bool) {
+    function decreaseAllowance(address spender, uint256 subtractedValue) external virtual returns (bool) {
         address owner = _msgSender();
         uint256 currentAllowance = allowance(owner, spender);
         require(currentAllowance >= subtractedValue, "ERC20: decreased allowance below zero");
@@ -154,7 +156,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
     /**
      * @inheritdoc INativeERC20
      */
-    function mint(address account, uint256 amount) external onlyPredicate returns (bool) {
+    function mint(address account, uint256 amount) external virtual onlyPredicate returns (bool) {
         _mint(account, amount);
 
         return true;
@@ -163,7 +165,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
     /**
      * @inheritdoc INativeERC20
      */
-    function burn(address account, uint256 amount) external onlyPredicate returns (bool) {
+    function burn(address account, uint256 amount) external virtual onlyPredicate returns (bool) {
         _burn(account, amount);
 
         return true;
@@ -218,7 +220,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
     /**
      * @dev See {IERC20-allowance}.
      */
-    function allowance(address owner, address spender) public view returns (uint256) {
+    function allowance(address owner, address spender) public view virtual returns (uint256) {
         return _allowances[owner][spender];
     }
 
@@ -250,7 +252,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - `to` cannot be the zero address.
      * - `from` must have a balance of at least `amount`.
      */
-    function _transfer(address from, address to, uint256 amount) internal {
+    function _transfer(address from, address to, uint256 amount) internal virtual {
         require(from != address(0), "ERC20: transfer from the zero address");
         require(to != address(0), "ERC20: transfer to the zero address");
 
@@ -270,7 +272,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      *
      * - `account` cannot be the zero address.
      */
-    function _mint(address account, uint256 amount) internal {
+    function _mint(address account, uint256 amount) internal virtual {
         require(account != address(0), "ERC20: mint to the zero address");
 
         _totalSupply += amount;
@@ -293,7 +295,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - `account` cannot be the zero address.
      * - `account` must have at least `amount` tokens.
      */
-    function _burn(address account, uint256 amount) internal {
+    function _burn(address account, uint256 amount) internal virtual {
         require(account != address(0), "ERC20: burn from the zero address");
 
         _totalSupply -= amount;
@@ -318,7 +320,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      * - `owner` cannot be the zero address.
      * - `spender` cannot be the zero address.
      */
-    function _approve(address owner, address spender, uint256 amount) internal {
+    function _approve(address owner, address spender, uint256 amount) internal virtual {
         require(owner != address(0), "ERC20: approve from the zero address");
         require(spender != address(0), "ERC20: approve to the zero address");
 
@@ -334,7 +336,7 @@ contract NativeERC20 is Context, Initializable, System, INativeERC20 {
      *
      * Might emit an {Approval} event.
      */
-    function _spendAllowance(address owner, address spender, uint256 amount) internal {
+    function _spendAllowance(address owner, address spender, uint256 amount) internal virtual {
         uint256 currentAllowance = allowance(owner, spender);
         if (currentAllowance != type(uint256).max) {
             require(currentAllowance >= amount, "ERC20: insufficient allowance");