Merge pull request #125 from OffchainLabs/update-tutorials-1

Update tutorials to ArbSDK v4 (1)

Author: TucksonDev

.env-sample

@@ -1,15 +1,13 @@
 # This is a sample .env file for use in local development.
-
 # Duplicate this file as .env here
 
-# Your Private key
-
-DEVNET_PRIVKEY="0x your key here"
-
-# Hosted Aggregator Node (JSON-RPC Endpoint). This is Arbitrum Sepolia Testnet, can use any Arbitrum chain
-
-L2RPC="https://sepolia-rollup.arbitrum.io/rpc"
+# Your private key
+PRIVATE_KEY="0x your key here"
 
-# Ethereum RPC; i.e., for Sepolia https://sepolia.infura.io/v3/<your infura key>
+# The main chain's RPC
+# (this can be an Arbitrum network, or your Orbit chain)
+CHAIN_RPC="https://sepolia-rollup.arbitrum.io/rpc"
 
-L1RPC=""
+# 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>"

README.md

@@ -1,6 +1,6 @@
 # Arbitrum Tutorials
 
-This monorepo will help you get started with building on Arbitrum. It provides various simple demos showing and explaining how to interact with Arbitrum — deploying and using contracts directly on L2, moving Ether and tokens betweens L1 and L2, and more.
+This monorepo will help you get started with building on Arbitrum chains. It provides various simple demos showing and explaining how to interact with Arbitrum chains (including Orbit chains) — deploying and using contracts directly on Arbitrum, moving Ether and tokens betweens the parent and child chains, and more.
 
 We show how you can use broadly supported Ethereum ecosystem tooling (Hardhat, Ethers-js, etc.) as well as our special [Arbitrum SDK](https://github.com/OffchainLabs/arbitrum-sdk) for convenience.
 
@@ -16,30 +16,38 @@ yarn install
 
 #### :white_check_mark: Basics
 
-- 🐹 [Pet Shop DApp](./packages/demo-dapp-pet-shop/) (L2 only)
-- 🗳 [Election DApp](./packages/demo-dapp-election/) (L2 only)
+- 🐹 [Pet Shop DApp](./packages/demo-dapp-pet-shop/)
+- 🗳 [Election DApp](./packages/demo-dapp-election/)
 
-#### :white_check_mark: Moving Stuff around
+#### :white_check_mark: Moving stuff around
 
 - ⤴️ 🔹 [Deposit Ether](./packages/eth-deposit/)
 - ⤵️ 🔹 [Withdraw Ether](./packages/eth-withdraw/)
 - ⤴️ 💸 [Deposit Token](./packages/token-deposit/)
 - ⤵️ 💸 [Withdraw token](./packages/token-withdraw/)
-- ⤴️ 🔹 [L2 Alias Control and Fund Transfer Guide](./packages/contract-deposit/)
+- ⤴️ 🔹 [Contract alias control in the child chain, and fund-transfer guide](./packages/contract-deposit/)
 
 #### :white_check_mark: General interop
 
-- 🤝 [Greeter](./packages/greeter/) (L1 to L2)
-- 📤 [Outbox](./packages/outbox-execute/) (L2 to L1)
+- 🤝 [Greeter](./packages/greeter/) (parent to child messages)
+- 📤 [Outbox](./packages/outbox-execute/) (child to parent messages)
 - ⏰ [L1 Confirmation Checker](./packages/l1-confirmation-checker/)
 - ⏰ [L2 block verification in assertion](./packages/l2-block-verification-in-assertion/)
 
-#### :white_check_mark: Advanced Features
+#### :white_check_mark: Advanced features
 
 - ®️ [Arb Address Table](./packages/address-table/)
 - 🌉 [Bridging Custom Token](./packages/custom-token-bridging/)
 - ✈️ [Delayed inbox message(l2MSG)](./packages/delayedInbox-l2msg/)
 - 🎁 [Redeem Retryable Ticket](./packages/redeem-failed-retryable/)
 - 🌀 [Deposit Ether or Tokens from L1 to L3](./packages/l1-l3-teleport/)
 
+## How to run the tutorials against a custom network
+
+As mentioned above, these tutorials use the [Arbitrum SDK](https://github.com/OffchainLabs/arbitrum-sdk), which loads the regular Arbitrum chains by default (Arbitrum One, Arbitrum Nova and Arbitrum Sepolia). You can use these tutorials against any other Arbitrum chain (including Orbit chains), by loading it to the Arbitrum SDK.
+
+To do that, fill the information of your chain in the [`customNetwork.json`](./customNetwork.json) file., which is automatically loaded in all tutorials.
+
+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.
+
 <p align="center"><img src="assets/logo.svg" width="300"></p>

package.json

@@ -6,7 +6,7 @@
   "license": "Apache-2.0",
   "private": "true",
   "engines": {
-    "node": ">= 8.0.0 < 17.0.0",
+    "node": ">= 8.0.0",
     "npm": "^6.0.0",
     "yarn": "^1.0.0"
   },
@@ -23,7 +23,11 @@
     "prettier-plugin-solidity": "^1.0.0-beta.17"
   },
   "dependencies": {
-    "@arbitrum/sdk": "^3.4.1"
+    "@arbitrum/sdk": "^4.0.1",
+    "@nomiclabs/hardhat-ethers": "^2.0.2",
+    "ethers": "^5.4.1",
+    "hardhat": "^2.2.0",
+    "dotenv": "^16.4.5"
   },
   "workspaces": {
     "packages": [

packages/address-table/.env-sample

@@ -1,5 +1,9 @@
-DEVNET_PRIVKEY="0x your key here"
+# This is a sample .env file for use in local development.
+# Duplicate this file as .env here
 
-# This is Arbitrum Sepolia Testnet, can use any Arbitrum chain
-L2RPC="https://sepolia-rollup.arbitrum.io/rpc"
+# Your private key
+PRIVATE_KEY="0x your key here"
 
+# The main chain's RPC
+# (this can be an Arbitrum network, or your Orbit chain)
+CHAIN_RPC="https://sepolia-rollup.arbitrum.io/rpc"

packages/address-table/README.md

@@ -1,6 +1,6 @@
-# Address Table Demo
+# Address table demo
 
-The Address table is a precompiled contract on Arbitrum for registering addresses which are then retrievable by an integer index; this saves gas by minimizing precious calldata required to input an address as a parameter.
+The Address table is a precompiled contract on Arbitrum chains for registering addresses which are then retrievable by an integer index; this saves gas by minimizing precious calldata required to input an address as a parameter.
 
 This demo shows a simple contract with affordances to retrieve an address from a contract by its index in the address table, and a client-side script to pre-register the given address (if necessary).
 
@@ -12,19 +12,21 @@ See `exec.js` for inline comments / explanation.
  yarn run exec
 ```
 
-## Config Environment Variables
+## 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., `DEVNET_PRIVKEY`)
+You'll still need to edit some variables, i.e., `PRIVATE_KEY` and `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.
 
 ### More info
 
-See our [developer documentation for more info](https://developer.offchainlabs.com/docs/special_features).
+See our [developer documentation for more info](https://docs.arbitrum.io/).
 
 <p align="left">
   <img width="350" height="150" src= "../../assets/logo.svg" />

packages/address-table/contracts/ArbitrumVIP.sol

@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: Unlicense
-pragma solidity ^0.7.2;
+pragma solidity ^0.8.0;
 
 import "@arbitrum/nitro-contracts/src/precompiles/ArbAddressTable.sol";
 import "hardhat/console.sol";
@@ -10,9 +10,9 @@ contract ArbitrumVIP {
 
     ArbAddressTable arbAddressTable;
 
-    constructor() public {
+    constructor() {
         // connect to precomiled address table contract
-        arbAddressTable = ArbAddressTable(102);
+        arbAddressTable = ArbAddressTable(address(102));
     }
 
     function addVIPPoints(uint256 addressIndex) external {

packages/address-table/package.json

@@ -3,17 +3,9 @@
   "license": "Apache-2.0",
   "version": "1.0.0",
   "scripts": {
-    "exec": "hardhat run scripts/exec.js --network l2"
-  },
-  "devDependencies": {
-    "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "@nomiclabs/hardhat-waffle": "^2.0.1",
-    "chai": "^4.3.4",
-    "ethereum-waffle": "^3.4.0",
-    "ethers": "^5.4.2",
-    "hardhat": "^2.5.0"
+    "exec": "hardhat run scripts/exec.js"
   },
   "dependencies": {
-    "@arbitrum/sdk": "^v3.1.9"
+    "@arbitrum/sdk": "^4.0.1"
   }
 }

packages/address-table/scripts/exec.js

@@ -1,40 +1,44 @@
+const { providers, Wallet } = require('ethers')
 const hre = require('hardhat')
 const {
   ArbAddressTable__factory,
 } = require('@arbitrum/sdk/dist/lib/abi/factories/ArbAddressTable__factory')
-const { addDefaultLocalNetwork } = require('@arbitrum/sdk')
 const { arbLog, requireEnvVariables } = require('arb-shared-dependencies')
-requireEnvVariables(['DEVNET_PRIVKEY', 'L2RPC'])
+const {
+  ARB_ADDRESS_TABLE_ADDRESS,
+} = require('@arbitrum/sdk/dist/lib/dataEntities/constants')
+requireEnvVariables(['PRIVATE_KEY', 'CHAIN_RPC'])
 require('dotenv').config()
 
+/**
+ * Set up: instantiate wallets connected to providers
+ */
+const walletPrivateKey = process.env.PRIVATE_KEY
+const provider = new providers.JsonRpcProvider(process.env.CHAIN_RPC)
+const wallet = new Wallet(walletPrivateKey, provider)
+
 async function main() {
   await arbLog('Using the Address Table')
 
   /**
-   * Add the default local network configuration to the SDK
-   * to allow this script to run on a local node
+   * Deploy ArbitrumVIP contract
    */
-  addDefaultLocalNetwork()
-
-  /**
-   * Deploy ArbitrumVIP contract to L2
-   */
-  const ArbitrumVIP = await hre.ethers.getContractFactory('ArbitrumVIP')
-  const arbitrumVIP = await ArbitrumVIP.deploy()
-
+  const ArbitrumVIPContract = await (
+    await hre.ethers.getContractFactory('ArbitrumVIP')
+  ).connect(wallet)
+  console.log('Deploying ArbitrumVIP contract...')
+  const arbitrumVIP = await ArbitrumVIPContract.deploy()
   await arbitrumVIP.deployed()
-
   console.log('ArbitrumVIP deployed to:', arbitrumVIP.address)
 
-  const signers = await hre.ethers.getSigners()
-  const myAddress = signers[0].address
+  const myAddress = wallet.address
 
   /**
    * Connect to the Arbitrum Address table pre-compile contract
    */
   const arbAddressTable = ArbAddressTable__factory.connect(
-    '0x0000000000000000000000000000000000000066',
-    signers[0]
+    ARB_ADDRESS_TABLE_ADDRESS,
+    wallet
   )
 
   //**

packages/arb-shared-dependencies/hardhat.config.js

@@ -46,5 +46,15 @@ module.exports = {
         ? [process.env['DEVNET_PRIVKEY']]
         : [],
     },
+    parent_chain: {
+      gas: 2100000,
+      gasLimit: 0,
+      url: process.env['PARENT_CHAIN_RPC'] || '',
+      accounts: process.env['PRIVATE_KEY'] ? [process.env['PRIVATE_KEY']] : [],
+    },
+    chain: {
+      url: process.env['CHAIN_RPC'] || '',
+      accounts: process.env['PRIVATE_KEY'] ? [process.env['PRIVATE_KEY']] : [],
+    },
   },
 }

packages/arb-shared-dependencies/index.js

@@ -1,5 +1,7 @@
 const hardhatConfig = require('./hardhat.config.js')
 const path = require('path')
+const fs = require('fs')
+const { registerCustomArbitrumNetwork } = require('@arbitrum/sdk')
 require('dotenv').config({ path: path.join(__dirname, '..', '..', '.env') })
 
 const wait = (ms = 0) => {
@@ -49,9 +51,30 @@ const requireEnvVariables = envVars => {
   }
   console.log('Environmental variables properly set 👍')
 }
+
+const addCustomNetworkFromFile = () => {
+  const pathToCustomNetworkFile = path.join(
+    __dirname,
+    '..',
+    '..',
+    'customNetwork.json'
+  )
+  if (!fs.existsSync(pathToCustomNetworkFile)) {
+    return
+  }
+
+  const customNetworkFileContents = fs.readFileSync(
+    pathToCustomNetworkFile,
+    'utf8'
+  )
+  const customNetworkInformation = JSON.parse(customNetworkFileContents)
+  registerCustomArbitrumNetwork(customNetworkInformation)
+}
+
 module.exports = {
   arbLog,
   arbLogTitle,
   hardhatConfig,
   requireEnvVariables,
+  addCustomNetworkFromFile,
 }