@imtbl/checkout-sdk 2.1.7 → 2.1.8-alpha.1

package/dist/types/widgets/definitions/configurations/index.d.ts

@@ -9,3 +9,4 @@ export * from './widget';
 export * from './addTokens';
 export * from './commerce';
 export * from './purchase';
+export * from './transfer';

package/dist/types/widgets/definitions/configurations/transfer.d.ts

@@ -0,0 +1,5 @@
+import { WidgetConfiguration } from './widget';
+/**
+ * Transfer Widget Configuration represents the configuration options for the Transfer Widget.
+ */
+export type TransferWidgetConfiguration = {} & WidgetConfiguration;

package/dist/types/widgets/definitions/events/index.d.ts

@@ -9,3 +9,4 @@ export * from './onramp';
 export * from './commerce';
 export * from './addTokens';
 export * from './purchase';
+export * from './transfer';

package/dist/types/widgets/definitions/events/transfer.d.ts

@@ -0,0 +1,25 @@
+export declare enum TransferEventType {
+    CLOSE_WIDGET = "close-widget",
+    REJECTED = "rejected",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful transfer.
+ */
+export type TransferSuccess = {
+    transactionHash: string;
+};
+/**
+ * Type representing a transfer failure
+ * @property {string} reason
+ */
+export type TransferFailed = {
+    reason: string;
+    timestamp: number;
+};
+/**
+ * Type representing a transfer rejected
+ * @property {string} reason
+ */
+export type TransferRejected = {};

package/dist/types/widgets/definitions/events/widgets.d.ts

@@ -13,7 +13,8 @@ export declare enum IMTBLWidgetEvents {
     IMTBL_SALE_WIDGET_EVENT = "imtbl-sale-widget",
     IMTBL_COMMERCE_WIDGET_EVENT = "imtbl-commerce-widget",
     IMTBL_ADD_TOKENS_WIDGET_EVENT = "imtbl-add-tokens-widget",
-    IMTBL_PURCHASE_WIDGET_EVENT = "imtbl-purchase-widget"
+    IMTBL_PURCHASE_WIDGET_EVENT = "imtbl-purchase-widget",
+    IMTBL_TRANSFER_WIDGET_EVENT = "imtbl-transfer-widget"
 }
 /**
  * Enum for events raised for about provider objects

package/dist/types/widgets/definitions/parameters/commerce.d.ts

@@ -7,6 +7,7 @@ import { OnRampWidgetParams } from './onramp';
 import { SaleWidgetParams } from './sale';
 import { AddTokensWidgetParams } from './addTokens';
 import { PurchaseWidgetParams } from './purchase';
+import { TransferWidgetParams } from './transfer';
 export declare enum CommerceFlowType {
     CONNECT = "CONNECT",
     WALLET = "WALLET",
@@ -15,7 +16,8 @@ export declare enum CommerceFlowType {
     BRIDGE = "BRIDGE",
     ONRAMP = "ONRAMP",
     ADD_TOKENS = "ADD_TOKENS",
-    PURCHASE = "PURCHASE"
+    PURCHASE = "PURCHASE",
+    TRANSFER = "TRANSFER"
 }
 export type CommerceWidgetConnectFlowParams = {
     flow: CommerceFlowType.CONNECT;
@@ -41,7 +43,10 @@ export type CommerceWidgetAddTokensFlowParams = {
 export type CommerceWidgetPurchaseFlowParams = {
     flow: CommerceFlowType.PURCHASE;
 } & PurchaseWidgetParams;
-export type CommerceWidgetFlowParams = CommerceWidgetConnectFlowParams | CommerceWidgetWalletFlowParams | CommerceWidgetSwapFlowParams | CommerceWidgetBridgeFlowParams | CommerceWidgetOnRampFlowParams | CommerceWidgetSaleFlowParams | CommerceWidgetAddTokensFlowParams | CommerceWidgetPurchaseFlowParams;
+export type CommerceWidgetTransferFlowParams = {
+    flow: CommerceFlowType.TRANSFER;
+} & TransferWidgetParams;
+export type CommerceWidgetFlowParams = CommerceWidgetConnectFlowParams | CommerceWidgetWalletFlowParams | CommerceWidgetSwapFlowParams | CommerceWidgetBridgeFlowParams | CommerceWidgetOnRampFlowParams | CommerceWidgetSaleFlowParams | CommerceWidgetAddTokensFlowParams | CommerceWidgetPurchaseFlowParams | CommerceWidgetTransferFlowParams;
 export type CommerceWidgetParams = {
     /** The language to use for the Commerce Widget */
     language?: WidgetLanguage;

package/dist/types/widgets/definitions/parameters/index.d.ts

@@ -1,4 +1,5 @@
 export type { AddTokensWidgetParams } from './addTokens';
+export type { TransferWidgetParams } from './transfer';
 export * from './connect';
 export * from './bridge';
 export * from './wallet';

package/dist/types/widgets/definitions/parameters/transfer.d.ts

@@ -0,0 +1,13 @@
+import { WidgetLanguage } from '../configurations/widget';
+export type TransferWidgetParams = {
+    /** The language to use for the Purchase widget */
+    language?: WidgetLanguage;
+    /** The amount to transfer */
+    amount?: string;
+    /** The token address to transfer */
+    tokenAddress?: `0x${string}` | 'native';
+    /** The to address to transfer to */
+    toAddress?: `0x${string}`;
+    /** Whether to show the back button */
+    showBackButton?: boolean;
+};

package/dist/types/widgets/definitions/types.d.ts

@@ -1,8 +1,9 @@
 import { Environment } from '@imtbl/config';
 import { BridgeClaimWithdrawalFailed, BridgeClaimWithdrawalSuccess, BridgeEventType, BridgeFailed, BridgeTransactionSent, ConnectEventType, ConnectionFailed, ConnectionSuccess, OnRampEventType, OnRampFailed, OnRampSuccess, OrchestrationEventType, ProviderEventType, ProviderUpdated, RequestBridgeEvent, RequestConnectEvent, RequestOnrampEvent, RequestSwapEvent, RequestWalletEvent, SaleEventType, SaleFailed, SalePaymentMethod, SalePaymentToken, SaleSuccess, SaleTransactionSuccess, SwapEventType, SwapFailed, SwapRejected, SwapSuccess, WalletConnectProviderChanged, WalletDisconnect, WalletEventType, WalletNetworkSwitch, CommerceEventType, CommerceProviderUpdatedEvent, CommerceSuccessEvent, CommerceFailureEvent, CommerceUserActionEvent, RequestAddTokensEvent, RequestGoBackEvent, AddTokensEventType, AddTokensConnectSuccess, AddTokensSuccess, AddTokensFailed, PurchaseConnectSuccess, PurchaseEventType, PurchaseFailed, PurchaseSuccess } from './events';
-import { BridgeWidgetParams, ConnectWidgetParams, SwapWidgetParams, WalletWidgetParams, OnRampWidgetParams, CommerceWidgetParams, AddTokensWidgetParams, SaleWidgetParams, PurchaseWidgetParams } from './parameters';
-import { BridgeWidgetConfiguration, ConnectWidgetConfiguration, OnrampWidgetConfiguration, SaleWidgetConfiguration, SwapWidgetConfiguration, WalletWidgetConfiguration, CommerceWidgetConfiguration, AddTokensWidgetConfiguration, WidgetTheme, PurchaseWidgetConfiguration } from './configurations';
+import { BridgeWidgetParams, ConnectWidgetParams, SwapWidgetParams, WalletWidgetParams, OnRampWidgetParams, CommerceWidgetParams, AddTokensWidgetParams, SaleWidgetParams, PurchaseWidgetParams, TransferWidgetParams } from './parameters';
+import { BridgeWidgetConfiguration, ConnectWidgetConfiguration, OnrampWidgetConfiguration, SaleWidgetConfiguration, SwapWidgetConfiguration, WalletWidgetConfiguration, CommerceWidgetConfiguration, AddTokensWidgetConfiguration, WidgetTheme, PurchaseWidgetConfiguration, TransferWidgetConfiguration } from './configurations';
 import { WrappedBrowserProvider } from '../../types';
+import { TransferEventType, TransferFailed, TransferRejected, TransferSuccess } from './events/transfer';
 /**
  * Enum representing the list of widget types.
  */
@@ -15,7 +16,8 @@ export declare enum WidgetType {
     SALE = "sale",
     IMMUTABLE_COMMERCE = "immutableCommerce",
     ADD_TOKENS = "addTokens",
-    PURCHASE = "purchase"
+    PURCHASE = "purchase",
+    TRANSFER = "transfer"
 }
 /**
  * Widget properties definition for each widget. Used for creating and updating widgets
@@ -34,6 +36,7 @@ export type WidgetConfigurations = {
     [WidgetType.ADD_TOKENS]: AddTokensWidgetConfiguration;
     [WidgetType.PURCHASE]: PurchaseWidgetConfiguration;
     [WidgetType.IMMUTABLE_COMMERCE]: CommerceWidgetConfiguration;
+    [WidgetType.TRANSFER]: TransferWidgetConfiguration;
 };
 export type WidgetParameters = {
     [WidgetType.CONNECT]: ConnectWidgetParams;
@@ -45,6 +48,7 @@ export type WidgetParameters = {
     [WidgetType.ADD_TOKENS]: AddTokensWidgetParams;
     [WidgetType.PURCHASE]: PurchaseWidgetParams;
     [WidgetType.IMMUTABLE_COMMERCE]: CommerceWidgetParams;
+    [WidgetType.TRANSFER]: TransferWidgetParams;
 };
 /**
  * Represents all the possible event types that are emitted by the widgets.
@@ -140,6 +144,12 @@ export type WidgetEventData = {
         [PurchaseEventType.SUCCESS]: PurchaseSuccess;
         [PurchaseEventType.FAILURE]: PurchaseFailed;
     } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.TRANSFER]: {
+        [TransferEventType.CLOSE_WIDGET]: {};
+        [TransferEventType.SUCCESS]: TransferSuccess;
+        [TransferEventType.FAILURE]: TransferFailed;
+        [TransferEventType.REJECTED]: TransferRejected;
+    } & OrchestrationMapping & ProviderEventMapping;
 };
 /**
  * Represents an event emitted by a widget. The event type should match the event data

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@imtbl/checkout-sdk",
   "description": "Immutable Checkout SDK",
-  "version": "2.1.7",
+  "version": "2.1.8-alpha.1",
   "author": "immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
-    "@imtbl/blockchain-data": "2.1.7",
-    "@imtbl/bridge-sdk": "2.1.7",
-    "@imtbl/config": "2.1.7",
-    "@imtbl/dex-sdk": "2.1.7",
-    "@imtbl/generated-clients": "2.1.7",
-    "@imtbl/metrics": "2.1.7",
-    "@imtbl/orderbook": "2.1.7",
-    "@imtbl/passport": "2.1.7",
+    "@imtbl/blockchain-data": "2.1.8-alpha.1",
+    "@imtbl/bridge-sdk": "2.1.8-alpha.1",
+    "@imtbl/config": "2.1.8-alpha.1",
+    "@imtbl/dex-sdk": "2.1.8-alpha.1",
+    "@imtbl/generated-clients": "2.1.8-alpha.1",
+    "@imtbl/metrics": "2.1.8-alpha.1",
+    "@imtbl/orderbook": "2.1.8-alpha.1",
+    "@imtbl/passport": "2.1.8-alpha.1",
     "@metamask/detect-provider": "^2.0.0",
     "axios": "^1.6.5",
     "ethers": "^6.13.4",