@imtbl/sdk 1.5.1 → 1.5.2

package/dist/checkout.js

@@ -138,7 +138,7 @@ const flattenProperties$1 = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION$1 = '1.5.1';
+const SDK_VERSION$1 = '1.5.2';
 let initialised$1 = false;
 const isInitialised$1 = () => initialised$1;
 const getReferrer$1 = () => {
@@ -17088,7 +17088,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.1';
+const SDK_VERSION = '1.5.2';
 let initialised = false;
 const isInitialised = () => initialised;
 const getReferrer = () => {
@@ -19907,6 +19907,9 @@ const MIN_MAX_HOPS = 1;
 const BASIS_POINT_PRECISION = 10000;
 // 10% maximum secondary fee
 const MAX_SECONDARY_FEE_BASIS_POINTS = 1000;
+// How much more gas does a swap with secondary fees cost?
+// This number is the average difference of a number of different swaps with different hop amounts, etc.
+const AVERAGE_SECONDARY_FEE_EXTRA_GAS = 50876;
 
 const quoteReturnMapping = {
     // eslint-disable-next-line @typescript-eslint/naming-convention
@@ -20327,6 +20330,59 @@ startTokenIn = tokenIn) => {
     return routes;
 };
 
+const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
+const IMMUTABLE_TESTNET_CHAIN_ID = 13473;
+
+const IMMUTABLE_MAINNET_RPC_URL = 'https://rpc.immutable.com';
+const IMMUTABLE_MAINNET_CHAIN_ID = 13371;
+
+const NATIVE_IMX_IMMUTABLE_TESTNET = {
+    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
+    decimals: 18,
+    symbol: 'tIMX',
+    name: 'Immutable Testnet Token',
+    type: 'native',
+};
+const WIMX_IMMUTABLE_TESTNET = {
+    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
+    address: '0x1CcCa691501174B4A623CeDA58cC8f1a76dc3439',
+    decimals: 18,
+    symbol: 'WIMX',
+    name: 'Wrapped Immutable Testnet Token',
+    type: 'erc20',
+};
+const IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS = [
+    WIMX_IMMUTABLE_TESTNET,
+];
+
+const NATIVE_IMX_IMMUTABLE_MAINNET = {
+    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
+    decimals: 18,
+    symbol: 'IMX',
+    name: 'Immutable Token',
+    type: 'native',
+};
+const WIMX_IMMUTABLE_MAINNET = {
+    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
+    address: '0x3a0c2ba54d6cbd3121f01b96dfd20e99d1696c9d',
+    decimals: 18,
+    symbol: 'WIMX',
+    name: 'Wrapped Immutable Token',
+    type: 'erc20',
+};
+const ETH_IMMUTABLE_MAINNET = {
+    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
+    address: '0x52a6c53869ce09a731cd772f245b97a4401d3348',
+    decimals: 18,
+    symbol: 'ETH',
+    name: 'Ethereum',
+    type: 'erc20',
+};
+const IMMUTABLE_MAINNET_COMMON_ROUTING_TOKENS = [
+    WIMX_IMMUTABLE_MAINNET,
+    ETH_IMMUTABLE_MAINNET,
+];
+
 const getFeeData = async (provider) => {
     const [block, maxPriorityFeePerGas] = await Promise.all([
         provider.getBlock('latest'),
@@ -20362,9 +20418,13 @@ const fetchGasPrice = async (provider, nativeToken) => {
  * @param {BigNumber} gasEstimate - The total gas units that will be used for the transaction
  * @returns - The cost of the transaction in the gas token's smallest denomination (e.g. WEI)
  */
-const calculateGasFee = (gasPrice, gasEstimate) => 
-// eslint-disable-next-line implicit-arrow-linebreak
-newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
+const calculateGasFee = (hasSecondaryFees, gasPrice, gasEstimate) => {
+    const baseGasFee = newAmount(gasEstimate.mul(gasPrice.value), gasPrice.token);
+    if (!hasSecondaryFees)
+        return baseGasFee;
+    return newAmount(baseGasFee.value.add(gasPrice.value.mul(AVERAGE_SECONDARY_FEE_EXTRA_GAS)), gasPrice.token);
+    // eslint-disable-next-line implicit-arrow-linebreak
+};
 
 /**
  * Check if the spender needs approval for the token
@@ -20451,7 +20511,7 @@ const getApproval = async (provider, ownerAddress, preparedApproval, gasPrice) =
         return null;
     }
     const gasEstimate = await getApproveGasEstimate(provider, ownerAddress, preparedApproval.spender, preparedApproval.amount.token.address);
-    const gasFeeEstimate = gasPrice ? calculateGasFee(gasPrice, gasEstimate) : null;
+    const gasFeeEstimate = gasPrice ? calculateGasFee(false, gasPrice, gasEstimate) : null;
     return {
         transaction: approveTransaction,
         gasFeeEstimate: gasFeeEstimate ? toPublicAmount(gasFeeEstimate) : null,
@@ -20600,59 +20660,6 @@ const IMX_WRAP_GAS_COST = 45038;
 // to avoid an extra remote call.
 const IMX_UNWRAP_GAS_COST = 35216;
 
-const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
-const IMMUTABLE_TESTNET_CHAIN_ID = 13473;
-
-const IMMUTABLE_MAINNET_RPC_URL = 'https://rpc.immutable.com';
-const IMMUTABLE_MAINNET_CHAIN_ID = 13371;
-
-const NATIVE_IMX_IMMUTABLE_TESTNET = {
-    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
-    decimals: 18,
-    symbol: 'tIMX',
-    name: 'Immutable Testnet Token',
-    type: 'native',
-};
-const WIMX_IMMUTABLE_TESTNET = {
-    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
-    address: '0x1CcCa691501174B4A623CeDA58cC8f1a76dc3439',
-    decimals: 18,
-    symbol: 'WIMX',
-    name: 'Wrapped Immutable Testnet Token',
-    type: 'erc20',
-};
-const IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS = [
-    WIMX_IMMUTABLE_TESTNET,
-];
-
-const NATIVE_IMX_IMMUTABLE_MAINNET = {
-    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
-    decimals: 18,
-    symbol: 'IMX',
-    name: 'Immutable Token',
-    type: 'native',
-};
-const WIMX_IMMUTABLE_MAINNET = {
-    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
-    address: '0x3a0c2ba54d6cbd3121f01b96dfd20e99d1696c9d',
-    decimals: 18,
-    symbol: 'WIMX',
-    name: 'Wrapped Immutable Token',
-    type: 'erc20',
-};
-const ETH_IMMUTABLE_MAINNET = {
-    chainId: IMMUTABLE_MAINNET_CHAIN_ID,
-    address: '0x52a6c53869ce09a731cd772f245b97a4401d3348',
-    decimals: 18,
-    symbol: 'ETH',
-    name: 'Ethereum',
-    type: 'erc20',
-};
-const IMMUTABLE_MAINNET_COMMON_ROUTING_TOKENS = [
-    WIMX_IMMUTABLE_MAINNET,
-    ETH_IMMUTABLE_MAINNET,
-];
-
 const zeroNativeCurrencyValue = '0x00';
 const multicallWithDeadlineFunctionSignature = 'multicall(uint256,bytes[])';
 function buildSinglePoolSwap(tokenIn, tokenOut, recipient, trade, route, amountIn, amountOut, routerContract, paymentsContract) {
@@ -20893,8 +20900,8 @@ const getSwapRecipient = (tokenOut, fromAddress, routerContractAddress, secondar
 function getSwap(tokenIn, tokenOut, adjustedQuote, fromAddress, slippage, deadline, routerContractAddress, secondaryFeesContractAddress, gasPrice, secondaryFees) {
     const swapRecipient = getSwapRecipient(tokenOut, fromAddress, routerContractAddress, secondaryFeesContractAddress, secondaryFees);
     const { calldata, maximumAmountIn } = createSwapParameters(tokenIn, tokenOut, adjustedQuote, swapRecipient, slippage, deadline, secondaryFees);
-    // TODO: Add additional gas fee estimates for secondary fees
-    const gasFeeEstimate = gasPrice ? calculateGasFee(gasPrice, adjustedQuote.gasEstimate) : null;
+    const hasSecondaryFees = secondaryFees.length > 0;
+    const gasFeeEstimate = gasPrice ? calculateGasFee(hasSecondaryFees, gasPrice, adjustedQuote.gasEstimate) : null;
     const transactionValue = getTransactionValue(tokenIn, maximumAmountIn);
     return {
         transaction: {
@@ -21116,7 +21123,7 @@ class Exchange {
     async getUnwrapTransaction(fromAddress, tokenAmount, wimxInterface, gasPrice) {
         const calldata = wimxInterface.encodeFunctionData('withdraw', [tokenAmount]);
         const gasEstimate = ethers.BigNumber.from(IMX_UNWRAP_GAS_COST);
-        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(gasPrice, gasEstimate)) : null;
+        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(false, gasPrice, gasEstimate)) : null;
         // This transaction is for calling calling `withdraw` on the WETH/WIMX contract.
         const transactionDetails = {
             transaction: {
@@ -21134,7 +21141,7 @@ class Exchange {
     getWrapTransaction(fromAddress, tokenAmount, wimxInterface, gasPrice) {
         const calldata = wimxInterface.encodeFunctionData('deposit');
         const gasEstimate = ethers.BigNumber.from(IMX_WRAP_GAS_COST);
-        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(gasPrice, gasEstimate)) : null;
+        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(false, gasPrice, gasEstimate)) : null;
         // This transaction is for calling calling `deposit` on the WETH/WIMX contract.
         const transactionDetails = {
             transaction: {
@@ -27266,7 +27273,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-1.5.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -28633,7 +28640,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '1.5.1';
+const SDK_VERSION_MARKER = '1.5.2';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 

package/dist/config.js

@@ -127,7 +127,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.1';
+const SDK_VERSION = '1.5.2';
 let initialised = false;
 const isInitialised = () => initialised;
 const getReferrer = () => {