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

@hyperlane-xyz/core 1.3.8 → 1.4.1

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 (373) hide show

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

@@ -1,16 +0,0 @@
-# Contents
-- [isms](/contracts/libs/isms)
-- [middleware](/contracts/libs/middleware)
-- [CallLib](Call.sol/library.CallLib.md)
-- [CheckpointLib](CheckpointLib.sol/library.CheckpointLib.md)
-- [EnumerableMapExtended](EnumerableMapExtended.sol/library.EnumerableMapExtended.md)
-- [LegacyCheckpointLib](LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md)
-- [MerkleLib](Merkle.sol/library.MerkleLib.md)
-- [Message](Message.sol/library.Message.md)
-- [MetaProxy](MetaProxy.sol/library.MetaProxy.md)
-- [MinimalProxy](MinimalProxy.sol/library.MinimalProxy.md)
-- [StaticMOfNAddressSetFactory](StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
-- [TypeCasts](TypeCasts.sol/library.TypeCasts.md)
-- [ValidatorAnnouncements](ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md)

package/docs/src/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md DELETED Viewed

@@ -1,123 +0,0 @@
-# StaticMOfNAddressSetFactory
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/StaticMOfNAddressSetFactory.sol)
-## State Variables
-### _implementation
-```solidity
-address private immutable _implementation;
-```
-## Functions
-### constructor
-```solidity
-constructor();
-```
-### _deployImplementation
-```solidity
-function _deployImplementation() internal virtual returns (address);
-```
-### deploy
-Deploys a StaticMOfNAddressSet contract address for the given
-values
-*Consider sorting addresses to ensure contract reuse*
-```solidity
-function deploy(address[] calldata _values, uint8 _threshold) external returns (address);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_values`|`address[]`|An array of addresses|
-|`_threshold`|`uint8`|The threshold value to use|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
-### getAddress
-Returns the StaticMOfNAddressSet contract address for the given
-values
-*Consider sorting addresses to ensure contract reuse*
-```solidity
-function getAddress(address[] calldata _values, uint8 _threshold) external view returns (address);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_values`|`address[]`|An array of addresses|
-|`_threshold`|`uint8`|The threshold value to use|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
-### _getAddress
-Returns the StaticMOfNAddressSet contract address for the given
-values
-```solidity
-function _getAddress(bytes32 _salt, bytes memory _bytecode) private view returns (address);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_salt`|`bytes32`|The salt used in Create2|
-|`_bytecode`|`bytes`|The metaproxy bytecode used in Create2|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
-### _saltAndBytecode
-Returns the create2 salt and bytecode for the given values
-```solidity
-function _saltAndBytecode(address[] calldata _values, uint8 _threshold) private view returns (bytes32, bytes memory);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_values`|`address[]`|An array of addresses|
-|`_threshold`|`uint8`|The threshold value to use|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|_salt The salt used in Create2|
-|`<none>`|`bytes`|_bytecode The metaproxy bytecode used in Create2|

package/docs/src/contracts/libs/TestMerkle.sol/contract.MerkleTree.md DELETED Viewed

@@ -1,66 +0,0 @@
-# MerkleTree
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/TestMerkle.sol)
-## Functions
-### constructor
-```solidity
-constructor();
-```
-### hashLeafPairs
-```solidity
-function hashLeafPairs(bytes32 left, bytes32 right) public pure returns (bytes32 _hash);
-```
-### getRoot
-PROOF GENERATION *
-```solidity
-function getRoot(bytes32[] memory data) public pure returns (bytes32);
-```
-### getProof
-```solidity
-function getProof(bytes32[] memory data, uint256 node) public pure returns (bytes32[] memory);
-```
-### hashLevel
-*function is private to prevent unsafe data from being passed*
-```solidity
-function hashLevel(bytes32[] memory data) private pure returns (bytes32[] memory);
-```
-### log2ceil
-MATH "LIBRARY" *
-*Note that x is assumed > 0*
-```solidity
-function log2ceil(uint256 x) public pure returns (uint256);
-```
-### log2ceilBitMagic
-Original bitmagic adapted from https://github.com/paulrberg/prb-math/blob/main/contracts/PRBMath.sol
-*Note that x assumed > 1*
-```solidity
-function log2ceilBitMagic(uint256 x) public pure returns (uint256);
-```

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

@@ -1,19 +0,0 @@
-# TypeCasts
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/TypeCasts.sol)
-## Functions
-### addressToBytes32
-```solidity
-function addressToBytes32(address _addr) internal pure returns (bytes32);
-```
-### bytes32ToAddress
-```solidity
-function bytes32ToAddress(bytes32 _buf) internal pure returns (address);
-```

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

@@ -1,31 +0,0 @@
-# ValidatorAnnouncements
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/ValidatorAnnouncements.sol)
-## Functions
-### getAnnouncementDigest
-Returns the digest validators are expected to sign when signing announcements.
-```solidity
-function getAnnouncementDigest(address _mailbox, uint32 _localDomain, string memory _storageLocation)
-    internal
-    pure
-    returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_mailbox`|`address`|Address of the mailbox being validated|
-|`_localDomain`|`uint32`|Domain of chain on which the contract is deployed|
-|`_storageLocation`|`string`|Storage location string.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The digest of the announcement.|

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

@@ -1,97 +0,0 @@
-# AggregationIsmMetadata
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/isms/AggregationIsmMetadata.sol)
-Format of metadata:
-[????:????] Metadata start/end uint32 ranges, packed as uint64
-[????:????] ISM metadata, packed encoding
-## State Variables
-### RANGE_SIZE
-```solidity
-uint256 private constant RANGE_SIZE = 4;
-```
-## Functions
-### hasMetadata
-Returns whether or not metadata was provided for the ISM at
-`_index`
-*Callers must ensure _index is less than the number of metadatas
-provided*
-```solidity
-function hasMetadata(bytes calldata _metadata, uint8 _index) internal pure returns (bool);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
-|`_index`|`uint8`|The index of the ISM to check for metadata for|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bool`|Whether or not metadata was provided for the ISM at `_index`|
-### metadataAt
-Returns the metadata provided for the ISM at `_index`
-*Callers must ensure _index is less than the number of metadatas
-provided*
-*Callers must ensure `hasMetadata(_metadata, _index)`*
-```solidity
-function metadataAt(bytes calldata _metadata, uint8 _index) internal pure returns (bytes calldata);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
-|`_index`|`uint8`|The index of the ISM to return metadata for|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|The metadata provided for the ISM at `_index`|
-### _metadataRange
-Returns the range of the metadata provided for the ISM at
-`_index`, or zeroes if not provided
-*Callers must ensure _index is less than the number of metadatas
-provided*
-```solidity
-function _metadataRange(bytes calldata _metadata, uint8 _index) private pure returns (uint32, uint32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
-|`_index`|`uint8`|The index of the ISM to return metadata range for|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint32`|The range of the metadata provided for the ISM at `_index`, or zeroes if not provided|
-|`<none>`|`uint32`||

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

@@ -1,296 +0,0 @@
-# LegacyMultisigIsmMetadata
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/isms/LegacyMultisigIsmMetadata.sol)
-Format of metadata:
-[   0:  32] Merkle root
-[  32:  36] Root index
-[  36:  68] Origin mailbox address
-[  68:1092] Merkle proof
-[1092:1093] Threshold
-[1093:????] Validator signatures, 65 bytes each, length == Threshold
-[????:????] Addresses of the entire validator set, left padded to bytes32
-## State Variables
-### MERKLE_ROOT_OFFSET
-```solidity
-uint256 private constant MERKLE_ROOT_OFFSET = 0;
-```
-### MERKLE_INDEX_OFFSET
-```solidity
-uint256 private constant MERKLE_INDEX_OFFSET = 32;
-```
-### ORIGIN_MAILBOX_OFFSET
-```solidity
-uint256 private constant ORIGIN_MAILBOX_OFFSET = 36;
-```
-### MERKLE_PROOF_OFFSET
-```solidity
-uint256 private constant MERKLE_PROOF_OFFSET = 68;
-```
-### THRESHOLD_OFFSET
-```solidity
-uint256 private constant THRESHOLD_OFFSET = 1092;
-```
-### SIGNATURES_OFFSET
-```solidity
-uint256 private constant SIGNATURES_OFFSET = 1093;
-```
-### SIGNATURE_LENGTH
-```solidity
-uint256 private constant SIGNATURE_LENGTH = 65;
-```
-## Functions
-### 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|
-### 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|
-### 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|
-### 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.|
-### threshold
-Returns the number of required signatures. Verified against
-the commitment stored in the module.
-```solidity
-function threshold(bytes calldata _metadata) internal pure returns (uint8);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint8`|The number of required signatures.|
-### 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`.|
-### validatorAt
-Returns the validator address at `_index`.
-*Assumes `_index` is less than the number of validators*
-```solidity
-function validatorAt(bytes calldata _metadata, uint256 _index) internal pure returns (address);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-|`_index`|`uint256`|The index of the validator to return.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address`|The validator address at `_index`.|
-### validators
-Returns the validator set encoded as bytes. Verified against the
-commitment stored in the module.
-*Validator addresses are encoded as tightly packed array of bytes32,
-sorted to match the enumerable set stored by the module.*
-```solidity
-function validators(bytes calldata _metadata) internal pure returns (bytes calldata);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|The validator set encoded as bytes.|
-### validatorCount
-Returns the size of the validator set encoded in the metadata
-*Validator addresses are encoded as tightly packed array of bytes32,
-sorted to match the enumerable set stored by the module.*
-```solidity
-function validatorCount(bytes calldata _metadata) internal pure returns (uint256);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|The size of the validator set encoded in the metadata|
-### _validatorsOffset
-Returns the offset in bytes of the list of validators within
-`_metadata`.
-```solidity
-function _validatorsOffset(bytes calldata _metadata) private pure returns (uint256);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|The index at which the list of validators starts|