feat: contracts v3 (#232)

succinctlabs · Oct 12, 2023 · d27860b · d27860b
1 parent 3f252a5
commit d27860b
Show file tree

Hide file tree

Showing 28 changed files with 444 additions and 1,825 deletions.
diff --git a/contracts/.solhint.json b/contracts/.solhint.json
@@ -3,11 +3,13 @@
     "rules": {
         "code-complexity": ["error", 18],
         "compiler-version": ["error", ">=0.8.0"],
-        "max-line-length": ["warn", 100],
-        "no-console": "warn",
+        "max-line-length": ["off", 100],
+        "no-console": "off",
         "var-name-mixedcase": "off",
         "func-name-mixedcase": "off",
         "avoid-low-level-calls": "off",
-        "no-inline-assembly": "off"
+        "no-inline-assembly": "off",
+        "no-global-import": "off",
+        "no-empty-blocks": "off"
     }
 }
diff --git a/contracts/foundry.toml b/contracts/foundry.toml
@@ -4,4 +4,11 @@ out = "out"
 libs = ["lib"]
 fs_permissions = [{ access = "read-write", path = "./"}]
 
+# https://book.getfoundry.sh/reference/config/formatter#line_length
+[fmt]
+line_length = 100
+tab_width = 4
+func_attrs_with_params_multiline = true
+ignore = ["lib/**"]
+
 # See more config options https://github.com/foundry-rs/foundry/tree/master/config
diff --git a/contracts/script/deploy/FunctionGateway.s.sol b/contracts/script/deploy/FunctionGateway.s.sol
@@ -2,18 +2,17 @@
 pragma solidity ^0.8.16;
 
 import "forge-std/console.sol";
-import {BaseScript} from "script/misc/Base.s.sol";
-import {FunctionGateway} from "src/FunctionGateway.sol";
-import {Proxy} from "src/upgrades/Proxy.sol";
+import {BaseScript} from "../misc/Base.s.sol";
+import {FunctionGateway} from "../../src/FunctionGateway.sol";
+import {Proxy} from "../../src/upgrades/Proxy.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 
 contract DeployFunctionGateway is BaseScript {
     function run() external broadcaster {
-        console.log("Deploying FunctionGateway contract on chain %s", Strings.toString(block.chainid));
+        console.log(
+            "Deploying FunctionGateway contract on chain %s", Strings.toString(block.chainid)
+        );
 
-        // Check inputs
-        uint256 SCALAR = envUint256("SCALAR");
-        address SUCCINCT_FEE_VAULT = envAddress("SUCCINCT_FEE_VAULT", block.chainid);
         address TIMELOCK = envAddress("TIMELOCK", block.chainid);
         address GUARDIAN = envAddress("GUARDIAN", block.chainid);
         bytes32 CREATE2_SALT = envBytes32("CREATE2_SALT");
@@ -23,8 +22,9 @@ contract DeployFunctionGateway is BaseScript {
         FunctionGateway gatewayImpl = new FunctionGateway{salt: CREATE2_SALT}();
         FunctionGateway gateway;
         if (!UPGRADE) {
-            gateway = FunctionGateway(address(new Proxy{salt: CREATE2_SALT}(address(gatewayImpl), "")));
-            gateway.initialize(SCALAR, SUCCINCT_FEE_VAULT, TIMELOCK, GUARDIAN);
+            gateway =
+                FunctionGateway(address(new Proxy{salt: CREATE2_SALT}(address(gatewayImpl), "")));
+            gateway.initialize(TIMELOCK, GUARDIAN);
         } else {
             gateway = FunctionGateway(envAddress("FUNCTION_GATEWAY", block.chainid));
             gateway.upgradeTo(address(gatewayImpl));

diff --git a/contracts/script/deploy/Guardian.s.sol b/contracts/script/deploy/Guardian.s.sol
@@ -10,7 +10,9 @@ import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 // "Guardian" refers to a Gnosis Safe proxy.
 contract DeployGuardian is BaseScript {
     function run() external broadcaster {
-        console.log("Deploying Guardian (Safe) contract on chain %s", Strings.toString(block.chainid));
+        console.log(
+            "Deploying Guardian (Safe) contract on chain %s", Strings.toString(block.chainid)
+        );
 
         // Check inputs
 
@@ -48,6 +50,12 @@ contract DeployGuardian is BaseScript {
             address(0)
         );
 
-        return Safe(payable(_safeFactory.createProxyWithNonce(address(_safeSingleton), initializer, uint256(_salt))));
+        return Safe(
+            payable(
+                _safeFactory.createProxyWithNonce(
+                    address(_safeSingleton), initializer, uint256(_salt)
+                )
+            )
+        );
     }
 }
diff --git a/contracts/script/deploy/StorageOracle.s.sol b/contracts/script/deploy/StorageOracle.s.sol
diff --git a/contracts/script/deploy/StorageVerifier.sol b/contracts/script/deploy/StorageVerifier.sol
diff --git a/contracts/script/deploy/SuccinctFeeVault.s.sol b/contracts/script/deploy/SuccinctFeeVault.s.sol
@@ -8,7 +8,9 @@ import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 
 contract DeploySuccinctFeeVault is BaseScript {
     function run() external broadcaster {
-        console.log("Deploying SuccinctFeeVault contract on chain %s", Strings.toString(block.chainid));
+        console.log(
+            "Deploying SuccinctFeeVault contract on chain %s", Strings.toString(block.chainid)
+        );
 
         // Check inputs
         bytes32 CREATE2_SALT = envBytes32("CREATE2_SALT");

diff --git a/contracts/script/misc/Base.s.sol b/contracts/script/misc/Base.s.sol
@@ -76,7 +76,10 @@ abstract contract BaseScript is Script {
         return value;
     }
 
-    function envUint32s(string memory name, string memory delimiter) internal returns (uint32[] memory) {
+    function envUint32s(string memory name, string memory delimiter)
+        internal
+        returns (uint32[] memory)
+    {
         uint256[] memory values = new uint256[](0);
         values = vm.envOr(name, delimiter, values);
         if (values.length == 0) {
@@ -167,9 +170,12 @@ abstract contract BaseScript is Script {
         console.log(string.concat(string.concat(addrVar, "="), Strings.toHexString(value)));
     }
 
-    function writeEnvAddresses(string memory file, string memory name, address[] memory values, string memory delimiter)
-        internal
-    {
+    function writeEnvAddresses(
+        string memory file,
+        string memory name,
+        address[] memory values,
+        string memory delimiter
+    ) internal {
         string memory addrVar = string.concat(name, "_", Strings.toString(block.chainid));
         string memory line = string.concat(addrVar, "=");
         string memory addrs;
@@ -243,7 +249,11 @@ abstract contract BaseScript is Script {
         return _b;
     }
 
-    function buildSignaturesFromArray(bytes[] memory _signatures) internal pure returns (bytes memory) {
+    function buildSignaturesFromArray(bytes[] memory _signatures)
+        internal
+        pure
+        returns (bytes memory)
+    {
         bytes memory signatures;
         for (uint256 i = 0; i < _signatures.length; i++) {
             signatures = bytes.concat(signatures, bytes(_signatures[i]));

diff --git a/contracts/script/misc/Upgrade.s.sol b/contracts/script/misc/Upgrade.s.sol
@@ -15,7 +15,10 @@ import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
 // 		);
 //
 contract UpgradeSignSchedule is BaseScript {
-    function run(address PROXY, address IMPL) external returns (address signer, bytes memory signature) {
+    function run(address PROXY, address IMPL)
+        external
+        returns (address signer, bytes memory signature)
+    {
         // Check inputs
         address TIMELOCK = envAddress("TIMELOCK", block.chainid);
         address GUARDIAN = envAddress("GUARDIAN", block.chainid);
@@ -36,9 +39,12 @@ contract UpgradeSignSchedule is BaseScript {
             bytes[] memory payloads = new bytes[](1);
             payloads[0] = abi.encodeWithSelector(IProxy.upgradeTo.selector, IMPL);
 
-            bytes32 id = ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
+            bytes32 id =
+                ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
             if (ITimelock(TIMELOCK).isOperation(id)) {
-                revert("operation already exists in Timelock, change CREATE2_SALT to schedule a new one");
+                revert(
+                    "operation already exists in Timelock, change CREATE2_SALT to schedule a new one"
+                );
             }
 
             scheduleBatchData = abi.encodeWithSelector(
@@ -82,7 +88,11 @@ contract UpgradeSignSchedule is BaseScript {
 // After enough signatures have been collected, a call to Safe.execTransaction(..., signatures) is
 // made which schedules the call on the Timelock.
 contract UpgradeSendSchedule is BaseScript {
-    function run(address PROXY, address IMPL, bytes memory _signatures) external broadcaster returns (bool success) {
+    function run(address PROXY, address IMPL, bytes memory _signatures)
+        external
+        broadcaster
+        returns (bool success)
+    {
         // Check inputs
         address TIMELOCK = envAddress("TIMELOCK", block.chainid);
         address GUARDIAN = envAddress("GUARDIAN", block.chainid);
@@ -103,9 +113,12 @@ contract UpgradeSendSchedule is BaseScript {
             bytes[] memory payloads = new bytes[](1);
             payloads[0] = abi.encodeWithSelector(IProxy.upgradeTo.selector, IMPL);
 
-            bytes32 id = ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
+            bytes32 id =
+                ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
             if (ITimelock(TIMELOCK).isOperation(id)) {
-                revert("operation already exists in Timelock, change CREATE2_SALT to schedule a new one");
+                revert(
+                    "operation already exists in Timelock, change CREATE2_SALT to schedule a new one"
+                );
             }
 
             scheduleBatchData = abi.encodeWithSelector(
@@ -122,7 +135,9 @@ contract UpgradeSendSchedule is BaseScript {
         {
             if (ISafe(GUARDIAN).getThreshold() * 65 > _signatures.length) {
                 console.log(
-                    "not enough signatures, need %d have %d", ISafe(GUARDIAN).getThreshold(), _signatures.length / 65
+                    "not enough signatures, need %d have %d",
+                    ISafe(GUARDIAN).getThreshold(),
+                    _signatures.length / 65
                 );
                 return false;
             }
@@ -147,7 +162,10 @@ contract UpgradeSendSchedule is BaseScript {
 
 // After MINIMUM_DELAY has passed, the call to Timelock.execute() can be made.
 contract UpgradeSignExecute is BaseScript {
-    function run(address PROXY, address IMPL) external returns (address signer, bytes memory signature) {
+    function run(address PROXY, address IMPL)
+        external
+        returns (address signer, bytes memory signature)
+    {
         // Check inputs
         address TIMELOCK = envAddress("TIMELOCK", block.chainid);
         address GUARDIAN = envAddress("GUARDIAN", block.chainid);
@@ -168,7 +186,8 @@ contract UpgradeSignExecute is BaseScript {
             bytes[] memory payloads = new bytes[](1);
             payloads[0] = abi.encodeWithSelector(IProxy.upgradeTo.selector, IMPL);
 
-            bytes32 id = ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
+            bytes32 id =
+                ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
             if (ITimelock(TIMELOCK).isOperationDone(id)) {
                 console.log("operation already executed in Timelock");
                 return (address(0), "");
@@ -212,7 +231,11 @@ contract UpgradeSignExecute is BaseScript {
 }
 
 contract UpgradeSendExecute is BaseScript {
-    function run(address PROXY, address IMPL, bytes memory _signatures) external broadcaster returns (bool success) {
+    function run(address PROXY, address IMPL, bytes memory _signatures)
+        external
+        broadcaster
+        returns (bool success)
+    {
         // Check inputs
         address TIMELOCK = envAddress("TIMELOCK", block.chainid);
         address GUARDIAN = envAddress("GUARDIAN", block.chainid);
@@ -233,7 +256,8 @@ contract UpgradeSendExecute is BaseScript {
             bytes[] memory payloads = new bytes[](1);
             payloads[0] = abi.encodeWithSelector(IProxy.upgradeTo.selector, IMPL);
 
-            bytes32 id = ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
+            bytes32 id =
+                ITimelock(TIMELOCK).hashOperationBatch(targets, values, payloads, 0, CREATE2_SALT);
             if (ITimelock(TIMELOCK).isOperationDone(id)) {
                 console.log("operation already executed in Timelock");
                 return true;
@@ -253,7 +277,9 @@ contract UpgradeSendExecute is BaseScript {
         {
             if (ISafe(GUARDIAN).getThreshold() * 65 > _signatures.length) {
                 console.log(
-                    "not enough signatures, need %d have %d", ISafe(GUARDIAN).getThreshold(), _signatures.length / 65
+                    "not enough signatures, need %d have %d",
+                    ISafe(GUARDIAN).getThreshold(),
+                    _signatures.length / 65
                 );
                 return false;
             }
@@ -338,7 +364,11 @@ interface ISafe {
     event RemovedOwner(address owner);
     event SafeReceived(address indexed sender, uint256 value);
     event SafeSetup(
-        address indexed initiator, address[] owners, uint256 threshold, address initializer, address fallbackHandler
+        address indexed initiator,
+        address[] owners,
+        uint256 threshold,
+        address initializer,
+        address fallbackHandler
     );
     event SignMsg(bytes32 indexed msgHash);
 
@@ -347,10 +377,15 @@ interface ISafe {
     function approveHash(bytes32 hashToApprove) external;
     function approvedHashes(address, bytes32) external view returns (uint256);
     function changeThreshold(uint256 _threshold) external;
-    function checkNSignatures(bytes32 dataHash, bytes memory data, bytes memory signatures, uint256 requiredSignatures)
+    function checkNSignatures(
+        bytes32 dataHash,
+        bytes memory data,
+        bytes memory signatures,
+        uint256 requiredSignatures
+    ) external view;
+    function checkSignatures(bytes32 dataHash, bytes memory data, bytes memory signatures)
         external
         view;
-    function checkSignatures(bytes32 dataHash, bytes memory data, bytes memory signatures) external view;
     function disableModule(address prevModule, address module) external;
     function domainSeparator() external view returns (bytes32);
     function enableModule(address module) external;
@@ -378,12 +413,18 @@ interface ISafe {
         address refundReceiver,
         bytes memory signatures
     ) external payable returns (bool success);
-    function execTransactionFromModule(address to, uint256 value, bytes memory data, Enum.Operation operation)
-        external
-        returns (bool success);
-    function execTransactionFromModuleReturnData(address to, uint256 value, bytes memory data, Enum.Operation operation)
-        external
-        returns (bool success, bytes memory returnData);
+    function execTransactionFromModule(
+        address to,
+        uint256 value,
+        bytes memory data,
+        Enum.Operation operation
+    ) external returns (bool success);
+    function execTransactionFromModuleReturnData(
+        address to,
+        uint256 value,
+        bytes memory data,
+        Enum.Operation operation
+    ) external returns (bool success, bytes memory returnData);
     function getChainId() external view returns (uint256);
     function getModulesPaginated(address start, uint256 pageSize)
         external