@imtbl/sdk 0.36.3 → 0.36.4

package/dist/index.cjs

@@ -4256,7 +4256,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.4' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -4316,7 +4316,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.4',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4755,7 +4755,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.3',
+    sdkVersion: 'ts-immutable-sdk-0.36.4',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -34698,12 +34698,12 @@ var ChainId;
 })(ChainId || (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.
  */
 var ChainName;
 (function (ChainName) {
@@ -34713,6 +34713,23 @@ var ChainName;
     ChainName["IMTBL_ZKEVM_DEVNET"] = "Immutable zkEVM Dev";
     ChainName["IMTBL_ZKEVM_MAINNET"] = "Immutable zkEVM";
 })(ChainName || (ChainName = {}));
+/**
+ * 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.
+ */
+var ChainSlug;
+(function (ChainSlug) {
+    ChainSlug["ETHEREUM"] = "ethereum";
+    ChainSlug["SEPOLIA"] = "sepolia";
+    ChainSlug["IMTBL_ZKEVM_MAINNET"] = "imtbl-zkevm-mainnet";
+    ChainSlug["IMTBL_ZKEVM_TESTNET"] = "imtbl-zkevm-testnet";
+    ChainSlug["IMTBL_ZKEVM_DEVNET"] = "imtbl-zkevm-devnet";
+})(ChainSlug || (ChainSlug = {}));
 
 var OnRampProvider;
 (function (OnRampProvider) {
@@ -34877,6 +34894,7 @@ var CheckoutErrorType;
     CheckoutErrorType["CONNECT_PROVIDER_ERROR"] = "CONNECT_PROVIDER_ERROR";
     CheckoutErrorType["GET_BALANCE_ERROR"] = "GET_BALANCE_ERROR";
     CheckoutErrorType["GET_INDEXER_BALANCE_ERROR"] = "GET_INDEXER_BALANCE_ERROR";
+    CheckoutErrorType["GET_ERC20_INFO_ERROR"] = "GET_ERC20_INFO_ERROR";
     CheckoutErrorType["GET_ERC20_BALANCE_ERROR"] = "GET_ERC20_BALANCE_ERROR";
     CheckoutErrorType["GET_ERC721_BALANCE_ERROR"] = "GET_ERC721_BALANCE_ERROR";
     CheckoutErrorType["GET_NETWORK_INFO_ERROR"] = "GET_NETWORK_INFO_ERROR";
@@ -35444,7 +35462,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.36.3';
+const SDK_VERSION_MARKER = '0.36.4';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -35605,6 +35623,22 @@ const getTokenAllowList = async (config, { type = TokenFilterTypes.ALL, chainId,
     };
 };
 const isNativeToken = (address) => !address || address.toLocaleLowerCase() === NATIVE;
+async function getERC20TokenInfo(web3Provider, tokenAddress) {
+    return await withCheckoutError(async () => {
+        const contract = new ethers.Contract(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
+        const [name, symbol, decimals] = await Promise.all([
+            contract.name(),
+            contract.symbol(),
+            contract.decimals(),
+        ]);
+        return {
+            name,
+            symbol,
+            decimals,
+            address: tokenAddress,
+        };
+    }, { type: CheckoutErrorType.GET_ERC20_INFO_ERROR });
+}
 
 const CACHE_DATA_TTL = 60; // seconds
 /**
@@ -35775,20 +35809,18 @@ async function getERC20Balance(web3Provider, walletAddress, tokenAddress) {
     return await withCheckoutError(async () => {
         const contract = new ethers.Contract(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
         return Promise.all([
-            contract.name(),
-            contract.symbol(),
+            getERC20TokenInfo(web3Provider, tokenAddress),
             contract.balanceOf(walletAddress),
-            contract.decimals(),
         ])
-            .then(([name, symbol, balance, decimals]) => {
-            const formattedBalance = ethers.utils.formatUnits(balance, decimals);
+            .then(([tokenInfo, balance]) => {
+            const formattedBalance = ethers.utils.formatUnits(balance, tokenInfo.decimals);
             return {
                 balance,
                 formattedBalance,
                 token: {
-                    name,
-                    symbol,
-                    decimals,
+                    name: tokenInfo.name,
+                    symbol: tokenInfo.symbol,
+                    decimals: tokenInfo.decimals,
                     address: tokenAddress,
                 },
             };
@@ -35888,6 +35920,9 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
     const allBalancePromises = [];
     tokens
         .forEach((token) => {
+        // For some reason isNativeToken always returns undefined.
+        // We have spent way too much time figuring out why this is happening.
+        // That we have given up -- keep it as it is for now.
         if (!token.address || token.address.toLocaleLowerCase() === NATIVE) {
             allBalancePromises.push(getBalance(config, web3Provider, walletAddress));
         }
@@ -35896,13 +35931,25 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
         }
     });
     const balanceResults = await Promise.allSettled(allBalancePromises);
-    const balances = balanceResults.filter((result) => result.status === 'fulfilled').map((result) => result.value);
+    const balances = balanceResults.filter((result) => result.status === 'fulfilled').map((result) => {
+        const resp = result;
+        const { token } = resp.value;
+        // For some reason isNativeToken always returns undefined.
+        // We have spent way too much time figuring out why this is happening.
+        // That we have given up -- keep it as it is for now.
+        if (!token.address || token.address.toLocaleLowerCase() === NATIVE)
+            resp.value.token.address = NATIVE;
+        return resp.value;
+    });
     return { balances };
 };
 const getAllBalances = async (config, web3Provider, walletAddress, chainId) => {
     if (!walletAddress && !web3Provider) {
         throw new CheckoutError('both walletAddress and provider are missing. At least one must be provided.', CheckoutErrorType.MISSING_PARAMS);
     }
+    if (!config.networkMap.get(chainId)) {
+        throw new CheckoutError(`chain ID ${chainId} not supported by the environment`, CheckoutErrorType.CHAIN_NOT_SUPPORTED_ERROR);
+    }
     const { tokens } = await getTokenAllowList(config, {
         type: TokenFilterTypes.ALL,
         chainId,
@@ -37484,11 +37531,11 @@ const getBridgeFeeEstimate = async (config, readOnlyProviders, fromChainId, toCh
 const INDEXER_ETH_ROOT_CONTRACT_ADDRESS = '0x0000000000000000000000000000000000000eee';
 const getIndexerChainName = (chainId) => {
     if (chainId === ChainId.IMTBL_ZKEVM_MAINNET)
-        return 'imtbl-zkevm-mainnet';
+        return ChainSlug.IMTBL_ZKEVM_MAINNET;
     if (chainId === ChainId.IMTBL_ZKEVM_TESTNET)
-        return 'imtbl-zkevm-testnet';
+        return ChainSlug.IMTBL_ZKEVM_TESTNET;
     if (chainId === ChainId.IMTBL_ZKEVM_DEVNET)
-        return 'imtbl-zkevm-devent';
+        return ChainSlug.IMTBL_ZKEVM_DEVNET;
     return '';
 };
 // Indexer ERC20 call does not support IMX so cannot get root chain mapping from this endpoint.
@@ -38934,6 +38981,8 @@ class Checkout {
      */
     async widgets(init) {
         const checkout = this;
+        // Preload the configurations
+        await checkout.config.remote.getConfig();
         const factory = new Promise((resolve, reject) => {
             function checkForWidgetsBundleLoaded() {
                 if (typeof ImmutableCheckoutWidgets !== 'undefined') {
@@ -38949,8 +38998,6 @@ class Checkout {
             try {
                 const script = loadUnresolved(init.version);
                 if (script.loaded && typeof ImmutableCheckoutWidgets !== 'undefined') {
-                    // eslint-disable-next-line no-console
-                    console.warn('Checkout widgets script is already loaded');
                     resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
                 }
                 else {
@@ -39004,6 +39051,15 @@ class Checkout {
         const switchNetworkRes = await switchWalletNetwork(this.config, web3Provider, params.chainId);
         return switchNetworkRes;
     }
+    /**
+     * 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.
+     */
+    async getTokenInfo(params) {
+        return await getERC20TokenInfo(params.provider, params.tokenAddress);
+    }
     /**
      * Retrieves the balance of a wallet address.
      * @param {GetBalanceParams} params - The parameters for retrieving the balance.
@@ -39188,6 +39244,7 @@ var checkout = /*#__PURE__*/Object.freeze({
     get BridgeEventType () { return BridgeEventType; },
     get ChainId () { return ChainId; },
     get ChainName () { return ChainName; },
+    get ChainSlug () { return ChainSlug; },
     Checkout: Checkout,
     CheckoutConfiguration: CheckoutConfiguration,
     get CheckoutErrorType () { return CheckoutErrorType; },

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} publishableApiKey
+ */
+type TelemetryConfig = {
+    publishableApiKey: 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,

package/dist/index.js

@@ -4234,7 +4234,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.3' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.4' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -4294,7 +4294,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.3',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.4',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4733,7 +4733,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.3',
+    sdkVersion: 'ts-immutable-sdk-0.36.4',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -34676,12 +34676,12 @@ var ChainId;
 })(ChainId || (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.
  */
 var ChainName;
 (function (ChainName) {
@@ -34691,6 +34691,23 @@ var ChainName;
     ChainName["IMTBL_ZKEVM_DEVNET"] = "Immutable zkEVM Dev";
     ChainName["IMTBL_ZKEVM_MAINNET"] = "Immutable zkEVM";
 })(ChainName || (ChainName = {}));
+/**
+ * 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.
+ */
+var ChainSlug;
+(function (ChainSlug) {
+    ChainSlug["ETHEREUM"] = "ethereum";
+    ChainSlug["SEPOLIA"] = "sepolia";
+    ChainSlug["IMTBL_ZKEVM_MAINNET"] = "imtbl-zkevm-mainnet";
+    ChainSlug["IMTBL_ZKEVM_TESTNET"] = "imtbl-zkevm-testnet";
+    ChainSlug["IMTBL_ZKEVM_DEVNET"] = "imtbl-zkevm-devnet";
+})(ChainSlug || (ChainSlug = {}));
 
 var OnRampProvider;
 (function (OnRampProvider) {
@@ -34855,6 +34872,7 @@ var CheckoutErrorType;
     CheckoutErrorType["CONNECT_PROVIDER_ERROR"] = "CONNECT_PROVIDER_ERROR";
     CheckoutErrorType["GET_BALANCE_ERROR"] = "GET_BALANCE_ERROR";
     CheckoutErrorType["GET_INDEXER_BALANCE_ERROR"] = "GET_INDEXER_BALANCE_ERROR";
+    CheckoutErrorType["GET_ERC20_INFO_ERROR"] = "GET_ERC20_INFO_ERROR";
     CheckoutErrorType["GET_ERC20_BALANCE_ERROR"] = "GET_ERC20_BALANCE_ERROR";
     CheckoutErrorType["GET_ERC721_BALANCE_ERROR"] = "GET_ERC721_BALANCE_ERROR";
     CheckoutErrorType["GET_NETWORK_INFO_ERROR"] = "GET_NETWORK_INFO_ERROR";
@@ -35422,7 +35440,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.36.3';
+const SDK_VERSION_MARKER = '0.36.4';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -35583,6 +35601,22 @@ const getTokenAllowList = async (config, { type = TokenFilterTypes.ALL, chainId,
     };
 };
 const isNativeToken = (address) => !address || address.toLocaleLowerCase() === NATIVE;
+async function getERC20TokenInfo(web3Provider, tokenAddress) {
+    return await withCheckoutError(async () => {
+        const contract = new Contract$1(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
+        const [name, symbol, decimals] = await Promise.all([
+            contract.name(),
+            contract.symbol(),
+            contract.decimals(),
+        ]);
+        return {
+            name,
+            symbol,
+            decimals,
+            address: tokenAddress,
+        };
+    }, { type: CheckoutErrorType.GET_ERC20_INFO_ERROR });
+}
 
 const CACHE_DATA_TTL = 60; // seconds
 /**
@@ -35753,20 +35787,18 @@ async function getERC20Balance(web3Provider, walletAddress, tokenAddress) {
     return await withCheckoutError(async () => {
         const contract = new Contract$1(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
         return Promise.all([
-            contract.name(),
-            contract.symbol(),
+            getERC20TokenInfo(web3Provider, tokenAddress),
             contract.balanceOf(walletAddress),
-            contract.decimals(),
         ])
-            .then(([name, symbol, balance, decimals]) => {
-            const formattedBalance = utils$2.formatUnits(balance, decimals);
+            .then(([tokenInfo, balance]) => {
+            const formattedBalance = utils$2.formatUnits(balance, tokenInfo.decimals);
             return {
                 balance,
                 formattedBalance,
                 token: {
-                    name,
-                    symbol,
-                    decimals,
+                    name: tokenInfo.name,
+                    symbol: tokenInfo.symbol,
+                    decimals: tokenInfo.decimals,
                     address: tokenAddress,
                 },
             };
@@ -35866,6 +35898,9 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
     const allBalancePromises = [];
     tokens
         .forEach((token) => {
+        // For some reason isNativeToken always returns undefined.
+        // We have spent way too much time figuring out why this is happening.
+        // That we have given up -- keep it as it is for now.
         if (!token.address || token.address.toLocaleLowerCase() === NATIVE) {
             allBalancePromises.push(getBalance(config, web3Provider, walletAddress));
         }
@@ -35874,13 +35909,25 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
         }
     });
     const balanceResults = await Promise.allSettled(allBalancePromises);
-    const balances = balanceResults.filter((result) => result.status === 'fulfilled').map((result) => result.value);
+    const balances = balanceResults.filter((result) => result.status === 'fulfilled').map((result) => {
+        const resp = result;
+        const { token } = resp.value;
+        // For some reason isNativeToken always returns undefined.
+        // We have spent way too much time figuring out why this is happening.
+        // That we have given up -- keep it as it is for now.
+        if (!token.address || token.address.toLocaleLowerCase() === NATIVE)
+            resp.value.token.address = NATIVE;
+        return resp.value;
+    });
     return { balances };
 };
 const getAllBalances = async (config, web3Provider, walletAddress, chainId) => {
     if (!walletAddress && !web3Provider) {
         throw new CheckoutError('both walletAddress and provider are missing. At least one must be provided.', CheckoutErrorType.MISSING_PARAMS);
     }
+    if (!config.networkMap.get(chainId)) {
+        throw new CheckoutError(`chain ID ${chainId} not supported by the environment`, CheckoutErrorType.CHAIN_NOT_SUPPORTED_ERROR);
+    }
     const { tokens } = await getTokenAllowList(config, {
         type: TokenFilterTypes.ALL,
         chainId,
@@ -37462,11 +37509,11 @@ const getBridgeFeeEstimate = async (config, readOnlyProviders, fromChainId, toCh
 const INDEXER_ETH_ROOT_CONTRACT_ADDRESS = '0x0000000000000000000000000000000000000eee';
 const getIndexerChainName = (chainId) => {
     if (chainId === ChainId.IMTBL_ZKEVM_MAINNET)
-        return 'imtbl-zkevm-mainnet';
+        return ChainSlug.IMTBL_ZKEVM_MAINNET;
     if (chainId === ChainId.IMTBL_ZKEVM_TESTNET)
-        return 'imtbl-zkevm-testnet';
+        return ChainSlug.IMTBL_ZKEVM_TESTNET;
     if (chainId === ChainId.IMTBL_ZKEVM_DEVNET)
-        return 'imtbl-zkevm-devent';
+        return ChainSlug.IMTBL_ZKEVM_DEVNET;
     return '';
 };
 // Indexer ERC20 call does not support IMX so cannot get root chain mapping from this endpoint.
@@ -38912,6 +38959,8 @@ class Checkout {
      */
     async widgets(init) {
         const checkout = this;
+        // Preload the configurations
+        await checkout.config.remote.getConfig();
         const factory = new Promise((resolve, reject) => {
             function checkForWidgetsBundleLoaded() {
                 if (typeof ImmutableCheckoutWidgets !== 'undefined') {
@@ -38927,8 +38976,6 @@ class Checkout {
             try {
                 const script = loadUnresolved(init.version);
                 if (script.loaded && typeof ImmutableCheckoutWidgets !== 'undefined') {
-                    // eslint-disable-next-line no-console
-                    console.warn('Checkout widgets script is already loaded');
                     resolve(new ImmutableCheckoutWidgets.WidgetsFactory(checkout, init.config));
                 }
                 else {
@@ -38982,6 +39029,15 @@ class Checkout {
         const switchNetworkRes = await switchWalletNetwork(this.config, web3Provider, params.chainId);
         return switchNetworkRes;
     }
+    /**
+     * 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.
+     */
+    async getTokenInfo(params) {
+        return await getERC20TokenInfo(params.provider, params.tokenAddress);
+    }
     /**
      * Retrieves the balance of a wallet address.
      * @param {GetBalanceParams} params - The parameters for retrieving the balance.
@@ -39166,6 +39222,7 @@ var checkout = /*#__PURE__*/Object.freeze({
     get BridgeEventType () { return BridgeEventType; },
     get ChainId () { return ChainId; },
     get ChainName () { return ChainName; },
+    get ChainSlug () { return ChainSlug; },
     Checkout: Checkout,
     CheckoutConfiguration: CheckoutConfiguration,
     get CheckoutErrorType () { return CheckoutErrorType; },

package/dist/passport.js

@@ -2349,7 +2349,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.36.3' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.36.4' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2405,7 +2405,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.3',
+    sdkVersion: 'ts-immutable-sdk-0.36.4',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.36.3",
+  "version": "0.36.4",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",