@imtbl/sdk 0.36.3 → 0.36.5

package/dist/index.d.ts

@@ -16574,12 +16574,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",
@@ -16588,6 +16588,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.
@@ -16605,6 +16621,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}.
@@ -17433,6 +17458,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. */
@@ -17447,6 +17473,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
@@ -17518,6 +17546,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 } }}
@@ -18686,6 +18721,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.
@@ -18866,6 +18908,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",
@@ -18940,6 +18983,8 @@ type checkout_d_ChainId = ChainId;
 declare const checkout_d_ChainId: typeof ChainId;
 type checkout_d_ChainName = ChainName;
 declare const checkout_d_ChainName: typeof ChainName;
+type checkout_d_ChainSlug = ChainSlug;
+declare const checkout_d_ChainSlug: typeof ChainSlug;
 type checkout_d_CheckConnectionParams = CheckConnectionParams;
 type checkout_d_CheckConnectionResult = CheckConnectionResult;
 type checkout_d_Checkout = Checkout;
@@ -19003,6 +19048,7 @@ type checkout_d_GetNetworkAllowListResult = GetNetworkAllowListResult;
 type checkout_d_GetNetworkParams = GetNetworkParams;
 type checkout_d_GetTokenAllowListParams = GetTokenAllowListParams;
 type checkout_d_GetTokenAllowListResult = GetTokenAllowListResult;
+type checkout_d_GetTokenInfoParams = GetTokenInfoParams;
 type checkout_d_GetWalletAllowListParams = GetWalletAllowListParams;
 type checkout_d_GetWalletAllowListResult = GetWalletAllowListResult;
 declare const checkout_d_IMMUTABLE_API_BASE_URL: typeof IMMUTABLE_API_BASE_URL;
@@ -19136,6 +19182,7 @@ declare namespace checkout_d {
     checkout_d_CancelResultSuccess as CancelResultSuccess,
     checkout_d_ChainId as ChainId,
     checkout_d_ChainName as ChainName,
+    checkout_d_ChainSlug as ChainSlug,
     checkout_d_CheckConnectionParams as CheckConnectionParams,
     checkout_d_CheckConnectionResult as CheckConnectionResult,
     checkout_d_Checkout as Checkout,
@@ -19189,6 +19236,7 @@ declare namespace checkout_d {
     checkout_d_GetNetworkParams as GetNetworkParams,
     checkout_d_GetTokenAllowListParams as GetTokenAllowListParams,
     checkout_d_GetTokenAllowListResult as GetTokenAllowListResult,
+    checkout_d_GetTokenInfoParams as GetTokenInfoParams,
     checkout_d_GetWalletAllowListParams as GetWalletAllowListParams,
     checkout_d_GetWalletAllowListResult as GetWalletAllowListResult,
     checkout_d_IMMUTABLE_API_BASE_URL as IMMUTABLE_API_BASE_URL,