Skip to content

Latest commit

 

History

History
209 lines (108 loc) · 3.91 KB

MessageBusReceiver.md

File metadata and controls

209 lines (108 loc) · 3.91 KB

MessageBusReceiver

Methods

authVerifier

function authVerifier() external view returns (address)

Returns

Name Type Description
_0 address undefined

executeMessage

function executeMessage(uint256 _srcChainId, bytes32 _srcAddress, address _dstAddress, uint256 _gasLimit, uint256 _nonce, bytes _message, bytes32 _messageId) external nonpayable

Relayer executes messages through an authenticated method to the destination receiver based on the originating transaction on source chain

Parameters

Name Type Description
_srcChainId uint256 Originating chain ID - typically a standard EVM chain ID, but may refer to a Synapse-specific chain ID on nonEVM chains
_srcAddress bytes32 Originating bytes32 address of the message sender on the srcChain
_dstAddress address Destination address that the arbitrary message will be passed to
_gasLimit uint256 Gas limit to be passed alongside the message, depending on the fee paid on srcChain
_nonce uint256 undefined
_message bytes Arbitrary message payload to pass to the destination chain receiver
_messageId bytes32 undefined

getExecutedMessage

function getExecutedMessage(bytes32 _messageId) external view returns (enum MessageBusReceiver.TxStatus)

Parameters

Name Type Description
_messageId bytes32 undefined

Returns

Name Type Description
_0 enum MessageBusReceiver.TxStatus undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

Name Type Description
_0 address undefined

renounceOwnership

function renounceOwnership() external nonpayable

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

Name Type Description
newOwner address undefined

updateAuthVerifier

function updateAuthVerifier(address _authVerifier) external nonpayable

Parameters

Name Type Description
_authVerifier address undefined

updateMessageStatus

function updateMessageStatus(bytes32 _messageId, enum MessageBusReceiver.TxStatus _status) external nonpayable

CONTRACT CONFIG

Parameters

Name Type Description
_messageId bytes32 undefined
_status enum MessageBusReceiver.TxStatus undefined

Events

CallReverted

event CallReverted(string reason)

Parameters

Name Type Description
reason string undefined

Executed

event Executed(bytes32 indexed messageId, enum MessageBusReceiver.TxStatus status, address indexed _dstAddress, uint64 srcChainId, uint64 srcNonce)

Parameters

Name Type Description
messageId indexed bytes32 undefined
status enum MessageBusReceiver.TxStatus undefined
_dstAddress indexed address undefined
srcChainId uint64 undefined
srcNonce uint64 undefined

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name Type Description
previousOwner indexed address undefined
newOwner indexed address undefined