feat(core): make chugsplash-deploy task execute locally

hujw77 · Apr 10, 2023 · 11fd15c · 11fd15c
1 parent acdb0e4
commit 11fd15c
Show file tree

Hide file tree

Showing 27 changed files with 699 additions and 965 deletions.
diff --git a/.changeset/unlucky-balloons-explode.md b/.changeset/unlucky-balloons-explode.md
@@ -0,0 +1,8 @@
+---
+'@chugsplash/core': minor
+'@chugsplash/contracts': patch
+'@chugsplash/executor': patch
+'@chugsplash/plugins': patch
+---
+
+Make chugsplash-deploy task execute locally by default
diff --git a/packages/contracts/contracts/ChugSplashDataTypes.sol b/packages/contracts/contracts/ChugSplashDataTypes.sol
@@ -37,6 +37,7 @@ struct ChugSplashBundleState {
     uint256 actionsExecuted;
     uint256 timeClaimed;
     address selectedExecutor;
+    bool remoteExecution;
 }
 
 /**

diff --git a/packages/contracts/contracts/ChugSplashManager.sol b/packages/contracts/contracts/ChugSplashManager.sol
@@ -41,6 +41,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         uint256 numActions,
         uint256 numTargets,
         string configUri,
+        bool remoteExecution,
         address proposer
     );
 
@@ -330,6 +331,15 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
             keccak256(abi.encode(_actionRoot, _targetRoot, _numActions, _numTargets, _configUri));
     }
 
+    function assertCallerIsOwnerOrSelectedExecutor(bool _remoteExecution) internal view {
+        _remoteExecution
+            ? require(
+                getSelectedExecutor(activeBundleId) == msg.sender,
+                "ChugSplashManager: caller is not approved executor"
+            )
+            : require(owner() == msg.sender, "ChugSplashManager: caller is not owner");
+    }
+
     function totalDebt() public view returns (uint256) {
         return totalExecutorDebt + totalProtocolDebt;
     }
@@ -397,7 +407,8 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         bytes32 _targetRoot,
         uint256 _numActions,
         uint256 _numTargets,
-        string memory _configUri
+        string memory _configUri,
+        bool _remoteExecution
     ) public {
         require(isProposer(msg.sender), "ChugSplashManager: caller must be proposer");
 
@@ -423,6 +434,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         bundle.targetRoot = _targetRoot;
         bundle.actions = new bool[](_numActions);
         bundle.targets = _numTargets;
+        bundle.remoteExecution = _remoteExecution;
 
         emit ChugSplashBundleProposed(
             bundleId,
@@ -431,6 +443,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
             _numActions,
             _numTargets,
             _configUri,
+            _remoteExecution,
             msg.sender
         );
         registry.announceWithData("ChugSplashBundleProposed", abi.encodePacked(msg.sender));
@@ -446,13 +459,15 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
      * @param _bundleId ID of the bundle to approve
      */
     function approveChugSplashBundle(bytes32 _bundleId) public onlyOwner {
-        require(
-            address(this).balance - totalDebt() >= ownerBondAmount,
-            "ChugSplashManager: insufficient balance in manager"
-        );
-
         ChugSplashBundleState storage bundle = _bundles[_bundleId];
 
+        if (bundle.remoteExecution) {
+            require(
+                address(this).balance - totalDebt() >= ownerBondAmount,
+                "ChugSplashManager: insufficient balance in manager"
+            );
+        }
+
         require(
             bundle.status == ChugSplashBundleStatus.PROPOSED,
             "ChugSplashManager: bundle must be proposed"
@@ -482,13 +497,10 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
     ) public {
         uint256 initialGasLeft = gasleft();
 
-        require(
-            getSelectedExecutor(activeBundleId) == msg.sender,
-            "ChugSplashManager: caller is not approved executor for active bundle ID"
-        );
-
         ChugSplashBundleState storage bundle = _bundles[activeBundleId];
 
+        assertCallerIsOwnerOrSelectedExecutor(bundle.remoteExecution);
+
         require(
             bundle.status == ChugSplashBundleStatus.APPROVED,
             "ChugSplashManager: execution has already been initiated"
@@ -557,7 +569,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         emit ChugSplashBundleInitiated(activeBundleId, msg.sender);
         registry.announce("ChugSplashBundleInitiated");
 
-        _payExecutorAndProtocol(initialGasLeft);
+        _payExecutorAndProtocol(initialGasLeft, bundle.remoteExecution);
     }
 
     /**
@@ -578,13 +590,10 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         bytes32 noProxyContractKindHash = keccak256("no-proxy");
         uint256 initialGasLeft = gasleft();
 
-        require(
-            getSelectedExecutor(activeBundleId) == msg.sender,
-            "ChugSplashManager: caller is not approved executor for active bundle ID"
-        );
-
         ChugSplashBundleState storage bundle = _bundles[activeBundleId];
 
+        assertCallerIsOwnerOrSelectedExecutor(bundle.remoteExecution);
+
         uint256 numActions = _actions.length;
         ChugSplashAction memory action;
         uint256 actionIndex;
@@ -665,7 +674,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
             registry.announceWithData("ChugSplashActionExecuted", abi.encodePacked(action.proxy));
         }
 
-        _payExecutorAndProtocol(initialGasLeft);
+        _payExecutorAndProtocol(initialGasLeft, bundle.remoteExecution);
     }
 
     /**
@@ -684,18 +693,15 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
     ) public {
         uint256 initialGasLeft = gasleft();
 
-        require(
-            getSelectedExecutor(activeBundleId) == msg.sender,
-            "ChugSplashManager: caller is not approved executor for active bundle ID"
-        );
+        ChugSplashBundleState storage bundle = _bundles[activeBundleId];
+
+        assertCallerIsOwnerOrSelectedExecutor(bundle.remoteExecution);
 
         require(
             activeBundleId != bytes32(0),
             "ChugSplashManager: no bundle has been approved for execution"
         );
 
-        ChugSplashBundleState storage bundle = _bundles[activeBundleId];
-
         require(
             bundle.actionsExecuted == bundle.actions.length,
             "ChugSplashManager: bundle was not executed completely"
@@ -751,7 +757,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         emit ChugSplashBundleCompleted(completedBundleId, msg.sender, bundle.actionsExecuted);
         registry.announce("ChugSplashBundleCompleted");
 
-        _payExecutorAndProtocol(initialGasLeft);
+        _payExecutorAndProtocol(initialGasLeft, bundle.remoteExecution);
     }
 
     function executeEntireBundle(
@@ -781,7 +787,7 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
 
         ChugSplashBundleState storage bundle = _bundles[activeBundleId];
 
-        if (bundle.timeClaimed + executionLockTime >= block.timestamp) {
+        if (bundle.remoteExecution && bundle.timeClaimed + executionLockTime >= block.timestamp) {
             // Give the owner's bond to the executor if the bundle is cancelled within the
             // `executionLockTime` window.
             totalExecutorDebt += ownerBondAmount;
@@ -808,6 +814,8 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
 
         ChugSplashBundleState storage bundle = _bundles[activeBundleId];
 
+        require(bundle.remoteExecution, "ChugSplashManager: bundle must be executed locally");
+
         require(
             block.timestamp > bundle.timeClaimed + executionLockTime,
             "ChugSplashManager: bundle is currently claimed by an executor"
@@ -949,7 +957,11 @@ contract ChugSplashManager is OwnableUpgradeable, ReentrancyGuardUpgradeable {
         registry.announce("ETHDeposited");
     }
 
-    function _payExecutorAndProtocol(uint256 _initialGasLeft) internal {
+    function _payExecutorAndProtocol(uint256 _initialGasLeft, bool _remoteExecution) internal {
+        if (!_remoteExecution) {
+            return;
+        }
+
         uint256 gasPrice;
         if (block.chainid != 10 && block.chainid != 420) {
             // Use the gas price for any network that isn't Optimism.

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -34,10 +34,12 @@
     "@eth-optimism/contracts-bedrock": "^0.8.0",
     "@eth-optimism/core-utils": "^0.9.1",
     "@ethersproject/abstract-provider": "^5.7.0",
+    "@nomiclabs/hardhat-etherscan": "^3.1.7",
     "@openzeppelin/hardhat-upgrades": "^1.22.1",
     "@openzeppelin/upgrades-core": "^1.20.6",
     "chalk": "^4.1.2",
     "core-js": "^3.27.1",
+    "dotenv": "^16.0.3",
     "ethers": "^5.6.9",
     "fs": "^0.0.1-security",
     "handlebars": "^4.7.7",
@@ -50,6 +52,7 @@
     "ora": "^5.4.1",
     "semver": "^7.3.8",
     "solidity-ast": "^0.4.45",
+    "undici": "^5.21.1",
     "yesno": "^0.4.0"
   },
   "devDependencies": {