feat: automates adding orbit chains (#1944)

Co-authored-by: Bartek <[email protected]>
Co-authored-by: Fionna Chan <[email protected]>

.github/ISSUE_TEMPLATE/add-orbit-chain-request.yml

@@ -1,6 +1,6 @@
 name: Add Orbit Chain Request
 description: File a request to have your Orbit chain added to the bridge
-title: "[feat]: "
+title: "[feat]: Add Orbit chain "
 labels: ["feat", "triage"]
 body:
   - type: markdown
@@ -59,11 +59,18 @@ body:
       label: Explorer URL
     validations:
       required: true
-  - type: input
+
+  - type: dropdown
     id: parent-chain-id
     attributes:
-      label: Parent chain ID
-      placeholder: ex. 42161
+      label: Parent Chain ID
+      description: Select the parent chain for your Orbit chain.
+      options:
+        - "1"
+        - "42161"
+        - "421614"
+        - "11155111"
+        - "17000"
     validations:
       required: true
 
@@ -78,7 +85,7 @@ body:
   - type: input
     id: native-token-address
     attributes:
-      label: Native token address
+      label: Native token address on Parent Chain
       placeholder: ex. 0x0000000000000000000000000000000000000000
     validations:
       required: false
@@ -88,7 +95,7 @@ body:
       label: Native token name
       placeholder: ex. Ether
     validations:
-      required: false           
+      required: false
   - type: input
     id: native-token-symbol
     attributes:
@@ -168,45 +175,46 @@ body:
       value: |
         You can find this information under the `"l2Contracts" : {...}` key.
   - type: input
-    id: parent-customGateway
+    id: parent-custom-gateway
     attributes:
-      label: customGateway
+      label: Parent Custom Gateway
     validations:
       required: true
   - type: input
-    id: parent-ERC20Gateway
+    id: parent-erc20-gateway
     attributes:
-      label: ERC20Gateway
+      label: Parent ERC20 Gateway
+      description: This is also called the standard gateway. [Read more](https://docs.arbitrum.io/build-decentralized-apps/token-bridging/token-bridge-erc20#default-standard-bridging).
     validations:
       required: true
   - type: input
-    id: parent-gatewayRouter
+    id: parent-gateway-router
     attributes:
-      label: gatewayRouter
+      label: Parent Gateway Router
     validations:
       required: true
   - type: input
     id: parent-multicall
     attributes:
-      label: multicall
+      label: Parent MultiCall
     validations:
       required: true
   - type: input
-    id: parent-proxyAdmin
+    id: parent-proxy-admin
     attributes:
-      label: proxyAdmin
+      label: Parent Proxy Admin
     validations:
       required: true
   - type: input
     id: parent-weth
     attributes:
-      label: weth
+      label: Parent WETH
     validations:
       required: true
   - type: input
-    id: parent-wethGateway
+    id: parent-weth-gateway
     attributes:
-      label: wethGateway
+      label: Parent WETH Gateway
     validations:
       required: true
 
@@ -219,44 +227,44 @@ body:
       value: |
         You can find this information under the `"l3Contracts" : {...}` key.
   - type: input
-    id: child-customGateway
+    id: child-custom-gateway
     attributes:
-      label: customGateway
+      label: Child Custom Gateway
     validations:
       required: true
   - type: input
-    id: child-ERC20Gateway
+    id: child-erc20-gateway
     attributes:
-      label: ERC20Gateway
+      label: Child ERC20 Gateway
     validations:
       required: true
   - type: input
-    id: child-gatewayRouter
+    id: child-gateway-router
     attributes:
-      label: gatewayRouter
+      label: Child Gateway Router
     validations:
       required: true
   - type: input
     id: child-multicall
     attributes:
-      label: multicall
+      label: Child Multicall
     validations:
       required: true
   - type: input
-    id: child-proxyAdmin
+    id: child-proxy-admin
     attributes:
-      label: proxyAdmin
+      label: Child Proxy Admin
     validations:
       required: true
   - type: input
     id: child-weth
     attributes:
-      label: weth
+      label: Child WETH
     validations:
       required: true
   - type: input
-    id: child-wethGateway
+    id: child-weth-gateway
     attributes:
-      label: wethGateway
+      label: Child WETH Gateway
     validations:
       required: true

.github/workflows/add-orbit-chain.yml

@@ -0,0 +1,41 @@
+name: Add Orbit Chain
+
+on:
+  workflow_dispatch:
+    inputs:
+      issue_number:
+        description: 'Issue Number'
+        required: true
+        type: string
+
+permissions:
+  issues: read
+  contents: write
+  pull-requests: write
+
+jobs:
+  add_orbit_chain:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+          cache: 'yarn'
+
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
+
+      - name: Build scripts
+        run: yarn workspace scripts build
+
+      - name: Run addOrbitChain script
+        run: yarn workspace scripts add-orbit-chain ../../packages/arb-token-bridge-ui/src/util/orbitChainsData.json
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          ISSUE_NUMBER: ${{ github.event.issue.number || inputs.issue_number }}

.github/workflows/build-test.yml

@@ -126,3 +126,36 @@ jobs:
       - name: Regular E2E Failed
         if: needs.e2e-tests.result != 'success' && needs.e2e-tests.result != 'skipped'
         run: exit 1
+
+  test-scripts:
+    name: "Test Scripts"
+    runs-on: ubuntu-latest
+    needs: [check-files]
+    if: needs.check-files.outputs.run_tests == 'true'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
+
+      - name: Run scripts tests
+        run: yarn workspace scripts test
+
+  validate-orbit-chains-data:
+    name: "Validate Orbit Chains Data"
+    runs-on: ubuntu-latest
+    needs: [check-files]
+    if: needs.check-files.outputs.run_tests == 'true'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install node_modules
+        uses: OffchainLabs/actions/node-modules/install@main
+
+      - name: Build
+        run: yarn workspace scripts build
+
+      - name: Validate orbitChainsData.json
+        run: yarn workspace scripts validate-orbit-chains-data ../arb-token-bridge-ui/src/util/orbitChainsData.json