IERC5564Announcer
Interface for calling the ERC5564Announcer contract, which emits an Announcement event to broadcast information about a transaction involving a stealth address. See ERC-5564 (opens in a new tab) to learn more.
Code: IERC5564Announcer.sol (opens in a new tab)
Functions
announce
function announce(
uint256 schemeId,
address stealthAddress,
bytes memory ephemeralPubKey,
bytes memory metadata
) externalCalled by integrators to emit an Announcement event.
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). |
address | stealthAddress | The computed stealth address for the recipient. |
bytes | ephemeralPubKey | Ephemeral public key used by the sender. |
bytes | metadata | Arbitrary data to emit with the event. The first byte MUST be the view tag. The remaining metadata can be used freely by the senders. |
Events
Announcement
event Announcement(
uint256 indexed schemeId,
address indexed stealthAddress,
address indexed caller,
bytes ephemeralPubKey,
bytes metadata
);Emitted when something is sent to a stealth address.
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). |
address | stealthAddress | The computed stealth address for the recipient. |
address | caller | The caller of the announce function that emitted this event. |
bytes | ephemeralPubKey | Ephemeral public key used by the sender to derive the stealthAddress. |
bytes | metadata | Arbitrary data to emit with the event. The first byte MUST be the view tag. The remaining metadata can be used by the senders as they like. See ERC-5564 (opens in a new tab) for recommendations on how to structure this metadata. |