feat: Add parent chain public decorator

.env.example

@@ -5,7 +5,7 @@ BASESCAN_API_KEY=
 NITRO_TESTNODE_DEPLOYER_PRIVATE_KEY=0xb6b15c8cb491557369f3c7d2c287b053eb229daa9c22138887752191c9520659
 
 NITRO_TESTNODE_L2_ROLLUP_OWNER_PRIVATE_KEY=0xdc04c5399f82306ec4b4d654a342f40e2e0620fe39950d967e1e574b32d4dd36
-NITRO_TESTNODE_L2_TOKEN_BRIDGE_DEPLOYER_PRIVATE_KEY=0xadd3d9301e184194943ce6244aa25c90e73c5843db16a994d202091f97f5bb27
+NITRO_TESTNODE_L2_TOKEN_BRIDGE_DEPLOYER_PRIVATE_KEY=0xb6b15c8cb491557369f3c7d2c287b053eb229daa9c22138887752191c9520659
 
 NITRO_TESTNODE_L3_ROLLUP_OWNER_PRIVATE_KEY=0xecdf21cb41c65afb51f91df408b7656e2c8739a5877f2814add0afd780cc210e
 NITRO_TESTNODE_L3_TOKEN_BRIDGE_DEPLOYER_PRIVATE_KEY=0xadd3d9301e184194943ce6244aa25c90e73c5843db16a994d202091f97f5bb27

.github/workflows/build-test.yml

@@ -13,64 +13,41 @@ env:
   ARBISCAN_API_KEY: ${{ secrets.ARBISCAN_API_KEY }}
 
 jobs:
-  install:
-    name: 'Install'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-
-      - name: Install node_modules
-        uses: OffchainLabs/actions/node-modules/install@main
-
   audit:
     name: 'Audit'
     runs-on: ubuntu-latest
-    needs: install
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Restore node_modules
-        uses: OffchainLabs/actions/node-modules/restore@main
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
 
       - name: Run audit
         run: yarn audit:ci
 
   check-formatting:
     name: 'Check Formatting'
     runs-on: ubuntu-latest
-    needs: install
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Restore node_modules
-        uses: OffchainLabs/actions/node-modules/restore@main
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
 
       - name: Check formatting with Prettier
         run: yarn prettier:check
 
   test-unit:
     name: Test (Unit)
     runs-on: ubuntu-latest
-    needs: install
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-
-      - name: Restore node_modules
-        uses: OffchainLabs/actions/node-modules/restore@main
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
 
       - name: Copy .env
         run: cp ./.env.example ./.env
@@ -84,30 +61,18 @@ jobs:
   test-integration:
     name: Test (Integration)
     runs-on: ubuntu-latest
-    needs: install
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 18
-
-      - name: Restore node_modules
-        uses: OffchainLabs/actions/node-modules/restore@main
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
 
       - name: Set up the local node
-        uses: OffchainLabs/actions/run-nitro-test-node@main
+        uses: OffchainLabs/actions/run-nitro-test-node@feat-simplify
         with:
-          nitro-testnode-ref: 1647de2c5f75ee0fbe5986e3f20d35bc75191ea6 # https://github.com/OffchainLabs/nitro-testnode/pull/42
-          # Use simple mode
-          no-simple: false
-          # RollupCreator on L1 is deployed by default
-          # RollupCreator on L2 is deployed with --l3node
-          l3-node: true
-          # L3 node with custom fee token when using --l3-fee-token
-          args: --l3-fee-token
+          nitro-testnode-ref: release
+          args: --tokenbridge --l3node --l3-token-bridge --l3-fee-token
 
       - name: Copy .env
         run: cp ./.env.example ./.env

README.md

@@ -1,13 +1,10 @@
 # Arbitrum Orbit SDK
 
-> [!WARNING]
-> Disclaimer: This project is an Alpha release and should not be used in a production environment. We are working on getting it ready for mainnet deployments, meanwhile please use it at your own discretion.
-
 TypeScript SDK for building [Arbitrum Orbit](https://arbitrum.io/orbit) chains.
 
 ## Installation
 
-Make sure you are using Node v18 or greater.
+Make sure you are using Node.js v18 or greater.
 
 ```bash
 yarn add @arbitrum/orbit-sdk viem@^1.20.0

audit-ci.jsonc

@@ -65,11 +65,6 @@
     // from: @arbitrum/token-bridge-contracts>@openzeppelin/contracts-upgradeable
     // from: @arbitrum/nitro-contracts>@openzeppelin/contracts
     // from: @arbitrum/token-bridge-contracts>@openzeppelin/contracts
-    "GHSA-9vx6-7xxf-x967",
-    // https://github.com/advisories/GHSA-grv7-fg5c-xmjg
-    // Uncontrolled resource consumption in braces
-    // eslint and hardhat dependency, only used in dev
-    // from: hardhat>braces & eslint>braces
-    "GHSA-grv7-fg5c-xmjg"
+    "GHSA-9vx6-7xxf-x967"
   ]
 }

examples/create-rollup-custom-fee-token/README.md

@@ -23,7 +23,7 @@ const createRollupConfig = createRollupPrepareDeploymentParamsConfig(parentChain
 await createRollup({
   params: {
     config: createRollupConfig,
-    batchPoster,
+    batchPosters: [batchPoster],
     validators: [validator],
     nativeToken,
   },

examples/create-rollup-custom-fee-token/index.ts

@@ -72,7 +72,7 @@ async function main() {
     await createRollup({
       params: {
         config: createRollupConfig,
-        batchPoster,
+        batchPosters: [batchPoster],
         validators: [validator],
         nativeToken,
       },

examples/create-rollup-custom-fee-token/low_level.ts

@@ -110,7 +110,7 @@ async function main() {
         owner: deployer.address,
         chainConfig,
       }),
-      batchPoster,
+      batchPosters: [batchPoster],
       validators: [validator],
       nativeToken,
     },

examples/create-rollup-eth/README.md

@@ -20,7 +20,7 @@ const createRollupConfig = createRollupPrepareDeploymentParamsConfig(parentChain
 await createRollup({
   params: {
     config: createRollupConfig,
-    batchPoster,
+    batchPosters: [batchPoster],
     validators: [validator],
   },
   account: deployer,

examples/create-rollup-eth/index.ts

@@ -66,7 +66,7 @@ async function main() {
     await createRollup({
       params: {
         config: createRollupConfig,
-        batchPoster,
+        batchPosters: [batchPoster],
         validators: [validator],
       },
       account: deployer,

examples/create-rollup-eth/low_level.ts

@@ -69,7 +69,7 @@ async function main() {
         owner: deployer.address,
         chainConfig,
       }),
-      batchPoster,
+      batchPosters: [batchPoster],
       validators: [validator],
     },
     account: deployer.address,

examples/setup-aep-fee-router/.env.example

@@ -0,0 +1,18 @@
+# Address of the Rollup contract
+ROLLUP_ADDRESS=
+
+# Private key of the account with executor privileges in the UpgradeExecutor admin contract for the chain
+# (usually, the deployer of the chain)
+CHAIN_OWNER_PRIVATE_KEY=
+
+# Orbit chain configuration
+ORBIT_CHAIN_ID=
+ORBIT_CHAIN_RPC=
+
+# Parent chain id
+PARENT_CHAIN_ID=1
+
+# Parent chain target address. It will receive 10% of the chain revenue on L1
+# NOTE: This is the ParentToChildRewardRouter contract on Ethereum (https://etherscan.io/address/0x40Cd7D713D7ae463f95cE5d342Ea6E7F5cF7C999)
+# that bridges the funds received to the Arbitrum Foundation Treasury Timelock contract on Arbitrum One (https://arbiscan.io/address/0xbFc1FECa8B09A5c5D3EFfE7429eBE24b9c09EF58)
+PARENT_CHAIN_TARGET_ADDRESS=0x40Cd7D713D7ae463f95cE5d342Ea6E7F5cF7C999

examples/setup-aep-fee-router/README.md

@@ -0,0 +1,57 @@
+# Arbitrum Orbit SDK
+
+## Setup fee routing for Orbit chains settling to non-Arbitrum chains (including Ethereum)
+
+This example script shows how to setup the appropriate fee routing to comply with the [Arbitrum Expansion Program](https://forum.arbitrum.foundation/t/the-arbitrum-expansion-program-and-developer-guild/20722) requirement of sharing 10% of the revenue back to the Arbitrum ecosystem.
+
+The script performs the following operations:
+
+1. Obtain all chain contracts (needed to execute the next steps)
+2. Obtain the current fee collectors of the chain: Orbit base fee collector, Orbit surplus fee collector, Parent chain surplus fee collector
+3. Deploy the ChildToParentRouter contract, configured to send the amounts received to the appropriate Arbitrum Foundation or Arbitrum DAO controlled address on the parent chain
+4. Deploy a RewardDistributor contract for each different fee collector account, configured to distribute 90% of the amounts received to the current fee collector, and 10% to the ChildToParentRouter contract
+5. Set each of the fee collectors to the RewardDistributor contracts
+
+Note that if all three fee types are collected by the same address, only one RewardDistributor contract will be deployed that will collect all those fees.
+
+## Variables needed
+
+- ROLLUP_ADDRESS: address of the Rollup contract
+- CHAIN_OWNER_PRIVATE_KEY: private key of the account with executor privileges in the UpgradeExecutor admin contract for the chain
+- ORBIT_CHAIN_ID: chainId of the Orbit chain
+- ORBIT_CHAIN_RPC: RPC of the Orbit chain
+- PARENT_CHAIN_ID: chainId of the parent chain (should be a non-Arbitrum chain, including Ethereum)
+- PARENT_CHAIN_TARGET_ADDRESS: address on the parent chain where 10% of the revenue will be sent to (more information below)
+
+### What PARENT_CHAIN_TARGET_ADDRESS to use
+
+When executing this script, the RewardDistributor contract will be configured to send 10% of the funds received (10% of the revenue of the chain) to the address specified in PARENT_CHAIN_TARGET_ADDRESS, in the parent chain.
+
+The PARENT_CHAIN_TARGET_ADDRESS should be an address controlled by the Arbitrum Foundation or the Arbitrum DAO. For L2 Orbit chains settling to Ethereum that use ETH as the native gas token, this variable should be `0x40Cd7D713D7ae463f95cE5d342Ea6E7F5cF7C999`, which is a ParentToChildRewardRouter contract that sends its balance in ETH to the Arbitrum Foundation Treasury Timelock contract on Arbitrum One.
+
+If your chain is an L2 Orbit chain that uses a different native gas token, or if it is an L3 Orbit chain that settles to a non-Arbitrum chain, you should set PARENT_CHAIN_TARGET_ADDRESS to a different address. Please reach out to the Arbitrum Foundation to get the appropriate address.
+
+## Setup
+
+1. Install dependencies
+
+   ```bash
+   yarn install
+   ```
+
+2. Create .env file and add the env vars
+
+   ```bash
+   cp .env.example .env
+   ```
+
+3. Run the example
+   ```bash
+   yarn dev
+   ```
+
+## References
+
+- [Arbitrum Expansion Program governance forum post](https://forum.arbitrum.foundation/t/the-arbitrum-expansion-program-and-developer-guild/20722)
+- [ChildToParentRouter contract](https://github.com/OffchainLabs/fund-distribution-contracts/blob/main/src/FeeRouter/ChildToParentRewardRouter.sol)
+- [RewardDistributor contract](https://github.com/OffchainLabs/fund-distribution-contracts/blob/main/src/RewardDistributor.sol)