chore: handle fast withdrawals in orbit form (#2086)

OffchainLabs · Nov 21, 2024 · cf19cbd · cf19cbd
1 parent 8c6671b
commit cf19cbd
Show file tree

Hide file tree

Showing 7 changed files with 43 additions and 5 deletions.
diff --git a/.github/ISSUE_TEMPLATE/add-orbit-chain-request.yml b/.github/ISSUE_TEMPLATE/add-orbit-chain-request.yml
@@ -227,6 +227,24 @@ body:
     validations:
       required: true
 
+  - type: dropdown
+    id: fast-withdrawal
+    attributes:
+      label: Fast Withdrawals active
+      description: Only select Yes if your chain has Fast Withdrawals enabled. We will show information in our UI that your chain has Fast Withdrawals implemented and that withdrawals will take less time than usual.
+      options:
+        - "No"
+        - "Yes"
+      default: 0
+  - type: input
+    id: fast-withdrawal-time
+    attributes:
+      label: Fast Withdrawals time in minutes
+      description: Only fill this if your chain has Fast Withdrawals enabled.
+      placeholder: ex. 1440
+    validations:
+      required: false
+
   - type: input
     id: launch-date
     attributes:

diff --git a/.github/workflows/add-orbit-chain.yml b/.github/workflows/add-orbit-chain.yml
@@ -78,8 +78,8 @@ jobs:
 
       - name: Commit changes
         run: |
-          git add packages/arb-token-bridge-ui/src/**/*
-          git add packages/arb-token-bridge-ui/public/**/*
+          git add "packages/arb-token-bridge-ui/src/**/*"
+          git add "packages/arb-token-bridge-ui/public/**/*" ":!public/images/__auto-generated/**"
           git status
           git commit -m "feat: add ${{ steps.issue.outputs.result }}"
           git push origin ${{ steps.branch.outputs.name }}

diff --git a/packages/scripts/src/addOrbitChain/schemas.ts b/packages/scripts/src/addOrbitChain/schemas.ts
@@ -151,6 +151,7 @@ export const bridgeUiConfigSchema = z.object({
       logoUrl: z.string().optional(),
     })
     .optional(),
+  fastWithdrawalTime: z.number().int().positive().optional(),
 });
 
 export const chainSchema = z
@@ -287,6 +288,8 @@ export const incomingChainDataSchema = z.object({
   childWeth: addressSchema,
   parentMultiCall: addressSchema,
   childMultiCall: addressSchema,
+  fastWithdrawalActive: z.boolean(),
+  fastWithdrawalMinutes: z.string().regex(/^\d+$/).optional(),
 });
 
 // Schema for the final OrbitChain structure
@@ -360,6 +363,8 @@ export const chainDataLabelToKey: Record<string, string> = {
   "Parent MultiCall": "parentMultiCall",
   "Child MultiCall": "childMultiCall",
   "Parent WETH": "parentWeth",
+  "Fast Withdrawals active": "fastWithdrawalActive",
+  "Fast Withdrawals time in minutes": "fastWithdrawalMinutes",
 };
 
 export interface Issue {

diff --git a/packages/scripts/src/addOrbitChain/tests/__mocks__/chainDataMocks.ts b/packages/scripts/src/addOrbitChain/tests/__mocks__/chainDataMocks.ts
@@ -174,6 +174,8 @@ export const mockIncomingChainData: IncomingChainData = {
   childWeth: "0x0000000000000000000000000000000000000019",
   parentMultiCall: "0x0000000000000000000000000000000000000010",
   childMultiCall: "0x0000000000000000000000000000000000000017",
+  fastWithdrawalMinutes: "15",
+  fastWithdrawalActive: true,
 };
 
 export const mockOrbitChain: OrbitChain = {
@@ -222,6 +224,7 @@ export const mockOrbitChain: OrbitChain = {
       symbol: "XAI",
       logoUrl: "/images/XaiLogo.svg",
     },
+    fastWithdrawalTime: 900000,
   },
 };
 

diff --git a/packages/scripts/src/addOrbitChain/tests/__snapshots__/transforms.test.ts.snap b/packages/scripts/src/addOrbitChain/tests/__snapshots__/transforms.test.ts.snap
@@ -34,6 +34,7 @@ exports[`Transforms > transformIncomingDataToOrbitChain > should transform incom
 {
   "bridgeUiConfig": {
     "color": "#FF0000",
+    "fastWithdrawalTime": 900000,
     "nativeTokenData": {
       "logoUrl": "/images/mockChain_NativeTokenLogo.png",
       "name": "Test Token",
@@ -147,7 +148,8 @@ exports[`Transforms > updateOrbitChainsFile > should add a new testnet chain whi
           \\"name\\": \\"Xai\\",
           \\"symbol\\": \\"XAI\\",
           \\"logoUrl\\": \\"/images/XaiLogo.svg\\"
-        }
+        },
+        \\"fastWithdrawalTime\\": 900000
       }
     }
   ]
@@ -202,7 +204,8 @@ exports[`Transforms > updateOrbitChainsFile > should handle updating an existing
           \\"name\\": \\"Xai\\",
           \\"symbol\\": \\"XAI\\",
           \\"logoUrl\\": \\"/images/XaiLogo.svg\\"
-        }
+        },
+        \\"fastWithdrawalTime\\": 900000
       }
     },
     {
@@ -283,7 +286,8 @@ exports[`Transforms > updateOrbitChainsFile > should update the orbit chains fil
           \\"name\\": \\"Xai\\",
           \\"symbol\\": \\"XAI\\",
           \\"logoUrl\\": \\"/images/XaiLogo.svg\\"
-        }
+        },
+        \\"fastWithdrawalTime\\": 900000
       }
     }
   ],

diff --git a/packages/scripts/src/addOrbitChain/tests/schemas.test.ts b/packages/scripts/src/addOrbitChain/tests/schemas.test.ts
@@ -156,6 +156,7 @@ describe("Validation Functions", () => {
           decimals: 18,
           logoUrl: "https://example.com/token-logo.png",
         },
+        fastWithdrawalTime: 900000,
       };
       expect(() =>
         bridgeUiConfigSchema.parse(validBridgeUiConfig)

diff --git a/packages/scripts/src/addOrbitChain/transforms.ts b/packages/scripts/src/addOrbitChain/transforms.ts
@@ -179,6 +179,8 @@ export const extractRawChainData = (
       if (key === "chainLogo" || key === "nativeTokenLogo") {
         const imageUrl = extractImageUrlFromMarkdown(trimmedValue);
         rawData[key] = imageUrl || trimmedValue;
+      } else if (key === "fastWithdrawalActive") {
+        rawData[key] = trimmedValue === "Yes";
       } else {
         rawData[key] = trimmedValue;
       }
@@ -392,6 +394,11 @@ export const transformIncomingDataToOrbitChain = async (
           logoUrl: nativeTokenLogoPath,
         },
       }),
+      ...(chainData.fastWithdrawalActive && {
+        fastWithdrawalTime: chainData.fastWithdrawalMinutes
+          ? Number(chainData.fastWithdrawalMinutes) * 60 * 1000
+          : undefined,
+      }),
     },
   };
 };