npm - @hyperlane-xyz/core - Versions diffs - 1.3.8 → 1.4.0 - Mend

@hyperlane-xyz/core 1.3.8 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (316) hide show

package/docs/src/contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md DELETED Viewed

@@ -1,177 +0,0 @@
-# MerkleRootMultisigIsmMetadata
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol)
-Format of metadata:
-[   0:  32] Origin mailbox address
-[  32:  36] Signed checkpoint index
-[  36:  68] Signed checkpoint message ID
-[  68:1092] Merkle proof
-[1092:????] Validator signatures (length := threshold * 65)
-## State Variables
-### ORIGIN_MAILBOX_OFFSET
-```solidity
-uint8 private constant ORIGIN_MAILBOX_OFFSET = 0;
-```
-### CHECKPOINT_INDEX_OFFSET
-```solidity
-uint8 private constant CHECKPOINT_INDEX_OFFSET = 32;
-```
-### CHECKPOINT_MESSAGE_ID_OFFSET
-```solidity
-uint8 private constant CHECKPOINT_MESSAGE_ID_OFFSET = 36;
-```
-### MERKLE_PROOF_OFFSET
-```solidity
-uint8 private constant MERKLE_PROOF_OFFSET = 68;
-```
-### MERKLE_PROOF_LENGTH
-```solidity
-uint16 private constant MERKLE_PROOF_LENGTH = 32 * 32;
-```
-### SIGNATURES_OFFSET
-```solidity
-uint16 private constant SIGNATURES_OFFSET = 1092;
-```
-### SIGNATURE_LENGTH
-```solidity
-uint8 private constant SIGNATURE_LENGTH = 65;
-```
-## Functions
-### originMailbox
-Returns the origin mailbox of the signed checkpoint as bytes32.
-```solidity
-function originMailbox(bytes calldata _metadata) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|Origin mailbox of the signed checkpoint as bytes32|
-### index
-Returns the index of the signed checkpoint.
-```solidity
-function index(bytes calldata _metadata) internal pure returns (uint32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint32`|Index of the signed checkpoint|
-### messageId
-Returns the message ID of the signed checkpoint.
-```solidity
-function messageId(bytes calldata _metadata) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|Message ID of the signed checkpoint|
-### proof
-Returns the merkle proof branch of the message.
-*This appears to be more gas efficient than returning a calldata
-slice and using that.*
-```solidity
-function proof(bytes calldata _metadata) internal pure returns (bytes32[32] memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32[32]`|Merkle proof branch of the message.|
-### signatureAt
-Returns the validator ECDSA signature at `_index`.
-*Assumes signatures are sorted by validator*
-*Assumes `_metadata` encodes `threshold` signatures.*
-*Assumes `_index` is less than `threshold`*
-```solidity
-function signatureAt(bytes calldata _metadata, uint256 _index) internal pure returns (bytes calldata);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-|`_index`|`uint256`|The index of the signature to return.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|The validator ECDSA signature at `_index`.|

package/docs/src/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md DELETED Viewed

@@ -1,109 +0,0 @@
-# MessageIdMultisigIsmMetadata
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol)
-Format of metadata:
-[   0:  32] Origin mailbox address
-[  32:  64] Signed checkpoint root
-[  64:????] Validator signatures (length := threshold * 65)
-## State Variables
-### ORIGIN_MAILBOX_OFFSET
-```solidity
-uint8 private constant ORIGIN_MAILBOX_OFFSET = 0;
-```
-### MERKLE_ROOT_OFFSET
-```solidity
-uint8 private constant MERKLE_ROOT_OFFSET = 32;
-```
-### SIGNATURES_OFFSET
-```solidity
-uint8 private constant SIGNATURES_OFFSET = 64;
-```
-### SIGNATURE_LENGTH
-```solidity
-uint8 private constant SIGNATURE_LENGTH = 65;
-```
-## Functions
-### originMailbox
-Returns the origin mailbox of the signed checkpoint as bytes32.
-```solidity
-function originMailbox(bytes calldata _metadata) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|Origin mailbox of the signed checkpoint as bytes32|
-### root
-Returns the merkle root of the signed checkpoint.
-```solidity
-function root(bytes calldata _metadata) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|Merkle root of the signed checkpoint|
-### signatureAt
-Returns the validator ECDSA signature at `_index`.
-*Assumes signatures are sorted by validator*
-*Assumes `_metadata` encodes `threshold` signatures.*
-*Assumes `_index` is less than `threshold`*
-```solidity
-function signatureAt(bytes calldata _metadata, uint256 _index) internal pure returns (bytes calldata);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-|`_index`|`uint256`|The index of the signature to return.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|The validator ECDSA signature at `_index`.|

package/docs/src/contracts/libs/isms/README.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Contents
-- [AggregationIsmMetadata](AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md)
-- [LegacyMultisigIsmMetadata](LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md)
-- [MerkleRootMultisigIsmMetadata](MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md)
-- [MessageIdMultisigIsmMetadata](MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md)

package/docs/src/contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md DELETED Viewed

@@ -1,134 +0,0 @@
-# InterchainAccountMessage
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/middleware/InterchainAccountMessage.sol)
-Format of message:
-[   0:  32] ICA owner
-[  32:  64] ICA ISM
-[  64:????] Calls, abi encoded
-## Functions
-### encode
-Returns formatted (packed) InterchainAccountMessage
-*This function should only be used in memory message construction.*
-```solidity
-function encode(address _owner, bytes32 _ism, address _to, uint256 _value, bytes memory _data)
-    internal
-    pure
-    returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_owner`|`address`|The owner of the interchain account|
-|`_ism`|`bytes32`|The address of the remote ISM|
-|`_to`|`address`|The address of the contract to call|
-|`_value`|`uint256`|The value to include in the call|
-|`_data`|`bytes`|The calldata|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### encode
-Returns formatted (packed) InterchainAccountMessage
-*This function should only be used in memory message construction.*
-```solidity
-function encode(bytes32 _owner, bytes32 _ism, CallLib.Call[] calldata _calls) internal pure returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_owner`|`bytes32`|The owner of the interchain account|
-|`_ism`|`bytes32`|The address of the remote ISM|
-|`_calls`|`CallLib.Call[]`|The sequence of calls to make|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### encode
-Returns formatted (packed) InterchainAccountMessage
-*This function should only be used in memory message construction.*
-```solidity
-function encode(address _owner, bytes32 _ism, CallLib.Call[] calldata _calls) internal pure returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_owner`|`address`|The owner of the interchain account|
-|`_ism`|`bytes32`|The address of the remote ISM|
-|`_calls`|`CallLib.Call[]`|The sequence of calls to make|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### decode
-Parses and returns the calls from the provided message
-```solidity
-function decode(bytes calldata _message) internal pure returns (bytes32, bytes32, CallLib.Call[] memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain account message|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The array of calls|
-|`<none>`|`bytes32`||
-|`<none>`|`CallLib.Call[]`||
-### ism
-Parses and returns the ISM address from the provided message
-```solidity
-function ism(bytes calldata _message) internal pure returns (address);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain account message|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address`|The ISM encoded in the message|

package/docs/src/contracts/libs/middleware/InterchainQueryMessage.sol/library.InterchainQueryMessage.md DELETED Viewed

@@ -1,203 +0,0 @@
-# InterchainQueryMessage
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/middleware/InterchainQueryMessage.sol)
-Format of message:
-[   0: 32] Sender address
-[  32: 64] Message type (left padded with zeroes)
-[  64:???] Encoded call array
-## State Variables
-### SENDER_OFFSET
-```solidity
-uint256 private constant SENDER_OFFSET = 0;
-```
-### TYPE_OFFSET
-```solidity
-uint256 private constant TYPE_OFFSET = 32;
-```
-### CALLS_OFFSET
-```solidity
-uint256 private constant CALLS_OFFSET = 64;
-```
-## Functions
-### sender
-Parses and returns the query sender from the provided message
-```solidity
-function sender(bytes calldata _message) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain query message|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The query sender as bytes32|
-### messageType
-Parses and returns the message type from the provided message
-```solidity
-function messageType(bytes calldata _message) internal pure returns (MessageType);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain query message|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`MessageType`|The message type (query or response)|
-### encode
-Returns formatted InterchainQueryMessage, type == QUERY
-```solidity
-function encode(bytes32 _sender, CallLib.StaticCallWithCallback[] calldata _calls)
-    internal
-    pure
-    returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_sender`|`bytes32`|The query sender as bytes32|
-|`_calls`|`CallLib.StaticCallWithCallback[]`|The sequence of queries to make, with the corresponding response callbacks|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### encode
-Returns formatted InterchainQueryMessage, type == QUERY
-```solidity
-function encode(bytes32 _sender, address _to, bytes memory _data, bytes memory _callback)
-    internal
-    pure
-    returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_sender`|`bytes32`|The query sender as bytes32|
-|`_to`|`address`|The address of the contract to query|
-|`_data`|`bytes`|The calldata encoding the query|
-|`_callback`|`bytes`|The calldata of the callback that will be made on the sender. The return value of the query will be appended.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### callsWithCallbacks
-Parses and returns the calls and callbacks from the message
-```solidity
-function callsWithCallbacks(bytes calldata _message)
-    internal
-    pure
-    returns (CallLib.StaticCallWithCallback[] memory _calls);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain query message, type == QUERY|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`_calls`|`CallLib.StaticCallWithCallback[]`|The sequence of queries to make with the corresponding response callbacks|
-### encode
-Returns formatted InterchainQueryMessage, type == RESPONSE
-```solidity
-function encode(bytes32 _sender, bytes[] memory _calls) internal pure returns (bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_sender`|`bytes32`|The query sender as bytes32|
-|`_calls`|`bytes[]`|The sequence of callbacks to make|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|Formatted message body|
-### rawCalls
-Parses and returns the callbacks from the message
-```solidity
-function rawCalls(bytes calldata _message) internal pure returns (bytes[] memory _calls);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|The interchain query message, type == RESPONSE|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`_calls`|`bytes[]`|The sequence of callbacks to make|
-## Enums
-### MessageType
-```solidity
-enum MessageType {
-    QUERY,
-    RESPONSE
-}
-```

package/docs/src/contracts/libs/middleware/README.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Contents
-- [InterchainAccountMessage](InterchainAccountMessage.sol/library.InterchainAccountMessage.md)
-- [InterchainQueryMessage](InterchainQueryMessage.sol/library.InterchainQueryMessage.md)