feat: Polygon ZKevm v2 hook and ism by iamzubin · Pull Request #4547 · hyperlane-xyz/hyperlane-monorepo

iamzubin · 2024-09-22T20:43:11Z

Description

This PR adds a hook and ISM contract for Polygon's zkEVM v2 bridge.

The contracts tap into the Polygon zkEVM bridge to ensure cross-chain messages come from a trusted source. This works by using the zkEVM bridge's exit nodes, which handle verifying the message integrity.

This PR also includes code from PR #3136

PR for docs : PR 40

Drive-by changes

None

Related issues
Fixes #2848

Backward compatibility
Yes

changeset-bot · 2024-09-22T20:43:15Z

⚠️ No Changeset found

Latest commit: 1b9ac7a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

aroralanuk · 2024-10-31T03:32:02Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+ * @notice Message hook to inform the {Polygon zkEVM chain Ism} of messages published through
+ * the native Polygon zkEVM bridge bridge.
+ */
+contract PolygonZkevmHook is IPostDispatchHook, MailboxClient {


can you inherit from AbstractMessageIdAuthHook here, it'll mean less code duplication?

aroralanuk · 2024-10-31T03:36:51Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+        bytes calldata,
+        bytes calldata
+    ) external pure override returns (uint256) {
+        return 0;


But I imagine there's still some additional overhead for the relayer to submit the tx on the destination chain. You can follow using a childHook which is effectively an IGP:

hyperlane-monorepo/solidity/contracts/hooks/ArbL2ToL1Hook.sol

Line 70 in f26453e

metadata.msgValue(0) + childHook.quoteDispatch(metadata, message);

aroralanuk

It's a good start, take a look at the comments. It'll be easier to separate this into two PRs for v1 and v2.

aroralanuk · 2024-10-31T03:37:29Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+        );
+        bytes32 messageId = message.id();
+
+        zkEvmBridge.bridgeMessage{value: msg.value}(


Only send the metadata.msgValue(0) and refund the rest

aroralanuk · 2024-10-31T03:38:25Z

solidity/contracts/hooks/PolygonZkevmV2Hook.sol

+ * @notice Message hook to inform the {Polygon zkEVM chain Ism} of messages published through
+ * the native Polygon zkEVM bridge bridge.
+ */
+contract PolygonZkevmV2Hook is IPostDispatchHook, MailboxClient {


inherit from AbstractMessageIdAuthHook here instead too

aroralanuk · 2024-10-31T03:39:25Z

solidity/contracts/hooks/PolygonZkevmV2Hook.sol

+            "PolygonzkEVMv2Hook: invalid destination domain"
+        );
+        require(
+            _zkEvmBridgeDestinationNetId <= 1,


this can only be 0 or 1 then?

aroralanuk · 2024-10-31T03:39:46Z

solidity/contracts/hooks/PolygonZkevmV2Hook.sol

+        bytes calldata
+    ) external view override returns (uint256) {
+        return
+            interchainGasPaymaster.quoteGasPayment(


make this child hook

aroralanuk · 2024-10-31T03:40:27Z

solidity/contracts/hooks/PolygonZkevmV2Hook.sol

+        bytes calldata _message
+    ) external payable override {
+        bytes32 messageId = keccak256(_message);
+        uint256 gasPayment = interchainGasPaymaster.quoteGasPayment(


childHook.quoteDispatch()

aroralanuk · 2024-10-31T03:52:04Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

+            VERIFIED_MASK_INDEX
+        );
+        if (_msgValue > 0) {
+            verifiedMessages[messageId] -= _msgValue;


send extra msgValue (via the metadata) so we don't have leftover here

aroralanuk · 2024-10-31T03:55:38Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

+     * @dev off-chain verification information for a given message.
+     * @param _message The message for which off-chain verification information is requested.
+     */
+    function getOffchainVerifyInfo(


why do we need CCIP here, the relayer will be calling the verify function, no?

maybe helpful to make a quick mermaid diagram.

@curlypoint did make a diagram for v1, v2 also follows similar flow.

yeah, that's something that was needed to be discussed as bridge needs to generate a proof to claim. the ccip call was for the hyperlane relayer to get that proof using PolygonZKevm api (tho that does not follow the ccip spec.

https://github.com/curlypoint/hyperlane-zkevm-ccip

aroralanuk · 2024-10-31T03:56:17Z

solidity/contracts/isms/hook/PolygonZkevmV2Ism.sol

+ * @notice Polygon zkEVM chain Ism that uses the Polygon zkEVM bridge to verify messages
+ */
+contract PolygonZkevmV2Ism is
+    ICcipReadIsm,


similar comments to v1

aroralanuk · 2024-10-31T03:58:40Z

solidity/contracts/isms/hook/PolygonZkevmV2Ism.sol

+     * @inheritdoc AbstractMessageIdAuthorizedIsm
+     */
+    function _isAuthorized() internal view override returns (bool) {
+        bytes32 originSender = abi.decode(msg.data[4:], (bytes32));


don't we need to access control msg.sender since msg.data[4:] can be arbitrarily set by the caller?

aroralanuk · 2024-10-31T03:58:55Z

solidity/contracts/mock/MockInterchainGasPaymaster.sol

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0


we already have TestInterchainGasPaymaster

iamzubin added 5 commits September 11, 2024 02:41

fix: abi.encodePacked => abi.endcode

61a1f84

add zkevm v2 ism

ba05d39

Merge branch 'hyperlane-xyz:main' into polygonZkevm

628fc75

polygon zkevm v2 update with test

f73a953

Merge branch 'hyperlane-xyz:main' into polygonZkevm

0f8bc70

iamzubin requested review from aroralanuk, tkporter and yorhodes as code owners September 22, 2024 20:43

iamzubin changed the title ~~Polygon ZKevm v2 hook and ism~~ feat: Polygon ZKevm v2 hook and ism Sep 22, 2024

missed changes

1b9ac7a

iamzubin mentioned this pull request Sep 24, 2024

Polygon zkEVM Hooks and ISMs #2848

Open

aroralanuk reviewed Oct 31, 2024

View reviewed changes

aroralanuk suggested changes Oct 31, 2024

View reviewed changes

		@@ -0,0 +1,25 @@
		// SPDX-License-Identifier: MIT OR Apache-2.0

Conversation

iamzubin commented Sep 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Sep 22, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aroralanuk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

iamzubin commented Sep 22, 2024 •

edited

Loading

changeset-bot bot commented Sep 22, 2024 •

edited

Loading