WT-1727 Update smart checkout output interfaces (#924)

Author: imx-mikhala

packages/checkout/sdk-sample-app/src/components/Buy.tsx

@@ -1,4 +1,4 @@
-import { Checkout, BuyResult, BuyStatusType, BuyStatus } from '@imtbl/checkout-sdk';
+import { Checkout } from '@imtbl/checkout-sdk';
 import { Web3Provider } from '@ethersproject/providers';
 import LoadingButton from './LoadingButton';
 import { useEffect, useState } from 'react';
@@ -38,7 +38,7 @@ export default function Buy({ checkout, provider }: BuyProps) {
         provider,
         orders: [{id: orderId, takerFees: [{amount: {percentageDecimal: 0.01}, recipient: '0x96654086969DCaa88933E753Aa52d46EAB269Ff7'}]}],
       });
-      console.log(buyResult);
+      console.log('Buy result', buyResult);
       setLoading(false);
     } catch (err: any) {
       console.log(err);

packages/checkout/sdk-sample-app/src/components/Cancel.tsx

@@ -33,10 +33,11 @@ export default function Cancel({ checkout, provider }: CancelProps) {
     setError(null);
     setLoading(true);
     try {
-      await checkout.cancel({
+      const result = await checkout.cancel({
         provider,
         orderIds: [orderId],
       });
+      console.log('Cancel result', result);
       setLoading(false);
     } catch (err: any) {
       setError(err);

packages/checkout/sdk-sample-app/src/components/Listings.tsx

@@ -1,4 +1,4 @@
-import { Checkout, BuyResult, BuyStatusType, BuyStatus } from '@imtbl/checkout-sdk';
+import { Checkout } from '@imtbl/checkout-sdk';
 import { Web3Provider } from '@ethersproject/providers';
 import LoadingButton from './LoadingButton';
 import { useEffect, useState } from 'react';

packages/checkout/sdk-sample-app/src/components/Sell.tsx

@@ -91,10 +91,11 @@ export default function Sell({ checkout, provider }: SellProps) {
         }]
       }]
 
-      await checkout.sell({
+      const result = await checkout.sell({
         provider,
         orders,
       });
+      console.log('Sell result', result);
       setLoading(false);
     } catch (err: any) {
       setError(err);

packages/checkout/sdk-sample-app/src/components/SmartCheckoutForm.tsx

@@ -131,13 +131,14 @@ export const SmartCheckoutForm = ({ checkout, provider }: SmartCheckoutProps) =>
     setLoading(true);
 
     try {
-      checkout.smartCheckout(
+      const result = await checkout.smartCheckout(
         {
           provider,
           itemRequirements,
           transactionOrGasAmount,
         }
       );
+      console.log('Smart checkout result', result);
       setLoading(false);
       setSuccess(true);
     } catch (err: any) {

packages/checkout/sdk/src/Checkout.ts

@@ -48,6 +48,10 @@ import {
   TokenFilterTypes,
   OnRampProviderFees,
   FiatRampParams,
+  SmartCheckoutResult,
+  CancelResult,
+  BuyResult,
+  SellResult,
 } from './types';
 import { CheckoutConfiguration } from './config';
 import { createReadOnlyProviders } from './readOnlyProviders/readOnlyProvider';
@@ -282,7 +286,7 @@ export class Checkout {
   */
   public async buy(
     params: BuyParams,
-  ): Promise<void> {
+  ): Promise<BuyResult> {
     if (this.config.isProduction) {
       throw new Error('This endpoint is not currently available.');
     }
@@ -292,15 +296,15 @@ export class Checkout {
 
     if (params.orders.length > 1) {
       // eslint-disable-next-line no-console
-      console.warn('This endpoint currently only actions the first order in the array.');
+      console.warn('This endpoint currently only processes the first order in the array.');
     }
 
     const web3Provider = await provider.validateProvider(
       this.config,
       params.provider,
     );
 
-    await buy.buy(this.config, web3Provider, params.orders);
+    return await buy.buy(this.config, web3Provider, params.orders);
   }
 
   /**
@@ -311,7 +315,7 @@ export class Checkout {
   */
   public async sell(
     params: SellParams,
-  ): Promise<void> {
+  ): Promise<SellResult> {
     if (this.config.isProduction) {
       throw new Error('This endpoint is not currently available.');
     }
@@ -321,15 +325,15 @@ export class Checkout {
 
     if (params.orders.length > 1) {
       // eslint-disable-next-line no-console
-      console.warn('This endpoint currently only actions the first order in the array.');
+      console.warn('This endpoint currently only processes the first order in the array.');
     }
 
     const web3Provider = await provider.validateProvider(
       this.config,
       params.provider,
     );
 
-    await sell.sell(
+    return await sell.sell(
       this.config,
       web3Provider,
       params.orders,
@@ -342,7 +346,7 @@ export class Checkout {
    */
   public async cancel(
     params: CancelParams,
-  ): Promise<void> {
+  ): Promise<CancelResult> {
     if (this.config.isProduction) {
       throw new Error('This endpoint is not currently available.');
     }
@@ -351,14 +355,14 @@ export class Checkout {
     console.warn('This endpoint is currently under construction.');
 
     // eslint-disable-next-line no-console
-    console.warn('This endpoint currently only actions the first order in the array.');
+    console.warn('This endpoint currently only processes the first order in the array.');
 
     const web3Provider = await provider.validateProvider(
       this.config,
       params.provider,
     );
 
-    await cancel.cancel(this.config, web3Provider, params.orderIds);
+    return await cancel.cancel(this.config, web3Provider, params.orderIds);
   }
 
   /**
@@ -367,7 +371,7 @@ export class Checkout {
    */
   public async smartCheckout(
     params: SmartCheckoutParams,
-  ): Promise<void> {
+  ): Promise<SmartCheckoutResult> {
     if (this.config.isProduction) {
       throw new Error('This endpoint is not currently available.');
     }
@@ -387,7 +391,7 @@ export class Checkout {
       throw new CheckoutError('Failed to map item requirements', CheckoutErrorType.ITEM_REQUIREMENTS_ERROR);
     }
 
-    await smartCheckout.smartCheckout(
+    return await smartCheckout.smartCheckout(
       this.config,
       web3Provider,
       itemRequirements,

packages/checkout/sdk/src/index.ts

@@ -3,6 +3,7 @@ export {
   ChainId,
   ChainName,
   CHECKOUT_API_BASE_URL,
+  CheckoutStatus,
   ExchangeType,
   GasEstimateType,
   GasTokenType,
@@ -15,24 +16,30 @@ export {
 } from './types';
 export type {
   AllowedNetworkConfig,
+  BuyOrder,
   BuyParams,
   BuyResult,
+  BuyToken,
   CancelParams,
+  CancelResult,
   CheckConnectionParams,
   CheckConnectionResult,
   CheckoutModuleConfiguration,
   ConnectParams,
   ConnectResult,
+  DexConfig,
   ERC20ItemRequirement,
   ERC721ItemRequirement,
-  FiatRampParams,
-  DexConfig,
   FeePercentage,
   FeeToken,
+  FiatRampParams,
+  FulfillmentTransaction,
+  GasAmount,
   GasEstimateBridgeToL2Result,
   GasEstimateParams,
   GasEstimateSwapResult,
   GasEstimateTokenConfig,
+  GasToken,
   GetAllBalancesParams,
   GetAllBalancesResult,
   GetBalanceParams,
@@ -50,8 +57,8 @@ export type {
   NetworkInfo,
   OrderFee,
   RemoteConfiguration,
-  SellParams,
   SellOrder,
+  SellParams,
   SellResult,
   SellToken,
   SendTransactionParams,

packages/checkout/sdk/src/smartCheckout/allowList/allowListCheck.test.ts

@@ -2,7 +2,10 @@ import { Environment } from '@imtbl/config';
 import { BigNumber } from 'ethers';
 import { CheckoutConfiguration } from '../../config';
 import {
-  allowListCheck, allowListCheckForBridge, allowListCheckForOnRamp, allowListCheckForSwap,
+  allowListCheck,
+  allowListCheckForBridge,
+  allowListCheckForOnRamp,
+  allowListCheckForSwap,
 } from './allowListCheck';
 import {
   BridgeConfig,

packages/checkout/sdk/src/smartCheckout/allowList/allowListCheck.ts

@@ -2,7 +2,7 @@ import { CheckoutConfiguration, getL1ChainId, getL2ChainId } from '../../config'
 import {
   BridgeConfig,
   DexConfig, OnRampConfig,
-  RoutingOptionsAvailable,
+  AvailableRoutingOptions,
   TokenInfo,
 } from '../../types';
 import { TokenBalanceResult, TokenBalances } from '../routing/types';
@@ -23,7 +23,7 @@ const filterTokens = (allowedTokens: TokenInfo[], balances: TokenBalanceResult |
 
 export const allowListCheckForOnRamp = async (
   config: CheckoutConfiguration,
-  availableRoutingOptions: RoutingOptionsAvailable,
+  availableRoutingOptions: AvailableRoutingOptions,
 ) : Promise<OnRampTokensAllowList> => {
   if (availableRoutingOptions.onRamp) {
     const onRampOptions = await config.remote.getConfig('onramp') as OnRampConfig;
@@ -42,7 +42,7 @@ export const allowListCheckForOnRamp = async (
 export const allowListCheckForBridge = async (
   config: CheckoutConfiguration,
   tokenBalances: TokenBalances,
-  availableRoutingOptions: RoutingOptionsAvailable,
+  availableRoutingOptions: AvailableRoutingOptions,
 ) : Promise<TokenInfo[]> => {
   if (availableRoutingOptions.bridge) {
     const allowedTokens = ((await config.remote.getConfig('bridge')) as BridgeConfig)?.tokens ?? [];
@@ -56,7 +56,7 @@ export const allowListCheckForBridge = async (
 export const allowListCheckForSwap = async (
   config: CheckoutConfiguration,
   tokenBalances: TokenBalances,
-  availableRoutingOptions: RoutingOptionsAvailable,
+  availableRoutingOptions: AvailableRoutingOptions,
 ) : Promise<TokenInfo[]> => {
   if (availableRoutingOptions.swap) {
     const allowedTokens = ((await config.remote.getConfig('dex')) as DexConfig)?.tokens ?? [];
@@ -73,7 +73,7 @@ export const allowListCheckForSwap = async (
 export const allowListCheck = async (
   config: CheckoutConfiguration,
   tokenBalances: TokenBalances,
-  availableRoutingOptions: RoutingOptionsAvailable,
+  availableRoutingOptions: AvailableRoutingOptions,
 ) : Promise<RoutingTokensAllowList> => {
   const tokenAllowList: RoutingTokensAllowList = {};
   tokenAllowList.swap = await allowListCheckForSwap(config, tokenBalances, availableRoutingOptions);