Feat/zk sync guardian compensations

.gitignore

@@ -1,6 +1,7 @@
 cache/
 out/
 .env
+.env.*
 test-command.txt
 broadcast/
 .DS_Store

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/zk-governance"]
 	path = lib/zk-governance
 	url = https://github.com/zksync-association/zk-governance
+[submodule "lib/cybercorps-contracts"]
+	path = lib/cybercorps-contracts
+	url = https://github.com/MetaLex-Tech/cybercorps-contracts

remappings.txt

@@ -8,4 +8,5 @@ openzeppelin-contracts/=lib/zk-governance/l1-contracts/lib/openzeppelin-contract
 @openzeppelin/contracts-upgradeable=lib/zk-governance/l2-contracts/lib/openzeppelin-contracts-upgradeable/contracts
 @openzeppelin/contracts/=lib/zk-governance/l2-contracts/lib/openzeppelin-contracts/contracts/
 solmate/=lib/zk-governance/l2-contracts/lib/flexible-voting/lib/solmate/src/
-zk-governance/=lib/zk-governance/
+zk-governance/=lib/zk-governance/
+cybercorps-contracts/=lib/cybercorps-contracts/

scripts/createAllTemplates.s.sol

@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity ^0.8.24;
+
+import {ZkSyncGuardianCompensation2024_2025} from "./lib/ZkSyncGuardianCompensation2024_2025.sol";
+import {ZkSyncGuardianCompensation2025_2026} from "./lib/ZkSyncGuardianCompensation2025_2026.sol";
+import {ZkSyncGuardianCompensationSepolia2024_2025} from "./lib/ZkSyncGuardianCompensationSepolia2024_2025.sol";
+import {ISafeProxyFactory, IGnosisSafe, GnosisTransaction} from "../test/lib/safe.sol";
+import {BorgAuth} from "cybercorps-contracts/src/libs/auth.sol";
+import {CyberAgreementRegistry} from "cybercorps-contracts/src/CyberAgreementRegistry.sol";
+import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import {IZkCappedMinterV2} from "../src/interfaces/zk-governance/IZkCappedMinterV2.sol";
+import {SafeTxHelper} from "./lib/SafeTxHelper.sol";
+import {Script} from "forge-std/Script.sol";
+import {VestingAllocationFactory} from "../src/VestingAllocationFactory.sol";
+import {console2} from "forge-std/console2.sol";
+import {metavestController} from "../src/MetaVesTController.sol";
+
+contract CreateAllTemplatesScript is SafeTxHelper, Script {
+    /// @dev For running from `forge script`
+    function run() public virtual {
+        // zkSync mainnet
+        run(ZkSyncGuardianCompensation2024_2025.getDefault(vm));
+    }
+
+    /// @dev For running in tests
+    function run(
+        ZkSyncGuardianCompensation2024_2025.Config memory config
+    ) public virtual returns(GnosisTransaction[] memory) {
+        IGnosisSafe safe;
+        ZkSyncGuardianCompensation2024_2025.Config memory config;
+
+        // zkSync Era (zkSync Guardians)
+        config = ZkSyncGuardianCompensation2024_2025.getDefault(vm);
+
+        safe = config.guardianSafe;
+
+        // TODO deprecated
+//        GnosisTransaction[] memory safeTxs = new GnosisTransaction[](config.guardians.length + 1);
+//        safeTxs[0] = GnosisTransaction({
+//            to: address(config.registry),
+//            value: 0 ether,
+//            data: abi.encodeWithSelector(
+//                CyberAgreementRegistry.createTemplate.selector,
+//                config.borgResolutionTemplate.id,
+//                config.borgResolutionTemplate.name,
+//                config.borgResolutionTemplate.agreementUri,
+//                config.borgResolutionTemplate.globalFields,
+//                config.borgResolutionTemplate.partyFields
+//            )
+//        });
+//        for (uint i = 0; i < config.guardians.length ; i++) {
+//            ZkSyncGuardianCompensation2024_2025.GuardianCompInfo memory guardian = config.guardians[i];
+//            safeTxs[i + 1] = GnosisTransaction({
+//                to: address(config.registry),
+//                value: 0 ether,
+//                data: abi.encodeWithSelector(
+//                    CyberAgreementRegistry.createTemplate.selector,
+//                    guardian.compTemplate.id,
+//                    guardian.compTemplate.name,
+//                    guardian.compTemplate.agreementUri,
+//                    guardian.compTemplate.globalFields,
+//                    guardian.compTemplate.partyFields
+//                )
+//            });
+//        }
+
+        GnosisTransaction[] memory safeTxs = new GnosisTransaction[](config.guardians.length);
+        for (uint i = 0; i < config.guardians.length ; i++) {
+            ZkSyncGuardianCompensation2024_2025.GuardianCompInfo memory guardian = config.guardians[i];
+            safeTxs[i] = GnosisTransaction({
+                to: address(config.registry),
+                value: 0 ether,
+                data: abi.encodeWithSelector(
+                    CyberAgreementRegistry.createTemplate.selector,
+                    guardian.compTemplate.id,
+                    guardian.compTemplate.name,
+                    guardian.compTemplate.agreementUri,
+                    guardian.compTemplate.globalFields,
+                    guardian.compTemplate.partyFields
+                )
+            });
+        }
+
+        // Output logs
+
+        console2.log("");
+        console2.log("=== CreateAllTemplatesScript ===");
+        console2.log("Safe: ", address(safe));
+        console2.log("Safe TXs:");
+        for (uint256 i = 0 ; i < safeTxs.length ; i++) {
+            console2.log("  #", i);
+            console2.log("    to:", safeTxs[i].to);
+            console2.log("    value:", safeTxs[i].value);
+            console2.log("    data:");
+            console2.logBytes(safeTxs[i].data);
+            console2.log("");
+        }
+
+        return safeTxs;
+    }
+}

scripts/createSafeTx.s.sol

@@ -0,0 +1,99 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity ^0.8.24;
+
+import {ZkSyncGuardianCompensation2024_2025} from "./lib/ZkSyncGuardianCompensation2024_2025.sol";
+import {ZkSyncGuardianCompensation2025_2026} from "./lib/ZkSyncGuardianCompensation2025_2026.sol";
+import {ZkSyncGuardianCompensationSepolia2024_2025} from "./lib/ZkSyncGuardianCompensationSepolia2024_2025.sol";
+import {ISafeProxyFactory, IGnosisSafe, GnosisTransaction} from "../test/lib/safe.sol";
+import {BorgAuth} from "cybercorps-contracts/src/libs/auth.sol";
+import {CyberAgreementRegistry} from "cybercorps-contracts/src/CyberAgreementRegistry.sol";
+import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import {IZkCappedMinterV2} from "../src/interfaces/zk-governance/IZkCappedMinterV2.sol";
+import {SafeTxHelper} from "./lib/SafeTxHelper.sol";
+import {Script} from "forge-std/Script.sol";
+import {VestingAllocationFactory} from "../src/VestingAllocationFactory.sol";
+import {console2} from "forge-std/console2.sol";
+import {metavestController} from "../src/MetaVesTController.sol";
+
+contract CreateSafeTxScript is SafeTxHelper, Script {
+    /// @dev For running from `forge script`. Provide the deployer private key through env var.
+    function run() public virtual {
+        IGnosisSafe safe;
+        ZkSyncGuardianCompensation2024_2025.Config memory config;
+
+        // zkSync Era (zkSync Guardians)
+        config = ZkSyncGuardianCompensation2024_2025.getDefault(vm);
+        safe = config.guardianSafe;
+        GnosisTransaction[] memory safeTxs = new GnosisTransaction[](7);
+        safeTxs[0] = GnosisTransaction({
+            to: address(config.registry),
+            value: 0 ether,
+            data: abi.encodeWithSelector(
+                CyberAgreementRegistry.createTemplate.selector,
+                vm.envUint("BORG_RESOLUTION_TEMPLATE_ID"), // template ID
+                vm.envString("BORG_RESOLUTION_TEMPLATE_NAME"), // template name
+                vm.envString("BORG_RESOLUTION_URI"), // agreement URI
+                config.borgResolutionGlobalFields,
+                config.borgResolutionPartyFields
+            )
+        });
+        for (uint i = 0; i < 6 ; i++) {
+            safeTxs[i + 1] = GnosisTransaction({
+                to: address(config.registry),
+                value: 0 ether,
+                data: abi.encodeWithSelector(
+                    CyberAgreementRegistry.createTemplate.selector,
+                    vm.envUint(string(abi.encodePacked("GUARDIAN_TEMPLATE_ID_", vm.toString(i)))), // template ID
+                    vm.envString(string(abi.encodePacked("GUARDIAN_TEMPLATE_NAME_", vm.toString(i)))), // template name
+                    vm.envString(string(abi.encodePacked("GUARDIAN_AGREEMENT_URI_", vm.toString(i)))), // agreement URI
+                    config.compGlobalFields,
+                    config.compPartyFields
+                )
+            });
+        }
+
+        // zkSync Sepolia
+//        config = ZkSyncGuardianCompensationSepolia2024_2025.getDefault(vm);
+//        safe = config.guardianSafe;
+//        GnosisTransaction[] memory safeTxs = new GnosisTransaction[](2);
+//        safeTxs[0] = GnosisTransaction({
+//            to: address(config.registry),
+//            value: 0 ether,
+//            data: abi.encodeWithSelector(
+//                CyberAgreementRegistry.createTemplate.selector,
+//                config.compTemplateId,
+//                config.compTemplateName,
+//                config.compAgreementUri,
+//                config.compGlobalFields,
+//                config.compPartyFields
+//            )
+//        });
+//        safeTxs[1] = GnosisTransaction({
+//            to: address(config.registry),
+//            value: 0 ether,
+//            data: abi.encodeWithSelector(
+//                CyberAgreementRegistry.createTemplate.selector,
+//                config.serviceTemplateId,
+//                config.serviceTemplateName,
+//                config.serviceAgreementUri,
+//                config.serviceGlobalFields,
+//                config.servicePartyFields
+//            )
+//        });
+
+        // Output logs
+
+        console2.log("");
+        console2.log("=== CreateSafeTxScript ===");
+        console2.log("Safe: ", address(safe));
+        console2.log("Safe TXs:");
+        for (uint256 i = 0 ; i < safeTxs.length ; i++) {
+            console2.log("  #", i);
+            console2.log("    to:", safeTxs[i].to);
+            console2.log("    value:", safeTxs[i].value);
+            console2.log("    data:");
+            console2.logBytes(safeTxs[i].data);
+            console2.log("");
+        }
+    }
+}

scripts/deployTestZkCappedMinter.s.sol

@@ -0,0 +1,87 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+pragma solidity ^0.8.24;
+
+import {ZkSyncGuardianCompensation2024_2025} from "./lib/ZkSyncGuardianCompensation2024_2025.sol";
+import {ZkSyncGuardianCompensationSepolia2024_2025} from "./lib/ZkSyncGuardianCompensationSepolia2024_2025.sol";
+import {ISafeProxyFactory, IGnosisSafe, GnosisTransaction} from "../test/lib/safe.sol";
+import {BorgAuth} from "cybercorps-contracts/src/libs/auth.sol";
+import {CyberAgreementRegistry} from "cybercorps-contracts/src/CyberAgreementRegistry.sol";
+import {ERC1967Proxy} from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
+import {ZkCappedMinterV2} from "zk-governance/l2-contracts/src/ZkCappedMinterV2.sol";
+import {IZkCappedMinterV2Factory} from "../src/interfaces/zk-governance/IZkCappedMinterV2Factory.sol";
+import {SafeTxHelper} from "./lib/SafeTxHelper.sol";
+import {Script} from "forge-std/Script.sol";
+import {VestingAllocationFactory} from "../src/VestingAllocationFactory.sol";
+import {console2} from "forge-std/console2.sol";
+import {metavestController} from "../src/MetaVesTController.sol";
+
+contract DeployTestZkCappedMinterScript is SafeTxHelper, Script {
+    /// @dev For running from `forge script`. Provide the deployer private key through env var.
+    function run() public virtual {
+        run(
+            vm.envUint("DEPLOYER_PRIVATE_KEY"),
+
+            // zkSync Sepolia for 2024-2025
+            "MetaLexMetaVestZkSyncGuardianCompensationTestnetV0.1.2024-2025",
+            IZkCappedMinterV2Factory(0x329CE320a0Ef03F8c0E01195604b5ef7D3Fb150E),
+            ZkSyncGuardianCompensationSepolia2024_2025.getDefault(vm)
+
+            // zkSync Sepolia for 2025-2026
+//            "MetaLexMetaVestZkSyncGuardianCompensationTestnetV0.1.2025-2026",
+//            IZkCappedMinterV2Factory(0x329CE320a0Ef03F8c0E01195604b5ef7D3Fb150E),
+//            ZkSyncGuardianCompensationSepolia2025_2026.getDefault(vm)
+        );
+    }
+
+    /// @dev For running in tests
+    function run(
+        uint256 deployerPrivateKey,
+        string memory saltStr,
+        IZkCappedMinterV2Factory zkCappedMinterFactory,
+        ZkSyncGuardianCompensation2024_2025.Config memory config
+    ) public virtual returns(
+        address
+    ) {
+        address deployer = vm.addr(deployerPrivateKey);
+
+        uint256 startTime = block.timestamp + 5 minutes;
+
+        console2.log("");
+        console2.log("=== DeployTestZkCappedMinterScript ===");
+        console2.log("Deployer: ", deployer);
+        console2.log("Salt string: ", saltStr);
+        console2.log("Start time: ", startTime);
+        console2.log("ZK Token: ", address(config.zkToken));
+        console2.log("Guardian SAFE: ", address(config.guardianSafe));
+        console2.log("");
+
+        bytes32 salt = keccak256(bytes(saltStr));
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        // Deploy MetaVesT Controller
+
+        ZkCappedMinterV2 zkCappedMinter = ZkCappedMinterV2(zkCappedMinterFactory.createCappedMinter(
+            address(config.zkToken),
+            address(config.guardianSafe),
+            8.5e6 ether,
+            uint48(startTime),
+            uint48(startTime + 365 days * 2),
+            uint256(salt)
+        ));
+
+        // Grant capped minter permission
+
+        config.zkToken.grantRole(config.zkToken.MINTER_ROLE(), address(zkCappedMinter));
+
+        vm.stopBroadcast();
+
+        // Output logs
+
+        console2.log("Deployed addresses:");
+        console2.log("  ZK Capped Minter v2: ", address(zkCappedMinter));
+        console2.log("");
+
+        return address(zkCappedMinter);
+    }
+}