test: reboot fork test setup (#511)

* reboot fork setup

* Fix: upgrade in reboot script

* follow naming convention

* fix: actual ethereum updater

* functional reboot setup

* feat: reload config

* refactor: put reboot actions into single forge script

* fix: only deploy accountant on ethereum

* exclude fork tests from test:unit

* changelog & readme

* refactor: config stores path and reloads from it

* refactor: rename update___ to write____Config

* fix: don't attempt to initialize again if unneeded

* fix: pushUpgrade checks if upgrade is unnecessary

* feat: don't re-deploy accountant if already deployed

* explicit import Script

* rename: push__ for gov actions

* console.log

* feat: don't overwrite config

* fix: safety on config loading

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

Author: anna-carroll

foundry.toml

@@ -71,11 +71,15 @@ src = 'packages/contracts-da-bridge/contracts'
 test = 'packages/contracts-da-bridge/contracts/test'
 out = 'packages/contracts-da-bridge/foundry_artifacts'
 ffi = true
+
 [profile.da-bridge-ci.fuzz]
 runs = 10_000
+
 [profile.ops]
 src = 'packages/contracts-ops/contracts'
 test = 'packages/contracts-ops/contracts/test'
 out = 'packages/contracts-ops/foundry_artifacts'
 ffi = true
 fs_permissions = [{ access = "read-write", path = "./actions" }]
+# same as above, + 5574 for contract size
+ignored_error_codes = [2462, 5878, 9302, 5574]

package.json

@@ -32,7 +32,7 @@
     "storage-inspect:generate": "yarn workspaces foreach -Apvi --include @nomad-xyz/contracts-core --include @nomad-xyz/contracts-bridge --include @nomad-xyz/contracts-router run storage-inspect:generate",
     "test:coverage": "yarn workspaces foreach -Apvi run test:coverage",
     "test:integration": "yarn local-environment test:integration",
-    "test:unit": "yarn workspaces foreach -Apvt --exclude @nomad-xyz/deploy run test:unit"
+    "test:unit": "yarn workspaces foreach -Apvt --exclude @nomad-xyz/deploy --exclude @nomad-xyz/contracts-ops run test:unit"
   },
   "packageManager": "[email protected]"
 }

packages/contracts-core/contracts/test/Home.t.sol

@@ -61,9 +61,9 @@ contract HomeTest is NomadTestWithUpdaterManager {
 
     function test_onlyUpdaterManagerSetUpdater() public {
         address newUpdater = vm.addr(420);
-        address oldUpdater = updater;
-        assertEq(home.updater(), updater);
-        assertEq(updaterManager.updater(), updater);
+        address oldUpdater = updaterAddr;
+        assertEq(home.updater(), updaterAddr);
+        assertEq(updaterManager.updater(), updaterAddr);
         vm.expectEmit(false, false, false, true);
         emit NewUpdater(oldUpdater, newUpdater);
         vm.prank(address(updaterManager));

packages/contracts-core/contracts/test/NomadBase.t.sol

@@ -18,16 +18,16 @@ contract NomadBaseTest is NomadTest {
         super.setUp();
         nbh = new NomadBaseHarness(homeDomain);
         vm.expectEmit(false, false, false, true);
-        emit NewUpdater(address(0), updater);
-        nbh.initialize(updater);
+        emit NewUpdater(address(0), updaterAddr);
+        nbh.initialize(updaterAddr);
         vm.label(address(nbh), "Nomad Base Harness");
     }
 
     function test_failInitializeTwice() public {
         vm.expectRevert(
             bytes("Initializable: contract is already initialized")
         );
-        nbh.initialize(updater);
+        nbh.initialize(updaterAddr);
     }
 
     function test_ownerIsContractCreator() public {

packages/contracts-core/contracts/test/Replica.t.sol

@@ -16,15 +16,15 @@ contract ReplicaTest is ReplicaHandlers {
 
     ReplicaHarness replica;
 
-    uint256 optimisticSeconds;
+    uint256 optimisticTimeout;
     bytes32 committedRoot;
 
     bytes32 exampleRoot;
     bytes32 exampleLeaf;
     uint256 exampleLeafIndex;
     bytes32[32] exampleProof;
 
-    function setUp() public override {
+    function setUp() public virtual override {
         super.setUp();
         committedRoot = "commited root";
 
@@ -137,17 +137,17 @@ contract ReplicaTest is ReplicaHandlers {
     }
 
     function initializeReplica() public {
-        optimisticSeconds = 10;
+        optimisticTimeout = 10;
 
         replica.initialize(
             remoteDomain,
-            updater,
+            updaterAddr,
             committedRoot,
-            optimisticSeconds
+            optimisticTimeout
         );
         assertEq(uint256(replica.remoteDomain()), uint256(remoteDomain));
         assertEq(replica.committedRoot(), committedRoot);
-        assertEq(replica.optimisticSeconds(), optimisticSeconds);
+        assertEq(replica.optimisticSeconds(), optimisticTimeout);
         assertEq(replica.confirmAt(committedRoot), 1);
     }
 
@@ -168,7 +168,7 @@ contract ReplicaTest is ReplicaHandlers {
 
         assertEq(
             replica.confirmAt(newRoot),
-            block.timestamp + optimisticSeconds
+            block.timestamp + optimisticTimeout
         );
         assertEq(replica.committedRoot(), newRoot);
     }
@@ -465,7 +465,7 @@ contract ReplicaTest is ReplicaHandlers {
 
     function test_setUpdaterOnlyOwner() public {
         vm.expectEmit(false, false, false, true);
-        emit NewUpdater(updater, vm.addr(10));
+        emit NewUpdater(updaterAddr, vm.addr(10));
         vm.prank(replica.owner());
         replica.setUpdater(vm.addr(10));
         vm.prank(vm.addr(1453));

packages/contracts-core/contracts/test/utils/NomadTest.sol

@@ -11,7 +11,7 @@ import {MerkleTest} from "./MerkleTest.sol";
 contract NomadTest is Test {
     uint256 updaterPK = 1;
     uint256 fakeUpdaterPK = 2;
-    address updater = vm.addr(updaterPK);
+    address updaterAddr = vm.addr(updaterPK);
     address fakeUpdater = vm.addr(fakeUpdaterPK);
     address signer = vm.addr(3);
     address fakeSigner = vm.addr(4);
@@ -22,7 +22,7 @@ contract NomadTest is Test {
     MerkleTest merkleTest;
 
     function setUp() public virtual {
-        vm.label(updater, "updater");
+        vm.label(updaterAddr, "updater");
         vm.label(fakeUpdater, "fake updater");
         vm.label(signer, "signer");
         vm.label(fakeSigner, "fake signer");
@@ -91,7 +91,7 @@ contract NomadTestWithUpdaterManager is NomadTest {
 
     function setUp() public virtual override {
         super.setUp();
-        updaterManager = new UpdaterManager(updater);
+        updaterManager = new UpdaterManager(updaterAddr);
     }
 }
 

packages/contracts-ops/CHANGELOG.md

@@ -9,3 +9,4 @@
 - feature: callbatch contract
 - feature: Config.sol exposes configuration to foundry scripts
 - feature: Produce callbatches required to perform an Upgrade
+- feature: Reboot script & Reboot fork test setup

packages/contracts-ops/README.md

@@ -38,12 +38,27 @@ Contains forge scripts for Nomad system maintenance
   - uses `CallBatch` and `Config`
   - Entrypoint:
     - `printCallBatches(string,string[],string,bool)`:
-      - config path (e.g `actions/production.json`)
+      - name of config JSON file in `./actions` folder (e.g `production.json` for `./actions/production.json`)
       - list of domains for which batches should be built (e.g `[evmos,ethereum,moonbeam]`)
       - name of the domain that should be considered as local (e.g `ethereum`)
       - `true` if scripts should run for recovery mode, `false` otherwise
   - Example:
-    - `FOUNDRY_PROFILE=ops forge script UpgradeCallBatches --sig "printCallBatches(string,string[],string,bool)" "actions/production.json" "[evmos,avalanche,xdai,milkomedaC1,moonbeam,ethereum]" "ethereum" true`
+    - `FOUNDRY_PROFILE=ops forge script UpgradeCallBatches --sig "printCallBatches(string,string[],string,bool)" "production.json" "[evmos,avalanche,xdai,milkomedaC1,moonbeam,ethereum]" "ethereum" true`
+- `Reboot.s.sol`
+  - Performs all steps necessary to reboot the protocol
+    - Deploy fresh implementations 
+    - Push calls to upgrade to fresh implementations 
+    - Rotate the Updater key
+    - Re-enroll the Replicas in the xAppConnectionManager
+  - uses `CallBatch` and `Config`
+  - Entrypoint:
+    - `runReboot(string,string,string,bool)`:
+      - name of config JSON file in `./actions` folder (e.g `production.json` for `./actions/production.json`)
+      - domain to run the script on (e.g `ethereum`)
+      - name of JSON file to output callBatch (e.g `rebootActions.json` for `./actions/rebootActions.json`)
+      - `true` to overwrite existing contents of output file, `false` otherwise
+  - Example:
+    - `FOUNDRY_PROFILE=ops forge script Reboot --sig "runReboot(string,string,string,bool)" "production.json" "ethereum" "rebootActions.json" true`
 
 ## Usage
 

packages/contracts-ops/contracts/CallBatch.sol

@@ -11,34 +11,36 @@ import {TypeCasts} from "@nomad-xyz/contracts-core/contracts/XAppConnectionManag
 import {JsonWriter} from "./JsonWriter.sol";
 
 import "forge-std/Script.sol";
+import "forge-std/Vm.sol";
 
-abstract contract CallBatch is Script {
+abstract contract CallBatch {
     using JsonWriter for JsonWriter.Buffer;
     using JsonWriter for string;
 
+    Vm private constant vm =
+        Vm(address(uint160(uint256(keccak256("hevm cheat code")))));
+
     string localDomainName;
     uint32 public localDomain;
     GovernanceMessage.Call[] public localCalls;
     uint32[] public remoteDomains;
     mapping(uint32 => GovernanceMessage.Call[]) public remoteCalls;
 
     bool public written;
-    JsonWriter.File outputFile;
+    JsonWriter.File batchOutput;
 
     function __CallBatch_initialize(
         string memory _localDomainName,
         uint32 _localDomain,
-        string memory _outputFilePath,
+        string memory _batchOutput,
         bool _overwrite
     ) public {
         require(localDomain == 0, "already initialized");
         require(_localDomain != 0, "can't pass zero domain");
         localDomainName = _localDomainName;
         localDomain = _localDomain;
-        outputFile.overwrite = _overwrite;
-        outputFile.path = string(
-            abi.encodePacked("./actions/", _outputFilePath)
-        );
+        batchOutput.overwrite = _overwrite;
+        batchOutput.path = string(abi.encodePacked("./actions/", _batchOutput));
     }
 
     function pushRemote(
@@ -112,7 +114,7 @@ abstract contract CallBatch is Script {
         string memory indent,
         GovernanceMessage.Call storage call,
         bool terminal
-    ) private {
+    ) private view {
         buffer.writeObjectOpen(indent);
         string memory inner = indent.nextIndent();
         buffer.writeKv(
@@ -129,7 +131,7 @@ abstract contract CallBatch is Script {
         JsonWriter.Buffer memory buffer,
         string memory indent,
         GovernanceMessage.Call[] storage calls
-    ) private {
+    ) private view {
         for (uint32 i = 0; i < calls.length; i++) {
             writeCall(
                 buffer,
@@ -142,6 +144,7 @@ abstract contract CallBatch is Script {
 
     function writeLocal(JsonWriter.Buffer memory buffer, string memory indent)
         private
+        view
     {
         buffer.writeArrayOpen(indent, "local");
         writeCallList(buffer, indent, localCalls);
@@ -150,6 +153,7 @@ abstract contract CallBatch is Script {
 
     function writeRemotes(JsonWriter.Buffer memory buffer, string memory indent)
         private
+        view
     {
         if (remoteDomains.length == 0) return;
         buffer.writeObjectOpen(indent, "remote");
@@ -172,7 +176,7 @@ abstract contract CallBatch is Script {
         uint32 domain,
         GovernanceMessage.Call[] memory calls,
         bool isLastDomain
-    ) private {
+    ) private pure {
         buffer.writeObjectOpen(indent, vm.toString(uint256(domain)));
         bytes memory data = abi.encodeWithSelector(
             GovernanceRouter.executeGovernanceActions.selector,
@@ -260,7 +264,7 @@ abstract contract CallBatch is Script {
         writeRemotes(buffer, inner);
         writeBuilt(buffer, inner, recovery);
         buffer.writeObjectClose(indent, true);
-        buffer.flushTo(outputFile);
+        buffer.flushTo(batchOutput);
         // finish
         written = true;
     }