Hyperlane Developer Experience Demo

integrations/hyperlane/HyperlaneDevExDemo.md

@@ -0,0 +1,27 @@
+# Hyperlane DevEx Demo
+
+This document outlines a demo of what the developer experience could be when using Hyperlane as a wrapper over OP's Native Interop.
+
+## Context
+
+OP's Native Interop allows developers to send cross-chain messages and native msg.value without taking on additional trust assumptions (beyond what the rollups themselves take on). However, a challenging aspect of any cross-chain messaging protocol is the need for the 2nd executing transaction. In Hyperlane's experience, exposing that complexity to users is very undesirable, and in practice a dedicated entity has to take on this task (and be paid for it). This demo showcases how a Hyperlane wrapper could allow Hyperlane relayers (which are completely permissionless) to do that work for OP native interop developers.
+
+This demo demonstrates the basic ergonomics for developers and how a relayer would work. Additional improvements to the demonstration including integrating the actual native interop trust assumptions are marked under [Future Improvements](#future-improvements)
+
+## Setup
+
+1. Follow the `supersim` setup guide and run supersim
+2. Install the hyperlane cli `npm install -g @hyperlane-xyz/cli@5.6.0-superchain.1`
+3. Set the private key for usage in subsequent demand in our shell. We are going to use the last default account (since the earlier ones seem to have nonce issues) `export HYP_KEY=0x2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6`
+4. Deploy Hyperlane on OpChainA `hyperlane core deploy --chain opchaina --yes --overrides ./integrations/hyperlane/hyperlane-registry --config $(pwd)/integrations/hyperlane/core-config.yaml`
+5. Deploy Hyperlane on OpChainB `hyperlane core deploy --chain opchainb --yes --overrides ./integrations/hyperlane/hyperlane-registry --config $(pwd)/integrations/hyperlane/core-config.yaml`
+6. Deploy the Superchain specific contracts with `hyperlane deploy-superchain-contracts --overrides $(pwd)/integrations/hyperlane/hyperlane-registry`. This will deploy the SuperchainHook and SuperchainISM and will set it as the default for messages sent via the Hyperlane mailbox.
+7. In a separate process (with the key again set as per Step 3.), you can run the relayer with `hyperlane relayer --chains opchaina,opchainb --overrides $(pwd)/integrations/hyperlane/hyperlane-registry`.
+8. Send a message via Hyperlane with `hyperlane send message --origin opchaina --destination opchainb --body "Hello from OpChainA via Hyperlane-enabled native interop" --overrides $(pwd)/integrations/hyperlane/hyperlane-registry`. This will call the [`Mailbox#dispatch`](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/Mailbox.sol#L102) function (think of it similar to CrossDomainMessenger's sendMessage function) with a [`TestRecipient`](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/f7333794883759dda9dc45b1ce56ce2452e93785/solidity/contracts/test/TestRecipient.sol#L30) as the receiver of that message. You should observe that the relayer automatically processes the previously dispatched message, without the message sender (i.e. the application), nor the user needing to do anything on the destination chain. You should also see in the Supersim logs that the message was secured using native interop, i.e. no additional trust assumptions had to be taken on.
+
+
+
+## Future Improvements
+
+- Integrate with TicTacToe.sol to show integration
+- Deploy Interchain Gas Paymaster to demonstrate seamless relayer payments by the message sender

integrations/hyperlane/core-config.yaml

@@ -0,0 +1,13 @@
+defaultHook:
+  type: merkleTreeHook
+defaultIsm:
+  relayer: "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"
+  type: trustedRelayerIsm
+owner: "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"
+requiredHook:
+  beneficiary: "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"
+  maxProtocolFee: "100000000000000000"
+  owner: "0xa0Ee7A142d267C1f36714E4a8F75612F20a79720"
+  protocolFee: "0"
+  type: protocolFee
+

integrations/hyperlane/hyperlane-registry/chains/l1/metadata.yaml

@@ -0,0 +1,13 @@
+# yaml-language-server: $schema=../schema.json
+chainId: 900
+displayName: L1
+domainId: 900
+isTestnet: true
+name: l1
+nativeToken:
+  decimals: 18
+  name: Ether
+  symbol: ETH
+protocol: ethereum
+rpcUrls:
+  - http: http://localhost:8545

integrations/hyperlane/hyperlane-registry/chains/opchaina/metadata.yaml

@@ -0,0 +1,13 @@
+# yaml-language-server: $schema=../schema.json
+chainId: 901
+displayName: Opchaina
+domainId: 901
+isTestnet: true
+name: opchaina
+nativeToken:
+  decimals: 18
+  name: Ether
+  symbol: ETH
+protocol: ethereum
+rpcUrls:
+  - http: http://localhost:9545

integrations/hyperlane/hyperlane-registry/chains/opchainb/metadata.yaml

@@ -0,0 +1,13 @@
+# yaml-language-server: $schema=../schema.json
+chainId: 902
+displayName: Opchainb
+domainId: 902
+isTestnet: true
+name: opchainb
+nativeToken:
+  decimals: 18
+  name: Ether
+  symbol: ETH
+protocol: ethereum
+rpcUrls:
+  - http: http://localhost:9546