WIP

pages/interop/tutorials/message-passing/manual-relay.mdx

@@ -59,7 +59,7 @@ Learn to relay transactions directly by sending the correct transaction.
 
 ### What you'll build
 
-*   A program to relay messages without using [the JavaScript library](https://www.npmjs.com/package/@eth-optimism/viem)
+*   A program to relay messages using [the JavaScript library](https://www.npmjs.com/package/@eth-optimism/viem)
 *   A shell script to relay messages using [`cast`](https://book.getfoundry.sh/cast/)
 
 ## Setup
@@ -103,7 +103,7 @@ These steps are necessary to run the tutorial, regardless of whether you are usi
       mkdir -p manual-relay/offchain
       cd manual-relay/offchain
       npm init -y
-      npm install --save-dev -y viem @eth-optimism/viem
+      npm install --save-dev viem @eth-optimism/viem
       mkdir src
       ```
 
@@ -183,132 +183,140 @@ These steps are necessary to run the tutorial, regardless of whether you are usi
 
 ## Manual relay using `cast`
 
-Run this script:
-
-```sh
-./manual-relay/sendAndRelay.sh
-```
+You can see an example of how to manually relay using `cast` in `manual-relay/sendAndRelay.sh`. 
+It is somewhat complicated, so the setup creates one that is tailored to your environment.
 
-### What does the script do?
+<details>
+  <summary>Explanation</summary>
+
+  ```sh
+  #! /bin/sh
+  PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
+  USER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+  URL_CHAIN_A=http://localhost:9545
+  URL_CHAIN_B=http://localhost:9546
+  GREETER_A_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
+  GREETER_B_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
+  CHAIN_ID_B=902
+  ```
 
-```sh
-#! /bin/sh
-PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80
-USER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
-URL_CHAIN_A=http://localhost:9545
-URL_CHAIN_B=http://localhost:9546
-GREETER_A_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
-GREETER_B_ADDRESS=0x5FbDB2315678afecb367f032d93F642f64180aa3
-CHAIN_ID_B=902
-```
+  This is the configuration.
+  The greeter addresses are identical because the nonce for the user address has an identical nonce on both chains.
 
-This is the configuration.
-The greeter addresses are identical because the nonce for the user address has an identical nonce on both chains.
+  ```sh
+  cast send -q --private-key $PRIVATE_KEY --rpc-url $URL_CHAIN_A $GREETER_A_ADDRESS "setGreeting(string)" "Hello from chain A $$"
+  ```
 
-```sh
-cast send -q --private-key $PRIVATE_KEY --rpc-url $URL_CHAIN_A $GREETER_A_ADDRESS "setGreeting(string)" "Hello from chain A $$"
-```
+  Send a message from chain A to chain B. The `$$` is the process ID, so if you rerun the script you'll see that the information changes.
 
-Send a message from chain A to chain B. The `$$` is the process ID, so if you rerun the script you'll see that the information changes.
+  ```sh
+  cast logs "SentMessage(uint256,address,uint256,address,bytes)" --rpc-url $URL_CHAIN_A | tail -14 > log-entry
+  ```
 
-```sh
-cast logs "SentMessage(uint256,address,uint256,address,bytes)" --rpc-url $URL_CHAIN_A | tail -14 > log-entry
-```
+  Whenever `L2ToL2CrossDomainMessenger` sends a message to a different blockchain, it emits a [`SendMessage`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/L2ToL2CrossDomainMessenger.sol#L83-L91) event.
+  Extract only the latest `SendMessage` event from the logs.
+
+  <details>
+    <summary>Example `log-entry`</summary>
+
+    ```yaml
+    - address: 0x4200000000000000000000000000000000000023
+      blockHash: 0xcd0be97ffb41694faf3a172ac612a23f224afc1bfecd7cb737a7a464cf5d133e
+      blockNumber: 426
+      data: 0x0000000000000000000000005fbdb2315678afecb367f032d93f642f64180aa300000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000064a41368620000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001948656c6c6f2066726f6d20636861696e2041203131333030370000000000000000000000000000000000000000000000000000000000000000000000
+      logIndex: 0
+      removed: false
+      topics: [
+              0x382409ac69001e11931a28435afef442cbfd20d9891907e8fa373ba7d351f320
+              0x0000000000000000000000000000000000000000000000000000000000000386
+              0x0000000000000000000000005fbdb2315678afecb367f032d93f642f64180aa3
+              0x0000000000000000000000000000000000000000000000000000000000000000
+      ]
+      transactionHash: 0x1d6f2e5e2c8f3eb055e95741380ca36492f784b9782848b66b66c65c5937ff3a
+      transactionIndex: 0
+    ```
+  </details>
+
+  ```sh
+  TOPICS=`cat log-entry | grep -A4 topics | awk '{print $1}' | tail -4 | sed 's/0x//'`
+  TOPICS=`echo $TOPICS | sed 's/ //g'`
+  ```
 
-Whenever `L2ToL2CrossDomainMessenger` sends a message to a different blockchain, it emits a [`SendMessage`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/L2ToL2CrossDomainMessenger.sol#L83-L91) event.
-Extract only the latest `SendMessage` event from the logs.
+  Consolidate the log topics into a single hex string.
 
-<details>
-  <summary>Example `log-entry`</summary>
-
-  ```yaml
-  - address: 0x4200000000000000000000000000000000000023
-    blockHash: 0xcd0be97ffb41694faf3a172ac612a23f224afc1bfecd7cb737a7a464cf5d133e
-    blockNumber: 426
-    data: 0x0000000000000000000000005fbdb2315678afecb367f032d93f642f64180aa300000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000064a41368620000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001948656c6c6f2066726f6d20636861696e2041203131333030370000000000000000000000000000000000000000000000000000000000000000000000
-    logIndex: 0
-    removed: false
-    topics: [
-            0x382409ac69001e11931a28435afef442cbfd20d9891907e8fa373ba7d351f320
-            0x0000000000000000000000000000000000000000000000000000000000000386
-            0x0000000000000000000000005fbdb2315678afecb367f032d93f642f64180aa3
-            0x0000000000000000000000000000000000000000000000000000000000000000
-    ]
-    transactionHash: 0x1d6f2e5e2c8f3eb055e95741380ca36492f784b9782848b66b66c65c5937ff3a
-    transactionIndex: 0
+  ```sh
+  ORIGIN=0x4200000000000000000000000000000000000023
+  BLOCK_NUMBER=`cat log-entry | awk '/blockNumber/ {print $2}'`
+  LOG_INDEX=`cat log-entry | awk '/logIndex/ {print $2}'`
+  TIMESTAMP=`cast block $BLOCK_NUMBER --rpc-url $URL_CHAIN_A | awk '/timestamp/ {print $2}'`
+  CHAIN_ID_A=`cast chain-id --rpc-url $URL_CHAIN_A`
+  SENT_MESSAGE=`cat log-entry | awk '/data/ {print $2}'`
   ```
-</details>
 
-```sh
-TOPICS=`cat log-entry | grep -A4 topics | awk '{print $1}' | tail -4 | sed 's/0x//'`
-TOPICS=`echo $TOPICS | sed 's/ //g'`
-```
+  Read additional fields from the log entry.
 
-Consolidate the log topics into a single hex string.
+  ```sh
+  LOG_ENTRY=0x`echo $TOPICS$SENT_MESSAGE | sed 's/0x//'`
+  ```
 
-```sh
-ORIGIN=0x4200000000000000000000000000000000000023
-BLOCK_NUMBER=`cat log-entry | awk '/blockNumber/ {print $2}'`
-LOG_INDEX=`cat log-entry | awk '/logIndex/ {print $2}'`
-TIMESTAMP=`cast block $BLOCK_NUMBER --rpc-url $URL_CHAIN_A | awk '/timestamp/ {print $2}'`
-CHAIN_ID_A=`cast chain-id --rpc-url $URL_CHAIN_A`
-SENT_MESSAGE=`cat log-entry | awk '/data/ {print $2}'`
-```
+  Consolidate the entire log entry.
+
+  ```sh
+  RPC_PARAMS=$(cat <<INNER_END_OF_FILE
+  {
+      "origin": "$ORIGIN",
+      "blockNumber": "$BLOCK_NUMBER",
+      "logIndex": "$LOG_INDEX",
+      "timestamp": "$TIMESTAMP",
+      "chainId": "$CHAIN_ID_A",
+      "payload": "$LOG_ENTRY"
+  }
+  INNER_END_OF_FILE
+  )
+
+  ACCESS_LIST=`cast rpc admin_getAccessListForIdentifier --rpc-url http://localhost:8420 "$RPC_PARAMS" | jq .accessList`
+  ```
 
-Read additional fields from the log entry.
+  To secure cross-chain messaging and prevent potential [denial-of-service attacks](https://github.com/ethereum-optimism/design-docs/blob/main/protocol/interop-access-list.md), relay transactions require properly formatted access lists that include a checksum derived from the message data.
+  This lets sequencers know what executing messages to expect in a transaction, which makes it easy not to include transactions that are invalid because they rely on messages that were never sent.
 
-```sh
-LOG_ENTRY=0x`echo $TOPICS$SENT_MESSAGE | sed 's/0x//'`
-```
+  The [algorithm to calculate the access list](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/CrossL2Inbox.sol#L87-L115) is a bit complicated, but you don't need to worry about it.
+  Supersim exposes [RPC calls](https://supersim.pages.dev/guides/interop/cast?highlight=manuall#7-construct-the-access-list-for-the-message) that calculates it for you on port 8420.
+  The code above will calculate the correct access list even if you're using a different interop cluster where autorelay is not functioning. 
+  This is because the code implements a [pure function](https://en.wikipedia.org/wiki/Pure_function), which produces consistent results regardless of external state.
+  In contrast, the `admin_getAccessListByMsgHash` RPC call is not a pure function, it is dependent on system state and therefore less flexible in these situations.
 
-Consolidate the entire log entry.
+  ```sh
+  echo Old greeting
+  cast call $GREETER_B_ADDRESS "greet()(string)" --rpc-url $URL_CHAIN_B
+  ```
 
-```sh
-RPC_PARAMS=$(cat <<INNER_END_OF_FILE
-{
-    "origin": "$ORIGIN",
-    "blockNumber": "$BLOCK_NUMBER",
-    "logIndex": "$LOG_INDEX",
-    "timestamp": "$TIMESTAMP",
-    "chainId": "$CHAIN_ID_A",
-    "payload": "$LOG_ENTRY"
-}
-INNER_END_OF_FILE
-)
-
-ACCESS_LIST=`cast rpc admin_getAccessListForIdentifier --rpc-url http://localhost:8420 "$RPC_PARAMS" | jq .accessList`
-```
+  Show the current greeting.
+  The message has not been relayed yet, so it's still the old greeting.
 
-To secure cross-chain messaging and prevent potential [denial-of-service attacks](https://github.com/ethereum-optimism/design-docs/blob/main/protocol/interop-access-list.md), relay transactions require properly formatted access lists that include a checksum derived from the message data.
-This lets sequencers know what executing messages to expect in a transaction, which makes it easy not to include transactions that are invalid because they rely on messages that were never sent.
+  ```sh
+  cast send -q $ORIGIN "relayMessage((address,uint256,uint256,uint256,uint256),bytes)" "($ORIGIN,$BLOCK_NUMBER,$LOG_INDEX,$TIMESTAMP,$CHAIN_ID_A)" $LOG_ENTRY --access-list "$ACCESS_LIST" --rpc-url $URL_CHAIN_B --private-key $PRIVATE_KEY
+  ```
 
-The [algorithm to calculate the access list](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/CrossL2Inbox.sol#L87-L115) is a bit complicated, but you don't need to worry about it.
-Supersim exposes [RPC calls](https://supersim.pages.dev/guides/interop/cast?highlight=manuall#7-construct-the-access-list-for-the-message) that calculates it for you on port 8420.
-The code above will calculate the correct access list even if you're using a different interop cluster where autorelay is not functioning. 
-This is because the code implements a [pure function](https://en.wikipedia.org/wiki/Pure_function), which produces consistent results regardless of external state.
-In contrast, the `admin_getAccessListByMsgHash` RPC call is not a pure function, it is dependent on system state and therefore less flexible in these situations.
+  Call [`relayMessage`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/L2ToL2CrossDomainMessenger.sol#L197-L256) to relay the message.
 
-```sh
-echo Old greeting
-cast call $GREETER_B_ADDRESS "greet()(string)" --rpc-url $URL_CHAIN_B
-```
+  ```sh
+  echo New greeting
+  cast call $GREETER_B_ADDRESS "greet()(string)" --rpc-url $URL_CHAIN_B
+  ```
 
-Show the current greeting.
-The message has not been relayed yet, so it's still the old greeting.
+  Again, show the current greeting.
+  Now it's the new one.
+
+</details>
 
-```sh
-cast send -q $ORIGIN "relayMessage((address,uint256,uint256,uint256,uint256),bytes)" "($ORIGIN,$BLOCK_NUMBER,$LOG_INDEX,$TIMESTAMP,$CHAIN_ID_A)" $LOG_ENTRY --access-list "$ACCESS_LIST" --rpc-url $URL_CHAIN_B --private-key $PRIVATE_KEY
-```
 
-Call [`relayMessage`](https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts-bedrock/src/L2/L2ToL2CrossDomainMessenger.sol#L197-L256) to relay the message.
+Run this script:
 
 ```sh
-echo New greeting
-cast call $GREETER_B_ADDRESS "greet()(string)" --rpc-url $URL_CHAIN_B
+./manual-relay/sendAndRelay.sh
 ```
 
-Again, show the current greeting.
-Now it's the new one.
 
 ## Next steps