Polygon ZKevm hook and ism #3136

curlypoint · 2024-01-08T21:09:28Z

Description

This PR includes the hook and ISM contract for polygon's zkEVM chain.

The contracts utilise the polygon zkevm bridge contracts to make sure the origin of the cross chain message is trusted, this relies on the fact that zkevm bridge uses exit nodes to verify the integrity.

more details can be found here

PR for docs : PR#40

Drive-by changes

nothing as of now

Related issues

Fixes Polygon zkEVM Hooks and ISMs #2848

Backward compatibility

Yes

Testing

🚧 Work in progress 🚧

changeset-bot · 2024-01-08T21:09:32Z

⚠️ No Changeset found

Latest commit: c4130b5

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

curlypoint · 2024-01-09T23:04:43Z

it seems they require an off chain compute server to get the smt proof and submit the claim transaction on the destination chain.

they do have their own server that provides the proof needed see this , or we can host our own using this

where should I write the script that's needed by the validators running for zkevm L1 and L2, and which path should I go ahead with? (edited)

yorhodes · 2024-01-10T22:13:11Z

it seems they require an off chain compute server to get the smt proof and submit the claim transaction on the destination chain.

You can use the CCIP Read ISM to do the offchain lookup

…nstead of message through brigde

curlypoint · 2024-01-14T00:14:00Z

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

Hey sorry for the confusion, I was talking about this. for now I've made a repo on my own account, we can move this to hyperlane repo once I figure where to put it

curlypoint · 2024-01-15T21:17:06Z

also, Having troubles in the testcases, might need some help there.

I also need help with the CCIP server implementation, where should I include those files in the PR.

meanwhile, if someone can just do a little sanity check with the PR, that'd be amazing too.

yorhodes

its a good start
I havent taken a look at the server implementation yet
I was hoping we dont need a separate server for every CCIP ISM

yorhodes · 2024-01-17T22:53:07Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+    IPolygonZkEVMBridge public immutable zkEvmBridge;
+
+    // left-padded address for ISM to verify messages
+    bytes32 public immutable ism;


because we know this is always an EVM destination, this can be address

yorhodes · 2024-01-17T22:53:48Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+        destinationDomain = _destinationDomain;
+        zkEvmBridge = IPolygonZkEVMBridge(_zkEvmBridge);
+        zkBridgeChainIdDestination = uint8(_zkBridgeChainId);


is the bridge chain ID different from destination domain?

Ahh yes, Polygon Zkevm Bridge uses ID 0 and 1 for Eth-mainnet and rollup chain respectively

yorhodes · 2024-01-17T22:54:14Z

solidity/contracts/interfaces/polygonZkevm/IPolygonZkEVMBridge.sol

in general prefer not to vendor these
can we import this somehow?

I only found this repository for the contracts, I could not find the contracts in any npm package.

yorhodes · 2024-01-17T22:55:58Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+        return true;
+    }
+
+    /// @dev This value is hardcoded to 0 because the Polygon zkEVM bridge does not support fee quotes


how are fees calculated?

Users have to call the claim function on destination chain, we're calling that in verify(metadata,message) call,after fetching the smt proof needed using CCIP.

solidity/contracts/hooks/PolygonZkevmHook.sol

yorhodes · 2024-01-17T22:56:47Z

solidity/contracts/hooks/PolygonZkevmHook.sol

+        );
+        bytes32 messageId = message.id();
+
+        zkEvmBridge.bridgeMessage(


can you pass value {value: metadata.msgValue(0)} here?

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

yorhodes · 2024-01-17T23:08:56Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

+     */
+    function verify(
+        bytes calldata _metadata,
+        bytes calldata


Suggested change

bytes calldata

bytes calldata message

you need to compare message.id() to the payload you passed on the origin chain

yorhodes · 2024-01-17T23:09:49Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

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


I dont really understand this

you need to compare the address originSender from onMessageReceived to the authorizedHook

Umm okay, So I wanted to use the _isAuthorized() for the verification, tho now I feel like just using a normal require check for originSender == TypeCasts.bytes32ToAddress(authorizedHook) would be better.

I was just slicing the function selector and just decoding the address to match it with authorisedHook

yorhodes · 2024-01-17T23:11:20Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

+     * Verifies the received message.
+     * @inheritdoc IBridgeMessageReceiver
+     */
+    function onMessageReceived(


anyone can call this, we need to restrict it to the zkevmbridge address?

…eep)

curlypoint · 2024-01-18T20:51:33Z

solidity/contracts/isms/hook/AbstractMessageIdAuthorizedIsm.sol

@@ -74,7 +74,7 @@ abstract contract AbstractMessageIdAuthorizedIsm is
        bytes calldata,
        /*_metadata*/
        bytes calldata message
-    ) external returns (bool) {
+    ) external virtual returns (bool) {


Needed to modify this function as relayer caller verify after the CCIP call

curlypoint · 2024-01-18T21:14:52Z

solidity/contracts/isms/hook/PolygonZkevmIsm.sol

+            originNetwork,
+            originAddress,
+            zkEvmBridgeDestinationNetId,
+            address(this),


was running into stack too deep, this should revert if does not match.

avious00 · 2024-01-25T15:50:29Z

hey @curlypoint let me know when Yorke's comments are resolved and you'd like another review. thanks for contributing!

curlypoint · 2024-01-26T18:07:57Z

Hey @avious00 , sorry for a delayed response, I made the requested changes, but I'm out of luck writing testcases on foundry. I need some help with that, rest of the PR requirements are fulfilled though :)

avious00 · 2024-03-05T22:54:02Z

sorry for missing your message @curlypoint - @aroralanuk can you share some advice or references here that could help them?

iamzubin · 2024-09-10T14:59:35Z

I'd like to continue the work on this PR.

WIP : Polygon ZKevm hook and ism

67478f7

curlypoint mentioned this pull request Jan 10, 2024

Polygon zkEVM Hooks and ISMs #2848

Open

curlypoint and others added 4 commits January 11, 2024 19:58

Merge branch 'hyperlane-xyz:main' into main

5926110

WIP : Use CCIP protocol to fetch proofs

bc02510

fixes for hook

b5bb215

Add PolygonZkEVM bridge message receiver interface, pass message id i…

959b819

…nstead of message through brigde

curlypoint added 2 commits January 14, 2024 05:45

TODO: test cases

6f89d45

add some docs

47f90ea

curlypoint mentioned this pull request Jan 15, 2024

add docs for polygonZkevm Bridge and hook hyperlane-xyz/v3-docs#40

Open

Try testing

3b85f3d

curlypoint marked this pull request as ready for review January 15, 2024 18:53

curlypoint requested review from yorhodes, tkporter and aroralanuk as code owners January 15, 2024 18:53

revert extra changes to abstractmessageidautharizedism

ab9a927

yorhodes reviewed Jan 17, 2024

View reviewed changes

curlypoint added 2 commits January 18, 2024 20:04

Fix: requested changes

ebc73a6

add test, add check for messageId in verify ism (ran into stack too d…

c4130b5

…eep)

curlypoint commented Jan 18, 2024

View reviewed changes

iamzubin mentioned this pull request Sep 22, 2024

feat: Polygon ZKevm v2 hook and ism #4547

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Polygon ZKevm hook and ism #3136

Polygon ZKevm hook and ism #3136

curlypoint commented Jan 8, 2024 •

edited

Loading

changeset-bot bot commented Jan 8, 2024 •

edited

Loading

curlypoint commented Jan 9, 2024 •

edited

Loading

yorhodes commented Jan 10, 2024

curlypoint commented Jan 14, 2024

curlypoint commented Jan 15, 2024

yorhodes left a comment

yorhodes Jan 17, 2024

yorhodes Jan 17, 2024

curlypoint Jan 18, 2024 •

edited

Loading

yorhodes Jan 17, 2024

curlypoint Jan 18, 2024

yorhodes Jan 17, 2024

curlypoint Jan 18, 2024 •

edited

Loading

yorhodes Jan 17, 2024

yorhodes Jan 17, 2024

yorhodes Jan 17, 2024

yorhodes Jan 17, 2024

curlypoint Jan 18, 2024

yorhodes Jan 17, 2024

curlypoint Jan 18, 2024

curlypoint Jan 18, 2024

avious00 commented Jan 25, 2024

curlypoint commented Jan 26, 2024

avious00 commented Mar 5, 2024

iamzubin commented Sep 10, 2024

Polygon ZKevm hook and ism #3136

Are you sure you want to change the base?

Polygon ZKevm hook and ism #3136

Conversation

curlypoint commented Jan 8, 2024 • edited Loading

Description

Drive-by changes

Related issues

Backward compatibility

Testing

changeset-bot bot commented Jan 8, 2024 • edited Loading

⚠️ No Changeset found

curlypoint commented Jan 9, 2024 • edited Loading

yorhodes commented Jan 10, 2024

curlypoint commented Jan 14, 2024

curlypoint commented Jan 15, 2024

yorhodes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

curlypoint Jan 18, 2024 • edited Loading

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

curlypoint Jan 18, 2024 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

avious00 commented Jan 25, 2024

curlypoint commented Jan 26, 2024

avious00 commented Mar 5, 2024

iamzubin commented Sep 10, 2024

curlypoint commented Jan 8, 2024 •

edited

Loading

changeset-bot bot commented Jan 8, 2024 •

edited

Loading

curlypoint commented Jan 9, 2024 •

edited

Loading

curlypoint Jan 18, 2024 •

edited

Loading

curlypoint Jan 18, 2024 •

edited

Loading