@imtbl/sdk 0.28.10 → 0.29.0-alpha.1

package/dist/checkout_sdk.d.ts

@@ -41,6 +41,14 @@ declare class BigNumber implements Hexable {
     static isBigNumber(value: any): value is BigNumber;
 }
 
+declare type Network = {
+    name: string;
+    chainId: number;
+    ensAddress?: string;
+    _defaultProvider?: (providers: any, options?: any) => any;
+};
+declare type Networkish = Network | string | number;
+
 declare type Deferrable<T> = {
     [K in keyof T]: T[K] | Promise<T[K]>;
 };
@@ -50,14 +58,6 @@ declare class Description<T = any> {
     });
 }
 
-declare type Network = {
-    name: string;
-    chainId: number;
-    ensAddress?: string;
-    _defaultProvider?: (providers: any, options?: any) => any;
-};
-declare type Networkish = Network | string | number;
-
 declare type AccessList = Array<{
     address: string;
     storageKeys: Array<string>;
@@ -238,43 +238,6 @@ declare abstract class Provider$1 implements OnceBlockable {
     static isProvider(value: any): value is Provider$1;
 }
 
-interface TypedDataDomain {
-    name?: string;
-    version?: string;
-    chainId?: BigNumberish;
-    verifyingContract?: string;
-    salt?: BytesLike;
-}
-interface TypedDataField {
-    name: string;
-    type: string;
-}
-interface TypedDataSigner {
-    _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
-}
-declare abstract class Signer {
-    readonly provider?: Provider$1;
-    abstract getAddress(): Promise<string>;
-    abstract signMessage(message: Bytes | string): Promise<string>;
-    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
-    abstract connect(provider: Provider$1): Signer;
-    readonly _isSigner: boolean;
-    constructor();
-    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
-    getTransactionCount(blockTag?: BlockTag): Promise<number>;
-    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
-    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
-    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
-    getChainId(): Promise<number>;
-    getGasPrice(): Promise<BigNumber>;
-    getFeeData(): Promise<FeeData$1>;
-    resolveName(name: string): Promise<string>;
-    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
-    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
-    _checkProvider(operation?: string): void;
-    static isSigner(value: any): value is Signer;
-}
-
 declare type FormatFunc = (value: any) => any;
 declare type FormatFuncs = {
     [key: string]: FormatFunc;
@@ -475,6 +438,43 @@ declare class BaseProvider extends Provider$1 implements EnsProvider {
     removeAllListeners(eventName?: EventType): this;
 }
 
+interface TypedDataDomain {
+    name?: string;
+    version?: string;
+    chainId?: BigNumberish;
+    verifyingContract?: string;
+    salt?: BytesLike;
+}
+interface TypedDataField {
+    name: string;
+    type: string;
+}
+interface TypedDataSigner {
+    _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>;
+}
+declare abstract class Signer {
+    readonly provider?: Provider$1;
+    abstract getAddress(): Promise<string>;
+    abstract signMessage(message: Bytes | string): Promise<string>;
+    abstract signTransaction(transaction: Deferrable<TransactionRequest>): Promise<string>;
+    abstract connect(provider: Provider$1): Signer;
+    readonly _isSigner: boolean;
+    constructor();
+    getBalance(blockTag?: BlockTag): Promise<BigNumber>;
+    getTransactionCount(blockTag?: BlockTag): Promise<number>;
+    estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>;
+    call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>;
+    sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>;
+    getChainId(): Promise<number>;
+    getGasPrice(): Promise<BigNumber>;
+    getFeeData(): Promise<FeeData$1>;
+    resolveName(name: string): Promise<string>;
+    checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>;
+    populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>;
+    _checkProvider(operation?: string): void;
+    static isSigner(value: any): value is Signer;
+}
+
 declare class JsonRpcSigner extends Signer implements TypedDataSigner {
     readonly provider: JsonRpcProvider;
     _index: number;
@@ -546,95 +546,6 @@ declare class Web3Provider extends JsonRpcProvider {
     send(method: string, params: Array<any>): Promise<any>;
 }
 
-declare enum Environment {
-    PRODUCTION = "production",
-    SANDBOX = "sandbox"
-}
-declare class ImmutableConfiguration {
-    readonly environment: Environment;
-    readonly rateLimitingKey?: string;
-    readonly apiKey?: string;
-    readonly clientAppId?: string;
-    constructor(options: {
-        environment: Environment;
-        rateLimitingKey?: string;
-        apiKey?: string;
-        clientAppId?: string;
-    });
-}
-interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
-    overrides?: T;
-}
-
-type ExchangeContracts = {
-    multicall: string;
-    coreFactory: string;
-    quoterV2: string;
-    peripheryRouter: string;
-    secondaryFee: string;
-};
-/**
- * Type representing an ERC20 token
- * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
- * @property {number} chainId - The chain ID
- * @property {string} address - The token address
- * @property {number} decimals - The token decimals
- * @property {string | undefined} symbol - The token symbol or undefined if it is not available
- * @property {string | undefined} name - The token name or undefined if it is not available
- */
-type ERC20 = {
-    type: 'erc20';
-    chainId: number;
-    address: string;
-    decimals: number;
-    symbol?: string;
-    name?: string;
-};
-/**
- * Type representing a native token
- * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
- * @property {number} chainId - The chain ID
- * @property {number} decimals - The token decimals
- * @property {string | undefined} symbol - The token symbol or undefined if it is not available
- * @property {string | undefined} name - The token name or undefined if it is not available
- */
-type Native = {
-    type: 'native';
-    chainId: number;
-    decimals: number;
-    symbol?: string;
-    name?: string;
-};
-/**
- * Type representing a token, either an {@link ERC20} or {@link Native}
- */
-type Coin = ERC20 | Native;
-/**
- * Type representing the overrides for the {@link Exchange} module
- * @property {string} rpcURL - The RPC URL for the chain
- * @property {ExchangeContracts} exchangeContracts - The DEX contract addresses
- * @property {ERC20[]} commonRoutingTokens - The tokens used to find available pools for a swap
- * @property {Coin} nativeToken - The native token of the chain
- * @property {ERC20} wrappedNativeToken - The wrapped native token of the chain
- */
-type ExchangeOverrides = {
-    rpcURL: string;
-    exchangeContracts: ExchangeContracts;
-    commonRoutingTokens: ERC20[];
-    nativeToken: Coin;
-    wrappedNativeToken: ERC20;
-};
-
-/**
- * @typedef {string} Address - Represents an Ethereum address.
- */
-type Address = string;
-/**
- * @typedef {Address | 'NATIVE'} FungibleToken - Represents a fungible token, either an ERC20 token address or the native token.
- */
-type FungibleToken = Address | 'NATIVE';
-
 // TypeScript Version: 3.0
 
 type AxiosRequestHeaders = Record<string, string | number | boolean>;
@@ -10184,6 +10095,36 @@ interface IMXProvider {
     completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
 }
 
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly rateLimitingKey?: string;
+    readonly apiKey?: string;
+    readonly publishableKey?: string;
+    constructor(options: {
+        environment: Environment;
+    });
+}
+type ImmutableConfigurationWithRequireableFields<T> = ImmutableConfiguration & (T extends {
+    apiKey: 'required';
+} ? Required<{
+    apiKey: string;
+}> : {}) & (T extends {
+    publishableKey: 'required';
+} ? Required<{
+    publishableKey: string;
+}> : {});
+type ImmutableConfigurationWithOmitableFields<T> = (T extends {
+    apiKey: 'omit';
+} ? Omit<ImmutableConfigurationWithRequireableFields<T>, 'apiKey'> : ImmutableConfigurationWithRequireableFields<T>);
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfigurationWithOmitableFields<T>;
+    overrides?: T;
+}
+
 interface ImxOverrides {
     immutableXConfig: ImmutableXConfiguration;
 }
@@ -10724,6 +10665,7 @@ declare enum ChainName {
     IMTBL_ZKEVM_DEVNET = "Immutable zkEVM Dev",
     IMTBL_ZKEVM_MAINNET = "Immutable zkEVM"
 }
+
 /**
  * Represents information about a token.
  * @interface TokenInfo
@@ -10740,6 +10682,7 @@ interface TokenInfo {
     address?: string;
     icon?: string;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.getBalance}.
  * @property {Web3Provider} provider - The provider used to get the balance.
@@ -10780,6 +10723,7 @@ interface GetAllBalancesParams {
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+
 interface OrderFee {
     amount: FeeToken | FeePercentage;
     recipient: string;
@@ -10790,88 +10734,111 @@ interface FeeToken {
 interface FeePercentage {
     percentageDecimal: number;
 }
+
 type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.SUCCESS} status
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type BuyResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type BuyResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
- * @property {SmartCheckoutInsufficient} smartCheckoutResult - The insufficient result of smart checkout
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
+ * @property {SmartCheckoutInsufficient} smartCheckoutResult
  */
 type BuyResultInsufficientFunds = {
+    /** The status to indicate insufficient funds */
     status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
 type SellResult = SellResultSuccess | SellResultFailed | SellResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.SUCCESS} status
+ * @property {string[]} orderIds
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type SellResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
+    /** The orders' ids */
     orderIds: string[];
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type SellResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
- * @property {SmartCheckoutInsufficient} smartCheckoutResult - The insufficient result of smart checkout
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
+ * @property {SmartCheckoutInsufficient} smartCheckoutResult
  */
 type SellResultInsufficientFunds = {
+    /** The status to indicate insufficient funds */
     status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
 type CancelResult = CancelResultSuccess | CancelResultFailed;
 /**
  * Represents the result of {@link Checkout.cancel}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
+ * @property {CheckoutStatus.SUCCESS} status
  */
 type CancelResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
 };
 /**
  * Represents the result of {@link Checkout.cancel}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
  */
 type CancelResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
 };
 /**
@@ -10888,22 +10855,27 @@ declare enum CheckoutStatus {
 }
 /**
  * The type representing the order to buy
- * @property {string} orderId - the id of the order to buy
- * @property {Array<OrderFee>} takerFees - array of order fees to apply to the order
+ * @property {string} orderId
+ * @property {Array<OrderFee>} takerFees
  */
 type BuyOrder = {
+    /** the id of the order to buy */
     id: string;
+    /** array of order fees to apply to the order */
     takerFees?: OrderFee[];
 };
 /**
  * The type representing the sell order to create a listing from
- * @property {SellToken} sellToken - the token to be listed for sale
- * @property {BuyToken} buyToken - the token info of the price of the item
- * @property {OrderFee[]} makerFees - option array of makerFees to be applied to the listing
+ * @property {SellToken} sellToken
+ * @property {BuyToken} buyToken
+ * @property {OrderFee[]} makerFees
  */
 type SellOrder = {
+    /** the token to be listed for sale */
     sellToken: SellToken;
+    /** the token info of the price of the item */
     buyToken: BuyToken;
+    /** option array of makerFees to be applied to the listing */
     makerFees?: OrderFee[];
 };
 /**
@@ -10913,77 +10885,97 @@ type SellOrder = {
 type BuyToken = NativeBuyToken | ERC20BuyToken;
 /**
  * Represents a native buy token
- * @property {ItemType} type - The type indicate this is a native token.
- * @property {string} amount - The amount of native token.
+ * @property {ItemType} type
+ * @property {string} amount
  */
 type NativeBuyToken = {
+    /** The type indicate this is a native token. */
     type: ItemType.NATIVE;
+    /** The amount of native token. */
     amount: string;
 };
 /**
  * Represents a ERC20 buy token
- * @property {ItemType} type - The type indicate this is a ERC20 token.
- * @property {string} amount - The amount of native token.
- * @property {string} contractAddress - The contract address of the ERC20.
+ * @property {ItemType} type
+ * @property {string} amount
+ * @property {string} contractAddress
  */
 type ERC20BuyToken = {
+    /** The type indicate this is a ERC20 token. */
     type: ItemType.ERC20;
+    /** The amount of native token. */
     amount: string;
+    /** The contract address of the ERC20. */
     contractAddress: string;
 };
 /**
  * The SellToken type
- * @property {string} id - The ERC721 token id
- * @property {string} collectionAddress - The ERC721 collection address
+ * @property {string} id
+ * @property {string} collectionAddress
  */
 type SellToken = {
+    /**  The ERC721 token id */
     id: string;
+    /** The ERC721 collection address */
     collectionAddress: string;
 };
 /**
  * Interface representing the parameters for {@link Checkout.smartCheckout}
- * @property {Web3Provider} provider - The provider to use for smart checkout.
- * @property {ItemRequirement[]} itemRequirements - The item requirements for the transaction.
- * @property {FulfillmentTransaction | GasAmount} transactionOrGasAmount - The transaction or gas amount.
+ * @property {Web3Provider} provider
+ * @property {ItemRequirement[]} itemRequirements
+ * @property {FulfillmentTransaction | GasAmount} transactionOrGasAmount
  */
 interface SmartCheckoutParams {
+    /** The provider to use for smart checkout. */
     provider: Web3Provider;
+    /** The item requirements for the transaction. */
     itemRequirements: (NativeItemRequirement | ERC20ItemRequirement | ERC721ItemRequirement)[];
+    /** The transaction or gas amount. */
     transactionOrGasAmount: FulfillmentTransaction | GasAmount;
 }
 /**
  * Represents a native item requirement for a transaction.
- * @property {ItemType.NATIVE} type - The type to indicate this is a native item requirement.
- * @property {string} amount - The amount of the item.
+ * @property {ItemType.NATIVE} type
+ * @property {string} amount
  */
 type NativeItemRequirement = {
+    /** The type to indicate this is a native item requirement. */
     type: ItemType.NATIVE;
+    /** The amount of the item. */
     amount: string;
 };
 /**
  * Represents an ERC20 item requirement for a transaction.
- * @property {ItemType.ERC20} type - The type to indicate this is a ERC20 item requirement.
- * @property {string} amount - The amount of the item.
- * @property {string} contractAddress - The contract address of the ERC20.
- * @property {string} spenderAddress - The contract address of the approver.
+ * @property {ItemType.ERC20} type
+ * @property {string} amount
+ * @property {string} contractAddress
+ * @property {string} spenderAddress
  */
 type ERC20ItemRequirement = {
+    /** The type to indicate this is a ERC20 item requirement. */
     type: ItemType.ERC20;
+    /** The amount of the item. */
     contractAddress: string;
+    /** The contract address of the ERC20. */
     amount: string;
+    /** The contract address of the approver. */
     spenderAddress: string;
 };
 /**
  * Represents an ERC721 item requirement for a transaction.
- * @property {ItemType.ERC721} type - The type to indicate this is a ERC721 item requirement.
- * @property {string} contractAddress - The contract address of the ERC721 collection.
- * @property {string} id - The ID of this ERC721 in the collection.
- * @property {string} spenderAddress - The contract address of the approver.
+ * @property {ItemType.ERC721} type
+ * @property {string} contractAddress
+ * @property {string} id
+ * @property {string} spenderAddress
  */
 type ERC721ItemRequirement = {
+    /** The type to indicate this is a ERC721 item requirement. */
     type: ItemType.ERC721;
+    /** The contract address of the ERC721 collection. */
     contractAddress: string;
+    /** The ID of this ERC721 in the collection. */
     id: string;
+    /** The contract address of the approver. */
     spenderAddress: string;
 };
 /**
@@ -11010,20 +11002,24 @@ declare enum TransactionOrGasType {
 }
 /**
  * The fulfillment transaction which contains the transaction to send.
- * @property {TransactionOrGasType} type - The type to indicate this is a fulfillment transaction.
- * @property {TransactionRequest} transaction - The transaction to send.
+ * @property {TransactionOrGasType} type
+ * @property {TransactionRequest} transaction
  */
 type FulfillmentTransaction = {
+    /** The type to indicate this is a fulfillment transaction. */
     type: TransactionOrGasType.TRANSACTION;
+    /** The transaction to send. */
     transaction: TransactionRequest;
 };
 /**
  * The gas amount which contains the gas token and the gas limit.
- * @property {TransactionOrGasType} type - The type to indicate this is a gas amount.
- * @property {GasToken} gasToken - The gas token.
+ * @property {TransactionOrGasType} type
+ * @property {GasToken} gasToken
  */
 type GasAmount = {
+    /** The type to indicate this is a gas amount. */
     type: TransactionOrGasType.GAS;
+    /** The gas token. */
     gasToken: GasToken;
 };
 /**
@@ -11042,22 +11038,27 @@ declare enum GasTokenType {
 }
 /**
  * Represents a native gas token.
- * @property {GasTokenType} type - The type to indicate this is a native gas token.
- * @property {BigNumber} limit - The gas limit.
+ * @property {GasTokenType} type
+ * @property {BigNumber} limit
  */
 type NativeGas = {
+    /** The type to indicate this is a native gas token. */
     type: GasTokenType.NATIVE;
+    /** The gas limit. */
     limit: BigNumber;
 };
 /**
  * Represents an ERC20 gas token.
- * @property {GasTokenType} type - The type to indicate this is an ERC20 gas token.
- * @property {string} contractAddress - The contract address of the ERC20.
- * @property {BigNumber} limit - The gas limit.
+ * @property {GasTokenType} type
+ * @property {string} contractAddress
+ * @property {BigNumber} limit
  */
 type ERC20Gas = {
+    /** The type to indicate this is an ERC20 gas token. */
     type: GasTokenType.ERC20;
+    /** The contract address of the ERC20. */
     contractAddress: string;
+    /** The gas limit. */
     limit: BigNumber;
 };
 /**
@@ -11066,34 +11067,38 @@ type ERC20Gas = {
 type SmartCheckoutResult = SmartCheckoutSufficient | SmartCheckoutInsufficient;
 /**
  * Represents the result of {@link Checkout.smartCheckout} when smart checkout is sufficient.
- * @property {boolean} sufficient - Indicates that smart checkout determined the user had sufficient funds.
- * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
- * determined were required for the transaction.
+ * @property {boolean} sufficient
+ * @property {TransactionRequirement[]} transactionRequirements
  */
 type SmartCheckoutSufficient = {
+    /** Indicates that smart checkout determined the user had sufficient funds. */
     sufficient: true;
+    /** The transaction requirements smart checkout determined were required for the transaction. */
     transactionRequirements: TransactionRequirement[];
 };
 /**
  * Represents the result of {@link Checkout.smartCheckout} when smart checkout is insufficient.
- * @property {boolean} sufficient - Indicates that smart checkout determined the user has insufficient funds
- * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
- * determined were required for the transaction.
- * @property {SmartCheckoutRouter} router - The type containing the funding routes the user can take to fulfill the transaction requirements
+ * @property {boolean} sufficient
+ * @property {TransactionRequirement[]} transactionRequirements
+ * @property {SmartCheckoutRouter} router
  */
 type SmartCheckoutInsufficient = {
+    /** Indicates that smart checkout determined the user has insufficient funds */
     sufficient: false;
+    /** The transaction requirements smart checkout determined were required for the transaction. */
     transactionRequirements: TransactionRequirement[];
+    /** The type containing the funding routes the user can take to fulfill the transaction requirements */
     router: SmartCheckoutRouter;
 };
 /**
  * Represents the routing outcome for a transaction.
- * @property {AvailableRoutingOptions} availableRoutingOptions - The routing options available to the user
- * @property {RoutingOutcome} routingOutcome - The routing outcome for the transaction which
- * includes the funding routes if routes were found
+ * @property {AvailableRoutingOptions} availableRoutingOptions
+ * @property {RoutingOutcome} routingOutcome
  */
 type SmartCheckoutRouter = {
+    /** The routing options available to the user */
     availableRoutingOptions: AvailableRoutingOptions;
+    /** The routing outcome for the transaction which includes the funding routes if routes were found */
     routingOutcome: RoutingOutcome;
 };
 /**
@@ -11111,109 +11116,137 @@ declare enum RoutingOutcomeType {
 type RoutingOutcome = RoutesFound | NoRoutesFound | NoRouteOptions;
 /**
  * Represents a routing outcome where funding routes were found.
- * @property {RoutingOutcomeType.ROUTES_FOUND} type - Indicates that funding routes were found for the transaction.
- * @property {AvailableRoutingOptions} fundingRoutes - The funding routes found for the transaction.
+ * @property {RoutingOutcomeType.ROUTES_FOUND} type
+ * @property {AvailableRoutingOptions} fundingRoutes
  */
 type RoutesFound = {
+    /** Indicates that funding routes were found for the transaction. */
     type: RoutingOutcomeType.ROUTES_FOUND;
+    /** The funding routes found for the transaction. */
     fundingRoutes: FundingRoute[];
 };
 /**
  * Represents a routing outcome where no funding routes were found.
- * @property {RoutingOutcomeType.NO_ROUTES_FOUND} type - Indicates that no funding routes were found for the transaction.
- * @property {string} message - The message indicating why no funding routes were found.
+ * @property {RoutingOutcomeType.NO_ROUTES_FOUND} type
+ * @property {string} message
  */
 type NoRoutesFound = {
+    /** Indicates that no funding routes were found for the transaction. */
     type: RoutingOutcomeType.NO_ROUTES_FOUND;
+    /** The message indicating why no funding routes were found. */
     message: string;
 };
 /**
  * Represents a routing outcome where no routing options were available for the transaction.
- * @property {RoutingOutcomeType.NO_ROUTE_OPTIONS} type - Indicates that no routing options were available for the transaction.
- * @property {string} message - The message indicating why no routing options were available.
+ * @property {RoutingOutcomeType.NO_ROUTE_OPTIONS} type
+ * @property {string} message
  */
 type NoRouteOptions = {
+    /** Indicates that no routing options were available for the transaction. */
     type: RoutingOutcomeType.NO_ROUTE_OPTIONS;
+    /** The message indicating why no routing options were available. */
     message: string;
 };
 /**
  * Represents a funding route
- * @property {number} priority - The priority of the route
- * @property {FundingStep[]} steps - The steps associated with this funding route
+ * @property {number} priority
+ * @property {FundingStep[]} steps
  */
 type FundingRoute = {
+    /** The priority of the route */
     priority: number;
+    /** The steps associated with this funding route */
     steps: FundingStep[];
 };
 /**
  * Represents a fee
- * @property {BigNumber} amount - The amount of the fee
- * @property {string} formatted - The formatted amount of the fee
- * @property {TokenInfo | undefined} token - The token info for the fee
+ * @property {BigNumber} amount
+ * @property {string} formatted
+ * @property {TokenInfo | undefined} token
  */
 type Fee = {
+    /** The amount of the fee */
     amount: BigNumber;
+    /** The formatted amount of the fee */
     formattedAmount: string;
+    /** The token info for the fee */
     token?: TokenInfo;
 };
 type FundingStep = BridgeFundingStep | SwapFundingStep | OnRampFundingStep;
 /**
  * Represents a bridge funding route
- * @property {FundingStepType.BRIDGE} type - Indicates that this is a bridge funding step
- * @property {number} chainId - The chain id the bridge should be executed on
- * @property {FundingItem} fundingItem - The funding item for the bridge
- * @property {BridgeFees} fees - The fees for the bridge
+ * @property {FundingStepType.BRIDGE} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
+ * @property {BridgeFees} fees
  */
 type BridgeFundingStep = {
+    /** Indicates that this is a bridge funding step */
     type: FundingStepType.BRIDGE;
+    /** The chain id the bridge should be executed on */
     chainId: number;
+    /** The funding item for the bridge */
     fundingItem: FundingItem;
+    /** The fees for the bridge */
     fees: BridgeFees;
 };
 /**
  * Represents the fees for a bridge funding step
- * @property {Fee} approvalGasFees - The approval gas fees for the bridge
- * @property {Fee} bridgeGasFees - The bridge gas fees for the bridge
- * @property {Fee[]} bridgeFees - Additional bridge fees for the bridge
+ * @property {Fee} approvalGasFees
+ * @property {Fee} bridgeGasFees
+ * @property {Fee[]} bridgeFees
  */
 type BridgeFees = {
+    /** The approval gas fees for the bridge */
     approvalGasFees: Fee;
+    /** The bridge gas fees for the bridge */
     bridgeGasFees: Fee;
+    /** Additional bridge fees for the bridge */
     bridgeFees: Fee[];
 };
 /**
  * Represents a swap funding route
- * @property {FundingStepType.SWAP} type - Indicates that this is a swap funding step
- * @property {number} chainId - The chain id the swap should be executed on
- * @property {FundingItem} fundingItem - The funding item for the swap
- * @property {SwapFees} fees - The fees for the swap
+ * @property {FundingStepType.SWAP} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
+ * @property {SwapFees} fees
  */
 type SwapFundingStep = {
+    /** Indicates that this is a swap funding step */
     type: FundingStepType.SWAP;
+    /** The chain id the swap should be executed on */
     chainId: number;
+    /** The funding item for the swap */
     fundingItem: FundingItem;
+    /** The fees for the swap */
     fees: SwapFees;
 };
 /**
  * Represents the fees for a swap funding step
- * @property {Fee} approvalGasFees - The approval gas fees for the swap
- * @property {Fee} swapGasFees - The swap gas fees for the swap
- * @property {Fee[]} swapFees - Additional swap fees for the swap
+ * @property {Fee} approvalGasFees
+ * @property {Fee} swapGasFees
+ * @property {Fee[]} swapFees
  */
 type SwapFees = {
+    /** The approval gas fees for the swap */
     approvalGasFees: Fee;
+    /** The swap gas fees for the swap */
     swapGasFees: Fee;
+    /** Additional swap fees for the swap */
     swapFees: Fee[];
 };
 /**
  * Represents an onramp funding route
- * @property {FundingStepType.ONRAMP} type - Indicates that this is an onramp funding step
- * @property {number} chainId - The chain id the onramp should provide funds to
- * @property {FundingItem} fundingItem - The item to be onramped
+ * @property {FundingStepType.ONRAMP} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
  */
 type OnRampFundingStep = {
+    /** Indicates that this is an onramp funding step */
     type: FundingStepType.ONRAMP;
+    /** The chain id the onramp should provide funds to */
     chainId: number;
+    /** The item to be onramped */
     fundingItem: FundingItem;
 };
 /**
@@ -11230,76 +11263,98 @@ declare enum FundingStepType {
 }
 /**
  * Represents a funding item
- * @property {ItemType.NATIVE | ItemType.ERC20} type - The type of the funding item
- * @property {FundsRequired} fundsRequired - The amount of funds required of this funding item
- * @property {UserBalance} userBalance - The current user balance of this funding item
- * @property {TokenInfo} token - The token info for the funding item
+ * @property {ItemType.NATIVE | ItemType.ERC20} type
+ * @property {FundsRequired} fundsRequired
+ * @property {UserBalance} userBalance
+ * @property {TokenInfo} token
  */
 type FundingItem = {
+    /** The type of the funding item */
     type: ItemType.NATIVE | ItemType.ERC20;
+    /** The amount of funds required of this funding item */
     fundsRequired: FundsRequired;
+    /** The current user balance of this funding item */
     userBalance: UserBalance;
+    /** The token info for the funding item */
     token: TokenInfo;
 };
 /**
  * Represents the funds required of a funding item
- * @property {BigNumber} amount - The amount of funds required
- * @property {string} formattedAmount - The formatted amount of funds required
+ * @property {BigNumber} amount
+ * @property {string} formattedAmount
  */
 type FundsRequired = {
+    /** The amount of funds required */
     amount: BigNumber;
+    /** The formatted amount of funds required */
     formattedAmount: string;
 };
 /**
  * Represents the user balance of a funding item
- * @property {BigNumber} balance - The balance of the funding item
- * @property {string} formattedBalance - The formatted balance of the funding item
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
  */
 type UserBalance = {
+    /** The balance of the funding item */
     balance: BigNumber;
+    /** The formatted balance of the funding item */
     formattedBalance: string;
 };
 /**
  * Represents the transaction requirement for a transaction.
- * @property {ItemType} type - The type of the transaction requirement.
- * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
- * @property {ItemBalance} required - The required item balance.
- * @property {ItemBalance} current - The current item balance.
- * @property {BalanceDelta} delta - The delta between the required and current balances.
+ * @property {ItemType} type
+ * @property {boolean} sufficient
+ * @property {ItemBalance} required
+ * @property {ItemBalance} current
+ * @property {BalanceDelta} delta
  */
 type TransactionRequirement = {
+    /** The type of the transaction requirement. */
     type: ItemType;
+    /** If the user address has sufficient funds to cover the transaction. */
     sufficient: boolean;
+    /** The required item balance. */
     required: ItemBalance;
+    /** The current item balance. */
     current: ItemBalance;
+    /** The delta between the required and current balances. */
     delta: BalanceDelta;
 };
 /**
  * Represents the balance for either a native or ERC20 token.
- * @property {ItemType.NATIVE | ItemType.ERC20} type - Type to indicate this is a native or ERC20 token.
- * @property {BigNumber} balance - The balance of the item.
- * @property {string} formattedBalance - The formatted balance of the item.
- * @property {TokenInfo} token - The token info of the item.
+ * @property {ItemType.NATIVE | ItemType.ERC20} type
+ * @property {BigNumber} balance
+ * @property {string} formattedBalanc
+ * @property {TokenInfo} token
  */
 type TokenBalance = {
+    /** Type to indicate this is a native or ERC20 token. */
     type: ItemType.NATIVE | ItemType.ERC20;
+    /** The balance of the item. */
     balance: BigNumber;
+    /** The formatted balance of the item. */
     formattedBalance: string;
+    /**  The token info of the item. */
     token: TokenInfo;
 };
 /**
  * Represents the balance for an ERC721.
- * @property {ItemType.ERC721} type - Type to indicate this is an ERC721 token.
- * @property {BigNumber} balance - The balance of the item.
- * @property {string} formattedBalance - The formatted balance of the item.
- * @property {string} contractAddress - The contract address of the ERC721 collection.
- * @property {string} id - The ID of the ERC721 in the collection.
+ * @property {ItemType.ERC721} type
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
+ * @property {string} contractAddress
+ * @property {string} id
  */
 type ERC721Balance = {
+    /** Type to indicate this is an ERC721 token. */
     type: ItemType.ERC721;
+    /** The balance of the item. */
     balance: BigNumber;
+    /** The formatted balance of the item. */
     formattedBalance: string;
+    /** The contract address of the ERC721 collection. */
     contractAddress: string;
+    /** The ID of the ERC721 in the collection */
     id: string;
 };
 /**
@@ -11308,25 +11363,31 @@ type ERC721Balance = {
 type ItemBalance = ERC721Balance | TokenBalance;
 /**
  * Represents the delta between two balances.
- * @property {BigNumber} balance - The delta of the balance.
- * @property {string} formattedBalance - The formatted balance of the delta.
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
  */
 type BalanceDelta = {
+    /** The delta of the balance. */
     balance: BigNumber;
+    /** The formatted balance of the delta. */
     formattedBalance: string;
 };
 /**
  * A type representing the Smart Checkout routing options available for a user
  * if they are configured and enabled (not geo-blocked etc.)
- * @property {boolean | undefined} onRamp - If the user can use onramp
- * @property {boolean | undefined} swap - If the user can use swap
- * @property {boolean | undefined} bridge - If the user can use bridge
+ * @property {boolean | undefined} onRamp
+ * @property {boolean | undefined} swap
+ * @property {boolean | undefined} bridge
  */
 type AvailableRoutingOptions = {
+    /** If the user can use onramp */
     onRamp?: boolean;
+    /** If the user can use swap */
     swap?: boolean;
+    /** If the user can use bridge */
     bridge?: boolean;
 };
+
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -11337,6 +11398,7 @@ interface BuyParams {
     provider: Web3Provider;
     orders: Array<BuyOrder>;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.cancel}
  * @property {Web3Provider} provider - The provider to use for the cancel.
@@ -11347,79 +11409,166 @@ interface CancelParams {
     provider: Web3Provider;
     orderIds: string[];
 }
-interface CheckoutOverrides {
-}
-interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
-    isOnRampEnabled?: boolean;
-    isSwapEnabled?: boolean;
-    isBridgeEnabled?: boolean;
-}
+
+type ExchangeContracts = {
+    multicall: string;
+    coreFactory: string;
+    quoterV2: string;
+    peripheryRouter: string;
+    secondaryFee: string;
+};
 /**
- * A type representing various remotely defined configurations which are
- * accessible via the Checkout config and configured based on the Environment.
- * @property {DexConfig} dex - The config used for the DEX.
- * @property {OnRampConfig} onramp - The config used for the OnRamp
- * @property {AllowedNetworkConfig[]} allowedNetworks - An array representing the allowed networks.
- * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens - The config for the tokens used to estimate gas.
+ * Type representing an ERC20 token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
+ * @property {number} chainId - The chain ID
+ * @property {string} address - The token address
+ * @property {number} decimals - The token decimals
+ * @property {string | undefined} symbol - The token symbol or undefined if it is not available
+ * @property {string | undefined} name - The token name or undefined if it is not available
  */
-type RemoteConfiguration = {
-    dex: DexConfig;
-    onramp: OnRampConfig;
-    bridge: BridgeConfig;
-    allowedNetworks: AllowedNetworkConfig[];
-    gasEstimateTokens?: GasEstimateTokenConfig;
-    imxAddressMapping?: ImxAddressConfig;
+type ERC20 = {
+    type: 'erc20';
+    chainId: number;
+    address: string;
+    decimals: number;
+    symbol?: string;
+    name?: string;
 };
 /**
- * A type representing the fee structure for an OnRamp provider
- * @property {string | undefined} minPercentage - minimum percentage fee shown if a fee range is provided
- * @property {string | undefined} maxPercentage - maximum percentage fee shown if a fee range is provided
- * @property {string | undefined} feePercentage - specific fee percentage shown if there is no range provided
+ * Type representing a native token
+ * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
+ * @property {number} chainId - The chain ID
+ * @property {number} decimals - The token decimals
+ * @property {string | undefined} symbol - The token symbol or undefined if it is not available
+ * @property {string | undefined} name - The token name or undefined if it is not available
  */
-type OnRampProviderFees = {
-    minPercentage?: string;
-    maxPercentage?: string;
-    feePercentage?: string;
+type Native = {
+    type: 'native';
+    chainId: number;
+    decimals: number;
+    symbol?: string;
+    name?: string;
 };
 /**
- * A type representing the configuration for the OnRamp for a specific provider.
- * @property {string} publishableApiKey - on ramp provider publishable api-key
- * @property {TokenInfo[]} tokens - allowed tokens for the OnRamp provider
- * @property {OnRampProviderFees} fees - on ramp provider transaction fees
+ * Type representing a token, either an {@link ERC20} or {@link Native}
  */
-type OnRampProviderConfig = {
-    publishableApiKey: string;
+type Coin = ERC20 | Native;
+/**
+ * Type representing the overrides for the {@link Exchange} module
+ * @property {string} rpcURL - The RPC URL for the chain
+ * @property {ExchangeContracts} exchangeContracts - The DEX contract addresses
+ * @property {ERC20[]} commonRoutingTokens - The tokens used to find available pools for a swap
+ * @property {Coin} nativeToken - The native token of the chain
+ * @property {ERC20} wrappedNativeToken - The wrapped native token of the chain
+ */
+type ExchangeOverrides = {
+    rpcURL: string;
+    exchangeContracts: ExchangeContracts;
+    commonRoutingTokens: ERC20[];
+    nativeToken: Coin;
+    wrappedNativeToken: ERC20;
+};
+
+interface CheckoutOverrides {
+}
+/**
+ * A type representing checkout SDK configurations.
+ * @property {boolean} isOnRampEnabled - To enable on-ramp feature in Checkout sdk.
+ * @property {boolean} isSwapEnabled - To enable swap feature in Checkout sdk.
+ * @property {boolean} isBridgeEnabled - To enable bridge feature in Checkout sdk.
+ * @property {Passport} passport - To enable passport wallet with Checkout sdk.
+*/
+interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
+    isOnRampEnabled?: boolean;
+    isSwapEnabled?: boolean;
+    isBridgeEnabled?: boolean;
+    passport?: Passport;
+}
+/**
+ * A type representing various remotely defined configurations which are
+ * accessible via the Checkout config and configured based on the Environment.
+ * @property {DexConfig} dex
+ * @property {OnRampConfig} onramp
+ * @property {BridgeConfig} bridge
+ * @property {AllowedNetworkConfig[]} allowedNetworks
+ * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens
+ * @property {ImxAddressConfig | undefined} imxAddressMapping
+ */
+type RemoteConfiguration = {
+    /** The config used for the DEX. */
+    dex: DexConfig;
+    /** The config used for the OnRamp */
+    onramp: OnRampConfig;
+    /** The config used for the Bridge. */
+    bridge: BridgeConfig;
+    /** An array representing the allowed networks. */
+    allowedNetworks: AllowedNetworkConfig[];
+    /** The config for the tokens used to estimate gas. */
+    gasEstimateTokens?: GasEstimateTokenConfig;
+    /** The IMX address mappings across available networks. */
+    imxAddressMapping?: ImxAddressConfig;
+};
+/**
+ * A type representing the fee structure for an OnRamp provider
+ * @property {string | undefined} minPercentage
+ * @property {string | undefined} maxPercentage
+ * @property {string | undefined} feePercentage
+ */
+type OnRampProviderFees = {
+    /** The minimum percentage fee shown if a fee range is provided */
+    minPercentage?: string;
+    /** The maximum percentage fee shown if a fee range is provided */
+    maxPercentage?: string;
+    /** The specific fee percentage shown if there is no range provided */
+    feePercentage?: string;
+};
+/**
+ * A type representing the configuration for the OnRamp for a specific provider.
+ * @property {string} publishableApiKey
+ * @property {TokenInfo[]} tokens
+ * @property {OnRampProviderFees} fees
+ */
+type OnRampProviderConfig = {
+    /** The on ramp provider publishable api-key */
+    publishableApiKey: string;
+    /** The allowed tokens for the OnRamp provider */
     tokens: TokenInfo[];
+    /** The on ramp provider transaction fees */
     fees: OnRampProviderFees;
 };
 /**
  * A type representing the configuration for the OnRamp.
- * @property {OnRampProviderConfig} transak - OnRamp config for Transak provider
+ * @property {OnRampProviderConfig} transak
  */
 type OnRampConfig = {
+    /** OnRamp config for Transak provider */
     [key: string]: OnRampProviderConfig;
 };
 /**
  * A type representing the configuration for the DEX.
- * @property {ExchangeOverrides | undefined} overrides - The DEX overrides.
- * @property {TokenInfo[] | undefined} tokens - An array of tokens compatible with the DEX.
+ * @property {ExchangeOverrides | undefined} overrides
+ * @property {TokenInfo[] | undefined} tokens
  */
 type DexConfig = {
+    /** The DEX overrides. */
     overrides?: ExchangeOverrides;
+    /** An array of tokens compatible with the DEX. */
     tokens?: TokenInfo[];
 };
 /**
  * A type representing the configuration for the Bridge.
- * @property {TokenInfo[] | undefined} tokens - An array of tokens compatible with the Bridge.
+ * @property {TokenInfo[] | undefined} tokens
  */
 type BridgeConfig = {
+    /** An array of tokens compatible with the Bridge. */
     tokens?: TokenInfo[];
 };
 /**
  * A type representing an allowed network.
- * @property {number} chainId - The network chain id.
+ * @property {number} chainId
  */
 type AllowedNetworkConfig = {
+    /** The network chain id. */
     chainId: number;
 };
 /**
@@ -11434,42 +11583,50 @@ type ImxAddressConfig = {
  * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}
  * - A map of addresses for estimating gas keyed by the network chain id.
  * @property {GasEstimateBridgeToL2TokenConfig | undefined} bridgeToL2Addresses
- * - The type representing the addresses for a bridge to layer 2 gas estimate.
- * @property {GasEstimateSwapTokenConfig | undefined} swapAddresses - The type representing the addresses for a swap gas estimate
+ * @property {GasEstimateSwapTokenConfig | undefined} swapAddresses
  */
 type GasEstimateTokenConfig = {
     [key: string]: {
+        /** The type representing the addresses for a bridge to layer 2 gas estimate. */
         bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig;
+        /** The type representing the addresses for a swap gas estimate */
         swapAddresses?: GasEstimateSwapTokenConfig;
     };
 };
 /**
  * A type representing the config for a bridge to layer 2 gas estimate.
- * @property {string | 'NATIVE'} gasTokenAddress - The address of the gas token.
- * @property {string} fromAddress - The address of the token being bridged.
+ * @property {string | 'NATIVE'} gasTokenAddress
+ * @property {string} fromAddress
  */
 type GasEstimateBridgeToL2TokenConfig = {
+    /**  The address of the gas token. */
     gasTokenAddress: string | 'NATIVE';
+    /** The address of the token being bridged. */
     fromAddress: string;
 };
 /**
  * A type representing the config for a swap gas estimate.
- * @property {string} inAddress - The in token address.
- * @property {string} outAddress - The out token address.
+ * @property {string} inAddress
+ * @property {string} outAddress
  */
 type GasEstimateSwapTokenConfig = {
+    /** The in token address. */
     inAddress: string;
+    /** The out token address. */
     outAddress: string;
 };
 /**
  * A type representing all the feature flags available.
- * @property {TokenInfo[] | undefined} allowed - List of allowed tokens for a given chain.
- * @property {boolean | undefined} blockscout - Feature flag to enable/disable blockscout integration.
+ * @property {TokenInfo[] | undefined} allowed -
+ * @property {boolean | undefined} blockscout -
  */
 type ChainTokensConfig = {
+    /** List of allowed tokens for a given chain. */
     allowed?: TokenInfo[];
+    /** Feature flag to enable/disable blockscout integration. */
     blockscout?: boolean;
 };
+
 /**
  * Interface representing the params of {@link Checkout.connect}.
  * @property {Web3Provider} provider - The provider used to connect to the network.
@@ -11500,6 +11657,16 @@ interface CheckConnectionResult {
     isConnected: boolean;
     walletAddress: string;
 }
+
+/**
+ * @typedef {string} Address - Represents an Ethereum address.
+ */
+type Address = string;
+/**
+ * @typedef {Address | 'NATIVE'} FungibleToken - Represents a fungible token, either an ERC20 token address or the native token.
+ */
+type FungibleToken = Address | 'NATIVE';
+
 /**
  * An enum representing the type of gas estimate.
  * @enum {string}
@@ -11563,6 +11730,7 @@ interface TokenAmountEstimate {
     estimatedAmount?: BigNumber;
     token?: TokenInfo;
 }
+
 /**
  * Represents information about a network.
  * @interface NetworkInfo
@@ -11577,6 +11745,7 @@ interface NetworkInfo {
     nativeCurrency: TokenInfo;
     isSupported: boolean;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.switchNetwork}.
  * @property {Web3Provider} provider - The provider to connect to the network.
@@ -11632,6 +11801,7 @@ declare enum NetworkFilterTypes {
 interface NetworkFilter {
     chainId: ChainId;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.sell}
  * @property {Web3Provider} provider - The provider to use for the sell.
@@ -11642,6 +11812,7 @@ interface SellParams {
     provider: Web3Provider;
     orders: Array<SellOrder>;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
  * @property {TokenFilterTypes} type - The type of token to retrieve.
@@ -11676,6 +11847,7 @@ declare enum TokenFilterTypes {
 interface TokenFilter {
     address: string;
 }
+
 /**
  * Interface representing the parameters for {@link Checkout.sendTransaction}.
  * @property {Web3Provider} provider - The provider to connect to the network.
@@ -11692,6 +11864,7 @@ interface SendTransactionParams {
 interface SendTransactionResult {
     transactionResponse: TransactionResponse;
 }
+
 /**
  * Enum representing the names of different wallet providers.
  */
@@ -11702,29 +11875,27 @@ declare enum WalletProviderName {
 /**
  * Interface for the parameters required to create a wallet provider {@link Checkout.createProvider}.
  * @interface CreateProviderParams
- * @property {WalletProviderName} walletProvider - The name of the wallet provider.
- * @property {Passport | undefined} passport - The Passport instance required to create a provider for passport users.
- * If walletProvider is 'passport', then the passport instance must be passed in.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name to create a provider for.
  */
 interface CreateProviderParams {
-    walletProvider: WalletProviderName;
-    passport?: Passport;
+    walletProviderName: WalletProviderName;
 }
 /**
  * Represents the result of creating a Web3 provider {@link Checkout.createProvider}.
  * @property {Web3Provider} provider - The created Web3 provider.
- * @property {WalletProviderName} providerName - The name of the wallet provider.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name of the provider that was created.
  */
 type CreateProviderResult = {
     provider: Web3Provider;
     walletProviderName: WalletProviderName;
 };
+
 /**
  * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
- * @property {WalletProviderName} connectionProvider - The connection provider to filter wallets by.
+ * @property {WalletProviderName} walletProviderName - The wallet provider name to filter wallets by.
  */
 interface WalletFilter {
-    walletProvider: WalletProviderName;
+    walletProviderName: WalletProviderName;
 }
 /**
  * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
@@ -11737,14 +11908,12 @@ interface GetWalletAllowListParams {
 }
 /**
  * Interface representing information about a wallet used in {@link GetWalletAllowListResult}.
- * @property {WalletProviderName} walletProvider - The connection provider for the wallet.
- * @property {string} name - The name of the wallet.
+ * @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.
  */
 interface WalletInfo {
-    walletProvider: WalletProviderName;
-    name: string;
+    walletProviderName: WalletProviderName;
     description?: string;
     icon?: string;
 }
@@ -11761,6 +11930,7 @@ interface GetWalletAllowListResult {
 declare enum WalletFilterTypes {
     ALL = "all"
 }
+
 /**
  * Base URL for the checkout API based on the environment.
  * @property {string} DEVELOPMENT - The base URL for the development environment.
@@ -11780,6 +11950,7 @@ type NetworkDetails = {
     blockExplorerUrls?: string[];
 };
 type NetworkMap = Map<ChainId, NetworkDetails>;
+
 /**
  * An enum representing the type of exchange.
  * @enum {string}
@@ -11801,71 +11972,27 @@ interface FiatRampParams {
     web3Provider: Web3Provider;
     tokenAmount?: string;
     tokenAddress?: string;
-    passport?: Passport;
-}
-/**
- * Enum representing different types of errors that can occur during the checkout process.
- */
-declare enum CheckoutErrorType {
-    WEB3_PROVIDER_ERROR = "WEB3_PROVIDER_ERROR",
-    PROVIDER_ERROR = "PROVIDER_ERROR",
-    DEFAULT_PROVIDER_ERROR = "DEFAULT_PROVIDER_ERROR",
-    CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
-    GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
-    GET_INDEXER_BALANCE_ERROR = "GET_INDEXER_BALANCE_ERROR",
-    GET_ERC20_BALANCE_ERROR = "GET_ERC20_BALANCE_ERROR",
-    GET_ERC721_BALANCE_ERROR = "GET_ERC721_BALANCE_ERROR",
-    GET_NETWORK_INFO_ERROR = "GET_NETWORK_INFO_ERROR",
-    METAMASK_PROVIDER_ERROR = "METAMASK_PROVIDER_ERROR",
-    CHAIN_NOT_SUPPORTED_ERROR = "CHAIN_NOT_SUPPORTED_ERROR",
-    PROVIDER_REQUEST_MISSING_ERROR = "PROVIDER_REQUEST_MISSING_ERROR",
-    PROVIDER_REQUEST_FAILED_ERROR = "PROVIDER_REQUEST_FAILED_ERROR",
-    USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
-    TRANSACTION_FAILED = "TRANSACTION_FAILED",
-    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
-    UNPREDICTABLE_GAS_LIMIT = "UNPREDICTABLE_GAS_LIMIT",
-    INVALID_GAS_ESTIMATE_TYPE = "INVALID_GAS_ESTIMATE_TYPE",
-    UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
-    UNSUPPORTED_BALANCE_REQUIREMENT_ERROR = "UNSUPPORTED_BALANCE_REQUIREMENT_ERROR",
-    GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
-    CANCEL_ORDER_LISTING_ERROR = "CANCEL_ORDER_LISTING_ERROR",
-    PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
-    CREATE_ORDER_LISTING_ERROR = "CREATE_ORDER_LISTING_ERROR",
-    FULFILL_ORDER_LISTING_ERROR = "FULFILL_ORDER_LISTING_ERROR",
-    SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
-    GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
-    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR",
-    EXECUTE_APPROVAL_TRANSACTION_ERROR = "EXECUTE_APPROVAL_TRANSACTION_ERROR",
-    EXECUTE_FULFILLMENT_TRANSACTION_ERROR = "EXECUTE_FULFILLMENT_TRANSACTION_ERROR",
-    SIGN_MESSAGE_ERROR = "SIGN_MESSAGE_ERROR",
-    BRIDGE_GAS_ESTIMATE_ERROR = "BRIDGE_GAS_ESTIMATE_ERROR",
-    ORDER_FEE_ERROR = "ORDER_FEE_ERROR",
-    ITEM_REQUIREMENTS_ERROR = "ITEM_REQUIREMENTS_ERROR",
-    API_ERROR = "API_ERROR",
-    ORDER_EXPIRED_ERROR = "ORDER_EXPIRED_ERROR"
+    passport?: any;
 }
-/**
- * Represents an error object with a specific type, optional message, and optional data.
- * @property {CheckoutErrorType} type - The type of the error.
- * @property {string | undefined} [message] - The error message.
- * @property {Object.<string, string> | undefined} [data] - Additional data associated with the error.
- */
-type ErrorType = {
-    type: CheckoutErrorType;
-    message?: string;
-    data?: {
-        [key: string]: string;
-    };
-};
+
 type RemoteConfigParams = {
     isDevelopment: boolean;
     isProduction: boolean;
 };
 declare class RemoteConfigFetcher {
+    private isDevelopment;
+    private isProduction;
+    private configCache;
+    private tokensCache;
     constructor(params: RemoteConfigParams);
+    private static makeHttpRequest;
+    private getEndpoint;
+    private loadConfig;
+    private loadConfigTokens;
     getConfig(key?: keyof RemoteConfiguration): Promise<RemoteConfiguration | RemoteConfiguration[keyof RemoteConfiguration] | undefined>;
     getTokensConfig(chainId: ChainId): Promise<ChainTokensConfig>;
 }
+
 declare class CheckoutConfiguration {
     readonly isDevelopment: boolean;
     readonly isProduction: boolean;
@@ -11877,9 +12004,7 @@ declare class CheckoutConfiguration {
     readonly networkMap: NetworkMap;
     constructor(config: CheckoutModuleConfiguration);
 }
-type AvailabilityService = {
-    checkDexAvailability: () => Promise<boolean>;
-};
+
 interface FiatRampWidgetParams {
     exchangeType: ExchangeType;
     isPassport: boolean;
@@ -11897,16 +12022,706 @@ declare class FiatRampService {
     constructor(config: CheckoutConfiguration);
     feeEstimate(): Promise<OnRampProviderFees>;
     createWidgetUrl(params: FiatRampWidgetParams): Promise<string>;
+    private getTransakWidgetUrl;
+}
+
+type AvailabilityService = {
+    checkDexAvailability: () => Promise<boolean>;
+};
+
+/**
+ * Enum representing the themes for the widgets.
+ */
+declare enum WidgetTheme {
+    LIGHT = "light",
+    DARK = "dark"
+}
+
+/**
+ * Widget Configuration represents the shared configuration options for the Checkout Widgets.
+ * @property {WidgetTheme | undefined} theme
+ */
+type WidgetConfiguration = {
+    /** The theme of the Checkout Widget (default: "DARK") */
+    theme?: WidgetTheme;
+};
+
+/**
+ * Enum representing the events emitted by the widgets.
+ */
+declare enum IMTBLWidgetEvents {
+    IMTBL_WIDGETS_PROVIDER = "imtbl-widgets-provider",
+    IMTBL_CONNECT_WIDGET_EVENT = "imtbl-connect-widget",
+    IMTBL_WALLET_WIDGET_EVENT = "imtbl-wallet-widget",
+    IMTBL_SWAP_WIDGET_EVENT = "imtbl-swap-widget",
+    IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget",
+    IMTBL_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget",
+    IMTBL_SALE_WIDGET_EVENT = "imtbl-sale-widget"
+}
+/**
+ * Enum for events raised for about provider objects
+ */
+declare enum ProviderEventType {
+    PROVIDER_UPDATED = "PROVIDER_UPDATED"
+}
+/**
+ * Payload type for the PROVIDER_UPDATED event
+ */
+type ProviderUpdated = {
+    provider: Web3Provider;
+};
+
+/**
+ * Enum representing possible Connect Widget event types.
+ */
+declare enum ConnectEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful connection.
+ * @property {Web3Provider} provider
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type ConnectionSuccess = {
+    /** The connected provider. */
+    provider: Web3Provider;
+    /** The wallet provider name of the connected provider. */
+    walletProviderName: WalletProviderName | undefined;
+};
+/**
+ * Represents a connection failure with a reason.
+ * @property {string} reason
+ */
+type ConnectionFailed = {
+    /** The reason for the failed connection. */
+    reason: string;
+};
+
+/**
+ * Enum representing possible Wallet Widget event types.
+ */
+declare enum WalletEventType {
+    CLOSE_WIDGET = "close-widget",
+    NETWORK_SWITCH = "network-switch",
+    DISCONNECT_WALLET = "disconnect-wallet"
 }
+/**
+ * Represents an event that is triggered when the user switches the network in their wallet.
+ * @property {string} network
+ * @property {number} chainId
+ * @property {Web3Provider} provider
+ */
+type WalletNetworkSwitch = {
+    /**  The name of the network that the user switched to. */
+    network: string;
+    /**  The chain ID of the network that the user switched to. */
+    chainId: number;
+    /** The Web3 provider object for the switched network. */
+    provider: Web3Provider;
+};
+/**
+ * Represents an event that is triggered when a wallet is disconnected.
+ */
+type WalletDisconnect = {};
+
+/**
+ * Enum representing possible Swap Widget event types.
+ */
+declare enum SwapEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    REJECTED = "rejected"
+}
+/**
+ * Represents a successful swap transaction.
+ * @property {string} transactionHash
+ */
+type SwapSuccess = {
+    /** The hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Type representing a Swap Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+type SwapFailed = {
+    /** The reason why the swap failed. */
+    reason: string;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+};
+/**
+ * Type representing a Swap Widget with type REJECTED.
+ * @property {string} reason -
+ * @property {number} timestamp -
+ */
+type SwapRejected = {
+    /** The reason why the swap failed. */
+    reason: string;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+};
+
+/**
+ * Enum representing possible Sale Widget event types.
+ */
+declare enum SaleEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure",
+    REJECTED = "rejected",
+    TRANSACTION_SUCCESS = "transaction-success"
+}
+/**
+ * Represents a successful Sale transaction.
+ * @property {Array} transactions -
+ */
+type SaleSuccess = {
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+    [key: string]: unknown;
+};
+/**
+ * Type representing a Sale Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ * @property {Array} transactions
+ */
+type SaleFailed = {
+    /** The reason why the swap failed. */
+    reason: string;
+    /** The timestamp of the failed swap. */
+    timestamp: number;
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+};
+/**
+ * Type representing a Sale Widget with type TRANSACTION_SUCCESS.
+ * @property {Object} transactions
+ */
+type SaleTransactionSuccess = {
+    /** The executed transactions */
+    transactions: {
+        method: string;
+        hash: string | undefined;
+    }[];
+};
+
+/**
+ * Enum of possible Bridge Widget event types.
+ */
+declare enum BridgeEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful bridge transaction.
+ * @property {string} transactionHash
+ */
+type BridgeSuccess = {
+    /** The hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Represents a failed bridge transaction.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+type BridgeFailed = {
+    /** The reason for the failed transaction. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};
+
+/**
+ * Enum representing different types of orchestration events.
+ */
+declare enum OrchestrationEventType {
+    REQUEST_CONNECT = "request-connect",
+    REQUEST_WALLET = "request-wallet",
+    REQUEST_SWAP = "request-swap",
+    REQUEST_BRIDGE = "request-bridge",
+    REQUEST_ONRAMP = "request-onramp"
+}
+/**
+ * Represents the connect event object when the connect widget is requested.
+ * @property {string} walletProviderName
+ */
+type RequestConnectEvent = {
+    /** The wallet provider name. */
+    walletProviderName: string;
+};
+/**
+ * Represents the wallet event object when the wallet widget is requested.
+ * @property {string} walletProviderName
+ */
+type RequestWalletEvent = {
+    /** The wallet provider name. */
+    walletProviderName: string;
+};
+/**
+ * Represents the swap event object when the swap widget is requested.
+ * @property {string} fromTokenAddress
+ * @property {string} toTokenAddress
+ * @property {string} amount
+ */
+type RequestSwapEvent = {
+    /** The address of the token to swap from. */
+    fromTokenAddress: string;
+    /** The address of the token to swap to. */
+    toTokenAddress: string;
+    /** The amount of from tokens to swap. */
+    amount: string;
+};
+/**
+ * Represents the bridge event object when the bridge widget is requested.
+ * @property {string} tokenAddress
+ * @property {string} amount
+ */
+type RequestBridgeEvent = {
+    /** The address of the token to bridge. */
+    tokenAddress: string;
+    /** The amount of tokens to bridge. */
+    amount: string;
+};
+/**
+ * Represents the onramp event object when the onramp widget is requested.
+ * @property {string} tokenAddress
+ * @property {string} amount
+ */
+type RequestOnrampEvent = {
+    /** The address of the token to be used for onramp. */
+    tokenAddress: string;
+    /** The amount of tokens to onramp. */
+    amount: string;
+};
+type OrchestrationEventData = RequestConnectEvent | RequestWalletEvent | RequestSwapEvent | RequestBridgeEvent | RequestOnrampEvent;
+
+/**
+ * Enum of possible OnRamp Widget event types.
+ */
+declare enum OnRampEventType {
+    CLOSE_WIDGET = "close-widget",
+    SUCCESS = "success",
+    FAILURE = "failure"
+}
+/**
+ * Represents a successful on-ramp transaction.
+ * @property {string} transactionHash
+ */
+type OnRampSuccess = {
+    /** The transaction hash of the successful transaction. */
+    transactionHash: string;
+};
+/**
+ * Type representing a On-ramp Widget with type FAILURE.
+ * @property {string} reason
+ * @property {number} timestamp
+ */
+type OnRampFailed = {
+    /** The reason why the on-ramp failed. */
+    reason: string;
+    /** The timestamp of the failed transaction. */
+    timestamp: number;
+};
+
+declare enum ConnectTargetLayer {
+    LAYER1 = "LAYER1",
+    LAYER2 = "LAYER2"
+}
+type ConnectWidgetParams = {};
+
+/**
+ * Bridge Widget parameters
+ * @property {string | undefined} fromContractAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type BridgeWidgetParams = {
+    /** The contract address of the token to bridge from, used to populate the bridge form token field */
+    fromContractAddress?: string;
+    /** The formatted amount to bridge, used to populate the bridge form amount field */
+    amount?: string;
+    /** The wallet provider name to use for the bridge widget */
+    walletProviderName?: WalletProviderName;
+};
+
+/**
+ * Wallet Widget parameters
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type WalletWidgetParams = {
+    /** The wallet provider name to use for the wallet widget */
+    walletProviderName?: WalletProviderName;
+};
+
+/**
+ * Swap Widget parameters
+ * @property {string | undefined} amount
+ * @property {string | undefined} fromContractAddress
+ * @property {string | undefined} toContractAddress
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type SwapWidgetParams = {
+    /** The formatted amount to swap, used to populate the swap from amount field */
+    amount?: string;
+    /** The contract address of the token to swap from */
+    fromContractAddress?: string;
+    /** The contract address of the token to swap to */
+    toContractAddress?: string;
+    /** The wallet provider name to use for the swap widget */
+    walletProviderName?: WalletProviderName;
+};
+
+/**
+ * OnRamp Widget parameters
+ * @property {string | undefined} contractAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type OnRampWidgetParams = {
+    /** The contract address of the token to onramp */
+    contractAddress?: string;
+    /** The formatted amount to onramp, used to populate the onramp form amount field */
+    amount?: string;
+    /** The wallet provider name to use for the onramp widget */
+    walletProviderName?: WalletProviderName;
+};
+
+/**
+ * Sale Widget parameters
+ * @property {string} amount
+ * @property {string} environmentId
+ * @property {string} fromContractAddress
+ * @property {SaleItem[]} items
+ * @property {WalletProviderName | undefined} walletProviderName
+ */
+type SaleWidgetParams = {
+    /** The total price to pay for the items in the sale */
+    amount?: string;
+    environmentId?: string;
+    fromContractAddress?: string;
+    /** The list of products to be purchased */
+    items?: SaleItem[];
+    /** The wallet provider name to default to if no web3Provider is passed */
+    walletProviderName?: WalletProviderName;
+};
+/**
+ * A product to be purchased
+ * @property {string} productId
+ * @property {number} qty
+ * @property {string} name
+ * @property {string} image
+ * @property {string} description
+ */
+type SaleItem = {
+    /** The id of the product */
+    productId: string;
+    /** The quantity to be purchased */
+    qty: number;
+    /** The name of the item */
+    name: string;
+    /** The image url of the item */
+    image: string;
+    /** The description of the item */
+    description: string;
+};
+
+/**
+ * Connect Widget Configuration represents the configuration options for the Connect Widget.
+ */
+type ConnectWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Bridge Widget Configuration represents the configuration options for the Bridge Widget.
+ */
+type BridgeWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Wallet Widget Configuration represents the configuration options for the Wallet Widget.
+ */
+type WalletWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Swap Widget Configuration represents the configuration options for the Swap Widget.
+ */
+type SwapWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Onramp Widget Configuration represents the configuration options for the Onramp Widget.
+ */
+type OnrampWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Sale Widget Configuration represents the configuration options for the Sale Widget.
+ */
+type SaleWidgetConfiguration = {} & WidgetConfiguration;
+
+/**
+ * Enum representing the list of widget types.
+ */
+declare enum WidgetType {
+    CONNECT = "connect",
+    WALLET = "wallet",
+    SWAP = "swap",
+    BRIDGE = "bridge",
+    ONRAMP = "onramp",
+    SALE = "sale"
+}
+/**
+ * Widget properties definition for each widget. Used for creating and updating widgets
+ */
+type WidgetProperties<T extends WidgetType> = {
+    config?: WidgetConfigurations[T];
+    provider?: Web3Provider;
+};
+type WidgetConfigurations = {
+    [WidgetType.CONNECT]: ConnectWidgetConfiguration;
+    [WidgetType.WALLET]: WalletWidgetConfiguration;
+    [WidgetType.SWAP]: SwapWidgetConfiguration;
+    [WidgetType.BRIDGE]: BridgeWidgetConfiguration;
+    [WidgetType.ONRAMP]: OnrampWidgetConfiguration;
+    [WidgetType.SALE]: SaleWidgetConfiguration;
+};
+type WidgetParameters = {
+    [WidgetType.CONNECT]: ConnectWidgetParams;
+    [WidgetType.WALLET]: WalletWidgetParams;
+    [WidgetType.SWAP]: SwapWidgetParams;
+    [WidgetType.BRIDGE]: BridgeWidgetParams;
+    [WidgetType.ONRAMP]: OnRampWidgetParams;
+    [WidgetType.SALE]: SaleWidgetParams;
+};
+/**
+ * Represents all the possible event types that are emitted by the widgets.
+ */
+type WidgetEventTypes = {
+    [WidgetType.CONNECT]: ConnectEventType | OrchestrationEventType;
+    [WidgetType.WALLET]: WalletEventType | OrchestrationEventType;
+    [WidgetType.SWAP]: SwapEventType | OrchestrationEventType;
+    [WidgetType.BRIDGE]: BridgeEventType | OrchestrationEventType;
+    [WidgetType.ONRAMP]: OnRampEventType | OrchestrationEventType;
+    [WidgetType.SALE]: SaleEventType | OrchestrationEventType;
+};
+type OrchestrationMapping = {
+    [OrchestrationEventType.REQUEST_CONNECT]: RequestConnectEvent;
+    [OrchestrationEventType.REQUEST_WALLET]: RequestWalletEvent;
+    [OrchestrationEventType.REQUEST_SWAP]: RequestSwapEvent;
+    [OrchestrationEventType.REQUEST_BRIDGE]: RequestBridgeEvent;
+    [OrchestrationEventType.REQUEST_ONRAMP]: RequestOnrampEvent;
+};
+type ProviderEventMapping = {
+    [ProviderEventType.PROVIDER_UPDATED]: ProviderUpdated;
+};
+/**
+ * Mapping of widget type, to each of it's events and then each event's payload
+ * Update this whenever a new event is created and used by a widget
+ * Each widget also has all of the orchestration events
+*/
+type WidgetEventData = {
+    [WidgetType.CONNECT]: {
+        [ConnectEventType.SUCCESS]: ConnectionSuccess;
+        [ConnectEventType.FAILURE]: ConnectionFailed;
+        [ConnectEventType.CLOSE_WIDGET]: {};
+    } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.WALLET]: {
+        [WalletEventType.NETWORK_SWITCH]: WalletNetworkSwitch;
+        [WalletEventType.DISCONNECT_WALLET]: WalletDisconnect;
+        [WalletEventType.CLOSE_WIDGET]: {};
+    } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.SWAP]: {
+        [SwapEventType.SUCCESS]: SwapSuccess;
+        [SwapEventType.FAILURE]: SwapFailed;
+        [SwapEventType.REJECTED]: SwapRejected;
+        [SwapEventType.CLOSE_WIDGET]: {};
+    } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.BRIDGE]: {
+        [BridgeEventType.SUCCESS]: BridgeSuccess;
+        [BridgeEventType.FAILURE]: BridgeFailed;
+        [BridgeEventType.CLOSE_WIDGET]: {};
+    } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.ONRAMP]: {
+        [OnRampEventType.SUCCESS]: OnRampSuccess;
+        [OnRampEventType.FAILURE]: OnRampFailed;
+        [OnRampEventType.CLOSE_WIDGET]: {};
+    } & OrchestrationMapping & ProviderEventMapping;
+    [WidgetType.SALE]: {
+        [SaleEventType.SUCCESS]: SaleSuccess;
+        [SaleEventType.FAILURE]: SaleFailed;
+        [SaleEventType.REJECTED]: any;
+        [SaleEventType.CLOSE_WIDGET]: {};
+        [SaleEventType.TRANSACTION_SUCCESS]: SaleTransactionSuccess;
+    } & OrchestrationMapping & ProviderEventMapping;
+};
+/**
+ * Represents an event emitted by a widget. The event type should match the event data
+ */
+/**
+ * Represents an event emitted by a widget.
+ * @template T - The widget type
+ * @template KEventName - The widget event name.
+ * @property {KEventName} type - The type of the event.
+ * @property {WidgetEventData[T][KEventName]} data - The data associated with the widget event.
+ */
+type WidgetEvent<T extends WidgetType, KEventName extends keyof WidgetEventData[T]> = {
+    type: KEventName;
+    data: WidgetEventData[T][KEventName];
+};
+/**
+ * Represents an event emitted by a widget.
+ * @template KEventName - The orchestration event name.
+ * @property {KEventName} type
+ * @property {OrchestrationMapping[KEventName]} data
+ */
+type OrchestrationEvent<KEventName extends keyof OrchestrationMapping> = {
+    /** The type of the event. */
+    type: KEventName;
+    /** The data associated with the event. */
+    data: OrchestrationMapping[KEventName];
+};
+/**
+ * Represents an event emitted by a widget.
+ * @template KEventName - The provider event name.
+ * @property {KEventName} type
+ * @property {ProviderEventMapping[KEventName]} data
+ */
+type ProviderEvent<KEventName extends keyof ProviderEventMapping> = {
+    /** The type of the event. */
+    type: KEventName;
+    /** The data associated with the event. */
+    data: ProviderEventMapping[KEventName];
+};
+interface IWidgetsFactory {
+    /**
+     * Create a new widget instance.
+     * @param type widget type to instantiate.
+     * @param props widget configurations and provider.
+     */
+    create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T>;
+    /**
+     * Update the widgets provider instance.
+     * @param provider the provider instance to update all widgets.
+     */
+    updateProvider(provider: Web3Provider): void;
+}
+/**
+ * Widget interface. Every widget implements this interface.
+ */
+interface Widget<T extends WidgetType> {
+    /**
+     * Mount a widget to a DOM ref element.
+     * @param id ID of the DOM element where the widget will be mounted.
+     * @param params widget parameters.
+     */
+    mount(id: string, params?: WidgetParameters[T]): void;
+    /**
+     * Unmount a widget and reset parameters
+     */
+    unmount(): void;
+    /**
+     * Update the widget properties
+     * @param props Widget specific properties including configuration
+     */
+    update(props: WidgetProperties<T>): void;
+    /**
+     * Add a listener for a widget event.
+     * @param event Widget specific event name.
+     * @param callback function to execute when the event is received.
+     */
+    addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+    /**
+     * Removes an event listener for a widget event.
+     * @param type Widget specific event name.
+     */
+    removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+}
+/**
+ * Represents the version of the Checkout Widgets to use defaults to (0.1.9-alpha)
+ * @property {number} major
+ * @property {number | undefined} minor
+ * @property {number | undefined} patch
+ * @property {'alpha' | undefined} prerelease
+ * @property {number | undefined} build
+ *
+ * @example
+ * { major: 0 } - use default version 0.1.9-alpha
+ * { major: 1 } - use version 1.x.x, pickup all new minor and patch versions released
+ * { major: 1, minor: 1 } - use version 1.1.x, pickup all new patch versions released
+ * { major: 1, minor: 2, patch: 3 } - use version 1.2.3 specifically
+ */
+type SemanticVersion = {
+    /** The major version of the widgets, must specify a major version even if it is 0. */
+    major: number;
+    /** The minor version of the widgets, leaving this blank will use the latest minor based on major */
+    minor?: number;
+    /** The patch version of the widgets, leaving this blank will use the latest minor based on minor */
+    patch?: number;
+    /** The prerelease version of the widgets, can only be 'alpha'. Do not use in production. */
+    prerelease?: 'alpha';
+    /** The build version of the widgets. Do not use in production. */
+    build?: number;
+};
+/**
+ * Represents the global configuration options for the Checkout Widgets.
+ * @property {WidgetTheme | undefined} theme
+ * @property {Environment | undefined} environment
+ * @property {SemanticVersion | undefined} version
+ * @property {boolean | undefined} isOnRampEnabled
+ * @property {boolean | undefined} isSwapEnabled
+ * @property {boolean | undefined} isBridgeEnabled
+ */
+type CheckoutWidgetsConfig = {
+    /** The theme of the Checkout Widget (default: "DARK") */
+    theme?: WidgetTheme;
+    /** The environment configuration (default: "SANDBOX") */
+    environment?: Environment;
+    /** The version of the checkout widgets js file to use (default: "0.1.x") */
+    version?: SemanticVersion;
+    /** Enable on-ramp top-up method (default: "true") */
+    isOnRampEnabled?: boolean;
+    /** Enable swap top-up method (default: "true") */
+    isSwapEnabled?: boolean;
+    /** Enable bridge top-up method (default: "true") */
+    isBridgeEnabled?: boolean;
+};
+
+/**
+ * Represents the configuration options for instantiating the Checkout Widgets factory.
+ * @property {WidgetConfiguration} config - global configuration options for the widgets.
+ * @property {SemanticVersion | undefined} version - version of the Checkout widgets bundle (default latest version will be used).
+ */
+type WidgetsInit = {
+    config: WidgetConfiguration;
+    version?: SemanticVersion;
+};
+
 declare class Checkout {
+    private readOnlyProviders;
     readonly config: CheckoutConfiguration;
     readonly fiatRampService: FiatRampService;
     readonly availability: AvailabilityService;
+    readonly passport?: Passport;
     /**
      * Constructs a new instance of the CheckoutModule class.
      * @param {CheckoutModuleConfiguration} [config=SANDBOX_CONFIGURATION] - The configuration object for the CheckoutModule.
      */
     constructor(config?: CheckoutModuleConfiguration);
+    /**
+     * Loads the widgets bundle and initiate the widgets factory.
+     * @param {WidgetsInit} init - The initialisation parameters for loading the widgets bundle and applying configuration
+     */
+    widgets(init: WidgetsInit): Promise<ImmutableCheckoutWidgets.WidgetsFactory>;
     /**
      * Creates a provider using the given parameters.
      * @param {CreateProviderParams} params - The parameters for creating the provider.
@@ -12026,4 +12841,126 @@ declare class Checkout {
     isSwapAvailable(): Promise<boolean>;
 }
 
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeFundingStep, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CHECKOUT_API_BASE_URL, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutStatus, ConnectParams, ConnectResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, FeePercentage, FeeToken, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, ItemBalance, ItemType, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, NoRouteOptions, NoRoutesFound, OnRampFundingStep, OrderFee, RemoteConfiguration, RoutesFound, RoutingOutcome, RoutingOutcomeType, SellOrder, SellParams, SellResult, SellResultFailed, SellResultInsufficientFunds, SellResultSuccess, SellToken, SendTransactionParams, SendTransactionResult, SmartCheckoutInsufficient, SmartCheckoutParams, SmartCheckoutResult, SmartCheckoutRouter, SmartCheckoutSufficient, SwapFundingStep, SwitchNetworkParams, SwitchNetworkResult, TokenBalance, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, TransactionRequirement, WalletFilter, WalletFilterTypes, WalletInfo, WalletProviderName };
+/**
+ * Declares global interfaces and namespaces for the application.
+ * @global
+ * @namespace ImmutableCheckoutWidgets
+ * */
+declare global {
+    namespace ImmutableCheckoutWidgets {
+        class WidgetsFactory implements IWidgetsFactory {
+            constructor(sdk: Checkout, config: CheckoutWidgetsConfig);
+            create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T>;
+            updateProvider(provider: Web3Provider): void;
+        }
+        class Connect<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Bridge<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Wallet<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Swap<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class OnRamp<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+        class Sale<T extends WidgetType> implements Widget<T> {
+            constructor(sdk: Checkout, props: WidgetProperties<T>);
+            mount(id: string, params?: WidgetParameters[T]): void;
+            unmount(): void;
+            update(props: WidgetProperties<T>): void;
+            addListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName, callback: (data: WidgetEventData[T][KEventName]) => void): void;
+            removeListener<KEventName extends keyof WidgetEventData[T]>(type: KEventName): void;
+        }
+    }
+}
+
+/**
+ * Enum representing different types of errors that can occur during the checkout process.
+ */
+declare enum CheckoutErrorType {
+    WEB3_PROVIDER_ERROR = "WEB3_PROVIDER_ERROR",
+    PROVIDER_ERROR = "PROVIDER_ERROR",
+    DEFAULT_PROVIDER_ERROR = "DEFAULT_PROVIDER_ERROR",
+    CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
+    GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
+    GET_INDEXER_BALANCE_ERROR = "GET_INDEXER_BALANCE_ERROR",
+    GET_ERC20_BALANCE_ERROR = "GET_ERC20_BALANCE_ERROR",
+    GET_ERC721_BALANCE_ERROR = "GET_ERC721_BALANCE_ERROR",
+    GET_NETWORK_INFO_ERROR = "GET_NETWORK_INFO_ERROR",
+    METAMASK_PROVIDER_ERROR = "METAMASK_PROVIDER_ERROR",
+    CHAIN_NOT_SUPPORTED_ERROR = "CHAIN_NOT_SUPPORTED_ERROR",
+    PROVIDER_REQUEST_MISSING_ERROR = "PROVIDER_REQUEST_MISSING_ERROR",
+    PROVIDER_REQUEST_FAILED_ERROR = "PROVIDER_REQUEST_FAILED_ERROR",
+    USER_REJECTED_REQUEST_ERROR = "USER_REJECTED_REQUEST_ERROR",
+    TRANSACTION_FAILED = "TRANSACTION_FAILED",
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+    UNPREDICTABLE_GAS_LIMIT = "UNPREDICTABLE_GAS_LIMIT",
+    INVALID_GAS_ESTIMATE_TYPE = "INVALID_GAS_ESTIMATE_TYPE",
+    UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
+    UNSUPPORTED_BALANCE_REQUIREMENT_ERROR = "UNSUPPORTED_BALANCE_REQUIREMENT_ERROR",
+    GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
+    CANCEL_ORDER_LISTING_ERROR = "CANCEL_ORDER_LISTING_ERROR",
+    PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
+    CREATE_ORDER_LISTING_ERROR = "CREATE_ORDER_LISTING_ERROR",
+    FULFILL_ORDER_LISTING_ERROR = "FULFILL_ORDER_LISTING_ERROR",
+    SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
+    GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
+    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR",
+    EXECUTE_APPROVAL_TRANSACTION_ERROR = "EXECUTE_APPROVAL_TRANSACTION_ERROR",
+    EXECUTE_FULFILLMENT_TRANSACTION_ERROR = "EXECUTE_FULFILLMENT_TRANSACTION_ERROR",
+    SIGN_MESSAGE_ERROR = "SIGN_MESSAGE_ERROR",
+    BRIDGE_GAS_ESTIMATE_ERROR = "BRIDGE_GAS_ESTIMATE_ERROR",
+    ORDER_FEE_ERROR = "ORDER_FEE_ERROR",
+    ITEM_REQUIREMENTS_ERROR = "ITEM_REQUIREMENTS_ERROR",
+    API_ERROR = "API_ERROR",
+    ORDER_EXPIRED_ERROR = "ORDER_EXPIRED_ERROR",
+    WIDGETS_SCRIPT_LOAD_ERROR = "WIDGETS_SCRIPT_LOAD_ERROR"
+}
+/**
+ * Represents an error object with a specific type, optional message, and optional data.
+ * @property {CheckoutErrorType} type
+ * @property {string | undefined} [message]
+ * @property {Object.<string, string> | undefined} [data]
+ */
+type ErrorType = {
+    /** The type of the error. */
+    type: CheckoutErrorType;
+    /** The error message. */
+    message?: string;
+    /** Additional data associated with the error. */
+    data?: {
+        [key: string]: string;
+    };
+};
+
+export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeSuccess, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CHECKOUT_API_BASE_URL, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutStatus, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, 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, 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, WidgetParameters, WidgetProperties, WidgetTheme, WidgetType };