Skip to content

Commit 87cd5fa

Browse files
committed
fix: elm-08
1 parent 7a04188 commit 87cd5fa

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/contracts/interfaces/IKeyRegistrar.sol

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ interface IKeyRegistrar is IKeyRegistrarErrors, IKeyRegistrarEvents, ISemVerMixi
177177
* @return g2Point The BN254 G2 public key
178178
* @dev Reverts for:
179179
* - InvalidCurveType: The operatorSet is not configured for BN254
180+
* @dev Returns empty points if the operator has not registered a key for the operatorSet. We
181+
* recommend calling `isRegistered` first to check if the operator has a key registered
180182
*/
181183
function getBN254Key(
182184
OperatorSet memory operatorSet,
@@ -190,6 +192,8 @@ interface IKeyRegistrar is IKeyRegistrarErrors, IKeyRegistrarEvents, ISemVerMixi
190192
* @return pubkey The ECDSA public key in bytes format
191193
* @dev Reverts for:
192194
* - InvalidCurveType: The operatorSet is not configured for ECDSA
195+
* @dev Returns 0x0 if the operator has not registered a key for the operatorSet. We
196+
* recommend calling `isRegistered` first to check if the operator has a key registered
193197
*/
194198
function getECDSAKey(OperatorSet memory operatorSet, address operator) external view returns (bytes memory);
195199

@@ -200,6 +204,8 @@ interface IKeyRegistrar is IKeyRegistrarErrors, IKeyRegistrarEvents, ISemVerMixi
200204
* @return pubkey The ECDSA public key in address format
201205
* @dev Reverts for:
202206
* - InvalidCurveType: The operatorSet is not configured for ECDSA
207+
* @dev Returns 0x0 if the operator has not registered a key for the operatorSet. We
208+
* recommend calling `isRegistered` first to check if the operator has a key registered
203209
*/
204210
function getECDSAAddress(OperatorSet memory operatorSet, address operator) external view returns (address);
205211

0 commit comments

Comments
 (0)