IIdentityUpdateBroadcaster

Git Source

Inherits: IPayloadBroadcaster

The IdentityUpdateBroadcaster is an identity payload broadcaster on an app chain.

Functions

addIdentityUpdate

Adds an identity update to a specific inbox ID.

Ensures the payload length is within the allowed range and increments the sequence ID.

function addIdentityUpdate(bytes32 inboxId_, bytes calldata identityUpdate_) external;

Parameters

NameTypeDescription
inboxId_bytes32The inbox ID.
identityUpdate_bytesThe identity update in bytes.

bootstrapIdentityUpdates

Bootstraps identity updates to satisfy a migration.

function bootstrapIdentityUpdates(
    bytes32[] calldata inboxIds_,
    bytes[] calldata identityUpdates_,
    uint64[] calldata sequenceIds_
) external;

Parameters

NameTypeDescription
inboxIds_bytes32[]The inbox IDs.
identityUpdates_bytes[]The identity updates in bytes.
sequenceIds_uint64[]The sequence IDs.

Events

IdentityUpdateCreated

Emitted when an identity update is sent.

event IdentityUpdateCreated(bytes32 indexed inboxId, bytes update, uint64 indexed sequenceId);

Parameters

NameTypeDescription
inboxIdbytes32The inbox ID.
updatebytesThe identity update in bytes. Contains the full MLS identity update payload.
sequenceIduint64The unique sequence ID of the identity update.

Errors

ArrayLengthMismatch

Thrown when the lengths of input arrays don't match.

error ArrayLengthMismatch();

EmptyArray

Thrown when a supplied array is empty.

error EmptyArray();