@imtbl/checkout-sdk 2.0.0-alpha.0

package/dist/types/types/swap.d.ts

@@ -0,0 +1,47 @@
+import { Quote, TransactionDetails } from '@imtbl/dex-sdk';
+import { TransactionReceipt, Eip1193Provider } from 'ethers';
+import { TokenInfo } from './tokenInfo';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the parameters for {@link Checkout.swap}.
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider used to get the wallet address.
+ * @property {TokenInfo} fromToken - The token to swap from.
+ * @property {TokenInfo} toToken - The token to swap to.
+ * @property {string | undefined} fromAmount - The amount to swap from.
+ * @property {string | undefined} toAmount - The amount to swap to.
+ * @property {number | undefined} slippagePercent - The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0
+ * @property {number | undefined} maxHops - Maximum hops allowed in optimal route. Default is 2
+ * @property {number | undefined} deadline - Latest time swap can execute. Default is 15 minutes
+ */
+export interface SwapParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    fromToken: TokenInfo;
+    toToken: TokenInfo;
+    fromAmount?: string;
+    toAmount?: string;
+    slippagePercent?: number;
+    maxHops?: number;
+    deadline?: number;
+}
+/**
+ * Interface representing the result of {@link Checkout.swapQuote}.
+ * @property {TransactionDetails} approval - The approval transaction details.
+ * @property {TransactionDetails} swap - The swap transaction details.
+ * @property {Quote} quote - The quote for the swap.
+ */
+export interface SwapQuoteResult {
+    approval: TransactionDetails | null;
+    swap: TransactionDetails;
+    quote: Quote;
+}
+/**
+ * Interface representing the result of {@link Checkout.swap}.
+ * @property {TransactionDetails} swap - The swap transaction details.
+ * @property {Quote} quote - The quote for the swap.
+ * @property {TransactionReceipt | null} swapReceipt - The receipt of the swap transaction.
+ */
+export interface SwapResult {
+    swap: TransactionDetails;
+    quote: Quote;
+    swapReceipt: TransactionReceipt | null;
+}

package/dist/types/types/token.d.ts

@@ -0,0 +1,40 @@
+import { ChainId } from './chains';
+import { TokenInfo } from './tokenInfo';
+export interface TokenMasterInfo extends TokenInfo {
+    chainId: ChainId;
+    tokenFeatures: TokenFilterTypes[];
+}
+/**
+ * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
+ * @property {TokenFilterTypes} type - The type of token to retrieve.
+ * @property {ChainId}  chainId - The ID of the blockchain network.
+ * @property {TokenFilter[]} [exclude] - The tokens to exclude from the list.
+ */
+export interface GetTokenAllowListParams {
+    type: TokenFilterTypes;
+    chainId: ChainId;
+    exclude?: TokenFilter[];
+}
+/**
+ * Interface representing the result of {@link Checkout.getTokenAllowList}.
+ * @property {TokenInfo[]} tokens - The list of tokens allowed for the specified params.
+ */
+export interface GetTokenAllowListResult {
+    tokens: TokenInfo[];
+}
+/**
+ * Enum representing the types of token filters available.
+ */
+export declare enum TokenFilterTypes {
+    ALL = "all",
+    SWAP = "swap",
+    BRIDGE = "bridge",
+    ONRAMP = "onramp"
+}
+/**
+ * Interface representing a token filter that can be used to exclude certain tokens.
+ * @property {string} address - The token contract address.
+ */
+export interface TokenFilter {
+    address: string;
+}

package/dist/types/types/tokenInfo.d.ts

@@ -0,0 +1,27 @@
+import { JsonRpcProvider } from 'ethers';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Represents information about a token.
+ * @interface TokenInfo
+ * @property {string} name - The name of the token.
+ * @property {string} symbol - The symbol of the token.
+ * @property {number} decimals - The number of decimal places the token supports.
+ * @property {string | undefined} [address] - The address of the token.
+ * @property {string | undefined} [icon] - The URL of the token's icon.
+ */
+export interface TokenInfo {
+    name: string;
+    symbol: string;
+    decimals: number;
+    address?: string;
+    icon?: string;
+}
+/**
+ * Interface representing the parameters for {@link Checkout.getTokenInfo}.
+ * @property {WrappedBrowserProvider | JsonRpcProvider} provider - The provider used to get the balance.
+ * @property {string} tokenAddress - The contract address of the token.
+ */
+export interface GetTokenInfoParams {
+    provider: WrappedBrowserProvider | JsonRpcProvider;
+    tokenAddress: string;
+}

package/dist/types/types/transaction.d.ts

@@ -0,0 +1,18 @@
+import { TransactionRequest, TransactionResponse, Eip1193Provider } from 'ethers';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the parameters for {@link Checkout.sendTransaction}.
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider to connect to the network.
+ * @property {TransactionRequest} transaction - The transaction to send.
+ */
+export interface SendTransactionParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    transaction: TransactionRequest;
+}
+/**
+ * Interface representing the result of {@link Checkout.sendTransaction}.
+ * @property {TransactionResponse} transactionResponse - The response of the transaction.
+ */
+export interface SendTransactionResult {
+    transactionResponse: TransactionResponse;
+}

package/dist/types/types/wallet.d.ts

@@ -0,0 +1,49 @@
+import { WalletProviderName } from './provider';
+export declare enum WalletAction {
+    CHECK_CONNECTION = "eth_accounts",
+    CONNECT = "eth_requestAccounts",
+    ADD_NETWORK = "wallet_addEthereumChain",
+    SWITCH_NETWORK = "wallet_switchEthereumChain",
+    GET_CHAINID = "eth_chainId",
+    REQUEST_PERMISSIONS = "wallet_requestPermissions"
+}
+/**
+ * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name to filter wallets by.
+ */
+export interface WalletFilter {
+    walletProviderName: WalletProviderName;
+}
+/**
+ * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
+ * @property {WalletFilterTypes} type - The type of wallets to filter by.
+ * @property {WalletFilter[]} [exclude] - An optional list of wallet filters to exclude from the allowed wallets list.
+ */
+export interface GetWalletAllowListParams {
+    type: WalletFilterTypes;
+    exclude?: WalletFilter[];
+}
+/**
+ * Interface representing information about a wallet used in {@link GetWalletAllowListResult}.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name for the wallet.
+ * @property {string | undefined} description - A description of the wallet.
+ * @property {string | undefined} icon - The URL/data:image of an icon for the wallet.
+ */
+export interface WalletInfo {
+    walletProviderName: WalletProviderName;
+    description?: string;
+    icon?: string;
+}
+/**
+ * Interface representing the result of {@link Checkout.getWalletAllowList}.
+ * @property {WalletInfo[]} wallets - A list of {@link WalletInfo} objects representing the allowed wallets.
+ */
+export interface GetWalletAllowListResult {
+    wallets: WalletInfo[];
+}
+/**
+ * Enum representing the platform filters used in {@link GetWalletAllowListParams}.
+ */
+export declare enum WalletFilterTypes {
+    ALL = "all"
+}

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

@@ -0,0 +1,11 @@
+import { WidgetConfiguration } from '../widgets/definitions/configurations/widget';
+import { SemanticVersion } from '../widgets/definitions/types';
+/**
+ * Represents the configuration options for instantiating the Commerce Widgets factory.
+ * @property {WidgetConfiguration} config - global configuration options for the widgets.
+ * @property {SemanticVersion | undefined} version - version of the Commerce Widgets bundle(default latest version will be used).
+ */
+export type WidgetsInit = {
+    config: WidgetConfiguration;
+    version?: SemanticVersion;
+};

package/dist/types/utils/utils.d.ts

@@ -0,0 +1,11 @@
+import { ChainId } from '../types';
+export declare const isMatchingAddress: (addressA?: string, addressB?: string) => boolean;
+export declare const isZkEvmChainId: (chainId: ChainId) => chainId is ChainId.IMTBL_ZKEVM_MAINNET | ChainId.IMTBL_ZKEVM_TESTNET | ChainId.IMTBL_ZKEVM_DEVNET;
+/**
+ * Rounds up a token amount to a set number of decimals, so it can be handled by Swap, Bridge, OnRamp Widgets.
+ * Widgets can only handle formatted values of 6 (DEFAULT_TOKEN_FORMATTING_DECIMALS) decimals.
+ * @param amount
+ * @param maxDecimals
+ * @returns
+ */
+export declare const formatSmartCheckoutAmount: (amount: string, maxDecimals?: number) => string;

package/dist/types/utils/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/wallet/index.d.ts

@@ -0,0 +1 @@
+export * from './wallet';

package/dist/types/wallet/wallet.d.ts

@@ -0,0 +1,2 @@
+import { GetWalletAllowListParams, GetWalletAllowListResult } from '../types';
+export declare function getWalletAllowList(params: GetWalletAllowListParams): Promise<GetWalletAllowListResult>;

package/dist/types/wallet/wallet.test.d.ts

@@ -0,0 +1 @@
+export {};

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

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

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

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

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

@@ -0,0 +1,17 @@
+import { ConnectWidgetConfiguration } from './connect';
+import { WalletWidgetConfiguration } from './wallet';
+import { BridgeWidgetConfiguration } from './bridge';
+import { SwapWidgetConfiguration } from './swap';
+import { OnrampWidgetConfiguration } from './onramp';
+import { SaleWidgetConfiguration } from './sale';
+import { AddTokensWidgetConfiguration } from './addTokens';
+import { WidgetConfiguration } from './widget';
+export type CommerceWidgetConfiguration = {
+    CONNECT?: Omit<ConnectWidgetConfiguration, keyof WidgetConfiguration>;
+    WALLET?: Omit<WalletWidgetConfiguration, keyof WidgetConfiguration>;
+    SWAP?: Omit<SwapWidgetConfiguration, keyof WidgetConfiguration>;
+    BRIDGE?: Omit<BridgeWidgetConfiguration, keyof WidgetConfiguration>;
+    ONRAMP?: Omit<OnrampWidgetConfiguration, keyof WidgetConfiguration>;
+    SALE?: Omit<SaleWidgetConfiguration, keyof WidgetConfiguration>;
+    ADD_TOKENS?: Omit<AddTokensWidgetConfiguration, keyof WidgetConfiguration>;
+} & Omit<WidgetConfiguration, 'walletConnect'>;

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

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

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

@@ -0,0 +1,11 @@
+export * from './connect';
+export * from './bridge';
+export * from './wallet';
+export * from './swap';
+export * from './onramp';
+export * from './sale';
+export * from './theme';
+export * from './widget';
+export * from './addTokens';
+export * from './commerce';
+export * from './purchase';

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

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

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

@@ -0,0 +1,2 @@
+import { WidgetConfiguration } from './widget';
+export type PurchaseWidgetConfiguration = {} & WidgetConfiguration;

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

@@ -0,0 +1,8 @@
+import { WidgetConfiguration } from './widget';
+/**
+ * Sale Widget Configuration represents the configuration options for the Sale Widget.
+ */
+export type SaleWidgetConfiguration = {
+    waitFulfillmentSettlements?: boolean;
+    hideExcludedPaymentTypes?: boolean;
+} & WidgetConfiguration;

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

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

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

@@ -0,0 +1,7 @@
+/**
+ * Enum representing the themes for the widgets.
+ */
+export declare enum WidgetTheme {
+    LIGHT = "light",
+    DARK = "dark"
+}

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

@@ -0,0 +1,12 @@
+import { WidgetConfiguration } from './widget';
+/**
+ * Wallet Widget Configuration represents the configuration options for the Wallet Widget.
+ * @property {boolean | undefined} showDisconnectButton
+ * @property {boolean | undefined} showNetworkMenu
+ */
+export type WalletWidgetConfiguration = {
+    /** Show/hide the disconnect button in the Wallet Widget (defaults to true) */
+    showDisconnectButton?: boolean;
+    /** Show/hide the network menu in the Wallet Widget (defaults to true) */
+    showNetworkMenu?: boolean;
+} & WidgetConfiguration;

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

@@ -0,0 +1,31 @@
+import { WidgetTheme } from './theme';
+/**
+ * Widget Configuration represents the shared configuration options for the Commerce Widgets.
+ * @property {WidgetTheme | undefined} theme
+ * @property {WidgetLanguage | undefined} language
+ * @property {WalletConnectConfig | undefined} walletConnect
+ */
+export type WidgetConfiguration = {
+    /** The theme of the Commerce Widget (default: "DARK") */
+    theme?: WidgetTheme;
+    language?: WidgetLanguage;
+    walletConnect?: WalletConnectConfig;
+};
+/**
+ * Widget Language represents the language options for the Commerce Widgets.
+ */
+export type WidgetLanguage = 'en' | 'ja' | 'ko' | 'zh';
+/**
+ * WalletConnect Config represents the configuration required to enable WalletConnect for the Commerce Widgets.
+ */
+export type WalletConnectConfig = {
+    /** WalletConnect projectId */
+    projectId: string;
+    /** Dapp metadata that will be displayed on wallet connection and transaction approvals. */
+    metadata: {
+        name: string;
+        description: string;
+        url: string;
+        icons: string[];
+    };
+};

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

@@ -0,0 +1,41 @@
+import { EIP6963ProviderInfo, WrappedBrowserProvider } from '../../../types';
+/**
+ * Enum of possible Add Tokens Widget event types.
+ */
+export declare enum AddTokensEventType {
+    CLOSE_WIDGET = "close-widget",
+    LANGUAGE_CHANGED = "language-changed",
+    CONNECT_SUCCESS = "connect-success",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful add tokens transaction.
+ * @property {string} transactionHash
+ */
+export type AddTokensSuccess = {
+    /** The transaction hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Type representing add tokens failure
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+export type AddTokensFailed = {
+    /** The reason why it failed. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};
+/**
+ * Type representing a successful provider connection
+ * @property {WrappedBrowserProvider} provider
+ * @property {EIP6963ProviderInfo} providerInfo
+ * @property {'from' | 'to'} providerType
+ */
+export type AddTokensConnectSuccess = {
+    provider: WrappedBrowserProvider;
+    providerInfo: EIP6963ProviderInfo;
+    providerType: 'from' | 'to';
+};

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

@@ -0,0 +1,52 @@
+/**
+ * Enum of possible Bridge Widget event types.
+ */
+export declare enum BridgeEventType {
+    CLOSE_WIDGET = "close-widget",
+    FAILURE = "failure",
+    TRANSACTION_SENT = "transaction-sent",
+    LANGUAGE_CHANGED = "language-changed",
+    CLAIM_WITHDRAWAL_SUCCESS = "claim-withdrawal-success",
+    CLAIM_WITHDRAWAL_FAILURE = "claim-withdrawal-failure"
+}
+/**
+ * Represents a successful bridge transaction.
+ * @property {string} transactionHash
+ */
+export type BridgeTransactionSent = {
+    /** The hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Represents a failed bridge transaction.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+export type BridgeFailed = {
+    /** The reason for the failed transaction. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};
+/**
+ * Represents a successful bridge claim withdrawal.
+ * @property {string} transactionHash
+ */
+export type BridgeClaimWithdrawalSuccess = {
+    /** The hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Represents a failed bridge claim withdrawal.
+ * @property {string} transactionHash
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+export type BridgeClaimWithdrawalFailed = {
+    /** The hash of the failed transaction. */
+    transactionHash: string;
+    /** The reason for the failed transaction. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};

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

@@ -0,0 +1,134 @@
+import { ConnectionFailed, ConnectionSuccess } from './connect';
+import { SaleFailed, SalePaymentMethod, SalePaymentToken, SaleSuccess, SaleTransactionSuccess } from './sale';
+import { EIP6963ProviderInfo, WalletProviderName, WrappedBrowserProvider } from '../../../types';
+import { OnRampFailed, OnRampSuccess } from './onramp';
+import { BridgeClaimWithdrawalFailed, BridgeClaimWithdrawalSuccess, BridgeFailed, BridgeTransactionSent } from './bridge';
+import { SwapFailed, SwapRejected, SwapSuccess } from './swap';
+import { WalletNetworkSwitch } from './wallet';
+import { AddTokensFailed, AddTokensSuccess, AddTokensConnectSuccess } from './addTokens';
+export declare enum CommerceEventType {
+    INITIALISED = "INITIALISED",
+    PROVIDER_UPDATED = "PROVIDER_UPDATED",
+    CLOSE = "CLOSE",
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE",
+    DISCONNECTED = "DISCONNECTED",
+    USER_ACTION = "USER_ACTION"
+}
+export declare enum CommerceSuccessEventType {
+    SWAP_SUCCESS = "SWAP_SUCCESS",
+    ONRAMP_SUCCESS = "ONRAMP_SUCCESS",
+    CONNECT_SUCCESS = "CONNECT_SUCCESS",
+    SALE_SUCCESS = "SALE_SUCCESS",
+    SALE_TRANSACTION_SUCCESS = "SALE_TRANSACTION_SUCCESS",
+    BRIDGE_SUCCESS = "BRIDGE_SUCCESS",
+    BRIDGE_CLAIM_WITHDRAWAL_SUCCESS = "BRIDGE_CLAIM_WITHDRAWAL_SUCCESS",
+    ADD_TOKENS_SUCCESS = "ADD_TOKENS_SUCCESS",
+    ADD_TOKENS_CONNECT_SUCCESS = "ADD_TOKENS_CONNECT_SUCCESS"
+}
+export declare enum CommerceFailureEventType {
+    BRIDGE_FAILED = "BRIDGE_FAILED",
+    BRIDGE_CLAIM_WITHDRAWAL_FAILED = "BRIDGE_CLAIM_WITHDRAWAL_FAILED",
+    SWAP_FAILED = "SWAP_FAILED",
+    SWAP_REJECTED = "SWAP_REJECTED",
+    CONNECT_FAILED = "CONNECT_FAILED",
+    SALE_FAILED = "SALE_FAILED",
+    ONRAMP_FAILED = "ONRAMP_FAILED",
+    ADD_TOKENS_FAILED = "ADD_TOKENS_FAILED"
+}
+export declare enum CommerceUserActionEventType {
+    PAYMENT_METHOD_SELECTED = "PAYMENT_METHOD_SELECTED",
+    PAYMENT_TOKEN_SELECTED = "PAYMENT_TOKEN_SELECTED",
+    NETWORK_SWITCH = "NETWORK_SWITCH"
+}
+export type CommerceProviderUpdatedEvent = {
+    /** The connected provider. */
+    provider: WrappedBrowserProvider;
+    /** The wallet provider name of the connected provider. */
+    walletProviderName: WalletProviderName | undefined;
+    /** The wallet provider EIP-6963 metadata. */
+    walletProviderInfo: EIP6963ProviderInfo | undefined;
+};
+export type CommerceSaleSuccessEvent = {
+    type: CommerceSuccessEventType.SALE_SUCCESS;
+    data: SaleSuccess;
+};
+export type CommerceSaleSuccessfulTransactionEvent = {
+    type: CommerceSuccessEventType.SALE_TRANSACTION_SUCCESS;
+    data: SaleTransactionSuccess;
+};
+export type CommerceOnRampSuccessEvent = {
+    type: CommerceSuccessEventType.ONRAMP_SUCCESS;
+    data: OnRampSuccess;
+};
+export type CommerceBridgeSuccessEvent = {
+    type: CommerceSuccessEventType.BRIDGE_SUCCESS;
+    data: BridgeTransactionSent;
+};
+export type CommerceBridgeClaimWithdrawalSuccessEvent = {
+    type: CommerceSuccessEventType.BRIDGE_CLAIM_WITHDRAWAL_SUCCESS;
+    data: BridgeClaimWithdrawalSuccess;
+};
+export type CommerceSwapSuccessEvent = {
+    type: CommerceSuccessEventType.SWAP_SUCCESS;
+    data: SwapSuccess;
+};
+export type CommerceConnectSuccessEvent = {
+    type: CommerceSuccessEventType.CONNECT_SUCCESS;
+    data: ConnectionSuccess;
+};
+export type CommerceAddTokensSuccessEvent = {
+    type: CommerceSuccessEventType.ADD_TOKENS_SUCCESS;
+    data: AddTokensSuccess;
+};
+export type CommerceAddTokensConnectSuccessEvent = {
+    type: CommerceSuccessEventType.ADD_TOKENS_CONNECT_SUCCESS;
+    data: AddTokensConnectSuccess;
+};
+export type CommerceSuccessEvent = CommerceAddTokensSuccessEvent | CommerceAddTokensConnectSuccessEvent | CommerceConnectSuccessEvent | CommerceBridgeSuccessEvent | CommerceBridgeClaimWithdrawalSuccessEvent | CommerceOnRampSuccessEvent | CommerceSwapSuccessEvent | CommerceSaleSuccessEvent | CommerceSaleSuccessfulTransactionEvent;
+export type CommerceBridgeFailureEvent = {
+    type: CommerceFailureEventType.BRIDGE_FAILED;
+    data: BridgeFailed;
+};
+export type CommerceBridgeClaimWithdrawalFailedEvent = {
+    type: CommerceFailureEventType.BRIDGE_CLAIM_WITHDRAWAL_FAILED;
+    data: BridgeClaimWithdrawalFailed;
+};
+export type CommerceConnectFailureEvent = {
+    type: CommerceFailureEventType.CONNECT_FAILED;
+    data: ConnectionFailed;
+};
+export type CommerceOnRampFailureEvent = {
+    type: CommerceFailureEventType.ONRAMP_FAILED;
+    data: OnRampFailed;
+};
+export type CommerceSwapFailureEvent = {
+    type: CommerceFailureEventType.SWAP_FAILED;
+    data: SwapFailed;
+};
+export type CommerceSwapRejectedEvent = {
+    type: CommerceFailureEventType.SWAP_REJECTED;
+    data: SwapRejected;
+};
+export type CommerceSaleFailureEvent = {
+    type: CommerceFailureEventType.SALE_FAILED;
+    data: SaleFailed;
+};
+export type CommerceAddTokensFailureEvent = {
+    type: CommerceFailureEventType.ADD_TOKENS_FAILED;
+    data: AddTokensFailed;
+};
+export type CommerceFailureEvent = CommerceAddTokensFailureEvent | CommerceBridgeFailureEvent | CommerceBridgeClaimWithdrawalFailedEvent | CommerceConnectFailureEvent | CommerceOnRampFailureEvent | CommerceSwapFailureEvent | CommerceSwapRejectedEvent | CommerceSaleFailureEvent;
+export type CommercePaymentMethodSelectedEvent = {
+    type: CommerceUserActionEventType.PAYMENT_METHOD_SELECTED;
+    data: SalePaymentMethod;
+};
+export type CommercePaymentTokenSelectedEvent = {
+    type: CommerceUserActionEventType.PAYMENT_TOKEN_SELECTED;
+    data: SalePaymentToken;
+};
+export type CommerceNetworkSwitchEvent = {
+    type: CommerceUserActionEventType.NETWORK_SWITCH;
+    data: WalletNetworkSwitch;
+};
+export type CommerceUserActionEvent = CommercePaymentMethodSelectedEvent | CommercePaymentTokenSelectedEvent | CommerceNetworkSwitchEvent;

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

@@ -0,0 +1,47 @@
+import { EIP6963ProviderInfo, WrappedBrowserProvider, WalletProviderName } from '../../../types';
+/**
+ * Enum representing possible Connect Widget event types.
+ */
+export declare enum ConnectEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    LANGUAGE_CHANGED = "language-changed",
+    WALLETCONNECT_PROVIDER_UPDATED = "walletconnect-provider-updated"
+}
+/**
+ * Represents a successful connection.
+ * @property {WrappedBrowserProvider} provider
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+export type ConnectionSuccess = {
+    /** The connected provider. */
+    provider: WrappedBrowserProvider;
+    /** The wallet provider name of the connected provider. */
+    walletProviderName: WalletProviderName | undefined;
+    /** The wallet provider EIP-6963 metadata. */
+    walletProviderInfo: EIP6963ProviderInfo | undefined;
+};
+/**
+ * Represents a connection failure with a reason.
+ * @property {string} reason
+ */
+export type ConnectionFailed = {
+    /** The reason for the failed connection. */
+    reason: string;
+};
+export type WalletConnectProviderChanged = {
+    ethereumProvider: any;
+    walletConnectManager: WalletConnectManager;
+};
+/**
+ * Provides access to the underlying WalletConnect modal and provider.
+ */
+export interface WalletConnectManager {
+    isInitialised: () => boolean;
+    isEnabled: () => boolean;
+    getModal: () => any;
+    getProvider: () => Promise<any>;
+    loadWalletListings: () => Promise<Response | undefined>;
+    getWalletLogoUrl: (walletSlug?: string) => Promise<string | undefined>;
+}

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

@@ -0,0 +1,11 @@
+export * from './widgets';
+export * from './connect';
+export * from './wallet';
+export * from './swap';
+export * from './sale';
+export * from './bridge';
+export * from './orchestration';
+export * from './onramp';
+export * from './commerce';
+export * from './addTokens';
+export * from './purchase';