@imtbl/sdk 0.36.1-alpha.1 → 0.36.2-alpha.1

package/dist/checkout.d.ts

@@ -10680,12 +10680,12 @@ interface TokenInfo {
  * Interface representing the parameters for {@link Checkout.getBalance}.
  * @property {Web3Provider} provider - The provider used to get the balance.
  * @property {string} walletAddress - The wallet address.
- * @property {string | undefined} contractAddress - The contract address of the token.
+ * @property {string | undefined} tokenAddress - The contract address of the token.
  */
 interface GetBalanceParams {
     provider: Web3Provider;
     walletAddress: string;
-    contractAddress?: string;
+    tokenAddress?: string;
 }
 /**
  * Interface representing the result of {@link Checkout.getBalance}.
@@ -10700,13 +10700,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;
 }
 /**
@@ -12354,13 +12354,13 @@ type ConnectWidgetParams = {};
 
 /**
  * Bridge Widget parameters
- * @property {string | undefined} contractAddress
+ * @property {string | undefined} tokenAddress
  * @property {string | undefined} amount
  * @property {WalletProviderName | undefined} walletProviderName
  */
 type BridgeWidgetParams = {
     /** The contract address of the token to bridge from, used to populate the bridge form token field */
-    contractAddress?: string;
+    tokenAddress?: string;
     /** The formatted amount to bridge, used to populate the bridge form amount field */
     amount?: string;
     /** The wallet provider name to use for the bridge widget */
@@ -12379,30 +12379,30 @@ type WalletWidgetParams = {
 /**
  * Swap Widget parameters
  * @property {string | undefined} amount
- * @property {string | undefined} fromContractAddress
- * @property {string | undefined} toContractAddress
+ * @property {string | undefined} fromTokenAddress
+ * @property {string | undefined} toTokenAddress
  * @property {WalletProviderName | undefined} walletProviderName
  */
 type SwapWidgetParams = {
     /** The formatted amount to swap, used to populate the swap from amount field */
     amount?: string;
     /** The contract address of the token to swap from */
-    fromContractAddress?: string;
+    fromTokenAddress?: string;
     /** The contract address of the token to swap to */
-    toContractAddress?: string;
+    toTokenAddress?: string;
     /** The wallet provider name to use for the swap widget */
     walletProviderName?: WalletProviderName;
 };
 
 /**
  * OnRamp Widget parameters
- * @property {string | undefined} contractAddress
+ * @property {string | undefined} tokenAddress
  * @property {string | undefined} amount
  * @property {WalletProviderName | undefined} walletProviderName
  */
 type OnRampWidgetParams = {
     /** The contract address of the token to onramp */
-    contractAddress?: string;
+    tokenAddress?: string;
     /** The formatted amount to onramp, used to populate the onramp form amount field */
     amount?: string;
     /** The wallet provider name to use for the onramp widget */
@@ -12413,7 +12413,7 @@ type OnRampWidgetParams = {
  * Sale Widget parameters
  * @property {string} amount
  * @property {string} environmentId
- * @property {string} fromContractAddress
+ * @property {string} fromTokenAddress
  * @property {SaleItem[]} items
  * @property {WalletProviderName | undefined} walletProviderName
  */
@@ -12421,7 +12421,7 @@ type SaleWidgetParams = {
     /** The total price to pay for the items in the sale */
     amount?: string;
     environmentId?: string;
-    fromContractAddress?: string;
+    fromTokenAddress?: string;
     /** The list of products to be purchased */
     items?: SaleItem[];
     /** The wallet provider name to default to if no web3Provider is passed */
@@ -12929,6 +12929,7 @@ 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",

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.1-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.2-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -26502,6 +26565,7 @@ 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";
@@ -26863,7 +26927,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 +27139,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.36.1-alpha.1';
+const SDK_VERSION_MARKER = '0.36.2-alpha.1';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -27402,9 +27466,9 @@ const getBalance = async (config, web3Provider, walletAddress) => await withChec
         token: networkInfo.nativeCurrency,
     };
 }, { type: CheckoutErrorType.GET_BALANCE_ERROR });
-async function getERC20Balance(web3Provider, walletAddress, contractAddress) {
+async function getERC20Balance(web3Provider, walletAddress, tokenAddress) {
     return await withCheckoutError(async () => {
-        const contract = new Contract$1(contractAddress, JSON.stringify(ERC20ABI), web3Provider);
+        const contract = new Contract$1(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
         return Promise.all([
             contract.name(),
             contract.symbol(),
@@ -27420,7 +27484,7 @@ async function getERC20Balance(web3Provider, walletAddress, contractAddress) {
                     name,
                     symbol,
                     decimals,
-                    address: contractAddress,
+                    address: tokenAddress,
                 },
             };
         });
@@ -27531,8 +27595,9 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
     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);
+    }
     const { tokens } = await getTokenAllowList(config, {
         type: TokenFilterTypes.ALL,
         chainId,
@@ -27548,6 +27613,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 +27621,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 +29159,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 });
@@ -30632,10 +30706,10 @@ class Checkout {
      */
     async getBalance(params) {
         const web3Provider = await validateProvider(this.config, params.provider);
-        if (!params.contractAddress || params.contractAddress === '') {
+        if (!params.tokenAddress || params.tokenAddress === '') {
             return await getBalance(this.config, web3Provider, params.walletAddress);
         }
-        return await getERC20Balance(web3Provider, params.walletAddress, params.contractAddress);
+        return await getERC20Balance(web3Provider, params.walletAddress, params.tokenAddress);
     }
     /**
      * Retrieves the balances of all tokens for a given wallet address on a specific chain.
@@ -30643,8 +30717,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.

package/dist/immutablex_client.js

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