docs: natspec BLSApkRegistry

Author: 0xClandestine

src/BLSApkRegistryStorage.sol

@@ -9,25 +9,30 @@ import {Initializable} from "@openzeppelin-upgrades/contracts/proxy/utils/Initia
 import {BN254} from "./libraries/BN254.sol";
 
 abstract contract BLSApkRegistryStorage is Initializable, IBLSApkRegistry {
-    /// @notice the hash of the zero pubkey aka BN254.G1Point(0,0)
+    /// @dev Returns the hash of the zero pubkey aka BN254.G1Point(0,0)
     bytes32 internal constant ZERO_PK_HASH =
         hex"ad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5";
 
-    /// @notice the registry coordinator contract
+    /// @inheritdoc IBLSApkRegistry
     address public immutable registryCoordinator;
 
-    // storage for individual pubkeys
-    /// @notice maps operator address to pubkey hash
+    /// INDIVIDUAL PUBLIC KEY STORAGE
+
+    /// @inheritdoc IBLSApkRegistry
     mapping(address operator => bytes32 operatorId) public operatorToPubkeyHash;
-    /// @notice maps pubkey hash to operator address
+
+    /// @inheritdoc IBLSApkRegistry
     mapping(bytes32 pubkeyHash => address operator) public pubkeyHashToOperator;
-    /// @notice maps operator address to pubkeyG1
+    
+    /// @inheritdoc IBLSApkRegistry
     mapping(address operator => BN254.G1Point pubkeyG1) public operatorToPubkey;
 
-    // storage for aggregate pubkeys (APKs)
-    /// @notice maps quorumNumber => historical aggregate pubkey updates
+    /// AGGREGATE PUBLIC KEY STORAGE
+
+    /// @inheritdoc IBLSApkRegistry
     mapping(uint8 => IBLSApkRegistryTypes.ApkUpdate[]) public apkHistory;
-    /// @notice maps quorumNumber => current aggregate pubkey of quorum
+
+    /// @inheritdoc IBLSApkRegistry
     mapping(uint8 => BN254.G1Point) public currentApk;
 
     constructor(
@@ -38,6 +43,5 @@ abstract contract BLSApkRegistryStorage is Initializable, IBLSApkRegistry {
         _disableInitializers();
     }
 
-    // storage gap for upgradeability
     uint256[45] private __GAP;
 }

src/interfaces/IBLSApkRegistry.sol

@@ -81,6 +81,16 @@ interface IBLSApkRegistry is IRegistry, IBLSApkRegistryErrors, IBLSApkRegistryEv
     /// @dev This value is immutable and set during contract construction.
     function registryCoordinator() external view returns (address);
 
+    /// @notice Maps `operator` to their BLS public key hash (`operatorId`).
+    /// @param operator The address of the operator.
+    /// @return operatorId The hash of the operator's BLS public key.
+    function operatorToPubkeyHash(address operator) external view returns (bytes32 operatorId);
+
+    /// @notice Maps `pubkeyHash` to their corresponding `operator` address.
+    /// @param pubkeyHash The hash of a BLS public key.
+    /// @return operator The address of the operator who registered this public key.
+    function pubkeyHashToOperator(bytes32 pubkeyHash) external view returns (address operator);
+
     /// @notice Maps `operator` to their BLS public key in G1.
     /// @dev Returns a non-encoded BN254.G1Point.
     /// @param operator The address of the operator.