Update tutorials to ArbSDK v4 (1)

TucksonDev · TucksonDev · commit 05e6b138682c · 2024-10-25T16:41:15.000+01:00
diff --git a/.env-sample b/.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>"
diff --git a/package.json b/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": [
diff --git a/packages/address-table/.env-sample b/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"
diff --git a/packages/address-table/README.md b/packages/address-table/README.md
@@ -20,11 +20,11 @@ Set the values shown in `.env-sample` as environmental variables. To copy it int
 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`)
 
 ### 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" />
diff --git a/packages/address-table/contracts/ArbitrumVIP.sol b/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 {
diff --git a/packages/address-table/package.json b/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"
   }
 }
diff --git a/packages/address-table/scripts/exec.js b/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
   )
 
   //**
diff --git a/packages/arb-shared-dependencies/hardhat.config.js b/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']] : [],
+    },
   },
 }
diff --git a/packages/arb-shared-dependencies/index.js b/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 addNetworkFromFile = () => {
+  const pathToLocalNetworkFile = path.join(
+    __dirname,
+    '..',
+    '..',
+    'localNetwork.json'
+  )
+  if (!fs.existsSync(pathToLocalNetworkFile)) {
+    return
+  }
+
+  const localNetworksFile = fs.readFileSync(pathToLocalNetworkFile, 'utf8')
+  const localL2 = JSON.parse(localNetworksFile).l2Network
+  const localL3 = JSON.parse(localNetworksFile).l3Network
+
+  const childChain = localL3 ? localL3 : localL2
+  registerCustomArbitrumNetwork(childChain)
+}
+
 module.exports = {
   arbLog,
   arbLogTitle,
   hardhatConfig,
   requireEnvVariables,
+  addNetworkFromFile,
 }
diff --git a/packages/arb-shared-dependencies/package.json b/packages/arb-shared-dependencies/package.json
@@ -5,16 +5,5 @@
   "scripts": {
     "build": "hardhat compile"
   },
-  "main": "index.js",
-  "devDependencies": {
-    "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "eslint": "^7.30.0",
-    "ethers": "^5.1.2",
-    "hardhat": "^2.2.0",
-    "prettier": "^2.3.2"
-  },
-  "dependencies": {
-    "dotenv": "^8.2.0",
-    "eslint-plugin-prettier": "^3.4.0"
-  }
+  "main": "index.js"
 }
diff --git a/packages/contract-deposit/.env-sample b/packages/contract-deposit/.env-sample
@@ -1,19 +1,16 @@
 # 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. You can use any Arbitrum chain.
-
-L2RPC="https://sepolia-rollup.arbitrum.io/rpc"
-
-# Ethereum RPC; i.e., for Sepolia https://sepolia.infura.io/v3/<your infura key>
+# Your private key
+PRIVATE_KEY="0x your key here"
 
-L1RPC=""
+# The main chain's RPC
+# (this can be an Arbitrum network, or your Orbit chain)
+CHAIN_RPC="https://sepolia-rollup.arbitrum.io/rpc"
 
-# The address that you will transfer the funds from your l2 alias to
+# 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>"
 
+# The address that you will transfer the funds from your address alias on the child chain to
 TransferTo=
diff --git a/packages/contract-deposit/README.md b/packages/contract-deposit/README.md
@@ -5,7 +5,7 @@
 It will deposit funds to l2 via a l1 contract, and because the inbox contract will alias the sender address if it is a contract,
 this tutorial shows how to control the alias address on l2 via its l1 contract address.
 
-This tutorial demonstrates depositing funds to L2 using an L1 contract. Since the Inbox contract changes the sender address if it's a contract [(a.k.a address aliasing)](https://docs.arbitrum.io/how-arbitrum-works/arbos/l1-l2-messaging#address-aliasing), it explains how to manage the new L2 address using the L1 contract address. It's a basic example of how an L1 contract controls its L2 alias and transfers its alias funds to another address. For practical use, we recommend our [funds recovery tool]((https://github.com/OffchainLabs/arbitrum-funds-recovery-tool)).
+This tutorial demonstrates depositing funds to L2 using an L1 contract. Since the Inbox contract changes the sender address if it's a contract [(a.k.a address aliasing)](https://docs.arbitrum.io/how-arbitrum-works/arbos/l1-l2-messaging#address-aliasing), it explains how to manage the new L2 address using the L1 contract address. It's a basic example of how an L1 contract controls its L2 alias and transfers its alias funds to another address. For practical use, we recommend our [funds recovery tool](<(https://github.com/OffchainLabs/arbitrum-funds-recovery-tool)>).
 
 The script and contracts demonstrate how to interact with Arbitrum's core bridge contracts to create these retryable messages, how to calculate and forward appropriate fees from L1 to L2, and how to use Arbitrum's L1-to-L2 message [address aliasing](https://developer.offchainlabs.com/docs/l1_l2_messages#address-aliasing).
 
diff --git a/packages/contract-deposit/contracts/EthDeposit.sol b/packages/contract-deposit/contracts/EthDeposit.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: Apache-2.0
-pragma solidity >=0.6.11;
+pragma solidity ^0.8.0;
 
 import "@arbitrum/nitro-contracts/src/bridge/Inbox.sol";
 
@@ -13,14 +13,14 @@ contract EthDeposit {
         inbox = IInbox(_inbox);
     }
 
-    function depositToL2() public payable returns (uint256) {
+    function depositToChildChain() public payable returns (uint256) {
         uint256 ticketID = inbox.depositEth{ value: msg.value }();
 
         emit EthDeposited(ticketID);
         return ticketID;
     }
 
-    function moveFundsFromL2AliasToAnotherAddress(
+    function moveFundsFromChildChainAliasToAnotherAddress(
         address to,
         uint256 l2callvalue,
         uint256 maxSubmissionCost,
@@ -29,8 +29,8 @@ contract EthDeposit {
     ) public payable returns (uint256) {
         /**
          * We are using unsafeCreateRetryableTicket because the safe one will check if
-         * the msg.value can be used to pay for the l2 callvalue while we will use l2's
-         * balance to pay for the l2 callvalue rather than l1 msg.value.
+         * the parent chain's msg.value can be used to pay for the child chain's callvalue, while in this case
+         * we'll use child chain's balance to pay for the callvalue rather than parent chain's msg.value
          */
         uint256 ticketID = inbox.unsafeCreateRetryableTicket{ value: msg.value }(
             to,
diff --git a/packages/contract-deposit/package.json b/packages/contract-deposit/package.json
@@ -6,14 +6,8 @@
     "build": "hardhat compile",
     "start": "hardhat run scripts/exec.js"
   },
-  "devDependencies": {
-    "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "ethers": "^5.1.2",
-    "hardhat": "^2.2.0"
-  },
   "dependencies": {
-    "@arbitrum/sdk": "^v3.1.9",
-    "@arbitrum/nitro-contracts": "v1.0.2",
-    "dotenv": "^8.2.0"
+    "@arbitrum/sdk": "^4.0.1",
+    "@arbitrum/nitro-contracts": "2.1.0"
   }
 }
diff --git a/packages/contract-deposit/scripts/exec.js b/packages/contract-deposit/scripts/exec.js
diff --git a/yarn.lock b/yarn.lock
