GroupMessageBroadcaster

Inherits: IGroupMessageBroadcaster, PayloadBroadcaster

A GroupMessageBroadcaster is a group message 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

Name	Type	Description
`parameterRegistry_`	`address`	The address of the parameter registry.

addMessage

Adds a message to the group.

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

function addMessage(bytes16 groupId_, bytes calldata message_) external;

Parameters

Name	Type	Description
`groupId_`	`bytes16`	The group ID.
`message_`	`bytes`	The message in bytes.

bootstrapMessages

Bootstraps messages to satisfy a migration.

function bootstrapMessages(bytes16[] calldata groupIds_, bytes[] calldata messages_, uint64[] calldata sequenceIds_)
    external;

Parameters

Name	Type	Description
`groupIds_`	`bytes16[]`	The group IDs.
`messages_`	`bytes[]`	The messages 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_);