feat: return multiple booleans from validatorOptInRouter.areValidator…

…sOptedIn
primev · Nov 7, 2024 · 6d49ffd · 6d49ffd
1 parent 443e126
commit 6d49ffd
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 38 deletions.
diff --git a/contracts-abi/abi/ValidatorOptInRouter.abi b/contracts-abi/abi/ValidatorOptInRouter.abi
@@ -45,8 +45,25 @@
     "outputs": [
       {
         "name": "",
-        "type": "bool[]",
-        "internalType": "bool[]"
+        "type": "tuple[]",
+        "internalType": "struct IValidatorOptInRouter.OptInStatus[]",
+        "components": [
+          {
+            "name": "isVanillaOptedIn",
+            "type": "bool",
+            "internalType": "bool"
+          },
+          {
+            "name": "isAvsOptedIn",
+            "type": "bool",
+            "internalType": "bool"
+          },
+          {
+            "name": "isMiddlewareOptedIn",
+            "type": "bool",
+            "internalType": "bool"
+          }
+        ]
       }
     ],
     "stateMutability": "view"

diff --git a/contracts-abi/clients/ValidatorOptInRouter/ValidatorOptInRouter.go b/contracts-abi/clients/ValidatorOptInRouter/ValidatorOptInRouter.go
diff --git a/contracts/contracts/interfaces/IValidatorOptInRouter.sol b/contracts/contracts/interfaces/IValidatorOptInRouter.sol
@@ -7,6 +7,12 @@ import {IMevCommitMiddleware} from "./IMevCommitMiddleware.sol";
 
 interface IValidatorOptInRouter {
 
+    struct OptInStatus {
+        bool isVanillaOptedIn;
+        bool isAvsOptedIn;
+        bool isMiddlewareOptedIn;
+    }
+
     /// @notice Emitted when the vanilla registry contract is set.
     event VanillaRegistrySet(address oldContract, address newContract);
 
@@ -33,6 +39,6 @@ interface IValidatorOptInRouter {
     /// @notice Allows the owner to set the mev-commit middleware contract.
     function setMevCommitMiddleware(IMevCommitMiddleware _mevCommitMiddleware) external;
 
-    /// @notice Returns an array of bools indicating whether each validator pubkey is opted in to mev-commit.
-    function areValidatorsOptedIn(bytes[] calldata valBLSPubKeys) external view returns (bool[] memory);
+    /// @notice Returns an array of OptInStatus structs indicating whether each validator pubkey is opted in to mev-commit.
+    function areValidatorsOptedIn(bytes[] calldata valBLSPubKeys) external view returns (OptInStatus[] memory);
 }
diff --git a/contracts/contracts/validator-registry/ValidatorOptInRouter.sol b/contracts/contracts/validator-registry/ValidatorOptInRouter.sol
@@ -67,14 +67,14 @@ contract ValidatorOptInRouter is IValidatorOptInRouter, ValidatorOptInRouterStor
         emit MevCommitMiddlewareSet(oldContract, address(mevCommitMiddleware));
     }
 
-    /// @notice Returns an array of bools indicating whether each validator pubkey is opted in to mev-commit.
-    function areValidatorsOptedIn(bytes[] calldata valBLSPubKeys) external view returns (bool[] memory) {
+    /// @notice Returns an array of OptInStatus structs indicating whether each validator pubkey is opted in to mev-commit.
+    function areValidatorsOptedIn(bytes[] calldata valBLSPubKeys) external view returns (OptInStatus[] memory) {
         uint256 len = valBLSPubKeys.length;
-        bool[] memory optedIn = new bool[](len);
+        OptInStatus[] memory optInStatuses = new OptInStatus[](len);
         for (uint256 i = 0; i < len; ++i) {
-            optedIn[i] = _isValidatorOptedIn(valBLSPubKeys[i]);
+            optInStatuses[i] = _isValidatorOptedIn(valBLSPubKeys[i]);
         }
-        return optedIn;
+        return optInStatuses;
     }
 
     /*
@@ -85,13 +85,13 @@ contract ValidatorOptInRouter is IValidatorOptInRouter, ValidatorOptInRouterStor
     function _authorizeUpgrade(address) internal override onlyOwner {}
 
     /// @notice Internal function to check if a validator is opted in to mev-commit with either simple staking or restaking.
-    function _isValidatorOptedIn(bytes calldata valBLSPubKey) internal view returns (bool) {
-        if (vanillaRegistry.isValidatorOptedIn(valBLSPubKey)) {
-            return true;
-        }
-        if (mevCommitAVS.isValidatorOptedIn(valBLSPubKey)) {
-            return true;
-        }
-        return mevCommitMiddleware.isValidatorOptedIn(valBLSPubKey);
+    /// @return OptInStatus struct indicating whether the validator is opted in to vanilla registry, 
+    /// eigen avs registry, and/or symbiotic middleware registry.
+    function _isValidatorOptedIn(bytes calldata valBLSPubKey) internal view returns (OptInStatus memory) {
+        OptInStatus memory optInStatus;
+        optInStatus.isVanillaOptedIn = vanillaRegistry.isValidatorOptedIn(valBLSPubKey);
+        optInStatus.isAvsOptedIn = mevCommitAVS.isValidatorOptedIn(valBLSPubKey);
+        optInStatus.isMiddlewareOptedIn = mevCommitMiddleware.isValidatorOptedIn(valBLSPubKey);
+        return optInStatus;
     }
 }