@imtbl/sdk 0.36.2 → 0.36.4

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}.
@@ -10700,13 +10725,13 @@ interface GetBalanceResult {
 }
 /**
  * Interface representing the parameters for {@link Checkout.getAllBalances}.
- * @property {Web3Provider} provider - The provider used to get the balances.
- * @property {string} walletAddress - The wallet address.
+ * @property {Web3Provider} provider - The provider used to get the balances, it is a required parameter if no walletAddress is provided.
+ * @property {string} walletAddress - The wallet address, it is a required parameter if no provider is provided.
  * @property {ChainId} chainId - The ID of the network.
  */
 interface GetAllBalancesParams {
-    provider: Web3Provider;
-    walletAddress: string;
+    provider?: Web3Provider;
+    walletAddress?: string;
     chainId: ChainId;
 }
 /**
@@ -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} publishableApiKey
+ */
+type TelemetryConfig = {
+    publishableApiKey: 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.
@@ -12929,12 +12971,14 @@ declare const IMMUTABLE_API_BASE_URL: {
  * Enum representing different types of errors that can occur during the checkout process.
  */
 declare enum CheckoutErrorType {
+    MISSING_PARAMS = "MISSING_PARAMS",
     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_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",
@@ -12984,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 };

package/dist/checkout.js

@@ -12519,59 +12519,18 @@ function parseUnits(value, unitName) {
     return parseFixed(value, (unitName != null) ? unitName : 18);
 }
 
-/**
- * @typedef {Object} CompletionStatus
- * @property {string} SUCCESS - The transaction has been successfully synced.
- * @property {string} PENDING - The transaction is still pending.
- * @property {string} FAILED - The transaction has failed.
- */
-var CompletionStatus;
-(function (CompletionStatus) {
-    CompletionStatus["SUCCESS"] = "SUCCESS";
-    CompletionStatus["PENDING"] = "PENDING";
-    CompletionStatus["FAILED"] = "FAILED";
-})(CompletionStatus || (CompletionStatus = {}));
-/**
- * @typedef {Object} BridgeFeeActions
- * @property {string} DEPOSIT - The transaction has been successfully synced.
- * @property {string} WITHDRAW - The transaction is still pending.
- * @property {string} FINALISE_WITHDRAWAL - Calculate gas .
- */
-var BridgeFeeActions;
-(function (BridgeFeeActions) {
-    BridgeFeeActions["DEPOSIT"] = "DEPOSIT";
-    BridgeFeeActions["WITHDRAW"] = "WITHDRAW";
-    BridgeFeeActions["FINALISE_WITHDRAWAL"] = "FINALISE_WITHDRAWAL";
-})(BridgeFeeActions || (BridgeFeeActions = {}));
-/**
- * @typedef {Object} BridgeMethodGas
- * @property {string} DEPOSIT_SOURCE - The gas required to deposit to the bridge.
- * @property {string} DEPOSIT_DESTINATION - The gas required to process the deposit on the destination chain.
- * @property {string} WITHDRAW_SOURCE - The gas required to withdraw from the bridge.
- * @property {string} WITHDRAW_DESTINATION - The gas required to process the withdrawal on the destination chain.
- * @property {string} FINALISE_WITHDRAWAL - The gas required to finalise a withdrawal from the flow rate queue.
- */
-var BridgeMethodsGasLimit;
-(function (BridgeMethodsGasLimit) {
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["DEPOSIT_SOURCE"] = 500000] = "DEPOSIT_SOURCE";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["DEPOSIT_DESTINATION"] = 700000] = "DEPOSIT_DESTINATION";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["WITHDRAW_SOURCE"] = 400000] = "WITHDRAW_SOURCE";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["WITHDRAW_DESTINATION"] = 700000] = "WITHDRAW_DESTINATION";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_SOURCE"] = 300000] = "MAP_TOKEN_SOURCE";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_DESTINATION"] = 700000] = "MAP_TOKEN_DESTINATION";
-    BridgeMethodsGasLimit[BridgeMethodsGasLimit["FINALISE_WITHDRAWAL"] = 200000] = "FINALISE_WITHDRAWAL";
-})(BridgeMethodsGasLimit || (BridgeMethodsGasLimit = {}));
-var StatusResponse;
-(function (StatusResponse) {
-    StatusResponse["PROCESSING"] = "PROCESSING";
-    StatusResponse["COMPLETE"] = "COMPLETE";
-    StatusResponse["RETRY"] = "RETRY";
-    StatusResponse["ERROR"] = "ERROR";
-    StatusResponse["NOT_ENOUGH_GAS"] = "NOT_ENOUGH_GAS";
-    StatusResponse["FLOW_RATE_CONTROLLED"] = "FLOW_RATE_CONTROLLED";
-})(StatusResponse || (StatusResponse = {}));
-
 const ROOT_ERC20_BRIDGE_FLOW_RATE = [
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: '_initializerAddress',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'constructor',
+    },
     {
         inputs: [],
         name: 'AlreadyMapped',
@@ -12722,6 +12681,16 @@ const ROOT_ERC20_BRIDGE_FLOW_RATE = [
         name: 'TokenIsZero',
         type: 'error',
     },
+    {
+        inputs: [],
+        name: 'TokenNotSupported',
+        type: 'error',
+    },
+    {
+        inputs: [],
+        name: 'UnauthorizedInitializer',
+        type: 'error',
+    },
     {
         inputs: [
             {
@@ -14145,6 +14114,19 @@ const ROOT_ERC20_BRIDGE_FLOW_RATE = [
         stateMutability: 'pure',
         type: 'function',
     },
+    {
+        inputs: [],
+        name: 'initializerAddress',
+        outputs: [
+            {
+                internalType: 'address',
+                name: '',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
     {
         inputs: [
             {
@@ -14841,6 +14823,17 @@ const withBridgeError = async (fn, customErrorType, details) => {
 };
 
 const CHILD_ERC20_BRIDGE = [
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: '_initializerAddress',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'nonpayable',
+        type: 'constructor',
+    },
     {
         inputs: [],
         name: 'AlreadyMapped',
@@ -14943,6 +14936,11 @@ const CHILD_ERC20_BRIDGE = [
         name: 'TransferWIMXFailed',
         type: 'error',
     },
+    {
+        inputs: [],
+        name: 'UnauthorizedInitializer',
+        type: 'error',
+    },
     {
         inputs: [],
         name: 'ZeroAddress',
@@ -15697,6 +15695,19 @@ const CHILD_ERC20_BRIDGE = [
         stateMutability: 'nonpayable',
         type: 'function',
     },
+    {
+        inputs: [],
+        name: 'initializerAddress',
+        outputs: [
+            {
+                internalType: 'address',
+                name: '',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
     {
         inputs: [
             {
@@ -16046,6 +16057,58 @@ const getGasPriceInWei$1 = (feeData) => {
     return null;
 };
 
+/**
+ * @typedef {Object} CompletionStatus
+ * @property {string} SUCCESS - The transaction has been successfully synced.
+ * @property {string} PENDING - The transaction is still pending.
+ * @property {string} FAILED - The transaction has failed.
+ */
+var CompletionStatus;
+(function (CompletionStatus) {
+    CompletionStatus["SUCCESS"] = "SUCCESS";
+    CompletionStatus["PENDING"] = "PENDING";
+    CompletionStatus["FAILED"] = "FAILED";
+})(CompletionStatus || (CompletionStatus = {}));
+/**
+ * @typedef {Object} BridgeFeeActions
+ * @property {string} DEPOSIT - The transaction has been successfully synced.
+ * @property {string} WITHDRAW - The transaction is still pending.
+ * @property {string} FINALISE_WITHDRAWAL - Calculate gas .
+ */
+var BridgeFeeActions;
+(function (BridgeFeeActions) {
+    BridgeFeeActions["DEPOSIT"] = "DEPOSIT";
+    BridgeFeeActions["WITHDRAW"] = "WITHDRAW";
+    BridgeFeeActions["FINALISE_WITHDRAWAL"] = "FINALISE_WITHDRAWAL";
+})(BridgeFeeActions || (BridgeFeeActions = {}));
+/**
+ * @typedef {Object} BridgeMethodGas
+ * @property {string} DEPOSIT_SOURCE - The gas required to deposit to the bridge.
+ * @property {string} DEPOSIT_DESTINATION - The gas required to process the deposit on the destination chain.
+ * @property {string} WITHDRAW_SOURCE - The gas required to withdraw from the bridge.
+ * @property {string} WITHDRAW_DESTINATION - The gas required to process the withdrawal on the destination chain.
+ * @property {string} FINALISE_WITHDRAWAL - The gas required to finalise a withdrawal from the flow rate queue.
+ */
+var BridgeMethodsGasLimit;
+(function (BridgeMethodsGasLimit) {
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["DEPOSIT_SOURCE"] = 500000] = "DEPOSIT_SOURCE";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["DEPOSIT_DESTINATION"] = 700000] = "DEPOSIT_DESTINATION";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["WITHDRAW_SOURCE"] = 400000] = "WITHDRAW_SOURCE";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["WITHDRAW_DESTINATION"] = 700000] = "WITHDRAW_DESTINATION";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_SOURCE"] = 300000] = "MAP_TOKEN_SOURCE";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_DESTINATION"] = 700000] = "MAP_TOKEN_DESTINATION";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["FINALISE_WITHDRAWAL"] = 200000] = "FINALISE_WITHDRAWAL";
+})(BridgeMethodsGasLimit || (BridgeMethodsGasLimit = {}));
+var StatusResponse;
+(function (StatusResponse) {
+    StatusResponse["PROCESSING"] = "PROCESSING";
+    StatusResponse["COMPLETE"] = "COMPLETE";
+    StatusResponse["RETRY"] = "RETRY";
+    StatusResponse["ERROR"] = "ERROR";
+    StatusResponse["NOT_ENOUGH_GAS"] = "NOT_ENOUGH_GAS";
+    StatusResponse["FLOW_RATE_CONTROLLED"] = "FLOW_RATE_CONTROLLED";
+})(StatusResponse || (StatusResponse = {}));
+
 /* eslint-disable class-methods-use-this */
 /**
  * Represents a token bridge, which manages asset transfers between two chains.
@@ -16666,8 +16729,8 @@ const CONTRACTS_FOR_BRIDGE = new Map()
     wrappedIMX: '0x0',
 })
     .set(ETH_SEPOLIA_TO_ZKEVM_TESTNET, {
-    rootERC20BridgeFlowRate: '0x8d4528775a4406Def316DC2b450eE539750F8FAA',
-    childERC20Bridge: '0xb0f971e2d11A4D410148af51b170D64E725c0bB9',
+    rootERC20BridgeFlowRate: '0x0D3C59c779Fd552C27b23F723E80246c840100F5',
+    childERC20Bridge: '0x0D3C59c779Fd552C27b23F723E80246c840100F5',
     wrappedIMX: '0xa86C6C6d3D51c0592BE85dA05A9b06B62360D56E',
 })
     .set(ETH_MAINNET_TO_ZKEVM_MAINNET, {
@@ -25770,7 +25833,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.4',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -26330,12 +26393,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) {
@@ -26345,6 +26408,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) {
@@ -26502,12 +26582,14 @@ var ExchangeType;
  */
 var CheckoutErrorType;
 (function (CheckoutErrorType) {
+    CheckoutErrorType["MISSING_PARAMS"] = "MISSING_PARAMS";
     CheckoutErrorType["WEB3_PROVIDER_ERROR"] = "WEB3_PROVIDER_ERROR";
     CheckoutErrorType["PROVIDER_ERROR"] = "PROVIDER_ERROR";
     CheckoutErrorType["DEFAULT_PROVIDER_ERROR"] = "DEFAULT_PROVIDER_ERROR";
     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";
@@ -26863,7 +26945,7 @@ const BLOCKSCOUT_CHAIN_URL_MAP = {
         nativeToken: SANDBOX_CHAIN_ID_NETWORK_MAP.get(ChainId.IMTBL_ZKEVM_TESTNET).nativeCurrency,
     },
     [ChainId.IMTBL_ZKEVM_MAINNET]: {
-        url: 'https://explorer.mainnet.immutable.com',
+        url: 'https://explorer.immutable.com',
         nativeToken: PRODUCTION_CHAIN_ID_NETWORK_MAP.get(ChainId.IMTBL_ZKEVM_MAINNET).nativeCurrency,
     },
     [ChainId.SEPOLIA]: {
@@ -27075,7 +27157,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.36.2';
+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;
 
@@ -27236,6 +27318,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
 /**
@@ -27406,20 +27504,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$1.formatUnits(balance, decimals);
+            .then(([tokenInfo, balance]) => {
+            const formattedBalance = utils$1.formatUnits(balance, tokenInfo.decimals);
             return {
                 balance,
                 formattedBalance,
                 token: {
-                    name,
-                    symbol,
-                    decimals,
+                    name: tokenInfo.name,
+                    symbol: tokenInfo.symbol,
+                    decimals: tokenInfo.decimals,
                     address: tokenAddress,
                 },
             };
@@ -27519,6 +27615,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));
         }
@@ -27527,12 +27626,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) => {
-    // eslint-disable-next-line no-param-reassign
-    chainId ||= await web3Provider.getSigner().getChainId();
+    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,
@@ -27548,6 +27660,7 @@ const getAllBalances = async (config, web3Provider, walletAddress, chainId) => {
         // eslint-disable-next-line no-console
         console.error(err);
     }
+    let address = walletAddress;
     if (flag && Blockscout.isChainSupported(chainId)) {
         // This is a hack because the widgets are still using the tokens symbol
         // to drive the conversions. If we remove all the token symbols from e.g. zkevm
@@ -27555,12 +27668,18 @@ const getAllBalances = async (config, web3Provider, walletAddress, chainId) => {
         // Please remove this hack once https://immutable.atlassian.net/browse/WT-1710
         // is done.
         const isL1Chain = getL1ChainId(config) === chainId;
-        return await measureAsyncExecution(config, `Time to fetch balances using blockscout for ${chainId}`, getIndexerBalance(walletAddress, chainId, isL1Chain ? tokens : undefined));
+        if (!address)
+            address = await web3Provider?.getSigner().getAddress();
+        return await measureAsyncExecution(config, `Time to fetch balances using blockscout for ${chainId}`, getIndexerBalance(address, chainId, isL1Chain ? tokens : undefined));
+    }
+    if (!web3Provider) {
+        throw new CheckoutError('indexer is disabled for this chain, you must provide a provider.', CheckoutErrorType.MISSING_PARAMS);
     }
     // This fallback to use ERC20s calls which is a best effort solution
     // Fails in fetching data from the RCP calls might result in some
     // missing data.
-    return await measureAsyncExecution(config, `Time to fetch balances using RPC for ${chainId}`, getBalances(config, web3Provider, walletAddress, tokens));
+    address ||= await web3Provider.getSigner().getAddress();
+    return await measureAsyncExecution(config, `Time to fetch balances using RPC for ${chainId}`, getBalances(config, web3Provider, address, tokens));
 };
 
 async function checkIsWalletConnected(web3Provider) {
@@ -29087,14 +29206,16 @@ const getEthBalance = (balances) => {
 const getBridgeFeeEstimate = async (config, readOnlyProviders, fromChainId, toChainId) => {
     const bridge = createBridgeInstance(fromChainId, toChainId, readOnlyProviders, config);
     try {
-        const fee = await bridge.getFee({
+        const bridgeFeeResponse = await bridge.getFee({
             action: BridgeFeeActions.DEPOSIT,
             gasMultiplier: 1.1,
             sourceChainId: fromChainId.toString(),
             destinationChainId: toChainId.toString(),
         });
-        fee.approvalGas = BigNumber$1.from(0);
-        return fee;
+        return {
+            ...bridgeFeeResponse,
+            approvalGas: BigNumber$1.from(0),
+        };
     }
     catch (err) {
         throw new CheckoutError('Error estimating gas for bridge', CheckoutErrorType.BRIDGE_GAS_ESTIMATE_ERROR, { message: err.message });
@@ -29105,11 +29226,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.
@@ -30555,6 +30676,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') {
@@ -30570,8 +30693,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 {
@@ -30625,6 +30746,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.
@@ -30643,8 +30773,7 @@ class Checkout {
      * @returns {Promise<GetAllBalancesResult>} - A promise that resolves to the result of retrieving the balances.
      */
     async getAllBalances(params) {
-        const web3Provider = await validateProvider(this.config, params.provider);
-        return getAllBalances(this.config, web3Provider, params.walletAddress, params.chainId);
+        return getAllBalances(this.config, params.provider, params.walletAddress, params.chainId);
     }
     /**
      * Retrieves the supported networks based on the provided parameters.
@@ -30805,4 +30934,4 @@ class Checkout {
     }
 }
 
-export { BridgeEventType, ChainId, ChainName, Checkout, CheckoutConfiguration, CheckoutErrorType, CheckoutStatus, ConnectEventType, ConnectTargetLayer, ExchangeType, FundingStepType, GasEstimateType, GasTokenType, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, ItemType, NetworkFilterTypes, OnRampEventType, OrchestrationEventType, ProviderEventType, RoutingOutcomeType, SaleEventType, SwapEventType, TokenFilterTypes, TransactionOrGasType, WalletEventType, WalletFilterTypes, WalletProviderName, WidgetTheme, WidgetType };
+export { BridgeEventType, ChainId, ChainName, ChainSlug, Checkout, CheckoutConfiguration, CheckoutErrorType, CheckoutStatus, ConnectEventType, ConnectTargetLayer, ExchangeType, FundingStepType, GasEstimateType, GasTokenType, IMMUTABLE_API_BASE_URL, IMTBLWidgetEvents, ItemType, NetworkFilterTypes, OnRampEventType, OrchestrationEventType, ProviderEventType, RoutingOutcomeType, SaleEventType, SwapEventType, TokenFilterTypes, TransactionOrGasType, WalletEventType, WalletFilterTypes, WalletProviderName, WidgetTheme, WidgetType };

package/dist/immutablex_client.js

@@ -17,7 +17,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.2',
+    sdkVersion: 'ts-immutable-sdk-0.36.4',
 });
 /**
  * Sets `sdkVersion` at the time of build