EndpointV2Mock
Methods
EMPTY_PAYLOAD_HASH
function EMPTY_PAYLOAD_HASH() external view returns (bytes32)
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
_executeNativeAirDropAndReturnLzGas
function _executeNativeAirDropAndReturnLzGas(bytes _options) external nonpayable returns (uint256 totalGas, uint256 dstAmount)
Parameters
| Name | Type | Description |
|---|---|---|
| _options | bytes | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| totalGas | uint256 | undefined |
| dstAmount | uint256 | undefined |
burn
function burn(address _oapp, uint32 _srcEid, bytes32 _sender, uint64 _nonce, bytes32 _payloadHash) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _oapp | address | undefined |
| _srcEid | uint32 | undefined |
| _sender | bytes32 | undefined |
| _nonce | uint64 | undefined |
| _payloadHash | bytes32 | undefined |
clear
function clear(address _oapp, Origin _origin, bytes32 _guid, bytes _message) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _oapp | address | undefined |
| _origin | Origin | undefined |
| _guid | bytes32 | undefined |
| _message | bytes | undefined |
composeQueue
function composeQueue(address from, address to, bytes32 guid, uint16 index) external view returns (bytes32 messageHash)
Parameters
| Name | Type | Description |
|---|---|---|
| from | address | undefined |
| to | address | undefined |
| guid | bytes32 | undefined |
| index | uint16 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| messageHash | bytes32 | undefined |
defaultReceiveLibrary
function defaultReceiveLibrary(uint32) external pure returns (address)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
defaultReceiveLibraryTimeout
function defaultReceiveLibraryTimeout(uint32) external pure returns (address lib, uint256 expiry)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| lib | address | undefined |
| expiry | uint256 | undefined |
defaultSendLibrary
function defaultSendLibrary(uint32) external pure returns (address)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
eid
function eid() external view returns (uint32)
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
executable
function executable(Origin, address) external pure returns (enum ExecutionState)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | Origin | undefined |
| _1 | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | enum ExecutionState | undefined |
executeNativeAirDropAndReturnLzGas
function executeNativeAirDropAndReturnLzGas(bytes _options) external nonpayable returns (uint256 totalGas, uint256 dstAmount)
Parameters
| Name | Type | Description |
|---|---|---|
| _options | bytes | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| totalGas | uint256 | undefined |
| dstAmount | uint256 | undefined |
getConfig
function getConfig(address, address, uint32, uint32) external pure returns (bytes config)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | address | undefined |
| _2 | uint32 | undefined |
| _3 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| config | bytes | undefined |
getExecutorFee
function getExecutorFee(uint256 _payloadSize, bytes _options) external view returns (uint256)
Parameters
| Name | Type | Description |
|---|---|---|
| _payloadSize | uint256 | undefined |
| _options | bytes | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
getReceiveLibrary
function getReceiveLibrary(address, uint32) external pure returns (address lib, bool isDefault)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| lib | address | undefined |
| isDefault | bool | undefined |
getRegisteredLibraries
function getRegisteredLibraries() external pure returns (address[])
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address[] | undefined |
getSendContext
function getSendContext() external view returns (uint32, address)
returns (eid, sender) if sending message, (0, 0) otherwise
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
| _1 | address | undefined |
getSendLibrary
function getSendLibrary(address, uint32) external pure returns (address lib)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| lib | address | undefined |
inboundNonce
function inboundNonce(address _receiver, uint32 _srcEid, bytes32 _sender) external view returns (uint64)
Parameters
| Name | Type | Description |
|---|---|---|
| _receiver | address | undefined |
| _srcEid | uint32 | undefined |
| _sender | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint64 | undefined |
inboundPayloadHash
function inboundPayloadHash(address receiver, uint32 srcEid, bytes32 sender, uint64 inboundNonce) external view returns (bytes32 payloadHash)
Parameters
| Name | Type | Description |
|---|---|---|
| receiver | address | undefined |
| srcEid | uint32 | undefined |
| sender | bytes32 | undefined |
| inboundNonce | uint64 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| payloadHash | bytes32 | undefined |
initializable
function initializable(Origin _origin, address _receiver) external view returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _origin | Origin | undefined |
| _receiver | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isDefaultSendLibrary
function isDefaultSendLibrary(address, uint32) external pure returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isRegisteredLibrary
function isRegisteredLibrary(address) external pure returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isSendingMessage
function isSendingMessage() external view returns (bool)
returns true if sending message
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isSupportedEid
function isSupportedEid(uint32) external pure returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
isValidReceiveLibrary
function isValidReceiveLibrary(address _receiver, uint32 _srcEid, address _actualReceiveLib) external view returns (bool)
called when the endpoint checks if the msgLib attempting to verify the msg is the configured msgLib of the Oappthis check provides the ability for Oapp to lock in a trusted msgLibit will fist check if the msgLib is the currently configured one. then check if the msgLib is the one in grace period of msgLib versioning upgrade
Parameters
| Name | Type | Description |
|---|---|---|
| _receiver | address | undefined |
| _srcEid | uint32 | undefined |
| _actualReceiveLib | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
lazyInboundNonce
function lazyInboundNonce(address receiver, uint32 srcEid, bytes32 sender) external view returns (uint64 nonce)
Parameters
| Name | Type | Description |
|---|---|---|
| receiver | address | undefined |
| srcEid | uint32 | undefined |
| sender | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| nonce | uint64 | undefined |
lzCompose
function lzCompose(address, address, bytes32, uint16, bytes, bytes) external payable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | address | undefined |
| _2 | bytes32 | undefined |
| _3 | uint16 | undefined |
| _4 | bytes | undefined |
| _5 | bytes | undefined |
lzEndpointLookup
function lzEndpointLookup(address) external view returns (address)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
lzReceive
function lzReceive(Origin, address, bytes32, bytes, bytes) external payable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | Origin | undefined |
| _1 | address | undefined |
| _2 | bytes32 | undefined |
| _3 | bytes | undefined |
| _4 | bytes | undefined |
lzToken
function lzToken() external pure returns (address)
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
nativeToken
function nativeToken() external pure returns (address)
Returns
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
nextGuid
function nextGuid(address, uint32, bytes32) external pure returns (bytes32)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bytes32 | undefined |
nilify
function nilify(address, uint32, bytes32, uint64, bytes32) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | bytes32 | undefined |
| _3 | uint64 | undefined |
| _4 | bytes32 | undefined |
outboundNonce
function outboundNonce(address sender, uint32 dstEid, bytes32 receiver) external view returns (uint64 nonce)
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined |
| dstEid | uint32 | undefined |
| receiver | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| nonce | uint64 | undefined |
quote
function quote(MessagingParams _params, address _sender) external view returns (struct MessagingFee)
Parameters
| Name | Type | Description |
|---|---|---|
| _params | MessagingParams | undefined |
| _sender | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | MessagingFee | undefined |
receiveLibraryTimeout
function receiveLibraryTimeout(address receiver, uint32 srcEid) external view returns (address lib, uint256 expiry)
Parameters
| Name | Type | Description |
|---|---|---|
| receiver | address | undefined |
| srcEid | uint32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| lib | address | undefined |
| expiry | uint256 | undefined |
receivePayload
function receivePayload(Origin _origin, address _receiver, bytes32 _payloadHash, bytes _message, uint256 _gas, uint256 _msgValue, bytes32 _guid) external payable
Parameters
| Name | Type | Description |
|---|---|---|
| _origin | Origin | undefined |
| _receiver | address | undefined |
| _payloadHash | bytes32 | undefined |
| _message | bytes | undefined |
| _gas | uint256 | undefined |
| _msgValue | uint256 | undefined |
| _guid | bytes32 | undefined |
registerLibrary
function registerLibrary(address) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
relayerFeeConfig
function relayerFeeConfig() external view returns (uint128 dstPriceRatio, uint128 dstGasPriceInWei, uint128 dstNativeAmtCap, uint64 baseGas, uint64 gasPerByte)
Returns
| Name | Type | Description |
|---|---|---|
| dstPriceRatio | uint128 | undefined |
| dstGasPriceInWei | uint128 | undefined |
| dstNativeAmtCap | uint128 | undefined |
| baseGas | uint64 | undefined |
| gasPerByte | uint64 | undefined |
send
function send(MessagingParams _params, address _refundAddress) external payable returns (struct MessagingReceipt receipt)
Parameters
| Name | Type | Description |
|---|---|---|
| _params | MessagingParams | undefined |
| _refundAddress | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| receipt | MessagingReceipt | undefined |
sendCompose
function sendCompose(address, bytes32, uint16, bytes) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | bytes32 | undefined |
| _2 | uint16 | undefined |
| _3 | bytes | undefined |
setConfig
function setConfig(address, address, SetConfigParam[]) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | address | undefined |
| _2 | SetConfigParam[] | undefined |
setDefaultReceiveLibrary
function setDefaultReceiveLibrary(uint32, address, uint256) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
| _1 | address | undefined |
| _2 | uint256 | undefined |
setDefaultReceiveLibraryTimeout
function setDefaultReceiveLibraryTimeout(uint32, address, uint256) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
| _1 | address | undefined |
| _2 | uint256 | undefined |
setDefaultSendLibrary
function setDefaultSendLibrary(uint32, address) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | uint32 | undefined |
| _1 | address | undefined |
setDelegate
function setDelegate(address) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
setDestLzEndpoint
function setDestLzEndpoint(address destAddr, address lzEndpointAddr) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| destAddr | address | undefined |
| lzEndpointAddr | address | undefined |
setLzToken
function setLzToken(address) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
setReceiveLibrary
function setReceiveLibrary(address, uint32, address, uint256) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | address | undefined |
| _3 | uint256 | undefined |
setReceiveLibraryTimeout
function setReceiveLibraryTimeout(address, uint32, address, uint256) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | address | undefined |
| _3 | uint256 | undefined |
setSendLibrary
function setSendLibrary(address, uint32, address) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | address | undefined |
skip
function skip(address, uint32, bytes32, uint64) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | address | undefined |
| _1 | uint32 | undefined |
| _2 | bytes32 | undefined |
| _3 | uint64 | undefined |
verifiable
function verifiable(Origin _origin, address _receiver) external view returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _origin | Origin | undefined |
| _receiver | address | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
verifiable
function verifiable(Origin, address, address, bytes32) external pure returns (bool)
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | Origin | undefined |
| _1 | address | undefined |
| _2 | address | undefined |
| _3 | bytes32 | undefined |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | bool | undefined |
verifierFee
function verifierFee() external view returns (uint256)
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | undefined |
verify
function verify(Origin, address, bytes32) external nonpayable
Parameters
| Name | Type | Description |
|---|---|---|
| _0 | Origin | undefined |
| _1 | address | undefined |
| _2 | bytes32 | undefined |
Events
ComposeDelivered
event ComposeDelivered(address from, address to, bytes32 guid, uint16 index)
Parameters
| Name | Type | Description |
|---|---|---|
| from | address | undefined |
| to | address | undefined |
| guid | bytes32 | undefined |
| index | uint16 | undefined |
ComposeSent
event ComposeSent(address from, address to, bytes32 guid, uint16 index, bytes message)
Parameters
| Name | Type | Description |
|---|---|---|
| from | address | undefined |
| to | address | undefined |
| guid | bytes32 | undefined |
| index | uint16 | undefined |
| message | bytes | undefined |
DefaultReceiveLibrarySet
event DefaultReceiveLibrarySet(uint32 eid, address newLib)
Parameters
| Name | Type | Description |
|---|---|---|
| eid | uint32 | undefined |
| newLib | address | undefined |
DefaultReceiveLibraryTimeoutSet
event DefaultReceiveLibraryTimeoutSet(uint32 eid, address oldLib, uint256 expiry)
Parameters
| Name | Type | Description |
|---|---|---|
| eid | uint32 | undefined |
| oldLib | address | undefined |
| expiry | uint256 | undefined |
DefaultSendLibrarySet
event DefaultSendLibrarySet(uint32 eid, address newLib)
Parameters
| Name | Type | Description |
|---|---|---|
| eid | uint32 | undefined |
| newLib | address | undefined |
DelegateSet
event DelegateSet(address sender, address delegate)
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined |
| delegate | address | undefined |
InboundNonceSkipped
event InboundNonceSkipped(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce)
Parameters
| Name | Type | Description |
|---|---|---|
| srcEid | uint32 | undefined |
| sender | bytes32 | undefined |
| receiver | address | undefined |
| nonce | uint64 | undefined |
LibraryRegistered
event LibraryRegistered(address newLib)
Parameters
| Name | Type | Description |
|---|---|---|
| newLib | address | undefined |
LzComposeAlert
event LzComposeAlert(address indexed from, address indexed to, address indexed executor, bytes32 guid, uint16 index, uint256 gas, uint256 value, bytes message, bytes extraData, bytes reason)
Parameters
| Name | Type | Description |
|---|---|---|
from indexed | address | undefined |
to indexed | address | undefined |
executor indexed | address | undefined |
| guid | bytes32 | undefined |
| index | uint16 | undefined |
| gas | uint256 | undefined |
| value | uint256 | undefined |
| message | bytes | undefined |
| extraData | bytes | undefined |
| reason | bytes | undefined |
LzReceiveAlert
event LzReceiveAlert(address indexed receiver, address indexed executor, Origin origin, bytes32 guid, uint256 gas, uint256 value, bytes message, bytes extraData, bytes reason)
Parameters
| Name | Type | Description |
|---|---|---|
receiver indexed | address | undefined |
executor indexed | address | undefined |
| origin | Origin | undefined |
| guid | bytes32 | undefined |
| gas | uint256 | undefined |
| value | uint256 | undefined |
| message | bytes | undefined |
| extraData | bytes | undefined |
| reason | bytes | undefined |
LzTokenSet
event LzTokenSet(address token)
Parameters
| Name | Type | Description |
|---|---|---|
| token | address | undefined |
PacketBurnt
event PacketBurnt(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce, bytes32 payloadHash)
Parameters
| Name | Type | Description |
|---|---|---|
| srcEid | uint32 | undefined |
| sender | bytes32 | undefined |
| receiver | address | undefined |
| nonce | uint64 | undefined |
| payloadHash | bytes32 | undefined |
PacketDelivered
event PacketDelivered(Origin origin, address receiver)
Parameters
| Name | Type | Description |
|---|---|---|
| origin | Origin | undefined |
| receiver | address | undefined |
PacketNilified
event PacketNilified(uint32 srcEid, bytes32 sender, address receiver, uint64 nonce, bytes32 payloadHash)
Parameters
| Name | Type | Description |
|---|---|---|
| srcEid | uint32 | undefined |
| sender | bytes32 | undefined |
| receiver | address | undefined |
| nonce | uint64 | undefined |
| payloadHash | bytes32 | undefined |
PacketSent
event PacketSent(bytes encodedPayload, bytes options, address sendLibrary)
Parameters
| Name | Type | Description |
|---|---|---|
| encodedPayload | bytes | undefined |
| options | bytes | undefined |
| sendLibrary | address | undefined |
PacketVerified
event PacketVerified(Origin origin, address receiver, bytes32 payloadHash)
Parameters
| Name | Type | Description |
|---|---|---|
| origin | Origin | undefined |
| receiver | address | undefined |
| payloadHash | bytes32 | undefined |
ReceiveLibrarySet
event ReceiveLibrarySet(address receiver, uint32 eid, address newLib)
Parameters
| Name | Type | Description |
|---|---|---|
| receiver | address | undefined |
| eid | uint32 | undefined |
| newLib | address | undefined |
ReceiveLibraryTimeoutSet
event ReceiveLibraryTimeoutSet(address receiver, uint32 eid, address oldLib, uint256 timeout)
Parameters
| Name | Type | Description |
|---|---|---|
| receiver | address | undefined |
| eid | uint32 | undefined |
| oldLib | address | undefined |
| timeout | uint256 | undefined |
SendLibrarySet
event SendLibrarySet(address sender, uint32 eid, address newLib)
Parameters
| Name | Type | Description |
|---|---|---|
| sender | address | undefined |
| eid | uint32 | undefined |
| newLib | address | undefined |
ValueTransferFailed
event ValueTransferFailed(address indexed to, uint256 indexed quantity)
Parameters
| Name | Type | Description |
|---|---|---|
to indexed | address | undefined |
quantity indexed | uint256 | undefined |
Errors
Executor_InvalidExecutorOptions
error Executor_InvalidExecutorOptions(uint256 cursor)
Parameters
| Name | Type | Description |
|---|---|---|
| cursor | uint256 | undefined |
Executor_InvalidLzComposeOption
error Executor_InvalidLzComposeOption()
Executor_InvalidLzReceiveOption
error Executor_InvalidLzReceiveOption()
Executor_InvalidNativeDropOption
error Executor_InvalidNativeDropOption()
Executor_NativeAmountExceedsCap
error Executor_NativeAmountExceedsCap(uint256 amount, uint256 cap)
Parameters
| Name | Type | Description |
|---|---|---|
| amount | uint256 | undefined |
| cap | uint256 | undefined |
Executor_NoOptions
error Executor_NoOptions()
Executor_UnsupportedOptionType
error Executor_UnsupportedOptionType(uint8 optionType)
Parameters
| Name | Type | Description |
|---|---|---|
| optionType | uint8 | undefined |
LZ_LzTokenUnavailable
error LZ_LzTokenUnavailable()
LZ_SendReentrancy
error LZ_SendReentrancy()
LZ_ULN_InvalidLegacyType1Option
error LZ_ULN_InvalidLegacyType1Option()
LZ_ULN_InvalidLegacyType2Option
error LZ_ULN_InvalidLegacyType2Option()
LZ_ULN_InvalidWorkerId
error LZ_ULN_InvalidWorkerId(uint8 workerId)
Parameters
| Name | Type | Description |
|---|---|---|
| workerId | uint8 | undefined |
LZ_ULN_InvalidWorkerOptions
error LZ_ULN_InvalidWorkerOptions(uint256 cursor)
Parameters
| Name | Type | Description |
|---|---|---|
| cursor | uint256 | undefined |
LZ_ULN_UnsupportedOptionType
error LZ_ULN_UnsupportedOptionType(uint16 optionType)
Parameters
| Name | Type | Description |
|---|---|---|
| optionType | uint16 | undefined |