Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +Inherits: +Verifier
+address public immutable ENDPOINT;
+address public owner;
+mapping(uint256 => uint256) public feeOf;
+mapping(uint256 => address) public dapiOf;
+mapping(address => bool) public approvedOf;
+modifier onlyOwner();
+modifier onlyApproved();
+constructor(address endpoint);
+receive() external payable;
+function changeOwner(address owner_) external onlyOwner;
+function isApproved(address operator) public view returns (bool);
+function setApproved(address operator, bool approve) public onlyOwner;
+function withdraw(address to, uint256 amount) external onlyApproved;
+function setFee(uint256 chainId, uint256 fee_) external onlyApproved;
+function setDapi(uint256 chainId, address dapi) external onlyOwner;
+function fee(uint256 toChainId, address) public view returns (uint256);
+function assign(bytes32 msgHash) external payable;
+function merkleRoot(uint256 chainId, uint256) public view override returns (bytes32);
+event Assigned(bytes32 indexed msgHash, uint256 fee);
+event SetFee(uint256 indexed chainId, uint256 fee);
+event SetDapi(uint256 indexed chainId, address dapi);
+event SetApproved(address operator, bool approve);
+address public immutable ENDPOINT;
+address public immutable CHANNEL;
+address public owner;
+mapping(uint256 => DstPrice) public priceOf;
+mapping(uint256 => DstConfig) public configOf;
+mapping(address => bool) public approvedOf;
+modifier onlyOwner();
+modifier onlyApproved();
+constructor(address endpoint, address channel);
+receive() external payable;
+function changeOwner(address owner_) external onlyOwner;
+function isApproved(address operator) public view returns (bool);
+function setApproved(address operator, bool approve) public onlyOwner;
+function setDstPrice(uint256 chainId, uint128 dstPriceRatio, uint128 dstGasPriceInWei) external onlyApproved;
+function setDstConfig(uint256 chainId, uint64 baseGas, uint64 gasPerByte) external onlyApproved;
+function withdraw(address to, uint256 amount) external onlyApproved;
+function fee(uint256 toChainId, address, uint256 size, bytes calldata params) public view returns (uint256);
+function assign(bytes32 msgHash, bytes calldata params) external payable;
+function relay(Message calldata message, bytes calldata proof, uint256 gasLimit) external onlyApproved;
+event Assigned(bytes32 indexed msgHash, uint256 fee, bytes parmas);
+event SetDstPrice(uint256 indexed chainId, uint128 dstPriceRatio, uint128 dstGasPriceInWei);
+event SetDstConfig(uint256 indexed chainId, uint64 baseGas, uint64 gasPerByte);
+event SetApproved(address operator, bool approve);
+struct DstPrice {
+ uint128 dstPriceRatio;
+ uint128 dstGasPriceInWei;
+}
+struct DstConfig {
+ uint64 baseGas;
+ uint64 gasPerByte;
+}
+Author: +Illusory Systems Inc.
+An incremental merkle tree modeled on the eth2 deposit contract.
+uint256 internal constant TREE_DEPTH = 32;
+uint256 internal constant MAX_LEAVES = 2 ** TREE_DEPTH - 1;
+bytes32 internal constant Z_0 = hex"0000000000000000000000000000000000000000000000000000000000000000";
+bytes32 internal constant Z_1 = hex"ad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5";
+bytes32 internal constant Z_2 = hex"b4c11951957c6f8f642c4af61cd6b24640fec6dc7fc607ee8206a99e92410d30";
+bytes32 internal constant Z_3 = hex"21ddb9a356815c3fac1026b6dec5df3124afbadb485c9ba5a3e3398a04b7ba85";
+bytes32 internal constant Z_4 = hex"e58769b32a1beaf1ea27375a44095a0d1fb664ce2dd358e7fcbfb78c26a19344";
+bytes32 internal constant Z_5 = hex"0eb01ebfc9ed27500cd4dfc979272d1f0913cc9f66540d7e8005811109e1cf2d";
+bytes32 internal constant Z_6 = hex"887c22bd8750d34016ac3c66b5ff102dacdd73f6b014e710b51e8022af9a1968";
+bytes32 internal constant Z_7 = hex"ffd70157e48063fc33c97a050f7f640233bf646cc98d9524c6b92bcf3ab56f83";
+bytes32 internal constant Z_8 = hex"9867cc5f7f196b93bae1e27e6320742445d290f2263827498b54fec539f756af";
+bytes32 internal constant Z_9 = hex"cefad4e508c098b9a7e1d8feb19955fb02ba9675585078710969d3440f5054e0";
+bytes32 internal constant Z_10 = hex"f9dc3e7fe016e050eff260334f18a5d4fe391d82092319f5964f2e2eb7c1c3a5";
+bytes32 internal constant Z_11 = hex"f8b13a49e282f609c317a833fb8d976d11517c571d1221a265d25af778ecf892";
+bytes32 internal constant Z_12 = hex"3490c6ceeb450aecdc82e28293031d10c7d73bf85e57bf041a97360aa2c5d99c";
+bytes32 internal constant Z_13 = hex"c1df82d9c4b87413eae2ef048f94b4d3554cea73d92b0f7af96e0271c691e2bb";
+bytes32 internal constant Z_14 = hex"5c67add7c6caf302256adedf7ab114da0acfe870d449a3a489f781d659e8becc";
+bytes32 internal constant Z_15 = hex"da7bce9f4e8618b6bd2f4132ce798cdc7a60e7e1460a7299e3c6342a579626d2";
+bytes32 internal constant Z_16 = hex"2733e50f526ec2fa19a22b31e8ed50f23cd1fdf94c9154ed3a7609a2f1ff981f";
+bytes32 internal constant Z_17 = hex"e1d3b5c807b281e4683cc6d6315cf95b9ade8641defcb32372f1c126e398ef7a";
+bytes32 internal constant Z_18 = hex"5a2dce0a8a7f68bb74560f8f71837c2c2ebbcbf7fffb42ae1896f13f7c7479a0";
+bytes32 internal constant Z_19 = hex"b46a28b6f55540f89444f63de0378e3d121be09e06cc9ded1c20e65876d36aa0";
+bytes32 internal constant Z_20 = hex"c65e9645644786b620e2dd2ad648ddfcbf4a7e5b1a3a4ecfe7f64667a3f0b7e2";
+bytes32 internal constant Z_21 = hex"f4418588ed35a2458cffeb39b93d26f18d2ab13bdce6aee58e7b99359ec2dfd9";
+bytes32 internal constant Z_22 = hex"5a9c16dc00d6ef18b7933a6f8dc65ccb55667138776f7dea101070dc8796e377";
+bytes32 internal constant Z_23 = hex"4df84f40ae0c8229d0d6069e5c8f39a7c299677a09d367fc7b05e3bc380ee652";
+bytes32 internal constant Z_24 = hex"cdc72595f74c7b1043d0e1ffbab734648c838dfb0527d971b602bc216c9619ef";
+bytes32 internal constant Z_25 = hex"0abf5ac974a1ed57f4050aa510dd9c74f508277b39d7973bb2dfccc5eeb0618d";
+bytes32 internal constant Z_26 = hex"b8cd74046ff337f0a7bf2c8e03e10f642c1886798d71806ab1e888d9e5ee87d0";
+bytes32 internal constant Z_27 = hex"838c5655cb21c6cb83313b5a631175dff4963772cce9108188b34ac87c81c41e";
+bytes32 internal constant Z_28 = hex"662ee4dd2dd7b2bc707961b1e646c4047669dcb6584f0d8d770daf5d7e7deb2e";
+bytes32 internal constant Z_29 = hex"388ab20e2573d171a88108e79d820e98f26c0b84aa8b2f4aa4968dbb818ea322";
+bytes32 internal constant Z_30 = hex"93237c50ba75ee485f4c22adf2f741400bdf8d6a9cc7df7ecae576221665d735";
+bytes32 internal constant Z_31 = hex"8448818bb4ae4562849e949e17ac16e0be16688e156b5cf15e098c627c0056a9";
+Inserts _node into merkle tree
Reverts if tree is full
+function insert(Tree storage _tree, bytes32 _node) internal;
+Parameters
+| Name | Type | Description |
|---|---|---|
_tree | Tree | |
_node | bytes32 | Element to insert into tree |
Calculates and returns_tree's current root given array of zero
+hashes
function rootWithCtx(Tree storage _tree, bytes32[TREE_DEPTH] memory _zeroes) internal view returns (bytes32 _current);
+Parameters
+| Name | Type | Description |
|---|---|---|
_tree | Tree | |
_zeroes | bytes32[TREE_DEPTH] | Array of zero hashes |
Returns
+| Name | Type | Description |
|---|---|---|
_current | bytes32 | Calculated root of _tree |
Calculates and returns_tree's current root
function root(Tree storage _tree) internal view returns (bytes32);
+Returns array of TREE_DEPTH zero hashes
+function zeroHashes() internal pure returns (bytes32[TREE_DEPTH] memory _zeroes);
+Returns
+| Name | Type | Description |
|---|---|---|
_zeroes | bytes32[TREE_DEPTH] | Array of TREE_DEPTH zero hashes |
Calculates and returns the merkle root for the given leaf
+_item, a merkle branch, and the index of _item in the tree.
function branchRoot(bytes32 _item, bytes32[TREE_DEPTH] memory _branch, uint256 _index)
+ internal
+ pure
+ returns (bytes32 _current);
+Parameters
+| Name | Type | Description |
|---|---|---|
_item | bytes32 | Merkle leaf |
_branch | bytes32[TREE_DEPTH] | Merkle proof |
_index | uint256 | Index of _item in tree |
Returns
+| Name | Type | Description |
|---|---|---|
_current | bytes32 | Calculated merkle root |
Struct representing incremental merkle tree. Contains current +branch and the number of inserted leaves in the tree.
+struct Tree {
+ bytes32[TREE_DEPTH] branch;
+ uint256 count;
+}
+function sendMessage(address from, uint256 toChainId, address to, bytes calldata encoded) external returns (bytes32);
+function recvMessage(Message calldata message, bytes calldata proof, uint256 gasLimit) external;
+follow https://eips.ethereum.org/EIPS/eip-5750
+Send a cross-chain message over the endpoint.
+function send(uint256 toChainId, address to, bytes calldata encoded, bytes calldata params)
+ external
+ payable
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Return the hash of the message as message id. |
Get a quote in source native gas, for the amount that send() requires to pay for message delivery.
+function fee(uint256 toChainId, address, bytes calldata encoded, bytes calldata params) external view;
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
<none> | address | |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Only message.to could clear this message.
+Retry failed message.
+function clearFailedMessage(Message calldata message) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Retry failed message.
+function retryFailedMessage(Message calldata message) external returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
function recv(Message calldata message, uint256 gasLimit) external returns (bool dispatchResult);
+function messageRoot() external view returns (bytes32);
+Fetch oracle price to relay message root to the destination chain.
+function fee(uint256 toChainId, address ua) external view returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The destination chain id. |
ua | address | The user application which send the message. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | uint256 | Oracle price in source native gas. |
Assign the relay message root task to oracle maintainer.
+function assign(bytes32 msgHash) external payable;
+Parameters
+| Name | Type | Description |
|---|---|---|
msgHash | bytes32 | Hash of the message. |
Fetch message root oracle.
+function merkleRoot(uint256 chainId) external view returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | The destination chain id. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Message root in destination chain. |
Fetch relayer price to relay message to the destination chain.
+function fee(uint256 toChainId, address ua, uint256 size, bytes calldata params) external view returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The destination chain id. |
ua | address | The user application which send the message. |
size | uint256 | The size of message encoded payload. |
params | bytes | General extensibility for relayer to custom functionality. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | uint256 | Relayer price in source native gas. |
Assign the relay message task to relayer maintainer.
+function assign(bytes32 msgHash, bytes calldata params) external payable;
+Parameters
+| Name | Type | Description |
|---|---|---|
msgHash | bytes32 | Hash of the message. |
params | bytes | General extensibility for relayer to custom functionality. |
User application custom configuration.
+struct Config {
+ address oracle;
+ address relayer;
+}
+If user application has not configured, then the default config is used.
+Fetch user application config.
+function getAppConfig(address ua) external view returns (Config memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
ua | address | User application contract address. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | Config | user application config. |
Set user application config.
+function setAppConfig(address oracle, address relayer) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Oracle which user application choose. |
relayer | address | Relayer which user application choose. |
function setDefaultConfig(address oracle, address relayer) external;
+function defaultConfig() external view returns (Config memory);
+Verify message proof
+Message proof provided by relayer. Oracle should provide message root of +source chain, and verify the merkle proof of the message hash.
+function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof) external view returns (bool);
+Parameters
+| Name | Type | Description |
|---|---|---|
fromChainId | uint256 | Source chain id. |
msgHash | bytes32 | Hash of the message. |
proof | bytes | Merkle proof of the message |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | Result of the message verify. |
uint256 internal constant LOW_28_MASK = 0x00000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff;
+Use when you really really really don't trust the called +contract. This prevents the called contract from causing reversion of +the caller in as many ways as we can.
+The main difference between this and a solidity low-level call is +that we limit the number of bytes that the callee can cause to be +copied to caller memory. This prevents stupid things like malicious +contracts returning 10,000,000 bytes causing a local OOG when copying +to memory.
+function excessivelySafeCall(address _target, uint256 _gas, uint16 _maxCopy, bytes memory _calldata)
+ internal
+ returns (bool, bytes memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
_target | address | The address to call |
_gas | uint256 | The amount of gas to forward to the remote contract |
_maxCopy | uint16 | The maximum number of bytes of returndata to copy to memory. |
_calldata | bytes | The data to send to the remote contract |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | success and returndata, as .call(). Returndata is capped to _maxCopy bytes. |
<none> | bytes |
Use when you really really really don't trust the called +contract. This prevents the called contract from causing reversion of +the caller in as many ways as we can.
+The main difference between this and a solidity low-level call is +that we limit the number of bytes that the callee can cause to be +copied to caller memory. This prevents stupid things like malicious +contracts returning 10,000,000 bytes causing a local OOG when copying +to memory.
+function excessivelySafeStaticCall(address _target, uint256 _gas, uint16 _maxCopy, bytes memory _calldata)
+ internal
+ view
+ returns (bool, bytes memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
_target | address | The address to call |
_gas | uint256 | The amount of gas to forward to the remote contract |
_maxCopy | uint16 | The maximum number of bytes of returndata to copy to memory. |
_calldata | bytes | The data to send to the remote contract |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | success and returndata, as .call(). Returndata is capped to _maxCopy bytes. |
<none> | bytes |
Swaps function selectors in encoded contract calls
+Allows reuse of encoded calldata for functions with identical +argument types but different names. It simply swaps out the first 4 bytes +for the new selector. This function modifies memory in place, and should +only be used with caution.
+function swapSelector(bytes4 _newSelector, bytes memory _buf) internal pure;
+Parameters
+| Name | Type | Description |
|---|---|---|
_newSelector | bytes4 | The new 4-byte selector |
_buf | bytes | The encoded contract args |
uint8 internal constant _NOT_ENTERED = 1;
+uint8 internal constant _ENTERED = 2;
+uint8 internal _send_state = 1;
+uint8 internal _receive_state = 1;
+modifier sendNonReentrant();
+modifier recvNonReentrant();
+address public immutable USER_CONFIG;
+address public immutable TRUSTED_ENDPOINT;
+constructor(address config, address endpoint);
+function clearFailedMessage(Message calldata message) external virtual;
+function retryFailedMessage(Message calldata message) external virtual returns (bool dispatchResult);
+function setAppConfig(address relayer, address oracle) external virtual;
+function isTrustedEndpoint(address endpoint) public view returns (bool);
+function _messageId() internal pure returns (bytes32 _msgDataMessageId);
+function _fromChainId() internal pure returns (uint256 _msgDataFromChainId);
+function _xmsgSender() internal view returns (address payable _from);
+A channel is a logical connection over cross-chain network. +It used for cross-chain message transfer.
+*Messages live in an incremental merkle tree (imt)
+++A Merkle tree is a binary and complete tree decorated with +the Merkle (hash) attribute.*
+
Incremental merkle tree root which all message hashes live in leafs.
+bytes32 public root;
+Incremental merkle tree.
+IncrementalMerkleTree.Tree private imt;
+msgHash => isDispathed.
+mapping(bytes32 => bool) public dones;
+Endpoint immutable address.
+address public immutable ENDPOINT;
+User config immutable address.
+address public immutable CONFIG;
+address private immutable _self = address(this);
+modifier onlyEndpoint();
+Init code.
+constructor(address config, address endpoint);
+Parameters
+| Name | Type | Description |
|---|---|---|
config | address | User config immutable address. |
endpoint | address | Endpoint immutable address. |
Fetch local chain id.
+function LOCAL_CHAINID() public view returns (uint256 chainId);
+Returns
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | Local chain id. |
Only endpoint could call this function.
+Send message.
+function sendMessage(address from, uint256 toChainId, address to, bytes calldata encoded)
+ external
+ onlyEndpoint
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
from | address | User application contract address which send the message. |
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
Only message.to's config relayer could relayer this message.
+Receive messages.
+function recvMessage(Message calldata message, bytes calldata proof, uint256 gasLimit) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Received message info. |
proof | bytes | Message proof of this message. |
gasLimit | uint256 | The gas limit of message execute. |
Fetch the messages count of incremental merkle tree.
+function messageCount() public view returns (uint256);
+Fetch the branch of incremental merkle tree.
+function imtBranch() public view returns (bytes32[32] memory);
+Notifies an observer that the message has been accepted.
+event MessageAccepted(bytes32 indexed msgHash, bytes32 root, Message message);
+Notifies an observer that the message has been dispatched.
+event MessageDispatched(bytes32 indexed msgHash, bool dispatchResult);
+The block of control information and data for comminicate +between user applications. Messages are the exchange medium +used by channels to send and receive data through cross-chain networks. +A message is sent from a source chain to a destination chain.
+struct Message {
+ address channel;
+ uint256 index;
+ uint256 fromChainId;
+ address from;
+ uint256 toChainId;
+ address to;
+ bytes encoded;
+}
+Hash of the message.
+function hash(Message memory message) pure returns (bytes32);
+Inherits: +ReentrancyGuard
+An endpoint is a type of network node for cross-chain communication. +It is an interface exposed by a communication channel.
+An endpoint is associated with an immutable channel and user configuration.
+msgHash => isFailed
+mapping(bytes32 => bool) public fails;
+User config immutable address.
+address public immutable CONFIG;
+Channel immutable address.
+address public immutable CHANNEL;
+Init code.
+constructor(address config, address channel);
+Parameters
+| Name | Type | Description |
|---|---|---|
config | address | User config immutable address. |
channel | address | Channel immutable address. |
follow https://eips.ethereum.org/EIPS/eip-5750
+Send a cross-chain message over the endpoint.
+function send(uint256 toChainId, address to, bytes calldata encoded, bytes calldata params)
+ external
+ payable
+ sendNonReentrant
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Get a quote in source native gas, for the amount that send() requires to pay for message delivery.
+function fee(uint256 toChainId, address, bytes calldata encoded, bytes calldata params)
+ external
+ view
+ returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
<none> | address | |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
function _handleRelayer(
+ address relayer,
+ bytes32 msgHash,
+ uint256 toChainId,
+ address ua,
+ uint256 size,
+ bytes calldata params
+) internal returns (uint256);
+function _handleOracle(address oracle, bytes32 msgHash, uint256 toChainId, address ua) internal returns (uint256);
+Only channel could call this function.
+Recv verified message from Channel and dispatch to destination user application address.
+function recv(Message calldata message, uint256 gasLimit) external recvNonReentrant returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Verified receive message info. |
gasLimit | uint256 | The gas limit of message execute. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
Retry failed message.
+function retryFailedMessage(Message calldata message) external recvNonReentrant returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
Only message.to could clear this message.
+Retry failed message.
+function clearFailedMessage(Message calldata message) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Dispatch the cross chain message.
+function _dispatch(Message memory message, bytes32 msgHash, uint256 gasLimit) private returns (bool dispatchResult);
+Notifies an observer that the failed message has been cleared.
+event ClearFailedMessage(bytes32 indexed msgHash);
+Notifies an observer that the failed message has been retried.
+event RetryFailedMessage(bytes32 indexed msgHash, bool dispatchResult);
+User config could select their own relayer and oracle. +The default configuration is used by default.
+Only setter could set default config.
+Setter address.
+address public setter;
+ua => config.
+mapping(address => Config) public appConfig;
+Default config.
+Config public defaultConfig;
+modifier onlySetter();
+constructor();
+Only current setter could call.
+Change setter.
+function changeSetter(address setter_) external onlySetter;
+Parameters
+| Name | Type | Description |
|---|---|---|
setter_ | address | New setter. |
Only setter could call.
+Set default config for all application.
+function setDefaultConfig(address oracle, address relayer) external onlySetter;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Default oracle. |
relayer | address | Default relayer. |
If user application has not configured, then the default config is used.
+Fetch user application config.
+function getAppConfig(address ua) external view returns (Config memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
ua | address | User application contract address. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | Config | user application config. |
Set user application config.
+function setAppConfig(address oracle, address relayer) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Oracle which user application. |
relayer | address | Relayer which user application choose. |
Notifies an observer that the default config has set.
+event SetDefaultConfig(address oracle, address relayer);
+Notifies an observer that the user application config has updated.
+event AppConfigUpdated(address indexed ua, address oracle, address relayer);
+Inherits: +IVerifier
+Fetch message root oracle.
+function merkleRoot(uint256 chainId, uint256 blockNumber) public view virtual returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | The destination chain id. |
blockNumber | uint256 | The block number where the message root is located. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Message root in destination chain. |
Verify message proof
+Message proof provided by relayer. Oracle should provide message root of +source chain, and verify the merkle proof of the message hash.
+function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof) external view returns (bool);
+Parameters
+| Name | Type | Description |
|---|---|---|
fromChainId | uint256 | Source chain id. |
msgHash | bytes32 | Hash of the message. |
proof | bytes | Merkle proof of the message |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | Result of the message verify. |
Message proof.
+struct Proof {
+ uint256 blockNumber;
+ uint256 messageIndex;
+ bytes32[32] messageProof;
+}
+A channel is a logical connection over cross-chain network. +It used for cross-chain message transfer.
+*Messages live in an incremental merkle tree (imt)
+++A Merkle tree is a binary and complete tree decorated with +the Merkle (hash) attribute.*
+
Incremental merkle tree root which all message hashes live in leafs.
+bytes32 public root;
+Incremental merkle tree.
+IncrementalMerkleTree.Tree private imt;
+msgHash => isDispathed.
+mapping(bytes32 => bool) public dones;
+Endpoint immutable address.
+address public immutable ENDPOINT;
+User config immutable address.
+address public immutable CONFIG;
+address private immutable _self = address(this);
+modifier onlyEndpoint();
+Init code.
+constructor(address config, address endpoint);
+Parameters
+| Name | Type | Description |
|---|---|---|
config | address | User config immutable address. |
endpoint | address | Endpoint immutable address. |
Fetch local chain id.
+function LOCAL_CHAINID() public view returns (uint256 chainId);
+Returns
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | Local chain id. |
Only endpoint could call this function.
+Send message.
+function sendMessage(address from, uint256 toChainId, address to, bytes calldata encoded)
+ external
+ onlyEndpoint
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
from | address | User application contract address which send the message. |
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
Only message.to's config relayer could relayer this message.
+Receive messages.
+function recvMessage(Message calldata message, bytes calldata proof, uint256 gasLimit) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Received message info. |
proof | bytes | Message proof of this message. |
gasLimit | uint256 | The gas limit of message execute. |
Fetch the messages count of incremental merkle tree.
+function messageCount() public view returns (uint256);
+Fetch the branch of incremental merkle tree.
+function imtBranch() public view returns (bytes32[32] memory);
+Notifies an observer that the message has been accepted.
+event MessageAccepted(bytes32 indexed msgHash, bytes32 root, Message message);
+Notifies an observer that the message has been dispatched.
+event MessageDispatched(bytes32 indexed msgHash, bool dispatchResult);
+Hash of the message.
+function hash(Message memory message) pure returns (bytes32);
+The block of control information and data for comminicate +between user applications. Messages are the exchange medium +used by channels to send and receive data through cross-chain networks. +A message is sent from a source chain to a destination chain.
+struct Message {
+ address channel;
+ uint256 index;
+ uint256 fromChainId;
+ address from;
+ uint256 toChainId;
+ address to;
+ bytes encoded;
+}
+Inherits: +ReentrancyGuard
+An endpoint is a type of network node for cross-chain communication. +It is an interface exposed by a communication channel.
+An endpoint is associated with an immutable channel and user configuration.
+msgHash => isFailed
+mapping(bytes32 => bool) public fails;
+User config immutable address.
+address public immutable CONFIG;
+Channel immutable address.
+address public immutable CHANNEL;
+Init code.
+constructor(address config, address channel);
+Parameters
+| Name | Type | Description |
|---|---|---|
config | address | User config immutable address. |
channel | address | Channel immutable address. |
follow https://eips.ethereum.org/EIPS/eip-5750
+Send a cross-chain message over the endpoint.
+function send(uint256 toChainId, address to, bytes calldata encoded, bytes calldata params)
+ external
+ payable
+ sendNonReentrant
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Get a quote in source native gas, for the amount that send() requires to pay for message delivery.
+function fee(uint256 toChainId, address, bytes calldata encoded, bytes calldata params)
+ external
+ view
+ returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
<none> | address | |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
function _handleRelayer(
+ address relayer,
+ bytes32 msgHash,
+ uint256 toChainId,
+ address ua,
+ uint256 size,
+ bytes calldata params
+) internal returns (uint256);
+function _handleOracle(address oracle, bytes32 msgHash, uint256 toChainId, address ua) internal returns (uint256);
+Only channel could call this function.
+Recv verified message from Channel and dispatch to destination user application address.
+function recv(Message calldata message, uint256 gasLimit) external recvNonReentrant returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Verified receive message info. |
gasLimit | uint256 | The gas limit of message execute. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
Retry failed message.
+function retryFailedMessage(Message calldata message) external recvNonReentrant returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
Only message.to could clear this message.
+Retry failed message.
+function clearFailedMessage(Message calldata message) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Dispatch the cross chain message.
+function _dispatch(Message memory message, bytes32 msgHash, uint256 gasLimit) private returns (bool dispatchResult);
+Notifies an observer that the failed message has been cleared.
+event ClearFailedMessage(bytes32 indexed msgHash);
+Notifies an observer that the failed message has been retried.
+event RetryFailedMessage(bytes32 indexed msgHash, bool dispatchResult);
+User config could select their own relayer and oracle. +The default configuration is used by default.
+Only setter could set default config.
+Setter address.
+address public setter;
+ua => config.
+mapping(address => Config) public appConfig;
+Default config.
+Config public defaultConfig;
+modifier onlySetter();
+constructor();
+Only current setter could call.
+Change setter.
+function changeSetter(address setter_) external onlySetter;
+Parameters
+| Name | Type | Description |
|---|---|---|
setter_ | address | New setter. |
Only setter could call.
+Set default config for all application.
+function setDefaultConfig(address oracle, address relayer) external onlySetter;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Default oracle. |
relayer | address | Default relayer. |
If user application has not configured, then the default config is used.
+Fetch user application config.
+function getAppConfig(address ua) external view returns (Config memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
ua | address | User application contract address. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | Config | user application config. |
Set user application config.
+function setAppConfig(address oracle, address relayer) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Oracle which user application. |
relayer | address | Relayer which user application choose. |
Notifies an observer that the default config has set.
+event SetDefaultConfig(address oracle, address relayer);
+Notifies an observer that the user application config has updated.
+event AppConfigUpdated(address indexed ua, address oracle, address relayer);
+Inherits: +IVerifier
+Fetch message root oracle.
+function merkleRoot(uint256 chainId, uint256 blockNumber) public view virtual returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | The destination chain id. |
blockNumber | uint256 | The block number where the message root is located. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Message root in destination chain. |
Verify message proof
+Message proof provided by relayer. Oracle should provide message root of +source chain, and verify the merkle proof of the message hash.
+function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof) external view returns (bool);
+Parameters
+| Name | Type | Description |
|---|---|---|
fromChainId | uint256 | Source chain id. |
msgHash | bytes32 | Hash of the message. |
proof | bytes | Merkle proof of the message |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | Result of the message verify. |
Message proof.
+struct Proof {
+ uint256 blockNumber;
+ uint256 messageIndex;
+ bytes32[32] messageProof;
+}
+Inherits: +Verifier
+address public immutable ENDPOINT;
+address public owner;
+mapping(uint256 => uint256) public feeOf;
+mapping(uint256 => address) public dapiOf;
+mapping(address => bool) public approvedOf;
+modifier onlyOwner();
+modifier onlyApproved();
+constructor(address endpoint);
+receive() external payable;
+function changeOwner(address owner_) external onlyOwner;
+function isApproved(address operator) public view returns (bool);
+function setApproved(address operator, bool approve) public onlyOwner;
+function withdraw(address to, uint256 amount) external onlyApproved;
+function setFee(uint256 chainId, uint256 fee_) external onlyApproved;
+function setDapi(uint256 chainId, address dapi) external onlyOwner;
+function fee(uint256 toChainId, address) public view returns (uint256);
+function assign(bytes32 msgHash) external payable;
+function merkleRoot(uint256 chainId, uint256) public view override returns (bytes32);
+event Assigned(bytes32 indexed msgHash, uint256 fee);
+event SetFee(uint256 indexed chainId, uint256 fee);
+event SetDapi(uint256 indexed chainId, address dapi);
+event SetApproved(address operator, bool approve);
+address public immutable ENDPOINT;
+address public immutable CHANNEL;
+address public owner;
+mapping(uint256 => DstPrice) public priceOf;
+mapping(uint256 => DstConfig) public configOf;
+mapping(address => bool) public approvedOf;
+modifier onlyOwner();
+modifier onlyApproved();
+constructor(address endpoint, address channel);
+receive() external payable;
+function changeOwner(address owner_) external onlyOwner;
+function isApproved(address operator) public view returns (bool);
+function setApproved(address operator, bool approve) public onlyOwner;
+function setDstPrice(uint256 chainId, uint128 dstPriceRatio, uint128 dstGasPriceInWei) external onlyApproved;
+function setDstConfig(uint256 chainId, uint64 baseGas, uint64 gasPerByte) external onlyApproved;
+function withdraw(address to, uint256 amount) external onlyApproved;
+function fee(uint256 toChainId, address, uint256 size, bytes calldata params) public view returns (uint256);
+function assign(bytes32 msgHash, bytes calldata params) external payable;
+function relay(Message calldata message, bytes calldata proof, uint256 gasLimit) external onlyApproved;
+event Assigned(bytes32 indexed msgHash, uint256 fee, bytes parmas);
+event SetDstPrice(uint256 indexed chainId, uint128 dstPriceRatio, uint128 dstGasPriceInWei);
+event SetDstConfig(uint256 indexed chainId, uint64 baseGas, uint64 gasPerByte);
+event SetApproved(address operator, bool approve);
+struct DstPrice {
+ uint128 dstPriceRatio;
+ uint128 dstGasPriceInWei;
+}
+struct DstConfig {
+ uint64 baseGas;
+ uint64 gasPerByte;
+}
+Author: +Illusory Systems Inc.
+An incremental merkle tree modeled on the eth2 deposit contract.
+uint256 internal constant TREE_DEPTH = 32;
+uint256 internal constant MAX_LEAVES = 2 ** TREE_DEPTH - 1;
+bytes32 internal constant Z_0 = hex"0000000000000000000000000000000000000000000000000000000000000000";
+bytes32 internal constant Z_1 = hex"ad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5";
+bytes32 internal constant Z_2 = hex"b4c11951957c6f8f642c4af61cd6b24640fec6dc7fc607ee8206a99e92410d30";
+bytes32 internal constant Z_3 = hex"21ddb9a356815c3fac1026b6dec5df3124afbadb485c9ba5a3e3398a04b7ba85";
+bytes32 internal constant Z_4 = hex"e58769b32a1beaf1ea27375a44095a0d1fb664ce2dd358e7fcbfb78c26a19344";
+bytes32 internal constant Z_5 = hex"0eb01ebfc9ed27500cd4dfc979272d1f0913cc9f66540d7e8005811109e1cf2d";
+bytes32 internal constant Z_6 = hex"887c22bd8750d34016ac3c66b5ff102dacdd73f6b014e710b51e8022af9a1968";
+bytes32 internal constant Z_7 = hex"ffd70157e48063fc33c97a050f7f640233bf646cc98d9524c6b92bcf3ab56f83";
+bytes32 internal constant Z_8 = hex"9867cc5f7f196b93bae1e27e6320742445d290f2263827498b54fec539f756af";
+bytes32 internal constant Z_9 = hex"cefad4e508c098b9a7e1d8feb19955fb02ba9675585078710969d3440f5054e0";
+bytes32 internal constant Z_10 = hex"f9dc3e7fe016e050eff260334f18a5d4fe391d82092319f5964f2e2eb7c1c3a5";
+bytes32 internal constant Z_11 = hex"f8b13a49e282f609c317a833fb8d976d11517c571d1221a265d25af778ecf892";
+bytes32 internal constant Z_12 = hex"3490c6ceeb450aecdc82e28293031d10c7d73bf85e57bf041a97360aa2c5d99c";
+bytes32 internal constant Z_13 = hex"c1df82d9c4b87413eae2ef048f94b4d3554cea73d92b0f7af96e0271c691e2bb";
+bytes32 internal constant Z_14 = hex"5c67add7c6caf302256adedf7ab114da0acfe870d449a3a489f781d659e8becc";
+bytes32 internal constant Z_15 = hex"da7bce9f4e8618b6bd2f4132ce798cdc7a60e7e1460a7299e3c6342a579626d2";
+bytes32 internal constant Z_16 = hex"2733e50f526ec2fa19a22b31e8ed50f23cd1fdf94c9154ed3a7609a2f1ff981f";
+bytes32 internal constant Z_17 = hex"e1d3b5c807b281e4683cc6d6315cf95b9ade8641defcb32372f1c126e398ef7a";
+bytes32 internal constant Z_18 = hex"5a2dce0a8a7f68bb74560f8f71837c2c2ebbcbf7fffb42ae1896f13f7c7479a0";
+bytes32 internal constant Z_19 = hex"b46a28b6f55540f89444f63de0378e3d121be09e06cc9ded1c20e65876d36aa0";
+bytes32 internal constant Z_20 = hex"c65e9645644786b620e2dd2ad648ddfcbf4a7e5b1a3a4ecfe7f64667a3f0b7e2";
+bytes32 internal constant Z_21 = hex"f4418588ed35a2458cffeb39b93d26f18d2ab13bdce6aee58e7b99359ec2dfd9";
+bytes32 internal constant Z_22 = hex"5a9c16dc00d6ef18b7933a6f8dc65ccb55667138776f7dea101070dc8796e377";
+bytes32 internal constant Z_23 = hex"4df84f40ae0c8229d0d6069e5c8f39a7c299677a09d367fc7b05e3bc380ee652";
+bytes32 internal constant Z_24 = hex"cdc72595f74c7b1043d0e1ffbab734648c838dfb0527d971b602bc216c9619ef";
+bytes32 internal constant Z_25 = hex"0abf5ac974a1ed57f4050aa510dd9c74f508277b39d7973bb2dfccc5eeb0618d";
+bytes32 internal constant Z_26 = hex"b8cd74046ff337f0a7bf2c8e03e10f642c1886798d71806ab1e888d9e5ee87d0";
+bytes32 internal constant Z_27 = hex"838c5655cb21c6cb83313b5a631175dff4963772cce9108188b34ac87c81c41e";
+bytes32 internal constant Z_28 = hex"662ee4dd2dd7b2bc707961b1e646c4047669dcb6584f0d8d770daf5d7e7deb2e";
+bytes32 internal constant Z_29 = hex"388ab20e2573d171a88108e79d820e98f26c0b84aa8b2f4aa4968dbb818ea322";
+bytes32 internal constant Z_30 = hex"93237c50ba75ee485f4c22adf2f741400bdf8d6a9cc7df7ecae576221665d735";
+bytes32 internal constant Z_31 = hex"8448818bb4ae4562849e949e17ac16e0be16688e156b5cf15e098c627c0056a9";
+Inserts _node into merkle tree
Reverts if tree is full
+function insert(Tree storage _tree, bytes32 _node) internal;
+Parameters
+| Name | Type | Description |
|---|---|---|
_tree | Tree | |
_node | bytes32 | Element to insert into tree |
Calculates and returns_tree's current root given array of zero
+hashes
function rootWithCtx(Tree storage _tree, bytes32[TREE_DEPTH] memory _zeroes) internal view returns (bytes32 _current);
+Parameters
+| Name | Type | Description |
|---|---|---|
_tree | Tree | |
_zeroes | bytes32[TREE_DEPTH] | Array of zero hashes |
Returns
+| Name | Type | Description |
|---|---|---|
_current | bytes32 | Calculated root of _tree |
Calculates and returns_tree's current root
function root(Tree storage _tree) internal view returns (bytes32);
+Returns array of TREE_DEPTH zero hashes
+function zeroHashes() internal pure returns (bytes32[TREE_DEPTH] memory _zeroes);
+Returns
+| Name | Type | Description |
|---|---|---|
_zeroes | bytes32[TREE_DEPTH] | Array of TREE_DEPTH zero hashes |
Calculates and returns the merkle root for the given leaf
+_item, a merkle branch, and the index of _item in the tree.
function branchRoot(bytes32 _item, bytes32[TREE_DEPTH] memory _branch, uint256 _index)
+ internal
+ pure
+ returns (bytes32 _current);
+Parameters
+| Name | Type | Description |
|---|---|---|
_item | bytes32 | Merkle leaf |
_branch | bytes32[TREE_DEPTH] | Merkle proof |
_index | uint256 | Index of _item in tree |
Returns
+| Name | Type | Description |
|---|---|---|
_current | bytes32 | Calculated merkle root |
Struct representing incremental merkle tree. Contains current +branch and the number of inserted leaves in the tree.
+struct Tree {
+ bytes32[TREE_DEPTH] branch;
+ uint256 count;
+}
+function sendMessage(address from, uint256 toChainId, address to, bytes calldata encoded) external returns (bytes32);
+function recvMessage(Message calldata message, bytes calldata proof, uint256 gasLimit) external;
+follow https://eips.ethereum.org/EIPS/eip-5750
+Send a cross-chain message over the endpoint.
+function send(uint256 toChainId, address to, bytes calldata encoded, bytes calldata params)
+ external
+ payable
+ returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
to | address | User application contract address which receive the message. |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Return the hash of the message as message id. |
Get a quote in source native gas, for the amount that send() requires to pay for message delivery.
+function fee(uint256 toChainId, address, bytes calldata encoded, bytes calldata params) external view;
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The Message destination chain id. |
<none> | address | |
encoded | bytes | The calldata which encoded by ABI Encoding. |
params | bytes | General extensibility for relayer to custom functionality. |
Only message.to could clear this message.
+Retry failed message.
+function clearFailedMessage(Message calldata message) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Retry failed message.
+function retryFailedMessage(Message calldata message) external returns (bool dispatchResult);
+Parameters
+| Name | Type | Description |
|---|---|---|
message | Message | Failed message info. |
Returns
+| Name | Type | Description |
|---|---|---|
dispatchResult | bool | Result of the message dispatch. |
function recv(Message calldata message, uint256 gasLimit) external returns (bool dispatchResult);
+function messageRoot() external view returns (bytes32);
+Fetch oracle price to relay message root to the destination chain.
+function fee(uint256 toChainId, address ua) external view returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The destination chain id. |
ua | address | The user application which send the message. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | uint256 | Oracle price in source native gas. |
Assign the relay message root task to oracle maintainer.
+function assign(bytes32 msgHash) external payable;
+Parameters
+| Name | Type | Description |
|---|---|---|
msgHash | bytes32 | Hash of the message. |
Fetch message root oracle.
+function merkleRoot(uint256 chainId) external view returns (bytes32);
+Parameters
+| Name | Type | Description |
|---|---|---|
chainId | uint256 | The destination chain id. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bytes32 | Message root in destination chain. |
Fetch relayer price to relay message to the destination chain.
+function fee(uint256 toChainId, address ua, uint256 size, bytes calldata params) external view returns (uint256);
+Parameters
+| Name | Type | Description |
|---|---|---|
toChainId | uint256 | The destination chain id. |
ua | address | The user application which send the message. |
size | uint256 | The size of message encoded payload. |
params | bytes | General extensibility for relayer to custom functionality. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | uint256 | Relayer price in source native gas. |
Assign the relay message task to relayer maintainer.
+function assign(bytes32 msgHash, bytes calldata params) external payable;
+Parameters
+| Name | Type | Description |
|---|---|---|
msgHash | bytes32 | Hash of the message. |
params | bytes | General extensibility for relayer to custom functionality. |
If user application has not configured, then the default config is used.
+Fetch user application config.
+function getAppConfig(address ua) external view returns (Config memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
ua | address | User application contract address. |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | Config | user application config. |
Set user application config.
+function setAppConfig(address oracle, address relayer) external;
+Parameters
+| Name | Type | Description |
|---|---|---|
oracle | address | Oracle which user application choose. |
relayer | address | Relayer which user application choose. |
function setDefaultConfig(address oracle, address relayer) external;
+function defaultConfig() external view returns (Config memory);
+User application custom configuration.
+struct Config {
+ address oracle;
+ address relayer;
+}
+Verify message proof
+Message proof provided by relayer. Oracle should provide message root of +source chain, and verify the merkle proof of the message hash.
+function verifyMessageProof(uint256 fromChainId, bytes32 msgHash, bytes calldata proof) external view returns (bool);
+Parameters
+| Name | Type | Description |
|---|---|---|
fromChainId | uint256 | Source chain id. |
msgHash | bytes32 | Hash of the message. |
proof | bytes | Merkle proof of the message |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | Result of the message verify. |
uint256 internal constant LOW_28_MASK = 0x00000000ffffffffffffffffffffffffffffffffffffffffffffffffffffffff;
+Use when you really really really don't trust the called +contract. This prevents the called contract from causing reversion of +the caller in as many ways as we can.
+The main difference between this and a solidity low-level call is +that we limit the number of bytes that the callee can cause to be +copied to caller memory. This prevents stupid things like malicious +contracts returning 10,000,000 bytes causing a local OOG when copying +to memory.
+function excessivelySafeCall(address _target, uint256 _gas, uint16 _maxCopy, bytes memory _calldata)
+ internal
+ returns (bool, bytes memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
_target | address | The address to call |
_gas | uint256 | The amount of gas to forward to the remote contract |
_maxCopy | uint16 | The maximum number of bytes of returndata to copy to memory. |
_calldata | bytes | The data to send to the remote contract |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | success and returndata, as .call(). Returndata is capped to _maxCopy bytes. |
<none> | bytes |
Use when you really really really don't trust the called +contract. This prevents the called contract from causing reversion of +the caller in as many ways as we can.
+The main difference between this and a solidity low-level call is +that we limit the number of bytes that the callee can cause to be +copied to caller memory. This prevents stupid things like malicious +contracts returning 10,000,000 bytes causing a local OOG when copying +to memory.
+function excessivelySafeStaticCall(address _target, uint256 _gas, uint16 _maxCopy, bytes memory _calldata)
+ internal
+ view
+ returns (bool, bytes memory);
+Parameters
+| Name | Type | Description |
|---|---|---|
_target | address | The address to call |
_gas | uint256 | The amount of gas to forward to the remote contract |
_maxCopy | uint16 | The maximum number of bytes of returndata to copy to memory. |
_calldata | bytes | The data to send to the remote contract |
Returns
+| Name | Type | Description |
|---|---|---|
<none> | bool | success and returndata, as .call(). Returndata is capped to _maxCopy bytes. |
<none> | bytes |
Swaps function selectors in encoded contract calls
+Allows reuse of encoded calldata for functions with identical +argument types but different names. It simply swaps out the first 4 bytes +for the new selector. This function modifies memory in place, and should +only be used with caution.
+function swapSelector(bytes4 _newSelector, bytes memory _buf) internal pure;
+Parameters
+| Name | Type | Description |
|---|---|---|
_newSelector | bytes4 | The new 4-byte selector |
_buf | bytes | The encoded contract args |
uint8 internal constant _NOT_ENTERED = 1;
+uint8 internal constant _ENTERED = 2;
+uint8 internal _send_state = 1;
+uint8 internal _receive_state = 1;
+modifier sendNonReentrant();
+modifier recvNonReentrant();
+address public immutable USER_CONFIG;
+address public immutable TRUSTED_ENDPOINT;
+constructor(address config, address endpoint);
+function clearFailedMessage(Message calldata message) external virtual;
+function retryFailedMessage(Message calldata message) external virtual returns (bool dispatchResult);
+function setAppConfig(address relayer, address oracle) external virtual;
+function isTrustedEndpoint(address endpoint) public view returns (bool);
+function _messageId() internal pure returns (bytes32 _msgDataMessageId);
+function _fromChainId() internal pure returns (uint256 _msgDataFromChainId);
+function _xmsgSender() internal view returns (address payable _from);
+