feat(evm): implement componentInterface script

The purpose of this script is to make it easier to track any interface changes in extensional components.
boostxyz · Sep 12, 2024 · 3e82b6f · 3e82b6f
1 parent eca42d9
commit 3e82b6f
Show file tree

Hide file tree

Showing 3 changed files with 156 additions and 1 deletion.
diff --git a/packages/evm/deploys/componentInterfaces.json b/packages/evm/deploys/componentInterfaces.json
@@ -0,0 +1,17 @@
+{
+  "AAllowListIncentive": "0xa466e6f",
+  "ABudget": "0xea5ad34e",
+  "ACGDAIncentive": "0xa39e44d9",
+  "ACloneable": "0x6ab67a0d",
+  "AERC20Incentive": "0x8c901437",
+  "AERC20VariableIncentive": "0x6060409d",
+  "AEventAction": "0x7687b0ed",
+  "AIncentive": "0x5970a689",
+  "AManagedBudget": "0xa0109882",
+  "APointsIncentive": "0xc5b24b8e",
+  "ASignerValidator": "0xb8ce7b22",
+  "ASimpleAllowList": "0x8ba1fc24",
+  "ASimpleBudget": "0x2929d19c",
+  "ASimpleDenyList": "0x3d30a22c",
+  "AVestingBudget": "0x64683da1"
+}
diff --git a/packages/evm/script/solidity/ComponentInterface.s.sol b/packages/evm/script/solidity/ComponentInterface.s.sol
@@ -0,0 +1,138 @@
+// SPDX-License-Identifier: GPL-3.0
+pragma solidity ^0.8.24;
+
+import "./Util.s.sol";
+
+import {LibString} from "@solady/utils/LibString.sol";
+
+import {ACloneable} from "contracts/shared/ACloneable.sol";
+
+import {ABudget} from "contracts/budgets/ABudget.sol";
+import {AManagedBudget} from "contracts/budgets/AManagedBudget.sol";
+import {ASimpleBudget} from "contracts/budgets/ASimpleBudget.sol";
+import {AVestingBudget} from "contracts/budgets/AVestingBudget.sol";
+
+import {ASignerValidator} from "contracts/validators/ASignerValidator.sol";
+
+import {AEventAction} from "contracts/actions/EventAction.sol";
+
+import {AAllowListIncentive} from "contracts/incentives/AllowListIncentive.sol";
+import {ACGDAIncentive} from "contracts/incentives/CGDAIncentive.sol";
+import {AERC20Incentive} from "contracts/incentives/ERC20Incentive.sol";
+import {AIncentive} from "contracts/incentives/AIncentive.sol";
+import {AERC20VariableIncentive} from "contracts/incentives/ERC20VariableIncentive.sol";
+import {APointsIncentive} from "contracts/incentives/PointsIncentive.sol";
+
+import {ASimpleAllowList} from "contracts/allowlists/SimpleAllowList.sol";
+import {ASimpleDenyList} from "contracts/allowlists/SimpleDenyList.sol";
+
+contract LogComponentInterface is ScriptUtils {
+    using stdJson for string;
+    using LibString for uint256;
+
+    string constant componentJsonKey = "componentJsonKey";
+    string componentJson;
+
+    function run() public {
+        _getInterfaceAManagedBudget();
+        _getInterfaceAEventAction();
+        _getInterfaceAERC20Incentive();
+        _getInterfaceACloneable();
+        _getInterfaceABudget();
+        _getInterfaceASimpleBudget();
+        _getInterfaceAVestingBudget();
+        _getInterfaceASignerValidator();
+        _getInterfaceAAllowListIncentive();
+        _getInterfaceACGDAIncentive();
+        _getInterfaceAIncentive();
+        _getInterfaceAERC20VariableIncentive();
+        _getInterfaceAPointsIncentive();
+        _getInterfaceASimpleAllowList();
+        _getInterfaceASimpleDenyList();
+
+        _saveJson();
+    }
+
+    function _buildJsonDeployPath() internal view override returns (string memory) {
+        return string(abi.encodePacked(vm.projectRoot(), "/deploys/componentInterfaces.json"));
+    }
+
+    function _saveJson() internal {
+        vm.writeJson(componentJson, _buildJsonDeployPath());
+    }
+
+    function _getInterfaceAManagedBudget() internal {
+        string memory interfaceId = uint256(uint32(type(AManagedBudget).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AManagedBudget", interfaceId);
+    }
+
+    function _getInterfaceAEventAction() internal {
+        string memory interfaceId = uint256(uint32(type(AEventAction).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AEventAction", interfaceId);
+    }
+
+    function _getInterfaceAERC20Incentive() internal {
+        string memory interfaceId = uint256(uint32(type(AERC20Incentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AERC20Incentive", interfaceId);
+    }
+
+    function _getInterfaceACloneable() internal {
+        string memory interfaceId = uint256(uint32(type(ACloneable).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ACloneable", interfaceId);
+    }
+
+    function _getInterfaceABudget() internal {
+        string memory interfaceId = uint256(uint32(type(ABudget).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ABudget", interfaceId);
+    }
+
+    function _getInterfaceASimpleBudget() internal {
+        string memory interfaceId = uint256(uint32(type(ASimpleBudget).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ASimpleBudget", interfaceId);
+    }
+
+    function _getInterfaceAVestingBudget() internal {
+        string memory interfaceId = uint256(uint32(type(AVestingBudget).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AVestingBudget", interfaceId);
+    }
+
+    function _getInterfaceASignerValidator() internal {
+        string memory interfaceId = uint256(uint32(type(ASignerValidator).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ASignerValidator", interfaceId);
+    }
+
+    function _getInterfaceAAllowListIncentive() internal {
+        string memory interfaceId = uint256(uint32(type(AAllowListIncentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AAllowListIncentive", interfaceId);
+    }
+
+    function _getInterfaceACGDAIncentive() internal {
+        string memory interfaceId = uint256(uint32(type(ACGDAIncentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ACGDAIncentive", interfaceId);
+    }
+
+    function _getInterfaceAIncentive() internal {
+        string memory interfaceId = uint256(uint32(type(AIncentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AIncentive", interfaceId);
+    }
+
+    function _getInterfaceAERC20VariableIncentive() internal {
+        string memory interfaceId = uint256(uint32(type(AERC20VariableIncentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("AERC20VariableIncentive", interfaceId);
+    }
+
+    function _getInterfaceAPointsIncentive() internal {
+        string memory interfaceId = uint256(uint32(type(APointsIncentive).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("APointsIncentive", interfaceId);
+    }
+
+    function _getInterfaceASimpleAllowList() internal {
+        string memory interfaceId = uint256(uint32(type(ASimpleAllowList).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ASimpleAllowList", interfaceId);
+    }
+
+    function _getInterfaceASimpleDenyList() internal {
+        string memory interfaceId = uint256(uint32(type(ASimpleDenyList).interfaceId)).toMinimalHexString();
+        componentJson = componentJsonKey.serialize("ASimpleDenyList", interfaceId);
+    }
+}
diff --git a/packages/evm/script/solidity/Util.s.sol b/packages/evm/script/solidity/Util.s.sol
@@ -21,7 +21,7 @@ contract ScriptUtils is Script {
         if (!success) revert("create2 failed");
     }
 
-    function _buildJsonDeployPath() internal view returns (string memory) {
+    function _buildJsonDeployPath() internal virtual view returns (string memory) {
         return string(abi.encodePacked(vm.projectRoot(), "/deploys/", vm.toString(block.chainid), ".json"));
     }
 }