feat: mutable storage ISMs #4577

yorhodes · 2024-09-26T17:23:48Z

Description

Some chains like zkSync do not support eip1167 (minimal/meta) proxies. This PR adds an alternative storage based multisig and aggregation ISM for use on these chains.

Drive-by changes

Simplify CLI multisig interactive config builder. Remove stale multisig config.

Related issues

None

Backward compatibility

Yes, relayer already supports this module type

Testing

Contract unit tests
Manual CLI tests

changeset-bot · 2024-09-26T17:23:52Z

🦋 Changeset detected

Latest commit: e9f7731

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages

Name	Type
@hyperlane-xyz/cli	Minor
@hyperlane-xyz/sdk	Minor
@hyperlane-xyz/core	Minor
@hyperlane-xyz/helloworld	Minor
@hyperlane-xyz/infra	Minor
@hyperlane-xyz/widgets	Minor
@hyperlane-xyz/ccip-server	Minor
@hyperlane-xyz/github-proxy	Minor
@hyperlane-xyz/utils	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

solidity/contracts/isms/multisig/AbstractMultisigIsm.sol

solidity/contracts/isms/multisig/StorageMultisigIsm.sol

@@ -0,0 +1,63 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+
+abstract contract AbstractStorageMultisigIsm is AbstractMultisigIsm, Ownable {
+    address[] public validators;
+    uint8 public threshold;


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+    AbstractMessageIdMultisigIsm,
+    AbstractStorageMultisigIsm
+{
+    uint8 public constant moduleType =


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+        uint8(IInterchainSecurityModule.Types.MESSAGE_ID_MULTISIG);
+
+    constructor(
+        address[] memory _validators,


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

codecov · 2024-09-26T17:36:27Z

Codecov Report

Attention: Patch coverage is 81.81818% with 6 lines in your changes missing coverage. Please review.

Project coverage is 73.92%. Comparing base (2934195) to head (1ed4003).
Report is 1 commits behind head on audit-q3-2024.

Additional details and impacted files

@@                Coverage Diff                @@
##           audit-q3-2024    #4577      +/-   ##
=================================================
+ Coverage          73.74%   73.92%   +0.18%     
=================================================
  Files                100      102       +2     
  Lines               1436     1469      +33     
  Branches             187      189       +2     
=================================================
+ Hits                1059     1086      +27     
- Misses               356      362       +6     
  Partials              21       21

Components	Coverage Δ
core	`84.61% <ø> (ø)`
hooks	`75.71% <ø> (ø)`
isms	`78.11% <81.81%> (+0.52%)`	⬆️
token	`88.75% <ø> (ø)`
middlewares	`77.39% <ø> (ø)`

solidity/contracts/interfaces/IThresholdAddressFactory.sol

@@ -0,0 +1,9 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+    event ValidatorsAndThresholdSet(address[] validators, uint8 threshold);
+
+    constructor(
+        address[] memory _validators,


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+
+    constructor(
+        address[] memory _validators,
+        uint8 _threshold


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+}
+
+contract StorageMerkleRootMultisigIsmFactory is StorageMultisigIsmFactory {
+    address internal immutable _implementation;


solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+}
+
+contract StorageMessageIdMultisigIsmFactory is StorageMultisigIsmFactory {
+    address internal immutable _implementation;


paulbalaji · 2024-09-26T20:33:40Z

typescript/sdk/src/ism/HyperlaneIsmFactory.ts

-      logger,
-      config.threshold,
-    );
+    const deployStatic = (factory: StaticThresholdAddressSetFactory) =>


will need to dupe this change to EvmIsmModule too

hyperlane-monorepo/typescript/sdk/src/ism/EvmIsmModule.ts

Line 433 in 471002b

protected async deployMultisigIsm({

brutal, I thought these were kinda using the same codepaths 😱

paulbalaji · 2024-09-26T20:36:26Z

typescript/cli/src/config/ism.ts

+      'Enter validator addresses (comma separated list) for multisig ISM:',
+  });
+  const validators = validatorsInput.split(',').map((v) => v.trim());
+  const threshold = parseInt(


maybe also check the given threshold >=1 and <= validators.length

should we also recommend a value?

trying to leave input validation to the zod schema
can make this change there I suppose though 0/n as a noop ISM could be useful

solidity/contracts/isms/multisig/StorageMultisigIsm.sol

+    }
+
+    function initialize(
+        address _owner,


nambrot

I mostly did a cursory review, so would like @aroralanuk to take a deeper look for the approval

solidity/contracts/isms/multisig/AbstractMultisigIsm.sol

nambrot · 2024-10-22T01:01:54Z

solidity/test/isms/MultisigIsm.t.sol

 import {TypeCasts} from "../../contracts/libs/TypeCasts.sol";
 import {MerkleTreeHook} from "../../contracts/hooks/MerkleTreeHook.sol";
 import {TestMerkleTreeHook} from "../../contracts/test/TestMerkleTreeHook.sol";
 import {TestPostDispatchHook} from "../../contracts/test/TestPostDispatchHook.sol";
 import {Message} from "../../contracts/libs/Message.sol";
 import {ThresholdTestUtils} from "./IsmTestUtils.sol";
+import {StorageMessageIdMultisigIsm, StorageMerkleRootMultisigIsm, StorageMessageIdMultisigIsmFactory, StorageMerkleRootMultisigIsmFactory, AbstractStorageMultisigIsm} from "../../contracts/isms/multisig/StorageMultisigIsm.sol";
+
+uint8 constant MAX_VALIDATORS = 20;


A comment on why this value is 20 might be nice

this was pretty arbitrary tbh

bumped it from 10 to 20

nambrot · 2024-10-22T01:03:39Z

typescript/cli/src/tests/multisig.test.ts

@@ -1,41 +0,0 @@
-import { expect } from 'chai';


Why is this getting removed?

we no longer use this config schema

### Description - Implements storage-based aggregation ISM ### Drive-by changes - Moves `PackageVersioned` imports from static to abstract aggregation ism ### Backward compatibility Yes ### Testing Unit Tests

solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.0;


solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

+import {OwnableUpgradeable} from "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
+
+contract StorageAggregationIsm is AbstractAggregationIsm, OwnableUpgradeable {
+    address[] public modules;


solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

+    event ModulesAndThresholdSet(address[] modules, uint8 threshold);
+
+    constructor(
+        address[] memory _modules,


solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

+
+    constructor(
+        address[] memory _modules,
+        uint8 _threshold


solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

+    }
+
+    function initialize(
+        address _owner,


solidity/contracts/isms/aggregation/StorageAggregationIsm.sol

+    IThresholdAddressFactory,
+    PackageVersioned
+{
+    address public immutable implementation;


github-advanced-security bot found potential problems Sep 26, 2024

View reviewed changes

yorhodes marked this pull request as ready for review September 26, 2024 20:17

yorhodes requested review from jmrossy, ltyu, paulbalaji, tkporter and aroralanuk as code owners September 26, 2024 20:17

yorhodes changed the title ~~feat: storage multisig ISM~~ feat: mutable storage multisig ISM Sep 26, 2024

paulbalaji reviewed Sep 26, 2024

View reviewed changes

github-advanced-security bot found potential problems Oct 2, 2024

View reviewed changes

nambrot reviewed Oct 22, 2024

View reviewed changes

yorhodes added 13 commits October 22, 2024 16:37

Implement Storage Multisig ISM

c5cd25c

Improve tests

5a9bf0b

Refactor tests

2b46831

Test setValidatorsAndThreshold

6520171

Disable initializers in constructor

5857562

Increase MAX_VALIDATORS in test

374f489

Deploy storage multisig ISMs atomically

8284243

Support storage multisig ISMs in CLI

6932a8e

Remove stale multisig config

9431654

Test initializable on storage multisig

aabb341

Transfer ownership to deployer instead of factory

44514f2

Fix ISM type

777a5e6

Add changeset

b51f1d3

yorhodes force-pushed the storage-multisig-ism branch from ce0e9a7 to b51f1d3 Compare October 22, 2024 20:38

yorhodes changed the base branch from main to audit-q3-2024 October 22, 2024 20:38

yorhodes added 2 commits October 22, 2024 17:28

Add PackageVersioned to storage multisig contracts

0349328

feat: Implement Storage Aggregation ISM (#4731)

1ed4003

### Description - Implements storage-based aggregation ISM ### Drive-by changes - Moves `PackageVersioned` imports from static to abstract aggregation ism ### Backward compatibility Yes ### Testing Unit Tests

yorhodes changed the title ~~feat: mutable storage multisig ISM~~ feat: mutable storage ISMs Oct 23, 2024

github-advanced-security bot found potential problems Oct 23, 2024

View reviewed changes

Merge branch 'audit-q3-2024' into storage-multisig-ism

e9f7731

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: mutable storage ISMs #4577

feat: mutable storage ISMs #4577

yorhodes commented Sep 26, 2024 •

edited

Loading

changeset-bot bot commented Sep 26, 2024 •

edited

Loading

codecov bot commented Sep 26, 2024 •

edited

Loading

paulbalaji Sep 26, 2024

yorhodes Sep 27, 2024

paulbalaji Sep 26, 2024

yorhodes Sep 27, 2024

nambrot left a comment

nambrot Oct 22, 2024

yorhodes Oct 22, 2024

yorhodes Oct 22, 2024

nambrot Oct 22, 2024

yorhodes Oct 22, 2024

		@@ -0,0 +1,63 @@
		// SPDX-License-Identifier: MIT OR Apache-2.0
		pragma solidity >=0.8.0;

		@@ -0,0 +1,9 @@
		// SPDX-License-Identifier: MIT OR Apache-2.0
		pragma solidity >=0.8.0;

		@@ -0,0 +1,83 @@
		// SPDX-License-Identifier: MIT OR Apache-2.0
		pragma solidity >=0.8.0;

feat: mutable storage ISMs #4577

Are you sure you want to change the base?

feat: mutable storage ISMs #4577

Conversation

yorhodes commented Sep 26, 2024 • edited Loading

Description

Drive-by changes

Related issues

Backward compatibility

Testing

changeset-bot bot commented Sep 26, 2024 • edited Loading

🦋 Changeset detected

codecov bot commented Sep 26, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nambrot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yorhodes commented Sep 26, 2024 •

edited

Loading

changeset-bot bot commented Sep 26, 2024 •

edited

Loading

codecov bot commented Sep 26, 2024 •

edited

Loading