Merge pull request #129 from OffchainLabs/update-tutorials-5

Update tutorials to ArbSDK v4 (5)

Author: TucksonDev

README.md

@@ -31,9 +31,9 @@ yarn install
 #### :white_check_mark: General interop
 
 - 🤝 [Greeter](./packages/greeter/) (parent to child messages)
-- 📤 [Outbox](./packages/outbox-execute/) (child to parent messages)
+- 📤 [Outbox tutorial: execute a child-to-parent message](./packages/outbox-execute/) (child to parent messages)
 - ⏰ [Parent chain confirmation checker](./packages/parent-chain-confirmation-checker/)
-- ⏰ [L2 block verification in assertion](./packages/l2-block-verification-in-assertion/)
+- ⏰ [Block verification in parent chain's assertion](./packages/block-verification-in-parent-chain-assertion/)
 
 #### :white_check_mark: Advanced features
 
@@ -53,4 +53,6 @@ To do that, fill the information of your chain in the [`customNetwork.json`](./c
 
 To obtain the information of a specific chain, you can use the method [`prepareArbitrumNetwork`](https://github.com/OffchainLabs/arbitrum-orbit-sdk/blob/main/src/utils/registerNewNetwork.ts#L18) of the Orbit SDK.
 
+You can also register multiple chains if you need to (for example, for the `l1-l3-teleport` tutorial). In that case, create an array of chain information objects in the `customNetwork.json` file.
+
 <p align="center"><img src="assets/logo.svg" width="300"></p>

customNetwork.json

@@ -5,7 +5,7 @@
     "bridge": "0x5eCF728ffC5C5E802091875f96281B5aeECf6C49",
     "inbox": "0x9f8c1c641336A371031499e3c362e40d58d0f254",
     "outbox": "0x50143333b44Ea46255BEb67255C9Afd35551072F",
-    "rollup": "0x837Fadd53667eFCE195D5B75063aaB277f7d712C",
+    "rollup": "0x7d98BA231d29D5C202981542C0291718A7358c63",
     "sequencerInbox": "0x18d19C5d3E685f5be5b9C86E097f0E439285D216"
   },
   "explorerUrl": "",

packages/address-table/scripts/exec.js

@@ -7,8 +7,8 @@ const { arbLog, requireEnvVariables } = require('arb-shared-dependencies')
 const {
   ARB_ADDRESS_TABLE_ADDRESS,
 } = require('@arbitrum/sdk/dist/lib/dataEntities/constants')
-requireEnvVariables(['PRIVATE_KEY', 'CHAIN_RPC'])
 require('dotenv').config()
+requireEnvVariables(['PRIVATE_KEY', 'CHAIN_RPC'])
 
 /**
  * Set up: instantiate wallets connected to providers

packages/arb-shared-dependencies/index.js

@@ -68,7 +68,13 @@ const addCustomNetworkFromFile = () => {
     'utf8'
   )
   const customNetworkInformation = JSON.parse(customNetworkFileContents)
-  registerCustomArbitrumNetwork(customNetworkInformation)
+  if (customNetworkInformation instanceof Array) {
+    customNetworkInformation.map(customNetwork =>
+      registerCustomArbitrumNetwork(customNetwork)
+    )
+  } else {
+    registerCustomArbitrumNetwork(customNetworkInformation)
+  }
 }
 
 module.exports = {

packages/block-verification-in-parent-chain-assertion/.env-sample

@@ -0,0 +1,10 @@
+# This is a sample .env file for use in local development.
+# Duplicate this file as .env here
+
+# The main chain's RPC
+# (this can be an Arbitrum network, or your Orbit chain)
+CHAIN_RPC="https://sepolia-rollup.arbitrum.io/rpc"
+
+# The parent chain's RPC
+# (this can be Ethereum, or the chain your Orbit chain settles to)
+PARENT_CHAIN_RPC="https://sepolia.infura.io/v3/<your infura key>"

packages/block-verification-in-parent-chain-assertion/README.md

@@ -0,0 +1,31 @@
+# Block verification in an assertion posted on the parent chain
+
+This tutorial shows how to verify whether a block of a chain has been processed as part of an RBlock assertion on its parent chain.
+
+It uses the `Rollup` contract to find the latest confirmed (or created if configured in the script) RBlock/node, find the event that created it, and get the latest processed block hash of the child chain that's part of the assertion of that RBlock/node.
+
+Then it checks whether the block number passed as argument was created before the latest block hash of the child chain processed.
+
+See [./exec.js](./scripts/exec.js) for inline explanations.
+
+## Set environment variables
+
+Set the values shown in `.env-sample` as environmental variables. To copy it into a `.env` file:
+
+```bash
+cp .env-sample .env
+```
+
+You'll still need to edit some variables, i.e., `CHAIN_RPC` and `PARENT_CHAIN_RPC`.
+
+Note that you can also set the environment variables in an `.env` file in the root of the monorepo, which will be available in all tutorials.
+
+## Run
+
+```shell
+yarn run exec {block_number}
+```
+
+<p align="left">
+  <img width="350" height="150" src= "../../assets/logo.svg" />
+</p>

packages/block-verification-in-parent-chain-assertion/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "block-verification-in-parent-chain-assertion",
+  "version": "1.0.0",
+  "description": "This tutorial shows how to verify whether a block has been processed as part of an RBlock assertion on the parent chain.",
+  "scripts": {
+    "exec": "ts-node scripts/exec.ts"
+  },
+  "dependencies": {
+    "@arbitrum/sdk": "^v4.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
+  }
+}

packages/block-verification-in-parent-chain-assertion/scripts/exec.ts

@@ -0,0 +1,105 @@
+import { providers, Contract } from "ethers"
+import { getArbitrumNetwork } from '@arbitrum/sdk'
+import { RollupCore__factory } from "@arbitrum/sdk/dist/lib/abi/factories/RollupCore__factory"
+import { arbLog, requireEnvVariables, addCustomNetworkFromFile } from 'arb-shared-dependencies'
+require('dotenv').config()
+requireEnvVariables(['CHAIN_RPC', 'PARENT_CHAIN_RPC'])
+
+/**
+ * Set up: instantiate wallets connected to providers
+ */
+const parentChainProvider = new providers.JsonRpcProvider(
+  process.env.PARENT_CHAIN_RPC
+)
+const childChainProvider = new providers.JsonRpcProvider(process.env.CHAIN_RPC)
+
+/**
+ * Use the latest node created instead of the last confirmed one
+ */
+const useCreatedNodeInsteadOfConfirmed = false;
+
+const main = async (childChainBlockNumberToVerify: number) => {
+  await arbLog('Find whether a block of the child chain has been processed as part of an RBlock on the parent chain')
+
+  /**
+   * Add the custom network configuration to the SDK if present
+   */
+  addCustomNetworkFromFile()
+
+  /**
+   * Use childChainNetwork to find the Rollup contract's address and instantiate a contract handler
+   */
+  const childChainNetwork = await getArbitrumNetwork(childChainProvider)
+  const rollupAddress = childChainNetwork.ethBridge.rollup
+  const rollup = new Contract(rollupAddress, RollupCore__factory.abi, parentChainProvider)
+  console.log(`Rollup contract found at address ${rollup.address}`)
+  
+  /**
+   * Get the latest node created or confirmed
+   */
+  const nodeId = useCreatedNodeInsteadOfConfirmed ? await rollup.latestNodeCreated() : await rollup.latestConfirmed()
+  console.log(`Latest ${useCreatedNodeInsteadOfConfirmed ? 'created' : 'confirmed'} Rblock/node: ${nodeId}`)
+
+  /**
+   * Find the NodeCreated event
+   */
+  const nodeCreatedEventFilter = rollup.filters.NodeCreated(nodeId)
+  const nodeCreatedEvents = await rollup.queryFilter(nodeCreatedEventFilter)
+  if (!nodeCreatedEvents) {
+    console.error(`INTERNAL ERROR: NodeCreated events not found for Rblock/node: ${nodeId}`)
+    return
+  }
+  const nodeCreatedEvent = nodeCreatedEvents[0]
+  console.log(`NodeCreated event found in transaction ${nodeCreatedEvent.transactionHash}`)
+
+  /**
+   * Finding the assertion within the NodeCreated event, and getting the afterState
+   */
+  if (!nodeCreatedEvent.args) {
+    console.error(`INTERNAL ERROR: NodeCreated event does not have an assertion for Rblock/node: ${nodeId}`)
+    return
+  }
+  const assertion = nodeCreatedEvent.args.assertion
+  const afterState = assertion.afterState
+
+  /**
+   * Latest child chain's block hash processed is in the first element of the bytes32Vals property in the globalState
+   */
+  const lastChildChainBlockHash = afterState.globalState.bytes32Vals[0]
+  console.log(`Last block hash of the child chain processed in this Rblock/node: ${lastChildChainBlockHash}`)
+
+  /**
+   * Getting the block number from that block hash
+   */
+  const lastChildChainBlock = await childChainProvider.getBlock(lastChildChainBlockHash)
+  const lastChildChainBlockNumber = lastChildChainBlock.number
+  console.log(`Last block number of the child chain processed in this Rblock/node: ${lastChildChainBlockNumber}`)
+
+  /**
+   * Final verification
+   */
+  console.log(`************`)
+  if (lastChildChainBlockNumber > childChainBlockNumberToVerify) {
+    console.log(`${childChainBlockNumberToVerify} has been processed as part of the latest ${useCreatedNodeInsteadOfConfirmed ? 'created' : 'confirmed'} RBlock/node`)
+  } else {
+    console.log(`${childChainBlockNumberToVerify} has NOT been processed as part of the latest ${useCreatedNodeInsteadOfConfirmed ? 'created' : 'confirmed'} RBlock/node`)
+  }
+  console.log(`************`)
+};
+
+// Getting the transaction hash from the command arguments
+if (process.argv.length < 3) {
+  console.log(`Missing block number of the child chain to verify whether it has been processed in the latest ${useCreatedNodeInsteadOfConfirmed ? 'created' : 'confirmed'} RBlock/node`)
+  console.log(`Usage: yarn run exec <block number>`)
+  process.exit()
+}
+
+const childChainBlockNumber = Number(process.argv[2]);
+
+// Calling main
+main(childChainBlockNumber)
+  .then(() => process.exit(0))
+  .catch(error => {
+      console.error(error)
+      process.exit(1)
+  });

packages/contract-deposit/scripts/exec.js

@@ -18,6 +18,7 @@ const {
   ParentEthDepositTransactionReceipt,
 } = require('@arbitrum/sdk')
 const { getBaseFee } = require('@arbitrum/sdk/dist/lib/utils/lib')
+require('dotenv').config()
 requireEnvVariables([
   'PRIVATE_KEY',
   'CHAIN_RPC',

packages/greeter/scripts/exec.js

@@ -15,6 +15,7 @@ const {
   getArbitrumNetwork,
 } = require('@arbitrum/sdk')
 const { getBaseFee } = require('@arbitrum/sdk/dist/lib/utils/lib')
+require('dotenv').config()
 requireEnvVariables(['PRIVATE_KEY', 'CHAIN_RPC', 'PARENT_CHAIN_RPC'])
 
 /**