@imtbl/sdk 1.5.0 → 1.5.1

package/dist/checkout.d.ts

@@ -21615,7 +21615,7 @@ type SellResultInsufficientFunds = {
     /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
-type CancelResult = CancelResultSuccess | CancelResultFailed | CancelResultFulfillmentsUnsettled;
+type CancelResult = CancelResultSuccess | CancelResultFailed | CancelResultFulfillmentsUnsettled | CancelResultGasless;
 /**
  * Represents the result of {@link Checkout.cancel}
  * @property {CheckoutStatus.SUCCESS} status
@@ -21644,18 +21644,58 @@ type CancelResultFailed = {
  * @property {SendTransactionResult[]} transactions
  */
 type CancelResultFulfillmentsUnsettled = {
-    /** The status to indicate success */
+    /** The status to indicate the fulfillments have not yet settled on chain. */
     status: CheckoutStatus.FULFILLMENTS_UNSETTLED;
     /** Array of transaction results */
     transactions: TransactionResponse[];
 };
+/**
+ * Represents the result of {@link Checkout.cancel} when using gasless cancel
+ * @property {SuccessfulGaslessCancellation[]} successfulCancellations
+ * @property {FailedGaslessCancellation[]} failedCancellations
+ * @property {PendingGaslessCancellation[]} pendingCancellations
+ */
+type CancelResultGasless = {
+    successfulCancellations: SuccessfulGaslessCancellation[];
+    failedCancellations: FailedGaslessCancellation[];
+    pendingCancellations: PendingGaslessCancellation[];
+};
+/**
+ * Represents a successful gasless cancellation
+ * @property {string} orderId
+ */
+type SuccessfulGaslessCancellation = {
+    /** The order id of the successful cancellation */
+    orderId: string;
+};
+/**
+ * Represents a failed gasless cancellation
+ * @property {string} orderId
+ * @property {string} reason
+ */
+type FailedGaslessCancellation = {
+    /** The order id of the failed cancellation */
+    orderId: string;
+    /** The reason for failure */
+    reason: string;
+};
+/**
+ * Represents a pending gasless cancellation
+ * @property {string} orderId
+ */
+type PendingGaslessCancellation = {
+    /** The order id of the pending cancellation */
+    orderId: string;
+};
 /**
  * Represents the overrides available for {@link Checkout.cancel}
  * @property {boolean} waitFulfillmentSettlements
  */
 type CancelOverrides = {
-    /** If the buy should wait for the fulfillment transactions to settle */
+    /** If the cancel should wait for the fulfillment transactions to settle */
     waitFulfillmentSettlements?: boolean;
+    /** If the cancel should use the gasless option */
+    useGaslessCancel?: boolean;
 };
 /**
  * An enum representing the checkout status types
@@ -21674,7 +21714,7 @@ declare enum CheckoutStatus {
 /**
  * The type representing the order to buy
  * @property {string} orderId
- * @property {Array<OrderFee>} takerFees
+ * @property {OrderFee[]} takerFees
  */
 type BuyOrder = {
     /** the id of the order to buy */
@@ -23991,4 +24031,4 @@ declare class BlockExplorerService {
     static getTransactionLink(chainId: ChainId, hash: string): string | undefined;
 }
 
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BlockExplorerService, BridgeClaimWithdrawalFailed, BridgeClaimWithdrawalSuccess, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyOverrides, BuyParams, BuyResult, BuyResultFailed, BuyResultFulfillmentsUnsettled, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelOverrides, CancelParams, CancelResult, CancelResultFailed, CancelResultFulfillmentsUnsettled, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FeeType, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, LanguageChanged, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SalePaymentMethod, SalePaymentTypes, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetLanguage, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };
+export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BlockExplorerService, BridgeClaimWithdrawalFailed, BridgeClaimWithdrawalSuccess, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyOverrides, BuyParams, BuyResult, BuyResultFailed, BuyResultFulfillmentsUnsettled, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelOverrides, CancelParams, CancelResult, CancelResultFailed, CancelResultFulfillmentsUnsettled, CancelResultGasless, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, FailedGaslessCancellation, Fee, FeePercentage, FeeToken, FeeType, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, LanguageChanged, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampEventType, OnRampFailed, OnRampFundingStep, OnRampProviderFees, OnRampSuccess, OnRampWidgetParams, OnrampWidgetConfiguration, OrchestrationEvent, OrchestrationEventData, OrchestrationEventType, OrderFee, PendingGaslessCancellation, ProviderEvent, ProviderEventType, ProviderUpdated, RemoteConfiguration, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, RoutesFound, RoutingOutcome, RoutingOutcomeType, SaleEventType, SaleFailed, SaleItem, SalePaymentMethod, SalePaymentTypes, SaleSuccess, SaleTransactionSuccess, SaleWidgetConfiguration, SaleWidgetParams, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SemanticVersion, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SuccessfulGaslessCancellation, SwapEventType, SwapFailed, SwapFundingStep, SwapRejected, SwapSuccess, SwapWidgetConfiguration, SwapWidgetParams, SwitchNetworkParams, SwitchNetworkResult, TokenAmountEstimate, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletDisconnect, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitch, WalletProviderName, WalletWidgetConfiguration, WalletWidgetParams, Widget, WidgetConfiguration, WidgetConfigurations, WidgetEvent, WidgetEventData, WidgetEventTypes, WidgetLanguage, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };

package/dist/checkout.js

@@ -138,7 +138,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.5.0';
+const SDK_VERSION$1 = '1.5.1';
 let initialised$1 = false;
 const isInitialised$1 = () => initialised$1;
 const getReferrer$1 = () => {
@@ -17088,7 +17088,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.0';
+const SDK_VERSION = '1.5.1';
 let initialised = false;
 const isInitialised = () => initialised;
 const getReferrer = () => {
@@ -27266,7 +27266,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.0',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -28633,7 +28633,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.5.0';
+const SDK_VERSION_MARKER = '1.5.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -31895,9 +31895,7 @@ const buy = async (config, provider, orders, overrides = {
     };
 };
 
-const cancel = async (config, provider, orderIds, overrides = {
-    waitFulfillmentSettlements: true,
-}) => {
+const cancelOnChain = async (config, orderbook, provider, orderIds, waitFulfillmentSettlements) => {
     let unsignedCancelOrderTransaction;
     if (orderIds.length === 0) {
         throw new CheckoutError('No orderIds were provided to the orderIds array. Please provide at least one orderId.', CheckoutErrorType.CANCEL_ORDER_LISTING_ERROR);
@@ -31906,7 +31904,6 @@ const cancel = async (config, provider, orderIds, overrides = {
     const orderId = orderIds[0];
     try {
         const offererAddress = await measureAsyncExecution(config, 'Time to get the address from the provider', provider.getSigner().getAddress());
-        const orderbook = createOrderbookInstance(config);
         const cancelOrderResponse = await measureAsyncExecution(config, 'Time to get the cancel order from the orderbook', orderbook.cancelOrdersOnChain([orderId], offererAddress));
         unsignedCancelOrderTransaction = await cancelOrderResponse.cancellationAction.buildTransaction();
     }
@@ -31916,7 +31913,7 @@ const cancel = async (config, provider, orderIds, overrides = {
             error: err,
         });
     }
-    if (overrides.waitFulfillmentSettlements) {
+    if (waitFulfillmentSettlements) {
         const result = await signFulfillmentTransactions(provider, [unsignedCancelOrderTransaction]);
         if (result.type === SignTransactionStatusType.FAILED) {
             return {
@@ -31944,6 +31941,56 @@ const cancel = async (config, provider, orderIds, overrides = {
         transactions,
     };
 };
+const gaslessCancel = async (orderbook, provider, orderIds) => {
+    try {
+        const signer = provider.getSigner();
+        const address = await signer.getAddress();
+        const { signableAction } = await orderbook.prepareOrderCancellations(orderIds);
+        // eslint-disable-next-line no-underscore-dangle
+        const signedMessage = await signer._signTypedData(signableAction.message.domain, signableAction.message.types, signableAction.message.value);
+        const { result } = await orderbook.cancelOrders(orderIds, address, signedMessage);
+        const successfulCancellations = [];
+        const failedCancellations = [];
+        const pendingCancellations = [];
+        for (const success of result.successful_cancellations) {
+            successfulCancellations.push({
+                orderId: success,
+            });
+        }
+        for (const failed of result.failed_cancellations) {
+            failedCancellations.push({
+                orderId: failed.order,
+                reason: failed.reason_code,
+            });
+        }
+        for (const pending of result.pending_cancellations) {
+            pendingCancellations.push({
+                orderId: pending,
+            });
+        }
+        return {
+            successfulCancellations,
+            failedCancellations,
+            pendingCancellations,
+        };
+    }
+    catch (err) {
+        throw new CheckoutError('An error occurred while cancelling the order listing', CheckoutErrorType.CANCEL_ORDER_LISTING_ERROR, {
+            orderIds,
+            error: err,
+        });
+    }
+};
+const cancel = async (config, provider, orderIds, overrides = {
+    waitFulfillmentSettlements: true,
+    useGaslessCancel: false,
+}) => {
+    const orderbook = createOrderbookInstance(config);
+    if (overrides.useGaslessCancel) {
+        return await gaslessCancel(orderbook, provider, orderIds);
+    }
+    return await cancelOnChain(config, orderbook, provider, orderIds, overrides.waitFulfillmentSettlements ?? true);
+};
 
 const getERC721Requirement = (id, contractAddress, spenderAddress) => ({
     type: ItemType.ERC721,

package/dist/config.js

@@ -127,7 +127,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.0';
+const SDK_VERSION = '1.5.1';
 let initialised = false;
 const isInitialised = () => initialised;
 const getReferrer = () => {