@imtbl/sdk 0.0.1-alpha.3 → 0.1.0-alpha

package/dist/index.d.ts

@@ -745,6 +745,12 @@ interface AxiosInstance extends Axios {
   (url: string, config?: AxiosRequestConfig): AxiosPromise;
 }
 
+/**
+ * Generates a deterministic Stark private key from the provided signer.
+ * @returns the private key as a hex string
+ */
+declare function generateLegacyStarkPrivateKey(signer: Signer): Promise<string>;
+
 /**
  * An abstraction of a Stark account, which can be used to sign messages and transactions on StarkEx to execute state changing operations
  */
@@ -762,6 +768,19 @@ interface StarkSigner {
      */
     getAddress(): string | Promise<string>;
 }
+/**
+ * A pair of Signers
+ */
+interface WalletConnection {
+    /**
+     * The L1 signer
+     */
+    ethSigner: Signer;
+    /**
+     * The L2 signer
+     */
+    starkSigner: StarkSigner;
+}
 
 /**
  * An ERC20 token
@@ -10242,6 +10261,10 @@ declare type UnsignedTransferRequest = TokenAmount & {
      */
     receiver: string;
 };
+/**
+ * Parameter required to Mint tokens
+ */
+declare type UnsignedMintRequest = Omit<MintRequest, 'auth_signature'>;
 /**
  * Parameter required to create a Transfer
  */
@@ -10274,6 +10297,13 @@ interface NftTransferDetails {
     tokenAddress: string;
 }
 
+/**
+ * Creates a new Stark Signer
+ * @params starkPrivateKey - the private key as a hex string
+ * @returns a StarkSigner
+ */
+declare function createStarkSigner(starkPrivateKey: string): StarkSigner;
+
 /**
  * The configuration for the Ethereum network
  */
@@ -10296,18 +10326,14 @@ interface ImmutableXConfiguration {
     ethConfiguration: EthConfiguration;
 }
 
-interface StarkExOverrides {
+interface ImxOverrides {
     immutableXConfig: ImmutableXConfiguration;
 }
-interface StarkExModuleConfiguration extends ModuleConfiguration<StarkExOverrides> {
-}
-declare class StarkExConfiguration {
-    readonly immutableXConfig: ImmutableXConfiguration;
-    readonly baseConfig: ImmutableConfiguration;
-    constructor({ baseConfig, overrides }: StarkExModuleConfiguration);
+interface ImxModuleConfiguration extends ModuleConfiguration<ImxOverrides> {
 }
 
-declare const StarkExAPIFactory: (config: StarkExConfiguration) => {
+declare class ImmutableXClient {
+    private immutableX;
     depositsApi: DepositsApi;
     mintsApi: MintsApi;
     ordersApi: OrdersApi;
@@ -10324,7 +10350,354 @@ declare const StarkExAPIFactory: (config: StarkExConfiguration) => {
     metadataApi: MetadataApi;
     metadataRefreshesApi: MetadataRefreshesApi;
     projectsApi: ProjectsApi;
-};
+    constructor(config: ImxModuleConfiguration);
+    /**
+     * Get details of a Deposit with the given ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Deposit
+     * @throws {@link index.IMXError}
+     */
+    getDeposit(request: DepositsApiGetDepositRequest): Promise<Deposit>;
+    /**
+     * Get a list of Deposits
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Deposits
+     * @throws {@link index.IMXError}
+     */
+    listDeposits(request?: DepositsApiListDepositsRequest): Promise<ListDepositsResponse>;
+    /**
+     * Get Stark keys for a registered User
+     * @param ethAddress - the eth address of the User
+     * @returns a promise that resolves with the requested User
+     * @throws {@link index.IMXError}
+     */
+    getUser(ethAddress: string): Promise<GetUsersApiResponse>;
+    /**
+     * Get details of an Asset
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Asset
+     * @throws {@link index.IMXError}
+     */
+    getAsset(request: AssetsApiGetAssetRequest): Promise<Asset>;
+    /**
+     * Get a list of Assets
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Assets
+     * @throws {@link index.IMXError}
+     */
+    listAssets(request?: AssetsApiListAssetsRequest): Promise<ListAssetsResponse>;
+    /**
+     * Create a Collection
+     * @param ethSigner - the L1 signer
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the created Collection
+     * @throws {@link index.IMXError}
+     */
+    createCollection(ethSigner: Signer, request: CreateCollectionRequest): Promise<Collection>;
+    /**
+     * Get details of a Collection at the given address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Collection
+     * @throws {@link index.IMXError}
+     */
+    getCollection(request: CollectionsApiGetCollectionRequest): Promise<Collection>;
+    /**
+     * Get a list of Collection filters
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Collection Filters
+     * @throws {@link index.IMXError}
+     */
+    listCollectionFilters(request: CollectionsApiListCollectionFiltersRequest): Promise<CollectionFilter>;
+    /**
+     * Get a list of Collections
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Collections
+     * @throws {@link index.IMXError}
+     */
+    listCollections(request?: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResponse>;
+    /**
+     * Update a Collection
+     * @param ethSigner - the L1 signer
+     * @param collectionAddress - the Collection contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the updated Collection
+     * @throws {@link index.IMXError}
+     */
+    updateCollection(ethSigner: Signer, collectionAddress: string, request: UpdateCollectionRequest): Promise<Collection>;
+    /**
+     * Add metadata schema to Collection
+     * @param ethSigner - the L1 signer
+     * @param collectionAddress - the Collection contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the SuccessResponse if successful
+     * @throws {@link index.IMXError}
+     */
+    addMetadataSchemaToCollection(ethSigner: Signer, collectionAddress: string, request: AddMetadataSchemaToCollectionRequest): Promise<SuccessResponse>;
+    /**
+     * Get Metadata schema
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Metadata schema
+     * @throws {@link index.IMXError}
+     */
+    getMetadataSchema(request: MetadataApiGetMetadataSchemaRequest): Promise<MetadataSchemaProperty[]>;
+    /**
+     * Update metadata schema by name
+     * @param ethSigner - the L1 signer
+     * @param collectionAddress - the Collection contract address
+     * @param name - the Metadata schema name
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the SuccessResponse if successful
+     * @throws {@link index.IMXError}
+     */
+    updateMetadataSchemaByName(ethSigner: Signer, collectionAddress: string, name: string, request: MetadataSchemaRequest): Promise<SuccessResponse>;
+    /**
+     * Get a list of metadata refreshes
+     * @param ethSigner - the L1 signer
+     * @param collectionAddress - the Collection contract address
+     * @param pageSize - the page size of the result
+     * @param cursor - the cursor
+     * @returns a promise that resolves with the requested metadata refreshes
+     * @throws {@link index.IMXError}
+     */
+    listMetadataRefreshes(ethSigner: Signer, collectionAddress?: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshes>;
+    /**
+     * Get a list of metadata refresh errors
+     * @param ethSigner - the L1 signer
+     * @param refreshId - the metadata refresh ID
+     * @param pageSize - the page size of the result
+     * @param cursor - the cursor
+     * @returns a promise that resolves with the requested metadata refresh errors
+     * @throws {@link index.IMXError}
+     */
+    getMetadataRefreshErrors(ethSigner: Signer, refreshId: string, pageSize?: number, cursor?: string): Promise<GetMetadataRefreshErrorsResponse>;
+    /**
+     * Get a list of metadata refresh results
+     * @param ethSigner - the L1 signer
+     * @param refreshId - the metadata refresh ID
+     * @returns a promise that resolves with the requested metadata refresh results
+     * @throws {@link index.IMXError}
+     */
+    getMetadataRefreshResults(ethSigner: Signer, refreshId: string): Promise<GetMetadataRefreshResponse>;
+    /**
+     * Request a metadata refresh
+     * @param ethSigner - the L1 signer
+     * @param request the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested metadata refresh
+     * @throws {@link index.IMXError}
+     */
+    createMetadataRefresh(ethSigner: Signer, request: CreateMetadataRefreshRequest): Promise<CreateMetadataRefreshResponse>;
+    /**
+     * Create a Project
+     * @param ethSigner - the L1 signer
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the created Project
+     * @throws {@link index.IMXError}
+     */
+    createProject(ethSigner: Signer, request: CreateProjectRequest): Promise<CreateProjectResponse>;
+    /**
+     * Get a Project
+     * @param ethSigner - the L1 signer
+     * @param id - the Project ID
+     * @returns a promise that resolves with the requested Project
+     * @throws {@link index.IMXError}
+     */
+    getProject(ethSigner: Signer, id: string): Promise<Project>;
+    /**
+     * Get Projects owned by the given User
+     * @param ethSigner - the L1 signer
+     * @param pageSize - the page size of the result
+     * @param cursor - the cursor
+     * @param orderBy - the property to sort by
+     * @param direction - direction to sort (asc/desc)
+     * @returns a promise that resolves with the requested Projects
+     * @throws {@link index.IMXError}
+     */
+    getProjects(ethSigner: Signer, pageSize?: number, cursor?: string, orderBy?: string, direction?: string): Promise<GetProjectsResponse>;
+    /**
+     * Get the token Balances of the User
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Balance
+     * @throws {@link index.IMXError}
+     */
+    getBalance(request: BalancesApiGetBalanceRequest): Promise<Balance>;
+    /**
+     * Get a list of Balances for given User
+     * @param request the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Balances
+     * @throws {@link index.IMXError}
+     */
+    listBalances(request: BalancesApiListBalancesRequest): Promise<ListBalancesResponse>;
+    /**
+     * Get details of a Mint with the given ID
+     * @param request the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Mint
+     * @throws {@link index.IMXError}
+     */
+    getMint(request: MintsApiGetMintRequest): Promise<Mint[]>;
+    /**
+     * Get a list of Mints
+     * @param request optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Mints
+     * @throws {@link index.IMXError}
+     */
+    listMints(request?: MintsApiListMintsRequest): Promise<ListMintsResponse>;
+    /**
+     * Mint tokens in a batch with fees
+     * @param ethSigner - the L1 signer
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the minted tokens
+     * @throws {@link index.IMXError}
+     */
+    mint(ethSigner: Signer, request: UnsignedMintRequest): Promise<MintTokensResponse>;
+    /**
+     * Get a list of Withdrawals
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Withdrawals
+     * @throws {@link index.IMXError}
+     */
+    listWithdrawals(request?: WithdrawalsApiListWithdrawalsRequest): Promise<ListWithdrawalsResponse>;
+    /**
+     * Get details of Withdrawal with the given ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Withdrawal
+     * @throws {@link index.IMXError}
+     */
+    getWithdrawal(request: WithdrawalsApiGetWithdrawalRequest): Promise<Withdrawal>;
+    /**
+     * Get details of an Order with the given ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Order
+     * @throws {@link index.IMXError}
+     */
+    getOrder(request: OrdersApiGetOrderRequest): Promise<Order>;
+    /**
+     * Get a list of Orders
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Orders
+     * @throws {@link index.IMXError}
+     */
+    listOrders(request?: OrdersApiListOrdersRequest): Promise<ListOrdersResponse>;
+    /**
+     * Get details of a Trade with the given ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Trade
+     * @throws {@link index.IMXError}
+     */
+    getTrade(request: TradesApiGetTradeRequest): Promise<Trade>;
+    /**
+     * Get a list of Trades
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Trades
+     * @throws {@link index.IMXError}
+     */
+    listTrades(request?: TradesApiListTradesRequest): Promise<ListTradesResponse>;
+    /**
+     * Get details of a Token
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Token
+     * @throws {@link index.IMXError}
+     */
+    getToken(request: TokensApiGetTokenRequest): Promise<TokenDetails>;
+    /**
+     * Get a list of Tokens
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Tokens
+     * @throws {@link index.IMXError}
+     */
+    listTokens(request?: TokensApiListTokensRequest): Promise<ListTokensResponse>;
+    /**
+     * Get details of a Transfer with the given ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested Transfer
+     * @throws {@link index.IMXError}
+     */
+    getTransfer(request: TransfersApiGetTransferRequest): Promise<Transfer>;
+    /**
+     * Get a list of Transfers
+     * @param request - optional request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with the requested list of Transfers
+     * @throws {@link index.IMXError}
+     */
+    listTransfers(request?: TransfersApiListTransfersRequest): Promise<ListTransfersResponse>;
+    /**
+     * Create a new Exchange transaction
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the created Exchange Transaction
+     * @throws {@link index.IMXError}
+     */
+    createExchange(request: ExchangesApiCreateExchangeRequest): Promise<ExchangeCreateExchangeAndURLResponse>;
+    /**
+     * Get an Exchange transaction
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the Exchange Transaction
+     * @throws {@link index.IMXError}
+     */
+    getExchange(request: ExchangesApiGetExchangeRequest): Promise<Exchange>;
+    /**
+     * Get Exchange transactions
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with Exchange Transactions
+     * @throws {@link index.IMXError}
+     */
+    getExchanges(request: ExchangesApiGetExchangesRequest): Promise<GetTransactionsResponse>;
+    /**
+     * Create a new Transfer request
+     * @param walletConnection - the pair of Eth/Stark signers
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the created Exchange Transfer
+     * @throws {@link index.IMXError}
+     */
+    exchangeTransfer(walletConnection: WalletConnection, request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
+    /**
+     * Create a new nft primary transaction
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with the created nft primary Transaction
+     * @throws {@link index.IMXError}
+     */
+    createNftPrimary(request: NftCheckoutPrimaryApiCreateNftPrimaryRequest): Promise<NftprimarytransactionCreateResponse>;
+    /**
+     * Get nft primary supported currencies and their limits
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with nft primary Currencies
+     * @throws {@link index.IMXError}
+     */
+    getCurrenciesNFTCheckoutPrimary(request: NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest): Promise<CurrencyWithLimits>;
+    /**
+     * Get nft primary transaction by transaction id
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with nft primary transaction
+     * @throws {@link index.IMXError}
+     */
+    getNftPrimaryTransaction(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest): Promise<NftprimarytransactionGetResponse>;
+    /**
+     * Get list of nft primary transactions
+     * @param request - the request object to be provided in the API request
+     * @returns a promise that resolves with nft primary transaction
+     * @throws {@link index.IMXError}
+     */
+    getNftPrimaryTransactions(request: NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest): Promise<NftprimarytransactionListTransactionsResponse>;
+}
+
+declare enum PassportErrorType {
+    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
+    INVALID_CONFIGURATION = "INVALID_CONFIGURATION",
+    WALLET_CONNECTION_ERROR = "WALLET_CONNECTION_ERROR",
+    NOT_LOGGED_IN_ERROR = "NOT_LOGGED_IN_ERROR",
+    SILENT_LOGIN_ERROR = "SILENT_LOGIN_ERROR",
+    REFRESH_TOKEN_ERROR = "REFRESH_TOKEN_ERROR",
+    USER_REGISTRATION_ERROR = "USER_REGISTRATION_ERROR",
+    LOGOUT_ERROR = "LOGOUT_ERROR",
+    TRANSFER_ERROR = "TRANSFER_ERROR",
+    CREATE_ORDER_ERROR = "CREATE_ORDER_ERROR",
+    CANCEL_ORDER_ERROR = "CANCEL_ORDER_ERROR",
+    EXCHANGE_TRANSFER_ERROR = "EXCHANGE_TRANSFER_ERROR",
+    CREATE_TRADE_ERROR = "CREATE_TRADE_ERROR",
+    OPERATION_NOT_SUPPORTED_ERROR = "OPERATION_NOT_SUPPORTED_ERROR"
+}
+declare class PassportError extends Error {
+    type: PassportErrorType;
+    constructor(message: string, type: PassportErrorType);
+}
 
 interface IMXProvider {
     /**
@@ -10414,7 +10787,7 @@ interface IMXProvider {
 declare class GenericIMXProvider implements IMXProvider {
     private readonly config;
     private readonly signers;
-    constructor(config: ProviderConfiguration$1, ethSigner: Signer, starkExSigner: StarkSigner);
+    constructor(config: ProviderConfiguration$1, ethSigner: Signer, starkSigner: StarkSigner);
     getAddress(): Promise<string>;
     registerOffchain(): Promise<RegisterUserResponse>;
     batchNftTransfer(request: Array<NftTransferDetails>): Promise<CreateTransferResponse>;
@@ -10431,7 +10804,7 @@ declare class GenericIMXProvider implements IMXProvider {
 
 declare class MetaMaskIMXProvider extends GenericIMXProvider {
     private static imxSigner;
-    constructor(config: ProviderConfiguration$1, ethSigner: Signer, starkExSigner: StarkSigner);
+    constructor(config: ProviderConfiguration$1, ethSigner: Signer, starkSigner: StarkSigner);
     static connect(config: ProviderConfiguration$1): Promise<MetaMaskIMXProvider>;
     static disconnect(): Promise<void>;
     static signMessage(message: string): Promise<string>;
@@ -10448,26 +10821,6 @@ declare class ProviderConfiguration {
     constructor({ baseConfig, overrides }: ProviderModuleConfiguration);
 }
 
-declare enum PassportErrorType {
-    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR",
-    INVALID_CONFIGURATION = "INVALID_CONFIGURATION",
-    WALLET_CONNECTION_ERROR = "WALLET_CONNECTION_ERROR",
-    NOT_LOGGED_IN_ERROR = "NOT_LOGGED_IN_ERROR",
-    REFRESH_TOKEN_ERROR = "REFRESH_TOKEN_ERROR",
-    USER_REGISTRATION_ERROR = "USER_REGISTRATION_ERROR",
-    LOGOUT_ERROR = "LOGOUT_ERROR",
-    TRANSFER_ERROR = "TRANSFER_ERROR",
-    CREATE_ORDER_ERROR = "CREATE_ORDER_ERROR",
-    CANCEL_ORDER_ERROR = "CANCEL_ORDER_ERROR",
-    EXCHANGE_TRANSFER_ERROR = "EXCHANGE_TRANSFER_ERROR",
-    CREATE_TRADE_ERROR = "CREATE_TRADE_ERROR",
-    OPERATION_NOT_SUPPORTED_ERROR = "OPERATION_NOT_SUPPORTED_ERROR"
-}
-declare class PassportError extends Error {
-    type: PassportErrorType;
-    constructor(message: string, type: PassportErrorType);
-}
-
 type UserProfile = {
     email?: string;
     nickname?: string;
@@ -10500,12 +10853,14 @@ declare class Passport {
     private magicAdapter;
     private readonly config;
     constructor(passportModuleConfiguration: PassportModuleConfiguration);
+    private getImxProvider;
+    connectImxSilent(): Promise<IMXProvider | null>;
     connectImx(): Promise<IMXProvider>;
     loginCallback(): Promise<void>;
     logout(): Promise<void>;
-    getUserInfo(): Promise<UserProfile>;
+    getUserInfo(): Promise<UserProfile | undefined>;
     getIdToken(): Promise<string | undefined>;
-    getAccessToken(): Promise<string>;
+    getAccessToken(): Promise<string | undefined>;
     private registerUser;
 }
 
@@ -10521,6 +10876,14 @@ declare class PassportConfiguration {
     constructor({ baseConfig, overrides, ...oidcConfiguration }: PassportModuleConfiguration);
 }
 
+/**
+ * Interface representing token information.
+ * @property {string} name - The token name.
+ * @property {string} symbol - The token symbol.
+ * @property {number} decimals - The token decimals.
+ * @property {string} [address] - The token contract address.
+ * @property {string} [icon] - The token icon URL/data:image.
+ */
 interface TokenInfo {
     name: string;
     symbol: string;
@@ -10528,98 +10891,218 @@ interface TokenInfo {
     address?: string;
     icon?: string;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
+ * @property {TokenFilterTypes} type - The type of token to retrieve.
+ * @property {ChainId}  chainId - The ID of the blockchain network.
+ * @property {TokenFilter[]} [exclude] - The tokens to exclude from the list.
+ */
 interface GetTokenAllowListParams {
     type: TokenFilterTypes;
     chainId: ChainId;
     exclude?: TokenFilter[];
 }
+/**
+ * Interface representing the result of {@link Checkout.getTokenAllowList}.
+ * @property {TokenInfo[]} tokens - The list of tokens allowed for the specified params.
+ */
 interface GetTokenAllowListResult {
     tokens: TokenInfo[];
 }
+/**
+ * Enum representing the types of token filters available.
+ */
 declare enum TokenFilterTypes {
     SWAP = "swap",
     BRIDGE = "bridge",
     ALL = "all"
 }
+/**
+ * Interface representing a token filter that can be used to exclude certain tokens.
+ * @property {string} address - The token contract address.
+ */
 interface TokenFilter {
     address: string;
 }
+/**
+ * Enum representing the supported chains with their corresponding IDs.
+ */
 declare enum ChainId {
     ETHEREUM = 1,
     GOERLI = 5,
     POLYGON = 137
 }
+/**
+ * Interface representing the information of a network.
+ * @property {string} name - The name of the network.
+ * @property {number} chainId - The ID of the network.
+ * @property {TokenInfo} nativeCurrency - The info of the network's native currency.
+ * @property {boolean} isSupported - Flag indicating if the network is supported by the application.
+ */
 interface NetworkInfo {
     name: string;
     chainId: number;
     nativeCurrency: TokenInfo;
     isSupported: boolean;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.switchNetwork}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {ChainId} chainId - The ID of the network to switch to.
+ */
 interface SwitchNetworkParams {
     provider: Web3Provider;
     chainId: ChainId;
 }
+/**
+ * Interface representing the result of {@link Checkout.switchNetwork}.
+ * @property {NetworkInfo} network - The information of the network that was switched to.
+ */
 interface SwitchNetworkResult {
     network: NetworkInfo;
+    provider: Web3Provider;
 }
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkInfo}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ */
 interface GetNetworkParams {
     provider: Web3Provider;
 }
+/**
+ * Enum representing the types of filters that can be applied to get the allow list of networks.
+ */
 declare enum NetworkFilterTypes {
     ALL = "all"
 }
+/**
+ * Interface representing a filter for filtering a specific network.
+ * @property {ChainId} chainId - The ID of the network to allow or disallow.
+ */
 interface NetworkFilter {
     chainId: ChainId;
 }
+/**
+ * * Interface representing the parameters for {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkFilterTypes} type - The type of allow list filter to apply.
+ * @property {NetworkFilter[]} [exclude] - The list of networks to exclude from the allow list.
+ */
 interface GetNetworkAllowListParams {
     type: NetworkFilterTypes;
     exclude?: NetworkFilter[];
 }
+/**
+ * Interface representing the result of {@link Checkout.getNetworkAllowList}.
+ * @property {NetworkInfo[]} networks - The list of allowed networks.
+ */
 interface GetNetworkAllowListResult {
     networks: NetworkInfo[];
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getBalance}.
+ * @property {@link Web3Provider} provider - The provider to connect to the network.
+ * @property {string} walletAddress - The wallet address.
+ * @property {string | undefined} contractAddress - The contract address of the token.
+ */
 interface GetBalanceParams {
     provider: Web3Provider;
     walletAddress: string;
     contractAddress?: string;
 }
+/**
+ * Interface representing the result of {@link Checkout.getBalance}.
+ * @property {BigNumber} balance - The balance of the wallet for the token.
+ * @property {string} formattedBalance - The formatted balance of the wallet for the token.
+ * @property {TokenInfo} token - The token information.
+ */
 interface GetBalanceResult {
     balance: BigNumber;
     formattedBalance: string;
     token: TokenInfo;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getAllBalances}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {string} walletAddress - The wallet address.
+ * @property {ChainId} chainId - The ID of the network.
+ */
 interface GetAllBalancesParams {
     provider: Web3Provider;
     walletAddress: string;
     chainId: ChainId;
 }
+/**
+ * Interface representing the result of {@link Checkout.getAllBalances}.
+ * @property {GetBalanceResult[]} balances - The array of balances of the wallet for every token.
+ */
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+/**
+ * Enum representing the list of default supported providers.
+ */
 declare enum ConnectionProviders {
     METAMASK = "metamask"
 }
+/**
+ * Interface representing the parameters for {@link Checkout.connect}.
+ * @property {ConnectionProviders} providerPreference - The preferred provider to connect to the network.
+ */
 type ConnectParams = {
     providerPreference: ConnectionProviders;
 };
+/**
+ * Interface representing the result of {@link Checkout.connect}.
+ * @property {Web3Provider} provider - The provider used to connect to the network.
+ * @property {NetworkInfo} network - Information about the connected network.
+ */
 interface ConnectResult {
     provider: Web3Provider;
     network: NetworkInfo;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.checkIsWalletConnected}.
+ * @property {ConnectionProviders} providerPreference - The preferred provider to use to check the connection status to th Web3 network.
+ */
 interface CheckConnectionParams {
     providerPreference: ConnectionProviders;
 }
+/**
+ * Interface representing the result of {@link Checkout.checkIsWalletConnected}.
+ * @property {boolean} isConnected - A boolean indicating the connection status of th Web3 provider.
+ * @property {string} walletAddress - The wallet address used to check the connection.
+ */
 interface CheckConnectionResult {
     isConnected: boolean;
     walletAddress: string;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.sendTransaction}.
+ * @property {Web3Provider} provider - The provider to connect to the network.
+ * @property {Transaction} transaction - The transaction to send.
+ */
 interface SendTransactionParams {
     provider: Web3Provider;
     transaction: Transaction;
 }
+/**
+ * Interface representing the result of {@link Checkout.sendTransaction}.
+ * @property {TransactionResponse} transactionResponse - The response of the transaction.
+ */
 interface SendTransactionResult {
     transactionResponse: TransactionResponse;
 }
+/**
+ * Interface representing a blockchain transaction.
+ * @property {string} nonce - The transaction nonce.
+ * @property {string} gasPrice - The gas price of the transaction.
+ * @property {string} gas - The gas limit for the transaction.
+ * @property {string} to - The address of the recipient.
+ * @property {string} from - The address of the sender.
+ * @property {string} value - The value to transfer in wei.
+ * @property {string} data - The data to include in the transaction.
+ * @property {number} chainId - The ID of the chain the transaction is for.
+ */
 interface Transaction {
     nonce: string;
     gasPrice: string;
@@ -10630,37 +11113,149 @@ interface Transaction {
     data: string;
     chainId: number;
 }
-declare enum WalletFilterTypes {
-    ALL = "all",
-    DESKTOP = "desktop",
-    MOBILE = "mobile"
-}
+/**
+ * Interface representing a wallet filter to be used in {@link GetWalletAllowListParams}.
+ * @property {ConnectionProviders} connectionProvider - The connection provider to filter wallets by.
+ */
 interface WalletFilter {
     connectionProvider: ConnectionProviders;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getWalletAllowList}.
+ * @property {WalletFilterTypes} type - The type of wallets to filter by.
+ * @property {WalletFilter[]} [exclude] - An optional list of wallet filters to exclude from the allowed wallets list.
+ */
 interface GetWalletAllowListParams {
     type: WalletFilterTypes;
     exclude?: WalletFilter[];
 }
+/**
+ * Interface representing information about a wallet used in {@link GetWalletAllowListResult}.
+ * @property {ConnectionProviders} connectionProvider - The connection provider for the wallet.
+ * @property {string} name - The name of the wallet.
+ * @property {string} description - A description of the wallet.
+ * @property {string} icon - The URL/data:image of an icon for the wallet.
+ */
 interface WalletInfo {
     connectionProvider: ConnectionProviders;
     name: string;
     description: string;
     icon: string;
 }
+/**
+ * Interface representing the result of {@link Checkout.getWalletAllowList}.
+ * @property {WalletInfo[]} wallets - A list of {@link WalletInfo} objects representing the allowed wallets.
+ */
 interface GetWalletAllowListResult {
     wallets: WalletInfo[];
 }
+/**
+ * Enum representing the platform filters used in {@link GetWalletAllowListParams}.
+ */
+declare enum WalletFilterTypes {
+    ALL = "all",
+    DESKTOP = "desktop",
+    MOBILE = "mobile"
+}
+/**
+ * The different types of errors that can be returned by the checkout process.
+ */
+declare enum CheckoutErrorType {
+    PROVIDER_PREFERENCE_ERROR = "PROVIDER_PREFERENCE_ERROR",
+    CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
+    GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
+    GET_ERC20_BALANCE_ERROR = "GET_ERC20_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_ERROR = "TRANSACTION_ERROR"
+}
+/**
+ * The type signature for an error.
+ * Contains a type that corresponds to a {@link CheckoutErrorType}, an optional message string and optional data object.
+ */
+type ErrorType = {
+    type: CheckoutErrorType;
+    message?: string;
+    data?: {
+        [key: string]: string;
+    };
+};
 declare class Checkout {
+    /**
+     * Check if a wallet is connected to the current application without requesting permission from the wallet and hence triggering a connect popup.
+     * @param {CheckConnectionParams} params - The necessary data required to verify a wallet connection status.
+     * @returns Wallet connection status details.
+     * @throws {@link ErrorType}
+     */
     checkIsWalletConnected(params: CheckConnectionParams): Promise<CheckConnectionResult>;
+    /**
+     * Establish a connection with a wallet provider such as MetaMask and returns the provider object and the current network details.
+     * @param {ConnectParams} params - The necessary data required to establish a connection with a wallet provider.
+     * @returns Wallet provider and current network information.
+     * @throws {@link ErrorType}
+     */
     connect(params: ConnectParams): Promise<ConnectResult>;
+    /**
+     * Switch the currently connected wallet to a new network.
+     * @param {SwitchNetworkParams} params - The necessary data required to switch network.
+     * @returns The new network information.
+     * @throws {@link ErrorType}
+     */
     switchNetwork(params: SwitchNetworkParams): Promise<SwitchNetworkResult>;
+    /**
+     * Fetch the balance of the native token of the current connected network or, if a contract address is provided, it will return the balance of that ERC20 token. For example, if the wallet is connected to the Ethereum Mainnet then the function gets the wallet ETH L1 balance.
+     * @param {GetBalanceParams} params - The necessary data required to fetch the wallet balance.
+     * @returns Native token balance for the given wallet.
+     * @throws {@link ErrorType}
+     */
     getBalance(params: GetBalanceParams): Promise<GetBalanceResult>;
+    /**
+     * Fetch all available balances (ERC20 & Native) of the current connected network of the given wallet. It will loop through the list of allowed tokens and check for balance on each one.
+     * @param {GetAllBalancesParams} params - The necessary data required to fetch all the wallet balances.
+     * @returns List of tokens balance for the given wallet.
+     * @throws {@link ErrorType}
+     */
     getAllBalances(params: GetAllBalancesParams): Promise<GetAllBalancesResult>;
+    /**
+     * Fetch the list of available networks that a wallet can add or/and switch to.
+     * @param {GetNetworkAllowListParams} params - The necessary data required to fetch the list of available networks.
+     * @returns List of networks.
+     * @throws {@link ErrorType}
+     */
     getNetworkAllowList(params: GetNetworkAllowListParams): Promise<GetNetworkAllowListResult>;
+    /**
+     * Get the list of tokens which are allowed to be used with the product.
+     * @param {GetTokenAllowListParams} params - The necessary data required to fetch the list of allowed tokens.
+     * @returns List of allowed tokens.
+     * @throws {@link ErrorType}
+     */
     getTokenAllowList(params: GetTokenAllowListParams): Promise<GetTokenAllowListResult>;
-    getWalletsAllowList(params: GetWalletAllowListParams): Promise<GetWalletAllowListResult>;
+    /**
+     * Fetch the list of wallets which are available to connect with.
+     * @param {GetWalletAllowListParams} params - The necessary data required to fetch the list of allowed wallets.
+     * @returns List of allowed wallets.
+     * @throws {@link ErrorType}
+     */
+    getWalletAllowList(params: GetWalletAllowListParams): Promise<GetWalletAllowListResult>;
+    /**
+     * Send a generic transaction to the provider.
+     * @param {SendTransactionParams} params - The necessary data required to send a transaction.
+     * @returns Transaction response.
+     * @throws {@link ErrorType}
+     * @remarks
+     * Further documenation can be found at [MetaMask | Sending Transactions](https://docs.metamask.io/guide/sending-transactions.html).
+     */
     sendTransaction(params: SendTransactionParams): Promise<SendTransactionResult>;
+    /**
+     * Get network information about the currently selected network.
+     * @param {GetNetworkParams} params - The necessary data required to get the current network information.
+     * @returns Network details.
+     * @throws {@link ErrorType}
+     */
     getNetworkInfo(params: GetNetworkParams): Promise<NetworkInfo>;
 }
 
@@ -21685,7 +22280,7 @@ interface Interaction {
   timestamp: number;
 }
 
-// Type definitions for React 18.0
+// NOTE: Users of the `experimental` builds of React should add a reference
 
 
 type NativeAnimationEvent = AnimationEvent;
@@ -25094,6 +25689,14 @@ interface ImtblTransitionExampleProps extends undefined<undefined<HTMLElement>,
     providerPreference: string;
     theme: string;
 }
+interface ImtblInnerWidgetExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+    providerPreference: string;
+    theme: string;
+}
+interface ImtblOuterWidgetExampleProps extends undefined<undefined<HTMLElement>, HTMLElement> {
+    providerPreference: string;
+    theme: string;
+}
 declare enum Network {
     ETHEREUM = "Ethereum",
     GOERLI = "Goerli",
@@ -25105,4 +25708,4 @@ declare enum WidgetTheme {
     CUSTOM = "custom"
 }
 
-export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuySuccess, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, ConnectEvent, ConnectEventType, ConnectParams, ConnectResult, ConnectionFailed, ConnectionProviders, ConnectionSuccess, Environment, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, Passport, PassportConfiguration, PassportError, ProviderConfiguration, SendTransactionParams, SendTransactionResult, StarkExAPIFactory, StarkExConfiguration, StarkExOverrides, SwapEvent, SwapEventType, SwapFailed, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, WalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WidgetTheme };
+export { BridgeEvent, BridgeEventType, BridgeFailed, BridgeSuccess, BuyClose, BuyEvent, BuyEventType, BuyFailed, BuyNotConnected, BuySuccess, ChainId, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, ConnectEvent, ConnectEventType, ConnectParams, ConnectResult, ConnectionFailed, ConnectionProviders, ConnectionSuccess, Environment, ErrorType, GenericIMXProvider, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, IMTBLWidgetEvents, IMXProvider, ImmutableConfiguration, ImmutableXClient, ImtblBridgeProps, ImtblBuyProps, ImtblConnectProps, ImtblExampleProps, ImtblInnerWidgetExampleProps, ImtblOuterWidgetExampleProps, ImtblSwapProps, ImtblTransitionExampleProps, ImtblWalletProps, ImxModuleConfiguration as ImxClientModuleConfiguration, WalletConnection as ImxClientWalletConnection, MetaMaskIMXProvider, ModuleConfiguration, Network, NetworkFilter, NetworkFilterTypes, NetworkInfo, Passport, PassportConfiguration, PassportError, ProviderConfiguration, SendTransactionParams, SendTransactionResult, SwapEvent, SwapEventType, SwapFailed, SwapSuccess, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, Transaction, WalletEvent, WalletEventType, WalletFilter, WalletFilterTypes, WalletInfo, WalletNetworkSwitchEvent, WidgetTheme, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey };