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

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.1-alpha.1' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.2-alpha.1' };
 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.1-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.2-alpha.1',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4755,7 +4755,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
@@ -26775,59 +26775,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',
@@ -26978,6 +26937,16 @@ const ROOT_ERC20_BRIDGE_FLOW_RATE = [
         name: 'TokenIsZero',
         type: 'error',
     },
+    {
+        inputs: [],
+        name: 'TokenNotSupported',
+        type: 'error',
+    },
+    {
+        inputs: [],
+        name: 'UnauthorizedInitializer',
+        type: 'error',
+    },
     {
         inputs: [
             {
@@ -28401,6 +28370,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: [
             {
@@ -29097,6 +29079,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',
@@ -29199,6 +29192,11 @@ const CHILD_ERC20_BRIDGE = [
         name: 'TransferWIMXFailed',
         type: 'error',
     },
+    {
+        inputs: [],
+        name: 'UnauthorizedInitializer',
+        type: 'error',
+    },
     {
         inputs: [],
         name: 'ZeroAddress',
@@ -29953,6 +29951,19 @@ const CHILD_ERC20_BRIDGE = [
         stateMutability: 'nonpayable',
         type: 'function',
     },
+    {
+        inputs: [],
+        name: 'initializerAddress',
+        outputs: [
+            {
+                internalType: 'address',
+                name: '',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
     {
         inputs: [
             {
@@ -30302,6 +30313,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.
@@ -30922,8 +30985,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, {
@@ -34807,6 +34870,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";
@@ -35168,7 +35232,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]: {
@@ -35380,7 +35444,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.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;
 
@@ -35707,9 +35771,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 ethers.Contract(contractAddress, JSON.stringify(ERC20ABI), web3Provider);
+        const contract = new ethers.Contract(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
         return Promise.all([
             contract.name(),
             contract.symbol(),
@@ -35725,7 +35789,7 @@ async function getERC20Balance(web3Provider, walletAddress, contractAddress) {
                     name,
                     symbol,
                     decimals,
-                    address: contractAddress,
+                    address: tokenAddress,
                 },
             };
         });
@@ -35836,8 +35900,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,
@@ -35853,6 +35918,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
@@ -35860,12 +35926,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) {
@@ -37392,14 +37464,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 = ethers.BigNumber.from(0);
-        return fee;
+        return {
+            ...bridgeFeeResponse,
+            approvalGas: ethers.BigNumber.from(0),
+        };
     }
     catch (err) {
         throw new CheckoutError('Error estimating gas for bridge', CheckoutErrorType.BRIDGE_GAS_ESTIMATE_ERROR, { message: err.message });
@@ -38937,10 +39011,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.
@@ -38948,8 +39022,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.