feat: WT-1984 Rename xbridge to bridge (#1283)

immutable · Dec 14, 2023 · 1802b18 · 1802b18
1 parent 4ce828e
commit 1802b18
Show file tree

Hide file tree

Showing 36 changed files with 207 additions and 207 deletions.
diff --git a/packages/checkout/widgets-lib/src/context/view-context/BridgeViewContextTypes.ts b/packages/checkout/widgets-lib/src/context/view-context/BridgeViewContextTypes.ts
@@ -0,0 +1,47 @@
+import { ApproveBridgeResponse, BridgeTxResponse } from '@imtbl/bridge-sdk';
+import { ViewType } from './ViewType';
+
+export enum BridgeWidgetViews {
+  WALLET_NETWORK_SELECTION = 'WALLET_NETWORK_SELECTION',
+  BRIDGE_FORM = 'BRIDGE_FORM',
+  BRIDGE_REVIEW = 'BRIDGE_REVIEW',
+  IN_PROGRESS = 'IN_PROGRESS',
+  BRIDGE_FAILURE = 'BRIDGE_FAILURE',
+  APPROVE_TRANSACTION = 'APPROVE_TRANSACTION',
+}
+
+export type BridgeWidgetView =
+  | BridgeCrossWalletSelection
+  | BridgeForm
+  | BridgeReview
+  | BridgeInProgress
+  | BridgeFailure
+  | BridgeApproveTransaction;
+
+interface BridgeCrossWalletSelection extends ViewType {
+  type: BridgeWidgetViews.WALLET_NETWORK_SELECTION,
+}
+
+interface BridgeForm extends ViewType {
+  type: BridgeWidgetViews.BRIDGE_FORM,
+}
+
+interface BridgeReview extends ViewType {
+  type: BridgeWidgetViews.BRIDGE_REVIEW,
+}
+
+interface BridgeInProgress extends ViewType {
+  type: BridgeWidgetViews.IN_PROGRESS,
+  transactionHash: string,
+}
+
+interface BridgeFailure extends ViewType {
+  type: BridgeWidgetViews.BRIDGE_FAILURE,
+  reason: string;
+}
+
+interface BridgeApproveTransaction extends ViewType {
+  type: BridgeWidgetViews.APPROVE_TRANSACTION,
+  approveTransaction: ApproveBridgeResponse;
+  transaction: BridgeTxResponse;
+}
diff --git a/packages/checkout/widgets-lib/src/context/view-context/ViewContext.test.ts b/packages/checkout/widgets-lib/src/context/view-context/ViewContext.test.ts
@@ -7,7 +7,7 @@ import {
   UpdateViewPayload,
   SharedViews,
 } from './ViewContext';
-import { XBridgeWidgetViews } from './XBridgeViewContextTypes';
+import { BridgeWidgetViews } from './BridgeViewContextTypes';
 
 describe('view-context', () => {
   describe('UPDATE_VIEW', () => {
@@ -186,34 +186,34 @@ describe('view-context', () => {
       const state = viewReducer(
         {
           view: {
-            type: XBridgeWidgetViews.BRIDGE_FAILURE,
+            type: BridgeWidgetViews.BRIDGE_FAILURE,
             reason: 'Transaction failed',
           },
           history: [
-            { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-            { type: XBridgeWidgetViews.BRIDGE_FORM },
-            { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+            { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+            { type: BridgeWidgetViews.BRIDGE_FORM },
+            { type: BridgeWidgetViews.BRIDGE_REVIEW },
             {
-              type: XBridgeWidgetViews.IN_PROGRESS,
+              type: BridgeWidgetViews.IN_PROGRESS,
               transactionHash: '',
             },
             {
-              type: XBridgeWidgetViews.BRIDGE_FAILURE,
+              type: BridgeWidgetViews.BRIDGE_FAILURE,
               reason: 'Transaction failed',
             },
           ],
         },
-        { payload: { type: ViewActions.GO_BACK_TO, view: { type: XBridgeWidgetViews.BRIDGE_REVIEW } } },
+        { payload: { type: ViewActions.GO_BACK_TO, view: { type: BridgeWidgetViews.BRIDGE_REVIEW } } },
       );
 
       expect(state).toEqual({
         view: {
-          type: XBridgeWidgetViews.BRIDGE_REVIEW,
+          type: BridgeWidgetViews.BRIDGE_REVIEW,
         },
         history: [
-          { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-          { type: XBridgeWidgetViews.BRIDGE_FORM },
-          { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+          { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+          { type: BridgeWidgetViews.BRIDGE_FORM },
+          { type: BridgeWidgetViews.BRIDGE_REVIEW },
         ],
       });
     });
@@ -222,36 +222,36 @@ describe('view-context', () => {
       const state = viewReducer(
         {
           view: {
-            type: XBridgeWidgetViews.BRIDGE_FAILURE,
+            type: BridgeWidgetViews.BRIDGE_FAILURE,
             reason: 'Transaction failed',
           },
           history: [
-            { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-            { type: XBridgeWidgetViews.BRIDGE_REVIEW },
-            { type: XBridgeWidgetViews.BRIDGE_FORM },
-            { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+            { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+            { type: BridgeWidgetViews.BRIDGE_REVIEW },
+            { type: BridgeWidgetViews.BRIDGE_FORM },
+            { type: BridgeWidgetViews.BRIDGE_REVIEW },
             {
-              type: XBridgeWidgetViews.IN_PROGRESS,
+              type: BridgeWidgetViews.IN_PROGRESS,
               transactionHash: '',
             },
             {
-              type: XBridgeWidgetViews.BRIDGE_FAILURE,
+              type: BridgeWidgetViews.BRIDGE_FAILURE,
               reason: 'Transaction failed',
             },
           ],
         },
-        { payload: { type: ViewActions.GO_BACK_TO, view: { type: XBridgeWidgetViews.BRIDGE_REVIEW } } },
+        { payload: { type: ViewActions.GO_BACK_TO, view: { type: BridgeWidgetViews.BRIDGE_REVIEW } } },
       );
 
       expect(state).toEqual({
         view: {
-          type: XBridgeWidgetViews.BRIDGE_REVIEW,
+          type: BridgeWidgetViews.BRIDGE_REVIEW,
         },
         history: [
-          { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-          { type: XBridgeWidgetViews.BRIDGE_REVIEW },
-          { type: XBridgeWidgetViews.BRIDGE_FORM },
-          { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+          { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+          { type: BridgeWidgetViews.BRIDGE_REVIEW },
+          { type: BridgeWidgetViews.BRIDGE_FORM },
+          { type: BridgeWidgetViews.BRIDGE_REVIEW },
         ],
       });
     });
@@ -260,19 +260,19 @@ describe('view-context', () => {
       const state = viewReducer(
         {
           view: {
-            type: XBridgeWidgetViews.BRIDGE_FAILURE,
+            type: BridgeWidgetViews.BRIDGE_FAILURE,
             reason: 'Transaction failed',
           },
           history: [
-            { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-            { type: XBridgeWidgetViews.BRIDGE_FORM },
-            { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+            { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+            { type: BridgeWidgetViews.BRIDGE_FORM },
+            { type: BridgeWidgetViews.BRIDGE_REVIEW },
             {
-              type: XBridgeWidgetViews.IN_PROGRESS,
+              type: BridgeWidgetViews.IN_PROGRESS,
               transactionHash: '',
             },
             {
-              type: XBridgeWidgetViews.BRIDGE_FAILURE,
+              type: BridgeWidgetViews.BRIDGE_FAILURE,
               reason: 'Transaction failed',
             },
           ],
@@ -282,19 +282,19 @@ describe('view-context', () => {
 
       expect(state).toEqual({
         view: {
-          type: XBridgeWidgetViews.BRIDGE_FAILURE,
+          type: BridgeWidgetViews.BRIDGE_FAILURE,
           reason: 'Transaction failed',
         },
         history: [
-          { type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION },
-          { type: XBridgeWidgetViews.BRIDGE_FORM },
-          { type: XBridgeWidgetViews.BRIDGE_REVIEW },
+          { type: BridgeWidgetViews.WALLET_NETWORK_SELECTION },
+          { type: BridgeWidgetViews.BRIDGE_FORM },
+          { type: BridgeWidgetViews.BRIDGE_REVIEW },
           {
-            type: XBridgeWidgetViews.IN_PROGRESS,
+            type: BridgeWidgetViews.IN_PROGRESS,
             transactionHash: '',
           },
           {
-            type: XBridgeWidgetViews.BRIDGE_FAILURE,
+            type: BridgeWidgetViews.BRIDGE_FAILURE,
             reason: 'Transaction failed',
           },
         ],

diff --git a/packages/checkout/widgets-lib/src/context/view-context/ViewContext.ts b/packages/checkout/widgets-lib/src/context/view-context/ViewContext.ts
@@ -2,7 +2,7 @@ import { createContext } from 'react';
 import { ConnectWidgetView } from './ConnectViewContextTypes';
 import { WalletWidgetView } from './WalletViewContextTypes';
 import { PrefilledSwapForm, SwapWidgetView } from './SwapViewContextTypes';
-import { XBridgeWidgetView } from './XBridgeViewContextTypes';
+import { BridgeWidgetView } from './BridgeViewContextTypes';
 import { SaleWidgetView } from './SaleViewContextTypes';
 import { ViewType } from './ViewType';
 import { OnRampWidgetView } from './OnRampViewContextTypes';
@@ -47,7 +47,7 @@ export type View =
   | SwapWidgetView
   | OnRampWidgetView
   | SaleWidgetView
-  | XBridgeWidgetView;
+  | BridgeWidgetView;
 
 export interface ViewState {
   view: View;

diff --git a/packages/checkout/widgets-lib/src/context/view-context/XBridgeViewContextTypes.ts b/packages/checkout/widgets-lib/src/context/view-context/XBridgeViewContextTypes.ts
diff --git a/packages/checkout/widgets-lib/src/factory.ts b/packages/checkout/widgets-lib/src/factory.ts
@@ -12,7 +12,7 @@ import { OnRamp } from 'widgets/on-ramp/OnRampWidgetRoot';
 import { Wallet } from 'widgets/wallet/WalletWidgetRoot';
 import { Sale } from 'widgets/sale/SaleWidgetRoot';
 import { Web3Provider } from '@ethersproject/providers';
-import { XBridge } from 'widgets/x-bridge/XBridgeWidgetRoot';
+import { Bridge } from 'widgets/bridge/BridgeWidgetRoot';
 import {
   sendProviderUpdatedEvent,
   addProviderListenersForWidgetRoot,
@@ -44,7 +44,7 @@ export class WidgetsFactory implements IWidgetsFactory {
         }) as Widget<WidgetType.CONNECT> as Widget<T>;
       }
       case WidgetType.BRIDGE: {
-        return new XBridge(this.sdk, {
+        return new Bridge(this.sdk, {
           config: { ...this.widgetConfig, ...(config) },
           provider,
         }) as Widget<WidgetType.BRIDGE> as Widget<T>;

diff --git a/packages/checkout/widgets-lib/src/resources/text/textConfig.ts b/packages/checkout/widgets-lib/src/resources/text/textConfig.ts
@@ -1,6 +1,6 @@
 /* eslint-disable max-len */
 import { WalletProviderName } from '@imtbl/checkout-sdk';
-import { XBridgeWidgetViews } from 'context/view-context/XBridgeViewContextTypes';
+import { BridgeWidgetViews } from 'context/view-context/BridgeViewContextTypes';
 import { ConnectWidgetViews } from '../../context/view-context/ConnectViewContextTypes';
 import { SwapWidgetViews } from '../../context/view-context/SwapViewContextTypes';
 import { SharedViews } from '../../context/view-context/ViewContext';
@@ -362,7 +362,7 @@ export const text = {
       text: 'Order completed',
       actionText: 'Continue',
     },
-    [XBridgeWidgetViews.WALLET_NETWORK_SELECTION]: {
+    [BridgeWidgetViews.WALLET_NETWORK_SELECTION]: {
       layoutHeading: 'Move',
       heading: 'Where would you like to move funds between?',
       fromFormInput: {
@@ -380,7 +380,7 @@ export const text = {
         text: 'Next',
       },
     },
-    [XBridgeWidgetViews.BRIDGE_FORM]: {
+    [BridgeWidgetViews.BRIDGE_FORM]: {
       header: {
         title: 'Move coins',
       },
@@ -406,7 +406,7 @@ export const text = {
         noTokenSelected: 'Select a coin to move',
       },
     },
-    [XBridgeWidgetViews.BRIDGE_REVIEW]: {
+    [BridgeWidgetViews.BRIDGE_REVIEW]: {
       layoutHeading: 'Move',
       heading: 'Ok, how does this look?',
       fromLabel: {
@@ -424,11 +424,11 @@ export const text = {
       },
       fiatPricePrefix: '~ USD $',
     },
-    [XBridgeWidgetViews.BRIDGE_FAILURE]: {
+    [BridgeWidgetViews.BRIDGE_FAILURE]: {
       statusText: 'Transaction failed',
       actionText: 'Review & Try again',
     },
-    [XBridgeWidgetViews.APPROVE_TRANSACTION]: {
+    [BridgeWidgetViews.APPROVE_TRANSACTION]: {
       content: {
         heading: 'Approve the transaction in your wallet',
         body: 'Follow the prompts in your wallet popup to confirm.',
@@ -441,7 +441,7 @@ export const text = {
         text: 'Initiating move',
       },
     },
-    [XBridgeWidgetViews.IN_PROGRESS]: {
+    [BridgeWidgetViews.IN_PROGRESS]: {
       heading: 'Move in progress',
       body1: (symbol: string) => `Less than 3 mins until your ${symbol} lands on zkEVM.`,
       body2: 'You can close this window, the transaction will be reflected in your wallet once complete.',

diff --git a/packages/checkout/widgets-lib/src/views/top-up/TopUpView.tsx b/packages/checkout/widgets-lib/src/views/top-up/TopUpView.tsx
@@ -10,7 +10,7 @@ import {
   IMTBLWidgetEvents,
 } from '@imtbl/checkout-sdk';
 import { DEFAULT_TOKEN_SYMBOLS } from 'context/crypto-fiat-context/CryptoFiatProvider';
-import { XBridgeWidgetViews } from 'context/view-context/XBridgeViewContextTypes';
+import { BridgeWidgetViews } from 'context/view-context/BridgeViewContextTypes';
 import { FooterLogo } from '../../components/Footer/FooterLogo';
 import { HeaderNavigation } from '../../components/Header/HeaderNavigation';
 import { SimpleLayout } from '../../components/SimpleLayout/SimpleLayout';
@@ -181,7 +181,7 @@ export function TopUpView({
         payload: {
           type: ViewActions.UPDATE_VIEW,
           view: {
-            type: XBridgeWidgetViews.WALLET_NETWORK_SELECTION,
+            type: BridgeWidgetViews.WALLET_NETWORK_SELECTION,
             data,
           },
         },