@hyperlane-xyz/core 5.2.1 → 5.4.0-beta.0

package/contracts/AttributeCheckpointFraud.sol

@@ -5,6 +5,7 @@ import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 import {TREE_DEPTH} from "./libs/Merkle.sol";
 import {CheckpointLib, Checkpoint} from "./libs/CheckpointLib.sol";
 import {CheckpointFraudProofs} from "./CheckpointFraudProofs.sol";
@@ -26,7 +27,8 @@ struct Attribution {
  * @title AttributeCheckpointFraud
  * @dev The AttributeCheckpointFraud contract is used to attribute fraud to a specific ECDSA checkpoint signer.
  */
-contract AttributeCheckpointFraud is Ownable {
+
+contract AttributeCheckpointFraud is Ownable, PackageVersioned {
     using CheckpointLib for Checkpoint;
     using Address for address;
 

package/contracts/CheckpointFraudProofs.sol

@@ -9,12 +9,14 @@ import {MerkleLib, TREE_DEPTH} from "./libs/Merkle.sol";
 import {MerkleTreeHook} from "./hooks/MerkleTreeHook.sol";
 import {IMailbox} from "./interfaces/IMailbox.sol";
 
+import {PackageVersioned} from "./PackageVersioned.sol";
+
 struct StoredIndex {
     uint32 index;
     bool exists;
 }
 
-contract CheckpointFraudProofs {
+contract CheckpointFraudProofs is PackageVersioned {
     using CheckpointLib for Checkpoint;
     using Address for address;
 

package/contracts/Mailbox.sol

@@ -10,12 +10,19 @@ import {IInterchainSecurityModule, ISpecifiesInterchainSecurityModule} from "./i
 import {IPostDispatchHook} from "./interfaces/hooks/IPostDispatchHook.sol";
 import {IMessageRecipient} from "./interfaces/IMessageRecipient.sol";
 import {IMailbox} from "./interfaces/IMailbox.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
 // ============ External Imports ============
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
-contract Mailbox is IMailbox, Indexed, Versioned, OwnableUpgradeable {
+contract Mailbox is
+    IMailbox,
+    Indexed,
+    Versioned,
+    OwnableUpgradeable,
+    PackageVersioned
+{
     // ============ Libraries ============
 
     using Message for bytes;

package/contracts/PackageVersioned.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.6.11;
+
+/**
+ * @title PackageVersioned
+ * @notice Package version getter for contracts
+ **/
+abstract contract PackageVersioned {
+    // GENERATED CODE - DO NOT EDIT
+    string public constant PACKAGE_VERSION = "5.4.0-beta.0";
+}

package/contracts/avs/ECDSAStakeRegistry.sol

@@ -7,6 +7,8 @@ import {IDelegationManager} from "../interfaces/avs/vendored/IDelegationManager.
 import {ISignatureUtils} from "../interfaces/avs/vendored/ISignatureUtils.sol";
 import {IServiceManager} from "../interfaces/avs/vendored/IServiceManager.sol";
 
+import {PackageVersioned} from "../PackageVersioned.sol";
+
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import {CheckpointsUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/CheckpointsUpgradeable.sol";
 import {SignatureCheckerUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/cryptography/SignatureCheckerUpgradeable.sol";
@@ -19,7 +21,8 @@ import {IERC1271Upgradeable} from "@openzeppelin/contracts-upgradeable/interface
 contract ECDSAStakeRegistry is
     IERC1271Upgradeable,
     OwnableUpgradeable,
-    ECDSAStakeRegistryStorage
+    ECDSAStakeRegistryStorage,
+    PackageVersioned
 {
     using SignatureCheckerUpgradeable for address;
     using CheckpointsUpgradeable for CheckpointsUpgradeable.History;

package/contracts/avs/HyperlaneServiceManager.sol

@@ -19,8 +19,9 @@ import {IAVSDirectory} from "../interfaces/avs/vendored/IAVSDirectory.sol";
 import {IRemoteChallenger} from "../interfaces/avs/IRemoteChallenger.sol";
 import {ISlasher} from "../interfaces/avs/vendored/ISlasher.sol";
 import {ECDSAServiceManagerBase} from "./ECDSAServiceManagerBase.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
-contract HyperlaneServiceManager is ECDSAServiceManagerBase {
+contract HyperlaneServiceManager is ECDSAServiceManagerBase, PackageVersioned {
     // ============ Libraries ============
 
     using EnumerableMapEnrollment for EnumerableMapEnrollment.AddressToEnrollmentMap;

package/contracts/client/MailboxClient.sol

@@ -6,12 +6,13 @@ import {IMailbox} from "../interfaces/IMailbox.sol";
 import {IPostDispatchHook} from "../interfaces/hooks/IPostDispatchHook.sol";
 import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
 import {Message} from "../libs/Message.sol";
+import {PackageVersioned} from "../PackageVersioned.sol";
 
 // ============ External Imports ============
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 
-abstract contract MailboxClient is OwnableUpgradeable {
+abstract contract MailboxClient is OwnableUpgradeable, PackageVersioned {
     using Message for bytes;
 
     IMailbox public immutable mailbox;

package/contracts/hooks/igp/StorageGasOracle.sol

@@ -3,6 +3,7 @@ pragma solidity >=0.8.0;
 
 // ============ Internal Imports ============
 import {IGasOracle} from "../../interfaces/IGasOracle.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
 // ============ External Imports ============
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
@@ -12,7 +13,7 @@ import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
  * @dev This contract is intended to be owned by an address that will
  * update the stored remote gas data.
  */
-contract StorageGasOracle is IGasOracle, Ownable {
+contract StorageGasOracle is IGasOracle, Ownable, PackageVersioned {
     // ============ Public Storage ============
 
     /// @notice Keyed by remote domain, gas data on that remote domain.

package/contracts/hooks/libs/AbstractPostDispatchHook.sol

@@ -16,12 +16,16 @@ pragma solidity >=0.8.0;
 // ============ Internal Imports ============
 import {StandardHookMetadata} from "./StandardHookMetadata.sol";
 import {IPostDispatchHook} from "../../interfaces/hooks/IPostDispatchHook.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
 /**
  * @title AbstractPostDispatch
  * @notice Abstract post dispatch hook supporting the current global hook metadata variant.
  */
-abstract contract AbstractPostDispatchHook is IPostDispatchHook {
+abstract contract AbstractPostDispatchHook is
+    IPostDispatchHook,
+    PackageVersioned
+{
     using StandardHookMetadata for bytes;
 
     // ============ External functions ============

package/contracts/isms/NoopIsm.sol

@@ -2,8 +2,9 @@
 pragma solidity >=0.8.0;
 
 import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
-contract NoopIsm is IInterchainSecurityModule {
+contract NoopIsm is IInterchainSecurityModule, PackageVersioned {
     uint8 public constant override moduleType = uint8(Types.NULL);
 
     function verify(

package/contracts/isms/PausableIsm.sol

@@ -7,8 +7,14 @@ import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 
 // ============ Internal Imports ============
 import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
-contract PausableIsm is IInterchainSecurityModule, Ownable, Pausable {
+contract PausableIsm is
+    IInterchainSecurityModule,
+    Ownable,
+    Pausable,
+    PackageVersioned
+{
     uint8 public constant override moduleType = uint8(Types.NULL);
 
     constructor(address owner) Ownable() Pausable() {

package/contracts/isms/TrustedRelayerIsm.sol

@@ -5,8 +5,9 @@ pragma solidity >=0.8.0;
 import {IInterchainSecurityModule} from "../interfaces/IInterchainSecurityModule.sol";
 import {Message} from "../libs/Message.sol";
 import {Mailbox} from "../Mailbox.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
-contract TrustedRelayerIsm is IInterchainSecurityModule {
+contract TrustedRelayerIsm is IInterchainSecurityModule, PackageVersioned {
     using Message for bytes;
 
     uint8 public immutable moduleType = uint8(Types.NULL);

package/contracts/isms/aggregation/StaticAggregationIsm.sol

@@ -5,13 +5,14 @@ pragma solidity >=0.8.0;
 import {AbstractAggregationIsm} from "./AbstractAggregationIsm.sol";
 import {AggregationIsmMetadata} from "../../isms/libs/AggregationIsmMetadata.sol";
 import {MetaProxy} from "../../libs/MetaProxy.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
 /**
  * @title StaticAggregationIsm
  * @notice Manages per-domain m-of-n ISM sets that are used to verify
  * interchain messages.
  */
-contract StaticAggregationIsm is AbstractAggregationIsm {
+contract StaticAggregationIsm is AbstractAggregationIsm, PackageVersioned {
     // ============ Public Functions ============
 
     /**

package/contracts/isms/aggregation/StaticAggregationIsmFactory.sol

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 pragma solidity >=0.8.0;
+
 // ============ Internal Imports ============
 import {StaticAggregationIsm} from "./StaticAggregationIsm.sol";
 import {StaticThresholdAddressSetFactory} from "../../libs/StaticAddressSetFactory.sol";

package/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

@@ -18,9 +18,9 @@ pragma solidity >=0.8.0;
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {LibBit} from "../../libs/LibBit.sol";
 import {Message} from "../../libs/Message.sol";
+import {PackageVersioned} from "contracts/PackageVersioned.sol";
 
 // ============ External Imports ============
-
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
@@ -31,7 +31,8 @@ import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Ini
  */
 abstract contract AbstractMessageIdAuthorizedIsm is
     IInterchainSecurityModule,
-    Initializable
+    Initializable,
+    PackageVersioned
 {
     using Address for address payable;
     using LibBit for uint256;

package/contracts/isms/multisig/AbstractMultisigIsm.sol

@@ -21,6 +21,7 @@ import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityMod
 import {IMultisigIsm} from "../../interfaces/isms/IMultisigIsm.sol";
 import {Message} from "../../libs/Message.sol";
 import {MerkleLib} from "../../libs/Merkle.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
 /**
  * @title AbstractMultisig
@@ -29,7 +30,7 @@ import {MerkleLib} from "../../libs/Merkle.sol";
  * for concrete implementations of `digest` and `signatureAt`.
  * @dev See ./StaticMultisigIsm.sol for concrete implementations.
  */
-abstract contract AbstractMultisig {
+abstract contract AbstractMultisig is PackageVersioned {
     /**
      * @notice Returns the digest to be used for signature verification.
      * @param _metadata ABI encoded module metadata

package/contracts/isms/routing/DomainRoutingIsm.sol

@@ -12,11 +12,16 @@ import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityMod
 import {Message} from "../../libs/Message.sol";
 import {TypeCasts} from "../../libs/TypeCasts.sol";
 import {EnumerableMapExtended} from "../../libs/EnumerableMapExtended.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
 /**
  * @title DomainRoutingIsm
  */
-contract DomainRoutingIsm is AbstractRoutingIsm, OwnableUpgradeable {
+contract DomainRoutingIsm is
+    AbstractRoutingIsm,
+    OwnableUpgradeable,
+    PackageVersioned
+{
     using EnumerableMapExtended for EnumerableMapExtended.UintToBytes32Map;
     using Message for bytes;
     using TypeCasts for bytes32;

package/contracts/isms/routing/DomainRoutingIsmFactory.sol

@@ -6,8 +6,9 @@ import {DomainRoutingIsm} from "./DomainRoutingIsm.sol";
 import {DefaultFallbackRoutingIsm} from "./DefaultFallbackRoutingIsm.sol";
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {MinimalProxy} from "../../libs/MinimalProxy.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
-abstract contract AbstractDomainRoutingIsmFactory {
+abstract contract AbstractDomainRoutingIsmFactory is PackageVersioned {
     /**
      * @notice Emitted when a routing module is deployed
      * @param module The deployed ISM

package/contracts/isms/routing/InterchainAccountIsm.sol

@@ -6,11 +6,12 @@ import {IMailbox} from "../../interfaces/IMailbox.sol";
 import {IInterchainSecurityModule} from "../../interfaces/IInterchainSecurityModule.sol";
 import {Message} from "../../libs/Message.sol";
 import {InterchainAccountMessage} from "../../middleware/libs/InterchainAccountMessage.sol";
+import {PackageVersioned} from "../../PackageVersioned.sol";
 
 /**
  * @title InterchainAccountIsm
  */
-contract InterchainAccountIsm is AbstractRoutingIsm {
+contract InterchainAccountIsm is AbstractRoutingIsm, PackageVersioned {
     IMailbox private immutable mailbox;
 
     // ============ Constructor ============

package/contracts/libs/StaticAddressSetFactory.sol

@@ -6,8 +6,9 @@ import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
 
 // ============ Internal Imports ============
 import {MetaProxy} from "./MetaProxy.sol";
+import {PackageVersioned} from "../PackageVersioned.sol";
 
-abstract contract StaticThresholdAddressSetFactory {
+abstract contract StaticThresholdAddressSetFactory is PackageVersioned {
     // ============ Immutables ============
     address public immutable implementation;
 

package/contracts/libs/StaticWeightedValidatorSetFactory.sol

@@ -8,8 +8,9 @@ import {IStaticWeightedMultisigIsm} from "../interfaces/isms/IWeightedMultisigIs
 
 // ============ Internal Imports ============
 import {MetaProxy} from "./MetaProxy.sol";
+import {PackageVersioned} from "../PackageVersioned.sol";
 
-abstract contract StaticWeightedValidatorSetFactory {
+abstract contract StaticWeightedValidatorSetFactory is PackageVersioned {
     // ============ Immutables ============
     address public immutable implementation;
 

package/contracts/middleware/README.md

@@ -3,13 +3,13 @@
 ## Interchain Accounts
 
 An interchain account is a smart contract that is deployed on a remote chain controlled exclusively by the origin chain's deployer account.
-Interchain accounts provide developers with a [transparent multicall API](../OwnableMulticall.sol) to remote smart contracts.
+Interchain accounts provide developers with a [transparent multicall API](libs/OwnableMulticall.sol) to remote smart contracts.
 This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
 
 See [IBC Interchain Accounts](https://github.com/cosmos/ibc/blob/main/spec/app/ics-027-interchain-accounts/README.md) for the Cosmos ecosystem equivalent.
 
 ## Interchain Query System
 
-The interchain query system generalizes view calls to contracts on remote chains. It is a [transparent multicall API](../OwnableMulticall.sol) that can be used to query remote smart contracts. This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
+The interchain query system generalizes view calls to contracts on remote chains. It is a [transparent multicall API](libs/OwnableMulticall.sol) that can be used to query remote smart contracts. This avoids the need to deploy application specific smart contracts on remote chains while simultaneously enabling cross-chain composability.
 
 See [IBC Interchain Query System](https://github.com/cosmos/ibc/tree/main/spec/app/ics-031-crosschain-queries) for the Cosmos ecosystem equivalent.

package/contracts/token/README.md

@@ -45,9 +45,9 @@ graph LR
 
 The Token Router contract comes in several flavors and a warp route can be composed of a combination of these flavors.
 
-- [`Native`](./contracts/HypNative.sol) - for warping native assets (e.g. ETH) from the canonical chain
-- [`Collateral`](./contracts/HypERC20Collateral.sol) - for warping tokens, ERC20 or ERC721, from the canonical chain
-- [`Synthetic`](./contracts/HypERC20.sol) - for representing tokens, Native/ERC20 or ERC721, on a non-canonical chain
+- [`Native`](./HypNative.sol) - for warping native assets (e.g. ETH) from the canonical chain
+- [`Collateral`](./HypERC20Collateral.sol) - for warping tokens, ERC20 or ERC721, from the canonical chain
+- [`Synthetic`](./HypERC20.sol) - for representing tokens, Native/ERC20 or ERC721, on a non-canonical chain
 
 ## Interchain Security Models