IERC6538Registry
Interface for calling the ERC6538Registry contract to map accounts to their stealth meta-addresses. See ERC-6538 (opens in a new tab) to learn more.
Code: IERC6538Registry.sol (opens in a new tab)
Functions
registerKeys
function registerKeys(uint256 schemeId, bytes calldata stealthMetaAddress) externalSets the caller's stealth meta-address for the given scheme ID.
Parameters:
| Type | Name | Description |
|---|---|---|
uint256 | schemeId | Identifier corresponding to the applied stealth address scheme, e.g., 1 for secp256k1, as specified in ERC-5564 (opens in a new tab). |
bytes | stealthMetaAddress | The stealth meta-address to register. |
registerKeysOnBehalf
function registerKeysOnBehalf(
address registrant,
uint256 schemeId,
bytes memory signature,
bytes calldata stealthMetaAddress
) externalSets the registrant's stealth meta-address for the given scheme ID.
Parameters:
| Type | Name | Description |
|---|---|---|
address | registrant | Address of the registrant. |
uint256 | schemeId | Identifier corresponding to the applied stealth address scheme, e.g., 1 for secp256k1, as specified in ERC-5564 (opens in a new tab). |
bytes | signature | A signature from the registrant authorizing the registration. |
bytes | stealthMetaAddress | The stealth meta-address to register. |
incrementNonce
function incrementNonce() externalIncrements the nonce of the sender to invalidate existing signatures.
DOMAIN_SEPARATOR
function DOMAIN_SEPARATOR() external view returns (bytes32)Returns the domain separator used in this contract.
stealthMetaAddressOf
function stealthMetaAddressOf(address registrant, uint256 schemeId) external view returns (bytes memory)Returns the stealth meta-address for the given registrant and schemeId.
Parameters:
| Type | Name | Description |
|---|---|---|
address | registrant | The address of the registrant. |
uint256 | schemeId | Identifier corresponding to the applied stealth address scheme. |
Return Values:
| Type | Description |
|---|---|
bytes | The stealth meta-address. |
ERC6538REGISTRY_ENTRY_TYPE_HASH
function ERC6538REGISTRY_ENTRY_TYPE_HASH() external view returns (bytes32)Returns the EIP-712 type hash used in registerKeysOnBehalf.
Return Values:
| Type | Description |
|---|---|
bytes32 | The EIP-712 type hash. |
nonceOf
function nonceOf(address registrant) external view returns (uint256)Returns the nonce of the given registrant.
Parameters:
| Type | Name | Description |
|---|---|---|
address | registrant | The address of the registrant. |
Return Values:
| Type | Description |
|---|---|
uint256 | The nonce. |
Events
StealthMetaAddressSet
event StealthMetaAddressSet(
address indexed registrant, uint256 indexed schemeId, bytes stealthMetaAddress
);Emitted when a registrant updates their stealth meta-address.
Parameters:
| Type | Name | Description |
|---|---|---|
address | registrant | The address of the registrant of the stealth meta-address. |
uint256 | schemeId | Identifier corresponding to the applied stealth address scheme, e.g., 1 for secp256k1, as specified in ERC-5564 (opens in a new tab). |
bytes | stealthMetaAddress | The stealth meta-address. Based on ERC-5564 (opens in a new tab). |
NonceIncremented
event NonceIncremented(address indexed registrant, uint256 newNonce);Emitted when a registrant increments their nonce.
Parameters:
| Type | Name | Description |
|---|---|---|
address | registrant | The account that incremented the nonce. |
uint256 | newNonce | The new nonce value. |
Errors
ERC6538Registry__InvalidSignature
error ERC6538Registry__InvalidSignature();Emitted when an invalid signature is provided to registerKeysOnBehalf.