@imtbl/sdk 0.36.3 → 0.36.5

package/dist/checkout.d.ts

@@ -10644,12 +10644,12 @@ declare enum ChainId {
 }
 /**
  * Enum representing different chain names.
- * @enum {number}
- * @property {number} IMTBL_ZKEVM_MAINNET - The chain name for IMTBL ZKEVM Mainnet.
- * @property {number} IMTBL_ZKEVM_TESTNET - The chain name for IMTBL ZKEVM Testnet.
- * @property {number} IMTBL_ZKEVM_DEVNET - The chain name for IMTBL ZKEVM Devnet.
- * @property {number} ETHEREUM - The chain name for Ethereum.
- * @property {number} SEPOLIA - The chain name for Sepolia.
+ * @enum {string}
+ * @property {string} IMTBL_ZKEVM_MAINNET - The chain name for IMTBL ZKEVM Mainnet.
+ * @property {string} IMTBL_ZKEVM_TESTNET - The chain name for IMTBL ZKEVM Testnet.
+ * @property {string} IMTBL_ZKEVM_DEVNET - The chain name for IMTBL ZKEVM Devnet.
+ * @property {string} ETHEREUM - The chain name for Ethereum.
+ * @property {string} SEPOLIA - The chain name for Sepolia.
  */
 declare enum ChainName {
     ETHEREUM = "Ethereum",
@@ -10658,6 +10658,22 @@ declare enum ChainName {
     IMTBL_ZKEVM_DEVNET = "Immutable zkEVM Dev",
     IMTBL_ZKEVM_MAINNET = "Immutable zkEVM"
 }
+/**
+ * Enum representing different chain slugs.
+ * @enum {string}
+ * @property {string} IMTBL_ZKEVM_MAINNET - The chain slug for IMTBL ZKEVM Mainnet.
+ * @property {string} IMTBL_ZKEVM_TESTNET - The chain slug for IMTBL ZKEVM Testnet.
+ * @property {string} IMTBL_ZKEVM_DEVNET - The chain slug for IMTBL ZKEVM Devnet.
+ * @property {string} ETHEREUM - The chain slug for Ethereum.
+ * @property {string} SEPOLIA - The chain slug for Sepolia.
+ */
+declare enum ChainSlug {
+    ETHEREUM = "ethereum",
+    SEPOLIA = "sepolia",
+    IMTBL_ZKEVM_MAINNET = "imtbl-zkevm-mainnet",
+    IMTBL_ZKEVM_TESTNET = "imtbl-zkevm-testnet",
+    IMTBL_ZKEVM_DEVNET = "imtbl-zkevm-devnet"
+}
 
 /**
  * Represents information about a token.
@@ -10675,6 +10691,15 @@ interface TokenInfo {
     address?: string;
     icon?: string;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.getTokenInfo}.
+ * @property {Web3Provider | JsonRpcProvider} provider - The provider used to get the balance.
+ * @property {string} tokenAddress - The contract address of the token.
+ */
+interface GetTokenInfoParams {
+    provider: Web3Provider | JsonRpcProvider;
+    tokenAddress: string;
+}
 
 /**
  * Interface representing the parameters for {@link Checkout.getBalance}.
@@ -11503,6 +11528,7 @@ interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverri
  * @property {AllowedNetworkConfig[]} allowedNetworks
  * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens
  * @property {ImxAddressConfig | undefined} imxAddressMapping
+ * @property {TelemetryConfig | undefined} telemetry
  */
 type RemoteConfiguration = {
     /** The config used for the DEX. */
@@ -11517,6 +11543,8 @@ type RemoteConfiguration = {
     gasEstimateTokens?: GasEstimateTokenConfig;
     /** The IMX address mappings across available networks. */
     imxAddressMapping?: ImxAddressConfig;
+    /** Telemetry config. */
+    telemetry?: TelemetryConfig;
 };
 /**
  * A type representing the fee structure for an OnRamp provider
@@ -11588,6 +11616,13 @@ type AllowedNetworkConfig = {
 type ImxAddressConfig = {
     [chainId: string]: string;
 };
+/**
+ * A type representing the telemetry configurations.
+ * @property {string} segmentPublishableKey
+ */
+type TelemetryConfig = {
+    segmentPublishableKey: string;
+};
 /**
  * A type representing the required information to estimate gas for a transaction.
  * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}
@@ -12756,6 +12791,13 @@ declare class Checkout {
      * @returns {Promise<SwitchNetworkResult>} - A promise that resolves to the result of switching the network.
      */
     switchNetwork(params: SwitchNetworkParams): Promise<SwitchNetworkResult>;
+    /**
+     * Retrieves the token information given the token address. This function makes RPC calls to
+     * ERC20 contracts to fetch the main contract information (e.g. symbol).
+     * @param {GetTokenInfoParams} params - The parameters for retrieving the token information.
+     * @returns {Promise<TokenInfo>} - A promise that resolves to the token info request.
+     */
+    getTokenInfo(params: GetTokenInfoParams): Promise<TokenInfo>;
     /**
      * Retrieves the balance of a wallet address.
      * @param {GetBalanceParams} params - The parameters for retrieving the balance.
@@ -12936,6 +12978,7 @@ declare enum CheckoutErrorType {
     CONNECT_PROVIDER_ERROR = "CONNECT_PROVIDER_ERROR",
     GET_BALANCE_ERROR = "GET_BALANCE_ERROR",
     GET_INDEXER_BALANCE_ERROR = "GET_INDEXER_BALANCE_ERROR",
+    GET_ERC20_INFO_ERROR = "GET_ERC20_INFO_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",
@@ -12985,4 +13028,4 @@ type ErrorType = {
     };
 };
 
-export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, 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, IMMUTABLE_API_BASE_URL, 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 };
+export { AllowedNetworkConfig, AvailableRoutingOptions, BalanceDelta, BridgeEventType, BridgeFailed, BridgeFundingStep, BridgeTransactionSent, BridgeWidgetConfiguration, BridgeWidgetParams, BuyOrder, BuyParams, BuyResult, BuyResultFailed, BuyResultInsufficientFunds, BuyResultSuccess, BuyToken, CancelParams, CancelResult, CancelResultFailed, CancelResultSuccess, ChainId, ChainName, ChainSlug, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutBridgeConfiguration, CheckoutConfiguration, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutOnRampConfiguration, CheckoutStatus, CheckoutSwapConfiguration, CheckoutWidgetsConfig, ConnectEventType, ConnectParams, ConnectResult, ConnectTargetLayer, ConnectWidgetConfiguration, ConnectWidgetParams, ConnectionFailed, ConnectionSuccess, CreateProviderParams, CreateProviderResult, DexConfig, ERC20ItemRequirement, ERC721Balance, ERC721ItemRequirement, ErrorType, ExchangeType, Fee, FeePercentage, FeeToken, FiatRampParams, FulfillmentTransaction, FundingItem, FundingRoute, FundingStep, FundingStepType, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetTokenInfoParams, GetWalletAllowListParams, GetWalletAllowListResult, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, IWidgetsFactory, ItemBalance, ItemType, 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 };