feat: [CM-632][Sale Widget] Add configuration flat to enable/disable …

…transaction finality confirmation (#1753)
immutable · May 10, 2024 · fe1269a · fe1269a
1 parent 5d5f89f
commit fe1269a
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 11 deletions.
diff --git a/packages/checkout/sdk/src/widgets/definitions/configurations/sale.ts b/packages/checkout/sdk/src/widgets/definitions/configurations/sale.ts
@@ -5,4 +5,5 @@ import { WidgetConfiguration } from './widget';
  */
 export type SaleWidgetConfiguration = {
   multicurrency?: boolean;
+  waitFulfillmentSettlements?: boolean;
 } & WidgetConfiguration;
diff --git a/packages/checkout/widgets-lib/src/widgets/sale/SaleWidget.tsx b/packages/checkout/widgets-lib/src/widgets/sale/SaleWidget.tsx
@@ -48,6 +48,7 @@ Omit<SaleWidgetParams, 'walletProviderName'>
 type WidgetParams = RequiredWidgetParams &
 OptionalWidgetParams & {
   multicurrency: boolean;
+  waitFulfillmentSettlements: boolean;
 };
 export interface SaleWidgetProps extends WidgetParams {
   config: StrongCheckoutWidgetsConfig;
@@ -63,6 +64,7 @@ export default function SaleWidget(props: SaleWidgetProps) {
     collectionName,
     excludePaymentTypes,
     multicurrency = false,
+    waitFulfillmentSettlements = true,
   } = props;
   const { connectLoaderState } = useContext(ConnectLoaderContext);
   const { checkout, provider } = connectLoaderState;
@@ -128,6 +130,7 @@ export default function SaleWidget(props: SaleWidgetProps) {
           collectionName,
           excludePaymentTypes,
           multicurrency,
+          waitFulfillmentSettlements,
         }}
       >
         <CryptoFiatProvider environment={config.environment}>

diff --git a/packages/checkout/widgets-lib/src/widgets/sale/SaleWidgetRoot.tsx b/packages/checkout/widgets-lib/src/widgets/sale/SaleWidgetRoot.tsx
@@ -88,7 +88,9 @@ export class Sale extends Base<WidgetType.SALE> {
       validatedParams.collectionName = '';
     }
 
-    if (params.excludePaymentTypes !== undefined && !Array.isArray(params.excludePaymentTypes)) {
+    if (
+      params.excludePaymentTypes !== undefined && !Array.isArray(params.excludePaymentTypes)
+    ) {
       // eslint-disable-next-line no-console
       console.warn('[IMTBL]: invalid "excludePaymentTypes" widget input');
       validatedParams.excludePaymentTypes = [];
@@ -122,7 +124,11 @@ export class Sale extends Base<WidgetType.SALE> {
                 sendSaleWidgetCloseEvent(window);
               }}
             >
-              <Suspense fallback={<LoadingView loadingText={t('views.LOADING_VIEW.text')} />}>
+              <Suspense
+                fallback={
+                  <LoadingView loadingText={t('views.LOADING_VIEW.text')} />
+                }
+              >
                 <SaleWidget
                   config={config}
                   amount={this.parameters.amount!}
@@ -132,6 +138,7 @@ export class Sale extends Base<WidgetType.SALE> {
                   excludePaymentTypes={this.parameters.excludePaymentTypes!}
                   language="en"
                   multicurrency={!!this.properties?.config?.multicurrency}
+                  waitFulfillmentSettlements={this.properties?.config?.waitFulfillmentSettlements ?? true}
                 />
               </Suspense>
             </ConnectLoader>

diff --git a/packages/checkout/widgets-lib/src/widgets/sale/context/SaleContextProvider.tsx b/packages/checkout/widgets-lib/src/widgets/sale/context/SaleContextProvider.tsx
@@ -54,6 +54,7 @@ type SaleContextProps = {
   passport?: Passport;
   excludePaymentTypes: SalePaymentTypes[];
   multicurrency: boolean;
+  waitFulfillmentSettlements: boolean;
 };
 
 type SaleContextValues = SaleContextProps & {
@@ -64,7 +65,6 @@ type SaleContextValues = SaleContextProps & {
   ) => Promise<SignResponse | undefined>;
   execute: (
     signResponse: SignResponse | undefined,
-    waitForTrnsactionSettlement: boolean,
     onTxnSuccess: (txn: ExecutedTransaction) => void,
     onTxnError: (error: any, txns: ExecutedTransaction[]) => void
   ) => Promise<ExecutedTransaction[]>;
@@ -136,6 +136,7 @@ const SaleContext = createContext<SaleContextValues>({
   excludePaymentTypes: [],
   multicurrency: false,
   selectedCurrency: undefined,
+  waitFulfillmentSettlements: true,
 });
 
 SaleContext.displayName = 'SaleSaleContext';
@@ -161,6 +162,7 @@ export function SaleContextProvider(props: {
       collectionName,
       excludePaymentTypes,
       multicurrency,
+      waitFulfillmentSettlements,
     },
   } = props;
 
@@ -252,6 +254,7 @@ export function SaleContextProvider(props: {
     recipientAddress,
     environmentId,
     environment,
+    waitFulfillmentSettlements,
   });
 
   const sign = useCallback(
@@ -428,6 +431,7 @@ export function SaleContextProvider(props: {
       excludePaymentTypes,
       multicurrency,
       selectedCurrency,
+      waitFulfillmentSettlements,
     }),
     [
       config,
@@ -462,6 +466,7 @@ export function SaleContextProvider(props: {
       excludePaymentTypes,
       multicurrency,
       selectedCurrency,
+      waitFulfillmentSettlements,
     ],
   );
 

diff --git a/packages/checkout/widgets-lib/src/widgets/sale/hooks/useSignOrder.ts b/packages/checkout/widgets-lib/src/widgets/sale/hooks/useSignOrder.ts
@@ -152,7 +152,7 @@ const toSignResponse = (
 
 export const useSignOrder = (input: SignOrderInput) => {
   const {
-    provider, items, environment, environmentId,
+    provider, items, environment, environmentId, waitFulfillmentSettlements,
   } = input;
   const [signError, setSignError] = useState<SignOrderError | undefined>(
     undefined,
@@ -186,7 +186,6 @@ export const useSignOrder = (input: SignOrderInput) => {
       data: string,
       gasLimit: number,
       method: string,
-      waitForTrnsactionSettlement: boolean,
     ): Promise<[hash: string | undefined, error: any]> => {
       let transactionHash: string | undefined;
 
@@ -202,7 +201,7 @@ export const useSignOrder = (input: SignOrderInput) => {
 
         setExecuteTransactions({ method, hash: txnResponse?.hash });
 
-        if (waitForTrnsactionSettlement) {
+        if (waitFulfillmentSettlements) {
           await txnResponse?.wait();
         }
 
@@ -326,7 +325,6 @@ export const useSignOrder = (input: SignOrderInput) => {
 
   const execute = async (
     signData: SignResponse | undefined,
-    waitForTrnsactionSettlement: boolean,
     onTxnSuccess: (txn: ExecutedTransaction) => void,
     onTxnError: (error: any, txns: ExecutedTransaction[]) => void,
   ): Promise<ExecutedTransaction[]> => {
@@ -360,7 +358,6 @@ export const useSignOrder = (input: SignOrderInput) => {
         data,
         gasEstimate,
         method,
-        waitForTrnsactionSettlement,
       );
 
       if (txnError || !hash) {

diff --git a/packages/checkout/widgets-lib/src/widgets/sale/types.ts b/packages/checkout/widgets-lib/src/widgets/sale/types.ts
@@ -52,6 +52,7 @@ export type SignOrderInput = {
   recipientAddress: string;
   environment: string;
   environmentId: string;
+  waitFulfillmentSettlements: boolean;
 };
 
 export type SignOrderError = {

diff --git a/packages/checkout/widgets-lib/src/widgets/sale/views/PayWithCoins.tsx b/packages/checkout/widgets-lib/src/widgets/sale/views/PayWithCoins.tsx
@@ -16,7 +16,7 @@ export function PayWithCoins() {
     sendSuccessEvent,
   } = useSaleEvent();
   const {
-    execute, signResponse, executeResponse, signTokenIds, provider,
+    execute, signResponse, executeResponse, signTokenIds,
   } = useSaleContext();
   const executedTxns = executeResponse?.transactions.length || 0;
 
@@ -35,10 +35,8 @@ export function PayWithCoins() {
   }
 
   const sendTransaction = async () => {
-    const waitForTrnsactionSettlement = !('isMetaMask' in (provider?.provider as any) && provider?.provider.isMetaMask);
     execute(
       signResponse,
-      waitForTrnsactionSettlement,
       (txn) => {
         sendTransactionSuccessEvent(txn); // not an analytics event
       },