Merge pull request #126 from OffchainLabs/update-tutorials-2

Update tutorials to ArbSDK v4 (2)

Author: TucksonDev

README.md

@@ -37,8 +37,9 @@ yarn install
 
 #### :white_check_mark: Advanced features
 
-- ®️ [Arb Address Table](./packages/address-table/)
-- 🌉 [Bridging Custom Token](./packages/custom-token-bridging/)
+- ®️ [ArbAddress table](./packages/address-table/)
+- 🌉 [Bridging a custom token through the generic-custom gateway](./packages/custom-token-bridging/)
+- 🌉 [Bridging a custom token through a custom gateway](./packages/custom-gateway-bridging/)
 - ✈️ [Send a signed transaction from the parent chain](./packages/delayedInbox-l2msg/)
 - 🎁 [Redeem Retryable Ticket](./packages/redeem-failed-retryable/)
 - 🌀 [Deposit Ether or Tokens from L1 to L3](./packages/l1-l3-teleport/)

packages/custom-gateway-bridging/.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>"

packages/custom-gateway-bridging/README.md

@@ -1,28 +1,30 @@
 # Custom gateway bridging tutorial
 
-When neither the StandardERC20gateway nor the generic-custom-gateway are enough to fulfill the bridging requirements of a token, there is the possibility of creating and registering a custom gateway. `custom-gateway-bridging` demonstrates how to create and register a custom gateway in Arbitrum's Token Bridge protocol.
+When neither the standard ERC20 gateway, nor the generic-custom gateway are enough to fulfill the bridging requirements of a token, there is the possibility of creating and registering a custom gateway. `custom-gateway-bridging` demonstrates how to create and register a custom gateway in the Arbitrum's Token Bridge.
 
-For more info on bridging assets on Arbitrum, see our [token bridging docs](https://developer.arbitrum.io/asset-bridging).
+For more info on bridging assets on Arbitrum, see our [token bridging docs](https://docs.arbitrum.io/build-decentralized-apps/token-bridging/token-bridge-erc20).
 
 ## Token bridging using a custom gateway
 
 Bridging custom tokens through a custom gateway follow a similar process than that of Arbitrum's generic-custom gateway. The difference, however, is that during the gateway registration process, a custom gateway is registered instead of the generic-custom gateway.
 
-Here, we deploy a [demo custom token](./contracts/L1Token.sol) on L1 and a [demo custom token](./contracts/L2Token.sol) on L2. We also deploy a demo custom gateway on both [L1](./contracts/L1CustomGateway.sol) and [L2](./contracts/L2CustomGateway.sol). We then use the Arbitrum router contract to register our L1 and L2 gateways.
+Here, we deploy a [demo custom token](./contracts/ParentChainToken.sol) to the parent chain and a [demo custom token](./contracts/ChildChainToken.sol) to the child chain. We also deploy a demo custom gateway on both [the parent chain](./contracts/ParentChainCustomGateway.sol) and [the child chain](./contracts/ChildChainCustomGateway.sol). We then use the Arbitrum router contract to register both gateways.
 
 We use the [Arbitrum SDK](https://github.com/OffchainLabs/arbitrum-sdk) library to initiate and verify the bridging.
 
 See [./exec.js](./scripts/exec.js) for inline explanation.
 
-### 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`, `CHAIN_RPC`, `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:
 

…y-bridging/contracts/L2CustomGateway.sol …ng/contracts/ChildChainCustomGateway.solpackages/custom-gateway-bridging/contracts/L2CustomGateway.sol renamed to packages/custom-gateway-bridging/contracts/ChildChainCustomGateway.sol packages/custom-gateway-bridging/contracts/L2CustomGateway.sol renamed to packages/custom-gateway-bridging/contracts/ChildChainCustomGateway.sol

@@ -11,7 +11,7 @@ import "@openzeppelin/contracts/access/Ownable.sol";
  * @dev Inheritance of Ownable is optional. In this case we use it to call the function setTokenBridgeInformation
  * and simplify the test
  */
-contract L2CustomGateway is IL2CustomGateway, L2CrosschainMessenger, Ownable {
+contract ChildChainCustomGateway is IL2CustomGateway, L2CrosschainMessenger, Ownable {
     // Exit number (used for tradeable exits)
     uint256 public exitNum;
 

…m-gateway-bridging/contracts/L2Token.sol …y-bridging/contracts/ChildChainToken.solpackages/custom-gateway-bridging/contracts/L2Token.sol renamed to packages/custom-gateway-bridging/contracts/ChildChainToken.sol packages/custom-gateway-bridging/contracts/L2Token.sol renamed to packages/custom-gateway-bridging/contracts/ChildChainToken.sol

@@ -7,7 +7,7 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 /**
  * @title Example implementation of a custom ERC20 token to be deployed on L2
  */
-contract L2Token is ERC20, IArbToken {
+contract ChildChainToken is ERC20, IArbToken {
     address public l2GatewayAddress;
     address public override l1Address;
 

…y-bridging/contracts/L1CustomGateway.sol …g/contracts/ParentChainCustomGateway.solpackages/custom-gateway-bridging/contracts/L1CustomGateway.sol renamed to packages/custom-gateway-bridging/contracts/ParentChainCustomGateway.sol packages/custom-gateway-bridging/contracts/L1CustomGateway.sol renamed to packages/custom-gateway-bridging/contracts/ParentChainCustomGateway.sol

@@ -11,7 +11,7 @@ import "@openzeppelin/contracts/access/Ownable.sol";
  * @dev Inheritance of Ownable is optional. In this case we use it to call the function setTokenBridgeInformation
  * and simplify the test
  */
-contract L1CustomGateway is IL1CustomGateway, L1CrosschainMessenger, Ownable {
+contract ParentChainCustomGateway is IL1CustomGateway, L1CrosschainMessenger, Ownable {
 
     // Token bridge state variables
     address public l1CustomToken;

…m-gateway-bridging/contracts/L1Token.sol …-bridging/contracts/ParentChainToken.solpackages/custom-gateway-bridging/contracts/L1Token.sol renamed to packages/custom-gateway-bridging/contracts/ParentChainToken.sol packages/custom-gateway-bridging/contracts/L1Token.sol renamed to packages/custom-gateway-bridging/contracts/ParentChainToken.sol

@@ -35,7 +35,7 @@ interface IL1GatewayRouter {
 /**
  * @title Example implementation of a custom ERC20 token to be deployed on L1
  */
-contract L1Token is Ownable, ICustomToken, ERC20 {
+contract ParentChainToken is Ownable, ICustomToken, ERC20 {
     address public l1GatewayAddress;
     address public routerAddress;
     bool private shouldRegisterGateway;

packages/custom-gateway-bridging/package.json

@@ -5,15 +5,8 @@
     "build": "hardhat compile",
     "exec": "hardhat run scripts/exec.js"
   },
-  "devDependencies": {
-    "@nomiclabs/hardhat-ethers": "^2.0.2",
-    "@openzeppelin/contracts": "^4.8.3",
-    "chai": "^4.3.4",
-    "ethers": "^5.1.2",
-    "hardhat": "^2.6.6"
-  },
   "dependencies": {
-    "@arbitrum/sdk": "^v3.1.9",
-    "dotenv": "^8.2.0"
+    "@arbitrum/sdk": "^4.0.1",
+    "@openzeppelin/contracts": "^4.8.3"
   }
 }