v2.1.2 decimals patch version (OffchainLabs#36)

* chore: update v3.0.0 meta

* feat: add any

* docs: comments

* chore: add rei hashes

* fix: type

* feat: check fee token

* feat: v3 upgrade check

* docs: bold upgrade draft

* add version path

* fmt

* add action

* fix

* snapshot

* add tests

* readme

* deployment script

* execution script

* format

* Revert "format"

This reverts commit 6fc72a0.

* reformat

* tight broadcast

* Update README.md

* misc

* fix

* postUpgradeInit

* main readme

* Update scripts/foundry/contract-upgrades/3.0.0/README.md

Co-authored-by: gzeon <[email protected]>

* readme tweak

* note

* Update scripts/foundry/contract-upgrades/3.0.0/README.md

* add 2.1.2 to 3.0.0 allowed versions

* typo

* fix: disable custom fee token chain support for v3 for now

* replace npm package

* metadata hashes

* chore: no bold upgrade

* chore: also remove v3 hashes

* ci: use foundry stable

* fix: lint

* test: remove pretty flag from inspect

* test: commit new format

* chore: deployments

---------

Co-authored-by: gzeon <[email protected]>
Co-authored-by: gzeon <[email protected]>

Author: godzillaba

.gas-snapshot

@@ -1 +1,4 @@
+NitroContracts2Point1Point2UpgradeActionTest:testShouldRevertOnEth() (gas: 61684)
+NitroContracts2Point1Point2UpgradeActionTest:testShouldRevertOnV2() (gas: 65683)
+NitroContracts2Point1Point2UpgradeActionTest:testShouldUpgradeAndSetDecimals() (gas: 91928)
 UpgradeArbOSVersionAtTimestampActionTest:test_1() (gas: 165)

.github/workflows/audit.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn audit:ci

.github/workflows/lint.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn && yarn build
       - run: yarn lint

.github/workflows/test-e2e.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn
       - run: cp .env.example .env && yarn test:e2e
@@ -52,7 +52,7 @@ jobs:
   #     - name: Install Foundry
   #       uses: foundry-rs/foundry-toolchain@v1
   #       with:
-  #         version: nightly
+  #         version: stable
 
   #     - run: yarn
   #     - run: cp .env.example .env && yarn test:e2e
@@ -80,7 +80,7 @@ jobs:
   #     - name: Install Foundry
   #       uses: foundry-rs/foundry-toolchain@v1
   #       with:
-  #         version: nightly
+  #         version: stable
 
   #     - run: yarn
   #     - run: cp .env.example .env && yarn test:e2e

.github/workflows/test-fork.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: ETH_FORK_URL=${{ secrets.ETH_FORK_URL }} ARB_FORK_URL=${{ secrets.ARB_FORK_URL }} yarn test:fork

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn test:unit
@@ -35,7 +35,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn test:sizes
@@ -50,7 +50,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn test:gas-check
@@ -65,7 +65,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn test:sigs
@@ -80,7 +80,7 @@ jobs:
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn minimal-install
       - run: yarn test:storage

README.md

@@ -50,6 +50,18 @@ _This section is also referenced in the documentation on ["How to upgrade ArbOS
 
 For ArbOS upgrades, a common pre-requisite is to deploy new Nitro contracts to the parent chain of your Orbit chain before scheduling the ArbOS upgrade. These contracts include the rollup logic, fraud proof contracts, and interfaces for interacting with Nitro precompiles. The scripts and instructions in this repository are meant for Orbit chain owners to upgrade the aforementioned contracts, set the new WASM module root, and then schedule the ArbOS upgrade.
 
+### Nitro contracts 2.1.2
+
+The [`nitro-contracts 2.1.2` upgrade guide](scripts/foundry/contract-upgrades/2.1.2) will patch the `ERC20Bridge` with a storage layout fix.
+
+This upgrade is only required if:
+
+1. The chain has a custom native token; AND
+1. The chain was originally deployed before `v2.0.0`; AND
+1. The chain wishes to upgrade to `v3.0.0`
+
+Do not perform this upgrade if the above requirements aren't met.
+
 ### Nitro contracts 2.1.0 (for [ArbOS 32 Bianca](https://docs.arbitrum.io/run-arbitrum-node/arbos-releases/arbos32))
 
 The [`nitro-contracts 2.1.0` upgrade action](scripts/foundry/contract-upgrades/2.1.0) will deploy `nitro-contracts v2.1.0` contracts to your Orbit's parent chain. Note that this action will only work for chains with `nitro-contracts v1.2.1` or `nitro-contracts v1.3.0`.

contracts/parent-chain/contract-upgrades/NitroContracts2Point1Point2UpgradeAction.sol

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity 0.8.16;
+
+import {ProxyAdmin} from "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+import {TransparentUpgradeableProxy} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {Address} from "@openzeppelin/contracts/utils/Address.sol";
+
+interface IERC20Bridge {
+    function nativeToken() external view returns (address);
+}
+
+interface IERC20Bridge_v2 {
+    function nativeTokenDecimals() external view returns (uint8);
+}
+
+interface IERC20Bridge_v2_patch {
+    function postUpgradeInit() external;
+}
+
+/**
+ * @title   NitroContracts2Point1Point2UpgradeAction
+ * @notice  Upgrade the bridge to ERC20Bridge v2.1.2 and force it to set nativeTokenDecimals to 18.
+ *          Will revert if the bridge is not an ERC20Bridge.
+ *          Will revert if ERC20Bridge is not v1.x.x
+ */
+contract NitroContracts2Point1Point2UpgradeAction {
+    address public immutable newBridgeImpl;
+
+    constructor(address _newBridgeImpl) {
+        require(
+            Address.isContract(_newBridgeImpl),
+            "NitroContracts2Point1Point2UpgradeAction: _newBridgeImpl is not a contract"
+        );
+
+        newBridgeImpl = _newBridgeImpl;
+    }
+
+    function perform(address bridge, ProxyAdmin proxyAdmin) external {
+        // ensure the bridge is an ERC20Bridge
+        try IERC20Bridge(bridge).nativeToken() returns (address) {}
+        catch {
+            // nativeToken() reverted, so it's not an ERC20Bridge
+            revert("NitroContracts2Point1Point2UpgradeAction: bridge is not an ERC20Bridge");
+        }
+
+        // ensure the bridge is v1.x.x
+        try IERC20Bridge_v2(address(bridge)).nativeTokenDecimals() returns (uint8) {
+            // nativeTokenDecimals() didn't revert, so it must be v2.x.x
+            revert("NitroContracts2Point1Point2UpgradeAction: bridge is not v1.x.x");
+        } catch {}
+
+        // upgrade to the new implementation and call forceEighteenDecimalsPatch
+        proxyAdmin.upgradeAndCall({
+            proxy: TransparentUpgradeableProxy(payable((bridge))),
+            implementation: newBridgeImpl,
+            data: abi.encodeCall(IERC20Bridge_v2_patch.postUpgradeInit, ())
+        });
+
+        // ensure decimals were set to 18
+        require(IERC20Bridge_v2((bridge)).nativeTokenDecimals() == 18, "decimals not set to 18");
+    }
+}

foundry.toml

@@ -6,5 +6,5 @@ test = 'test'
 cache_path  = 'cache_forge'
 solc_version = '0.8.16'
 optimizer_runs = 2000
-fs_permissions = [{ access = "read", path = "node_modules/@arbitrum/"}, { access = "read", path = "node_modules/@openzeppelin/"},{ access = "read-write", path = "./scripts/foundry"}]
+fs_permissions = [{ access = "read", path = "node_modules/@offchainlabs/"},{ access = "read", path = "node_modules/@arbitrum/"}, { access = "read", path = "node_modules/@openzeppelin/"},{ access = "read-write", path = "./scripts/foundry"}]
 script = 'scripts'

package.json

@@ -28,6 +28,7 @@
     "@arbitrum/nitro-contracts-1.2.1": "npm:@arbitrum/[email protected]",
     "@arbitrum/nitro-contracts-1.3.0": "npm:@arbitrum/[email protected]",
     "@arbitrum/nitro-contracts-2.1.0": "npm:@arbitrum/[email protected]",
+    "@arbitrum/nitro-contracts-2.1.2": "npm:@arbitrum/[email protected]",
     "@arbitrum/token-bridge-1.2.2": "npm:@arbitrum/[email protected]",
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
     "@nomicfoundation/hardhat-ethers": "^3.0.0",