@imtbl/sdk 0.44.2 → 0.44.3

package/dist/index.cjs

@@ -10641,7 +10641,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.44.2' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.44.3' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -10713,7 +10713,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.44.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.44.3',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11152,7 +11152,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.44.2',
+    sdkVersion: 'ts-immutable-sdk-0.44.3',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -36448,6 +36448,7 @@ var BridgeMethodsGasLimit;
     BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_SOURCE"] = 200000] = "MAP_TOKEN_SOURCE";
     BridgeMethodsGasLimit[BridgeMethodsGasLimit["MAP_TOKEN_DESTINATION"] = 200000] = "MAP_TOKEN_DESTINATION";
     BridgeMethodsGasLimit[BridgeMethodsGasLimit["FINALISE_WITHDRAWAL"] = 200000] = "FINALISE_WITHDRAWAL";
+    BridgeMethodsGasLimit[BridgeMethodsGasLimit["APPROVE_TOKEN"] = 55000] = "APPROVE_TOKEN";
 })(BridgeMethodsGasLimit || (BridgeMethodsGasLimit = {}));
 var StatusResponse;
 (function (StatusResponse) {
@@ -36635,8 +36636,12 @@ class TokenBridge {
             throw new BridgeError(`Finalised withdrawals must be on the root chain (${this.config.bridgeInstance.rootChainID})`, BridgeErrorType.UNSUPPORTED_ERROR);
         }
         let sourceChainGas = BigNumber.from(0);
+        let approvalFee = BigNumber.from(0);
         let bridgeFee = BigNumber.from(0);
         const imtblFee = BigNumber.from(0);
+        if ('token' in req && req.token !== 'NATIVE') {
+            approvalFee = await this.getGasEstimates(this.config.rootProvider, BridgeMethodsGasLimit.APPROVE_TOKEN);
+        }
         if (req.action === BridgeFeeActions.FINALISE_WITHDRAWAL) {
             sourceChainGas = await this.getGasEstimates(this.config.rootProvider, BridgeMethodsGasLimit.FINALISE_WITHDRAWAL);
         }
@@ -36647,9 +36652,10 @@ class TokenBridge {
             const feeResult = await this.calculateBridgeFee(req.sourceChainId, req.destinationChainId, BridgeMethodsGasLimit[`${req.action}_DESTINATION`], req.gasMultiplier);
             bridgeFee = feeResult.bridgeFee;
         }
-        const totalFees = sourceChainGas.add(bridgeFee).add(imtblFee);
+        const totalFees = sourceChainGas.add(approvalFee).add(bridgeFee).add(imtblFee);
         return {
             sourceChainGas,
+            approvalFee,
             bridgeFee,
             imtblFee,
             totalFees,
@@ -36879,6 +36885,8 @@ class TokenBridge {
             gasMultiplier,
             sourceChainId,
             destinationChainId,
+            token,
+            amount,
         });
         const canReceive = await this.checkReceiver(provider, recipient);
         if (!canReceive) {
@@ -41628,7 +41636,7 @@ async function switchWalletNetwork(config, web3Provider, chainId) {
                 // eslint-disable-next-line @typescript-eslint/no-shadow
             }
             catch (err) {
-                throw new CheckoutError('User cancelled add network request', CheckoutErrorType.USER_REJECTED_REQUEST_ERROR);
+                throw new CheckoutError('User cancelled add network request', CheckoutErrorType.USER_REJECTED_REQUEST_ERROR, { error: err });
             }
         }
         else {
@@ -41992,7 +42000,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.44.2';
+const SDK_VERSION_MARKER = '0.44.3';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -42022,8 +42030,8 @@ class RemoteConfigFetcher {
             try {
                 responseData = JSON.parse(response.data);
             }
-            catch (jsonError) {
-                throw new CheckoutError('Invalid configuration', CheckoutErrorType.API_ERROR);
+            catch (err) {
+                throw new CheckoutError('Invalid configuration', CheckoutErrorType.API_ERROR, { error: err });
             }
         }
         return responseData;
@@ -42036,7 +42044,7 @@ class RemoteConfigFetcher {
             response = await this.httpClient.get(`${this.getEndpoint()}/${this.version}/config`);
         }
         catch (err) {
-            throw new CheckoutError(`Error: ${err.message}`, CheckoutErrorType.API_ERROR);
+            throw new CheckoutError(`Error: ${err.message}`, CheckoutErrorType.API_ERROR, { error: err });
         }
         // Ensure that the configuration is valid
         this.configCache = this.parseResponse(response);
@@ -42050,7 +42058,7 @@ class RemoteConfigFetcher {
             response = await this.httpClient.get(`${this.getEndpoint()}/${this.version}/config/tokens`);
         }
         catch (err) {
-            throw new CheckoutError(`Error: ${err.message}`, CheckoutErrorType.API_ERROR);
+            throw new CheckoutError(`Error: ${err.message}`, CheckoutErrorType.API_ERROR, { error: err });
         }
         // Ensure that the configuration is valid
         this.tokensCache = this.parseResponse(response);
@@ -42413,7 +42421,7 @@ const getIndexerBalance = async (config, walletAddress, chainId, filterTokens) =
             // means we are safe to assume that a 404 is a missing wallet due to inactivity
             // or simply an incorrect wallet address was provided.
             if (err?.code !== globalAxios$1.HttpStatusCode.NotFound) {
-                throw new CheckoutError(err.message || 'InternalServerError | getTokensByWalletAddress', CheckoutErrorType.GET_INDEXER_BALANCE_ERROR, err);
+                throw new CheckoutError(err.message || 'InternalServerError | getTokensByWalletAddress', CheckoutErrorType.GET_INDEXER_BALANCE_ERROR, { error: err });
             }
         }
     };
@@ -42432,7 +42440,7 @@ const getIndexerBalance = async (config, walletAddress, chainId, filterTokens) =
             // means we are safe to assume that a 404 is a missing wallet due to inactivity
             // or simply an incorrect wallet address was provided.
             if (err?.code !== globalAxios$1.HttpStatusCode.NotFound) {
-                throw new CheckoutError(err.message || 'InternalServerError | getNativeTokenByWalletAddress', CheckoutErrorType.GET_INDEXER_BALANCE_ERROR, err);
+                throw new CheckoutError(err.message || 'InternalServerError | getNativeTokenByWalletAddress', CheckoutErrorType.GET_INDEXER_BALANCE_ERROR, { error: err });
             }
         }
     };
@@ -42545,6 +42553,7 @@ async function checkIsWalletConnected(web3Provider) {
     }
     catch (err) {
         throw new CheckoutError('Check wallet connection request failed', CheckoutErrorType.PROVIDER_REQUEST_FAILED_ERROR, {
+            error: err,
             rpcMethod: WalletAction.CHECK_CONNECTION,
         });
     }
@@ -42637,7 +42646,7 @@ async function validateProvider(config, web3Provider, validateProviderOptions) {
             }
         }
         catch (err) {
-            throw new CheckoutError('Unable to detect the web3Provider network', CheckoutErrorType.WEB3_PROVIDER_ERROR);
+            throw new CheckoutError('Unable to detect the web3Provider network', CheckoutErrorType.WEB3_PROVIDER_ERROR, { error: err });
         }
         if (web3ChainId !== underlyingChainId && !options.allowMistmatchedChainId) {
             throw new CheckoutError('Your wallet has changed network, please switch to a supported network', CheckoutErrorType.WEB3_PROVIDER_ERROR);
@@ -42689,15 +42698,15 @@ const sendTransaction = async (web3Provider, transaction) => {
     }
     catch (err) {
         if (err.code === ethers.ethers.errors.INSUFFICIENT_FUNDS) {
-            throw new CheckoutError(err.message, CheckoutErrorType.INSUFFICIENT_FUNDS);
+            throw new CheckoutError(err.message, CheckoutErrorType.INSUFFICIENT_FUNDS, { error: err });
         }
         if (err.code === ethers.ethers.errors.ACTION_REJECTED) {
-            throw new CheckoutError(err.message, CheckoutErrorType.USER_REJECTED_REQUEST_ERROR);
+            throw new CheckoutError(err.message, CheckoutErrorType.USER_REJECTED_REQUEST_ERROR, { error: err });
         }
         if (err.code === ethers.ethers.errors.UNPREDICTABLE_GAS_LIMIT) {
-            throw new CheckoutError(err.message, CheckoutErrorType.UNPREDICTABLE_GAS_LIMIT);
+            throw new CheckoutError(err.message, CheckoutErrorType.UNPREDICTABLE_GAS_LIMIT, { error: err });
         }
-        throw new CheckoutError(err.message, CheckoutErrorType.TRANSACTION_FAILED);
+        throw new CheckoutError(err.message, CheckoutErrorType.TRANSACTION_FAILED, { error: err });
     }
 };
 
@@ -42710,6 +42719,8 @@ async function getBridgeFeeEstimate$1(tokenBridge, fromChainId, toChainId, confi
         gasMultiplier: 1.1,
         sourceChainId: fromChainId.toString(),
         destinationChainId: toChainId.toString(),
+        token: NATIVE.toUpperCase(),
+        amount: ethers.BigNumber.from(0),
     });
 }
 
@@ -42789,6 +42800,7 @@ async function bridgeToL2GasEstimator(readOnlyProviders, config) {
             gasEstimateType: GasEstimateType.BRIDGE_TO_L2,
             fees: {
                 sourceChainGas: ethers.BigNumber.from(0),
+                approvalFee: ethers.BigNumber.from(0),
                 bridgeFee: ethers.BigNumber.from(0),
                 imtblFee: ethers.BigNumber.from(0),
                 totalFees: ethers.BigNumber.from(0),
@@ -42938,7 +42950,7 @@ const getERC20Allowance = async (provider, ownerAddress, contractAddress, spende
         return await contract.allowance(ownerAddress, spenderAddress);
     }
     catch (err) {
-        throw new CheckoutError('Failed to get the allowance for ERC20', CheckoutErrorType.GET_ERC20_ALLOWANCE_ERROR, { contractAddress });
+        throw new CheckoutError('Failed to get the allowance for ERC20', CheckoutErrorType.GET_ERC20_ALLOWANCE_ERROR, { contractAddress, error: err });
     }
 };
 // Returns the approval transaction for the ERC20 that the owner can sign
@@ -42951,8 +42963,8 @@ const getERC20ApprovalTransaction = async (provider, ownerAddress, contractAddre
             approveTransaction.from = ownerAddress;
         return approveTransaction;
     }
-    catch {
-        throw new CheckoutError('Failed to get the approval transaction for ERC20', CheckoutErrorType.GET_ERC20_ALLOWANCE_ERROR, { contractAddress });
+    catch (err) {
+        throw new CheckoutError('Failed to get the approval transaction for ERC20', CheckoutErrorType.GET_ERC20_ALLOWANCE_ERROR, { contractAddress, error: err });
     }
 };
 const hasERC20Allowances = async (provider, ownerAddress, itemRequirements) => {
@@ -43024,7 +43036,12 @@ const getERC721ApprovedForAll = async (provider, ownerAddress, contractAddress,
         return await contract.isApprovedForAll(ownerAddress, spenderAddress);
     }
     catch (err) {
-        throw new CheckoutError('Failed to check approval for all ERC721s of collection', CheckoutErrorType.GET_ERC721_ALLOWANCE_ERROR, { ownerAddress, contractAddress, spenderAddress });
+        throw new CheckoutError('Failed to check approval for all ERC721s of collection', CheckoutErrorType.GET_ERC721_ALLOWANCE_ERROR, {
+            ownerAddress,
+            contractAddress,
+            spenderAddress,
+            error: err,
+        });
     }
 };
 // Returns a populated transaction to approve the ERC721 for the spender.
@@ -43038,7 +43055,11 @@ const getApproveTransaction = async (provider, ownerAddress, contractAddress, sp
     }
     catch (err) {
         throw new CheckoutError('Failed to get the approval transaction for ERC721', CheckoutErrorType.GET_ERC721_ALLOWANCE_ERROR, {
-            id: id.toString(), contractAddress, spenderAddress, ownerAddress,
+            id: id.toString(),
+            contractAddress,
+            spenderAddress,
+            ownerAddress,
+            error: err,
         });
     }
 };
@@ -43050,7 +43071,11 @@ const getERC721ApprovedAddress = async (provider, contractAddress, id) => {
         return await contract.getApproved(id);
     }
     catch (err) {
-        throw new CheckoutError('Failed to get approved address for ERC721', CheckoutErrorType.GET_ERC721_ALLOWANCE_ERROR, { id: id.toString(), contractAddress });
+        throw new CheckoutError('Failed to get approved address for ERC721', CheckoutErrorType.GET_ERC721_ALLOWANCE_ERROR, {
+            id: id.toString(),
+            contractAddress,
+            error: err,
+        });
     }
 };
 const convertIdToNumber = (id, contractAddress) => {
@@ -43378,8 +43403,8 @@ const getTokenBalances = async (config, provider, ownerAddress, itemRequirements
         const { balances } = await getAllBalances(config, provider, ownerAddress, getL2ChainId(config));
         return balances.filter((balance) => tokenMap.get((balance.token.address || NATIVE).toLocaleLowerCase()));
     }
-    catch (error) {
-        throw new CheckoutError('Failed to get balances', CheckoutErrorType.GET_BALANCE_ERROR);
+    catch (err) {
+        throw new CheckoutError('Failed to get balances', CheckoutErrorType.GET_BALANCE_ERROR, { error: err });
     }
 };
 /**
@@ -43417,8 +43442,8 @@ const getERC721Balances = async (provider, ownerAddress, itemRequirements) => {
             });
         });
     }
-    catch (error) {
-        throw new CheckoutError('Failed to get ERC721 balances', CheckoutErrorType.GET_ERC721_BALANCE_ERROR);
+    catch (err) {
+        throw new CheckoutError('Failed to get ERC721 balances', CheckoutErrorType.GET_ERC721_BALANCE_ERROR, { error: err });
     }
     return erc721Balances;
 };
@@ -43488,7 +43513,7 @@ const estimateGas = async (provider, transaction) => {
         return await provider.estimateGas(transaction);
     }
     catch (err) {
-        throw new CheckoutError('Failed to estimate gas for transaction', CheckoutErrorType.UNPREDICTABLE_GAS_LIMIT);
+        throw new CheckoutError('Failed to estimate gas for transaction', CheckoutErrorType.UNPREDICTABLE_GAS_LIMIT, { error: err });
     }
 };
 const getGasItemRequirement = (gas, transactionOrGas) => {
@@ -43552,14 +43577,14 @@ const availabilityService = (isDevelopment, isProduction) => {
         try {
             response = await globalAxios$1.post(`${postEndpoint()}/v1/availability/checkout/swap`);
         }
-        catch (error) {
+        catch (err) {
             // The request was made and the server responded with a status code
             // that falls out of the range of 2xx
-            response = error.response;
+            response = err.response;
             // If 403 then the service is geo-blocked
             if (response.status === 403)
                 return false;
-            throw new CheckoutError(`Error fetching from api: ${response.status} ${response.statusText}`, CheckoutErrorType.API_ERROR);
+            throw new CheckoutError(`Error fetching from api: ${response.status} ${response.statusText}`, CheckoutErrorType.API_ERROR, { error: err });
         }
         return true;
     };
@@ -44070,7 +44095,7 @@ const getBridgeFeeEstimate = async (config, readOnlyProviders, fromChainId, toCh
         };
     }
     catch (err) {
-        throw new CheckoutError('Error estimating gas for bridge', CheckoutErrorType.BRIDGE_GAS_ESTIMATE_ERROR, { message: err.message });
+        throw new CheckoutError('Error estimating gas for bridge', CheckoutErrorType.BRIDGE_GAS_ESTIMATE_ERROR, { error: err });
     }
 };
 
@@ -44720,7 +44745,7 @@ const routingCalculator = async (config, ownerAddress, balanceRequirements, avai
         readOnlyProviders = await createReadOnlyProviders(config);
     }
     catch (err) {
-        throw new CheckoutError('Error occurred while creating read only providers', CheckoutErrorType.PROVIDER_ERROR, { message: err.message });
+        throw new CheckoutError('Error occurred while creating read only providers', CheckoutErrorType.PROVIDER_ERROR, { error: err });
     }
     const tokenBalances = await measureAsyncExecution(config, 'Time to get token balances inside router', getAllTokenBalances(config, readOnlyProviders, ownerAddress, availableRoutingOptions));
     const allowList = await measureAsyncExecution(config, 'Time to get routing allowlist', allowListCheck(config, tokenBalances, availableRoutingOptions));
@@ -44843,9 +44868,7 @@ const signApprovalTransactions = async (provider, approvalTransactions) => {
         receipts = await Promise.all(response.map((transaction) => transaction.transactionResponse.wait()));
     }
     catch (err) {
-        throw new CheckoutError('An error occurred while executing the approval transaction', CheckoutErrorType.EXECUTE_APPROVAL_TRANSACTION_ERROR, {
-            message: err.message,
-        });
+        throw new CheckoutError('An error occurred while executing the approval transaction', CheckoutErrorType.EXECUTE_APPROVAL_TRANSACTION_ERROR, { error: err });
     }
     for (const receipt of receipts) {
         if (receipt.status === 0) {
@@ -44867,9 +44890,7 @@ const signFulfillmentTransactions = async (provider, fulfillmentTransactions) =>
         receipts = await Promise.all(response.map((transaction) => transaction.transactionResponse.wait()));
     }
     catch (err) {
-        throw new CheckoutError('An error occurred while executing the fulfillment transaction', CheckoutErrorType.EXECUTE_FULFILLMENT_TRANSACTION_ERROR, {
-            message: err.message,
-        });
+        throw new CheckoutError('An error occurred while executing the fulfillment transaction', CheckoutErrorType.EXECUTE_FULFILLMENT_TRANSACTION_ERROR, { error: err });
     }
     for (const receipt of receipts) {
         if (receipt.status === 0) {
@@ -44895,9 +44916,7 @@ const signMessage = async (provider, unsignedMessage) => {
         };
     }
     catch (err) {
-        throw new CheckoutError('An error occurred while signing the message', CheckoutErrorType.SIGN_MESSAGE_ERROR, {
-            message: err.message,
-        });
+        throw new CheckoutError('An error occurred while signing the message', CheckoutErrorType.SIGN_MESSAGE_ERROR, { error: err });
     }
 };
 
@@ -45080,8 +45099,8 @@ const buy = async (config, provider, orders, overrides = {
     }
     catch (err) {
         throw new CheckoutError('An error occurred while getting the order listing', CheckoutErrorType.GET_ORDER_LISTING_ERROR, {
+            error: err,
             orderId: id,
-            message: err.message,
         });
     }
     if (order.result.buy.length === 0) {
@@ -45120,7 +45139,7 @@ const buy = async (config, provider, orders, overrides = {
         if (!err.message.includes('The fulfiller does not have the balances needed to fulfill')) {
             throw new CheckoutError('Error occurred while trying to fulfill the order', CheckoutErrorType.FULFILL_ORDER_LISTING_ERROR, {
                 orderId: id,
-                message: err.message,
+                error: err,
             });
         }
     }
@@ -45179,9 +45198,7 @@ const buy = async (config, provider, orders, overrides = {
             }
         }
         catch (err) {
-            throw new CheckoutError('Error fetching fulfillment transaction', CheckoutErrorType.FULFILL_ORDER_LISTING_ERROR, {
-                message: err.message,
-            });
+            throw new CheckoutError('Error fetching fulfillment transaction', CheckoutErrorType.FULFILL_ORDER_LISTING_ERROR, { error: err });
         }
         if (overrides.waitFulfillmentSettlements) {
             const fulfillmentResult = await signFulfillmentTransactions(provider, unsignedFulfillmentTransactions);
@@ -45236,7 +45253,7 @@ const cancel = async (config, provider, orderIds) => {
     catch (err) {
         throw new CheckoutError('An error occurred while cancelling the order listing', CheckoutErrorType.CANCEL_ORDER_LISTING_ERROR, {
             orderId,
-            message: err.message,
+            error: err,
         });
     }
     const result = await signFulfillmentTransactions(provider, [unsignedCancelOrderTransaction]);
@@ -45305,7 +45322,7 @@ const sell = async (config, provider, orders) => {
     }
     catch (err) {
         throw new CheckoutError('An error occurred while preparing the listing', CheckoutErrorType.PREPARE_ORDER_LISTING_ERROR, {
-            message: err.message,
+            error: err,
             id: sellToken.id,
             collectionAddress: sellToken.collectionAddress,
         });
@@ -45361,7 +45378,7 @@ const sell = async (config, provider, orders) => {
         }
         catch (err) {
             throw new CheckoutError('An error occurred while creating the listing', CheckoutErrorType.CREATE_ORDER_LISTING_ERROR, {
-                message: err.message,
+                error: err,
                 collectionId: sellToken.id,
                 collectionAddress: sellToken.collectionAddress,
             });
@@ -45658,7 +45675,7 @@ class Checkout {
                 }
             }
             catch (err) {
-                reject(new CheckoutError('Failed to load widgets script', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR, { message: err.message }));
+                reject(new CheckoutError('Failed to load widgets script', CheckoutErrorType.WIDGETS_SCRIPT_LOAD_ERROR, { error: err }));
             }
         });
         return factory;
@@ -45824,8 +45841,8 @@ class Checkout {
         try {
             itemRequirements = await getItemRequirementsFromRequirements(web3Provider, params.itemRequirements);
         }
-        catch (error) {
-            throw new CheckoutError('Failed to map item requirements', CheckoutErrorType.ITEM_REQUIREMENTS_ERROR);
+        catch (err) {
+            throw new CheckoutError('Failed to map item requirements', CheckoutErrorType.ITEM_REQUIREMENTS_ERROR, { error: err });
         }
         return await smartCheckout(this.config, web3Provider, itemRequirements, params.transactionOrGasAmount);
     }

package/dist/index.d.ts

@@ -18085,17 +18085,20 @@ interface CheckConnectionResult {
  * @typedef {Object} BridgeFeeResponse
  * @property {ethers.BigNumber} sourceChainGas - Gas cost to send tokens to the bridge contract on the source chain.
  * - priced in the source chain's native token.
+ * @property {ethers.BigNumber} approvalFee - Gas cost to approve bridge contract to spend tokens on the source chain.
+ * - priced in the source chain's native token.
  * @property {ethers.BigNumber} bridgeFee - destinationChainGas + validatorFee.
  * This will be added to the tx.value of the bridge transaction and forwarded to the Axelar Gas Service contract.
  * - priced in the source chain's native token.
  * @property {ethers.BigNumber} imtblFee - The fee charged by Immutable to facilitate the bridge.
  * - priced in the source chain's native token.
  * @property {ethers.BigNumber} totalFees - The total fees the user will be charged which is;
- * sourceChainGas + bridgeFee + imtblFee.
+ * sourceChainGas + approvalFee + bridgeFee + imtblFee.
  * - priced in the source chain's native token.
  */
 interface BridgeFeeResponse {
     sourceChainGas: BigNumber;
+    approvalFee: BigNumber;
     bridgeFee: BigNumber;
     imtblFee: BigNumber;
     totalFees: BigNumber;