IdentityUpdateBroadcaster

Git Source

Inherits: IIdentityUpdateBroadcaster, PayloadBroadcaster

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

Functions

constructor

Constructor for the implementation contract, such that the implementation cannot be initialized.

constructor(address parameterRegistry_) PayloadBroadcaster(parameterRegistry_);

Parameters

NameTypeDescription
parameterRegistry_addressThe address of the parameter registry.

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.

minPayloadSizeParameterKey

The parameter registry key used to fetch the minimum payload size.

function minPayloadSizeParameterKey()
    public
    pure
    override(IPayloadBroadcaster, PayloadBroadcaster)
    returns (string memory key_);

maxPayloadSizeParameterKey

The parameter registry key used to fetch the maximum payload size.

function maxPayloadSizeParameterKey()
    public
    pure
    override(IPayloadBroadcaster, PayloadBroadcaster)
    returns (string memory key_);

migratorParameterKey

The parameter registry key used to fetch the migrator.

function migratorParameterKey()
    public
    pure
    override(IPayloadBroadcaster, PayloadBroadcaster)
    returns (string memory key_);

pausedParameterKey

The parameter registry key used to fetch the paused status.

function pausedParameterKey()
    public
    pure
    override(IPayloadBroadcaster, PayloadBroadcaster)
    returns (string memory key_);

payloadBootstrapperParameterKey

The parameter registry key used to fetch the payload bootstrapper.

function payloadBootstrapperParameterKey()
    public
    pure
    override(IPayloadBroadcaster, PayloadBroadcaster)
    returns (string memory key_);