@imtbl/sdk 0.27.9 → 0.27.11

package/dist/checkout_sdk.js

@@ -2,7 +2,8 @@ import { ethers, ContractFactory, utils, Contract as Contract$1, BigNumber as Bi
 import globalAxios, { HttpStatusCode } from 'axios';
 import { Web3Provider, JsonRpcProvider } from '@ethersproject/providers';
 import $7v2Z6$metamaskdetectprovider from '@metamask/detect-provider';
-import { TradeType, Token, CurrencyAmount, Percent } from '@uniswap/sdk-core';
+import * as Uniswap from '@uniswap/sdk-core';
+import { TradeType, Percent } from '@uniswap/sdk-core';
 import assert from 'assert';
 import { FeeAmount, Route, SwapQuoter, Pool, Trade, toHex as toHex$1, encodeRouteToPath } from '@uniswap/v3-sdk';
 import { keccak256 as keccak256$1 } from '@ethersproject/solidity';
@@ -14681,13 +14682,14 @@ const quoteReturnMapping = {
  * @param poolB the other pool
  */
 function poolEquals(poolA, poolB) {
-    return (poolA === poolB
-        || (poolA.token0.equals(poolB.token0)
-            && poolA.token1.equals(poolB.token1)
-            && poolA.fee === poolB.fee));
+    return (poolA === poolB ||
+        (poolA.token0.equals(poolB.token0) && poolA.token1.equals(poolB.token1) && poolA.fee === poolB.fee));
 }
-async function getERC20Decimals(tokenAddress, provider) {
-    const decimalsFunctionSig = ethers.utils.id('decimals()').substring(0, 10);
+const decimalsFunctionSig = ethers.utils.id('decimals()').substring(0, 10);
+async function getTokenDecimals(tokenAddress, provider, nativeToken) {
+    if (tokenAddress === 'native') {
+        return nativeToken.decimals;
+    }
     try {
         const decimalsResult = await provider.call({
             to: tokenAddress,
@@ -14715,9 +14717,10 @@ function isValidNonZeroAddress(address) {
         return false;
     }
 }
+const isValidTokenLiteral = (address) => address === 'native' ? true : isValidNonZeroAddress(address);
 const erc20ToUniswapToken = (token) => 
 // eslint-disable-next-line implicit-arrow-linebreak
-new Token(token.chainId, token.address, token.decimals, token.symbol, token.name);
+new Uniswap.Token(token.chainId, token.address, token.decimals, token.symbol, token.name);
 const uniswapTokenToERC20 = (token) => ({
     chainId: token.chainId,
     address: token.address,
@@ -14728,7 +14731,7 @@ const uniswapTokenToERC20 = (token) => ({
 });
 const toCurrencyAmount = (amount) => {
     const token = erc20ToUniswapToken(amount.token);
-    return CurrencyAmount.fromRawAmount(token, amount.value.toString());
+    return Uniswap.CurrencyAmount.fromRawAmount(token, amount.value.toString());
 };
 const newAmount = (amount, token) => ({
     value: amount,
@@ -14774,6 +14777,28 @@ const subtractAmount = (a, b) => {
     }
     throw new Error('Token mismatch: token types must be the same');
 };
+/**
+ * Converts our internal token type which could be ERC20 or Native
+ * into a format consumable by Checkout. They require an address to be
+ * present. We populate the address with empty string if it's Native.
+ * If it's ERC20, we don't need to change it.
+ */
+const toPublicTokenType = (token) => {
+    if (token.type === 'native') {
+        return {
+            address: '',
+            chainId: token.chainId,
+            decimals: token.decimals,
+            symbol: token.symbol,
+            name: token.name,
+        };
+    }
+    return token;
+};
+const toPublicAmount = (amount) => ({
+    token: toPublicTokenType(amount.token),
+    value: amount.value,
+});
 
 const amountIndex = 0;
 const gasEstimateIndex = 3;
@@ -15147,12 +15172,13 @@ const getUnsignedERC20ApproveTransaction = (ownerAddress, tokenAmount, spenderAd
         from: ownerAddress,
     };
 };
-const prepareApproval = (tradeType, amountSpecified, amountWithSlippage, contracts, secondaryFees) => {
-    const amountOfTokenIn = tradeType === TradeType.EXACT_INPUT ? amountSpecified : amountWithSlippage;
-    const spender = secondaryFees.length === 0
-        ? contracts.routerAddress
-        : contracts.secondaryFeeAddress;
-    return { spender, amount: amountOfTokenIn };
+const prepareApproval = (tradeType, userSpecifiedAmount, quotedAmountWithSlippage, contracts, secondaryFees) => {
+    const amountInToApprove = tradeType === TradeType.EXACT_INPUT ? userSpecifiedAmount : quotedAmountWithSlippage;
+    if (!isERC20Amount(amountInToApprove)) {
+        return null;
+    }
+    const spender = secondaryFees.length === 0 ? contracts.routerAddress : contracts.secondaryFeeAddress;
+    return { spender, amount: amountInToApprove };
 };
 /**
  * Get an unsigned approval transaction if needed
@@ -15184,7 +15210,7 @@ async function getApproveGasEstimate(provider, ownerAddress, spenderAddress, tok
         from: ownerAddress,
     });
 }
-const getApproval = async (provider, ownerAddress, preparedApproval, gasPrice, nativeTokenService) => {
+const getApproval = async (provider, ownerAddress, preparedApproval, gasPrice) => {
     const approveTransaction = await getApproveTransaction(provider, ownerAddress, preparedApproval.amount, preparedApproval.spender);
     if (!approveTransaction) {
         return null;
@@ -15193,11 +15219,42 @@ const getApproval = async (provider, ownerAddress, preparedApproval, gasPrice, n
     const gasFeeEstimate = gasPrice ? calculateGasFee(gasPrice, gasEstimate) : null;
     return {
         transaction: approveTransaction,
-        // TODO: TP-1649: Remove the wrapping here
-        gasFeeEstimate: gasFeeEstimate ? nativeTokenService.maybeWrapAmount(gasFeeEstimate) : null,
+        gasFeeEstimate: gasFeeEstimate ? toPublicAmount(gasFeeEstimate) : null,
     };
 };
 
+const canUnwrapToken = (token) => token.type === 'native';
+class NativeTokenService {
+    nativeToken;
+    wrappedToken;
+    constructor(nativeToken, wrappedToken) {
+        this.nativeToken = nativeToken;
+        this.wrappedToken = wrappedToken;
+    }
+    wrapAmount(amount) {
+        if (!canUnwrapToken(amount.token)) {
+            throw new Error(`cannot wrap non-native token: ${amount.token.address}`);
+        }
+        return newAmount(amount.value, this.wrappedToken);
+    }
+    unwrapAmount(amount) {
+        const isWrappedToken = amount.token.address.toLowerCase() !== this.wrappedToken.address.toLowerCase();
+        if (isWrappedToken) {
+            throw new Error(`cannot unwrap non-wrapped token ${amount.token.address}`);
+        }
+        return newAmount(amount.value, this.nativeToken);
+    }
+    maybeWrapToken(token) {
+        if (canUnwrapToken(token)) {
+            return this.wrappedToken;
+        }
+        return token;
+    }
+    maybeWrapAmount(amount) {
+        return newAmount(amount.value, this.maybeWrapToken(amount.token));
+    }
+}
+
 // slippageToPercent takes the slippage as a percentage (e.g. 0.1) and
 // converts it to the Uniswap equivalent type
 const slippageToFraction = (slippage) => {
@@ -15217,11 +15274,11 @@ const slippageToFraction = (slippage) => {
     return new Percent(numerator, denominator);
 };
 
-function getQuoteAmountFromTradeType(tradeInfo) {
-    if (tradeInfo.tradeType === TradeType.EXACT_INPUT) {
-        return tradeInfo.amountOut;
+function getQuoteAmountFromTradeType(routerQuote) {
+    if (routerQuote.tradeType === TradeType.EXACT_INPUT) {
+        return routerQuote.amountOut;
     }
-    return tradeInfo.amountIn;
+    return routerQuote.amountIn;
 }
 function applySlippage(tradeType, amount, slippage) {
     const slippageTolerance = slippageToFraction(slippage);
@@ -15230,22 +15287,18 @@ function applySlippage(tradeType, amount, slippage) {
     const amountWithSlippage = maybeInverted.multiply(amount.toString()).quotient;
     return ethers.BigNumber.from(amountWithSlippage.toString());
 }
-function prepareUserQuote(otherToken, tradeInfo, slippage, fees, nativeTokenService) {
-    const quote = getQuoteAmountFromTradeType(tradeInfo);
-    const amountWithSlippage = applySlippage(tradeInfo.tradeType, quote.value, slippage);
+const prepareUserQuote = (nativeTokenService, routerQuote, slippage, tokenOfQuotedAmount) => {
+    const erc20QuoteAmount = getQuoteAmountFromTradeType(routerQuote);
+    // If the quote amount is the native token, we need to unwrap it if the user originally specified the native token
+    const quotedAmount = canUnwrapToken(tokenOfQuotedAmount)
+        ? nativeTokenService.unwrapAmount(erc20QuoteAmount)
+        : erc20QuoteAmount;
+    const quotedAmountWithMaxSlippage = newAmount(applySlippage(routerQuote.tradeType, quotedAmount.value, slippage), tokenOfQuotedAmount);
     return {
-        amount: quote,
-        amountWithMaxSlippage: {
-            token: otherToken,
-            value: amountWithSlippage,
-        },
-        slippage,
-        fees: fees.withAmounts().map((fee) => ({
-            ...fee,
-            amount: nativeTokenService.maybeWrapAmount(fee.amount),
-        })),
+        quotedAmount,
+        quotedAmountWithMaxSlippage,
     };
-}
+};
 function getOurQuoteReqAmount(amountSpecified, // the amount specified by the user, either exactIn or exactOut
 fees, tradeType, nativeTokenService) {
     if (tradeType === TradeType.EXACT_OUTPUT) {
@@ -15313,46 +15366,8 @@ class Fees {
     }
 }
 
-class NativeTokenService {
-    nativeToken;
-    wrappedToken;
-    constructor(nativeToken, wrappedToken) {
-        this.nativeToken = nativeToken;
-        this.wrappedToken = wrappedToken;
-    }
-    wrapAmount(amount) {
-        return newAmount(amount.value, this.wrappedToken);
-    }
-    unwrapAmount(amount) {
-        if (amount.token !== this.wrappedToken) {
-            throw new Error(`token ${amount.token.address} is not wrapped`);
-        }
-        return newAmount(amount.value, this.nativeToken);
-    }
-    maybeWrapToken(token) {
-        if (this.isNativeToken(token)) {
-            return this.wrappedToken;
-        }
-        return token;
-    }
-    maybeWrapAmount(amount) {
-        return newAmount(amount.value, this.maybeWrapToken(amount.token));
-    }
-    isNativeToken(token) {
-        return token === this.nativeToken;
-    }
-}
-
 const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
 const IMMUTABLE_TESTNET_CHAIN_ID = 13472;
-
-const NATIVE_IMX_IMMUTABLE_TESTNET = {
-    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
-    decimals: 18,
-    symbol: 'tIMX',
-    name: 'Immutable Testnet Token',
-    type: 'native',
-};
 const TIMX_IMMUTABLE_TESTNET = {
     chainId: IMMUTABLE_TESTNET_CHAIN_ID,
     address: '0x0000000000000000000000000000000000001010',
@@ -15382,7 +15397,9 @@ function buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, amountI
         recipient: fee.recipient,
     }));
     if (trade.tradeType === TradeType.EXACT_INPUT) {
-        return secondaryFeeContract.encodeFunctionData('exactInputSingleWithSecondaryFee', [secondaryFeeValues, {
+        return secondaryFeeContract.encodeFunctionData('exactInputSingleWithSecondaryFee', [
+            secondaryFeeValues,
+            {
                 tokenIn: route.tokenPath[0].address,
                 tokenOut: route.tokenPath[1].address,
                 fee: route.pools[0].fee,
@@ -15390,9 +15407,12 @@ function buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, amountI
                 amountIn,
                 amountOutMinimum: amountOut,
                 sqrtPriceLimitX96: 0,
-            }]);
+            },
+        ]);
     }
-    return secondaryFeeContract.encodeFunctionData('exactOutputSingleWithSecondaryFee', [secondaryFeeValues, {
+    return secondaryFeeContract.encodeFunctionData('exactOutputSingleWithSecondaryFee', [
+        secondaryFeeValues,
+        {
             tokenIn: route.tokenPath[0].address,
             tokenOut: route.tokenPath[1].address,
             fee: route.pools[0].fee,
@@ -15400,7 +15420,8 @@ function buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, amountI
             amountInMaximum: amountIn,
             amountOut,
             sqrtPriceLimitX96: 0,
-        }]);
+        },
+    ]);
 }
 function buildSwapParametersForMultiPoolSwap(fromAddress, trade, route, amountIn, amountOut, secondaryFees, secondaryFeeContract) {
     const path = encodeRouteToPath(route, trade.tradeType === TradeType.EXACT_OUTPUT);
@@ -15409,19 +15430,25 @@ function buildSwapParametersForMultiPoolSwap(fromAddress, trade, route, amountIn
         recipient: fee.recipient,
     }));
     if (trade.tradeType === TradeType.EXACT_INPUT) {
-        return secondaryFeeContract.encodeFunctionData('exactInputWithSecondaryFee', [secondaryFeeValues, {
+        return secondaryFeeContract.encodeFunctionData('exactInputWithSecondaryFee', [
+            secondaryFeeValues,
+            {
                 path,
                 recipient: fromAddress,
                 amountIn,
                 amountOutMinimum: amountOut,
-            }]);
+            },
+        ]);
     }
-    return secondaryFeeContract.encodeFunctionData('exactOutputWithSecondaryFee', [secondaryFeeValues, {
+    return secondaryFeeContract.encodeFunctionData('exactOutputWithSecondaryFee', [
+        secondaryFeeValues,
+        {
             path,
             recipient: fromAddress,
             amountInMaximum: amountIn,
             amountOut,
-        }]);
+        },
+    ]);
 }
 /**
  * Builds swap parameters
@@ -15446,7 +15473,10 @@ function buildSwapParameters(fromAddress, trade, options, secondaryFees, seconda
 function createSwapCallParametersWithFees(trade, fromAddress, swapOptions, secondaryFees) {
     const secondaryFeeContract = SecondaryFee__factory.createInterface();
     const swapWithFeesCalldata = buildSwapParameters(fromAddress, trade, swapOptions, secondaryFees, secondaryFeeContract);
-    return secondaryFeeContract.encodeFunctionData(multicallWithDeadlineFunctionSignature, [swapOptions.deadlineOrPreviousBlockhash, [swapWithFeesCalldata]]);
+    return secondaryFeeContract.encodeFunctionData(multicallWithDeadlineFunctionSignature, [
+        swapOptions.deadlineOrPreviousBlockhash,
+        [swapWithFeesCalldata],
+    ]);
 }
 function createSwapParameters(adjustedQuote, fromAddress, slippage, deadline, secondaryFees) {
     // Create an unchecked trade to be used in generating swap parameters.
@@ -15486,7 +15516,7 @@ function getSwap(adjustedQuote, fromAddress, slippage, deadline, peripheryRouter
 const adjustAmountIn = (ourQuote, amountSpecified, fees, nativeTokenService) => {
     if (ourQuote.tradeType === TradeType.EXACT_OUTPUT) {
         // when doing exact output, calculate the fees based on the amountIn
-        const amountToAdd = nativeTokenService.isNativeToken(fees.token)
+        const amountToAdd = canUnwrapToken(fees.token)
             ? nativeTokenService.unwrapAmount(ourQuote.amountIn)
             : ourQuote.amountIn;
         fees.addAmount(amountToAdd);
@@ -15530,7 +15560,7 @@ const SUPPORTED_SANDBOX_CHAINS = {
         rpcUrl: IMMUTABLE_TESTNET_RPC_URL,
         contracts: CONTRACTS_FOR_CHAIN_ID[IMMUTABLE_TESTNET_CHAIN_ID],
         commonRoutingTokens: IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS,
-        nativeToken: NATIVE_IMX_IMMUTABLE_TESTNET,
+        nativeToken: TIMX_IMMUTABLE_TESTNET,
         wrappedNativeToken: TIMX_IMMUTABLE_TESTNET, // TODO: TP-1649: Change to WIMX when ready.
     },
 };
@@ -15602,6 +15632,15 @@ class ExchangeConfiguration {
     }
 }
 
+const toPublicQuote = (amount, amountWithMaxSlippage, slippage, fees) => ({
+    amount: toPublicAmount(amount),
+    amountWithMaxSlippage: toPublicAmount(amountWithMaxSlippage),
+    slippage,
+    fees: fees.withAmounts().map((fee) => ({
+        ...fee,
+        amount: toPublicAmount(fee.amount),
+    })),
+});
 class Exchange {
     provider;
     router;
@@ -15630,8 +15669,8 @@ class Exchange {
     }
     static validate(tokenInAddress, tokenOutAddress, maxHops, slippagePercent, fromAddress) {
         assert(isValidNonZeroAddress(fromAddress), new InvalidAddressError('invalid from address'));
-        assert(isValidNonZeroAddress(tokenInAddress), new InvalidAddressError('invalid token in address'));
-        assert(isValidNonZeroAddress(tokenOutAddress), new InvalidAddressError('invalid token out address'));
+        assert(isValidTokenLiteral(tokenInAddress), new InvalidAddressError('invalid token in address'));
+        assert(isValidTokenLiteral(tokenOutAddress), new InvalidAddressError('invalid token out address'));
         assert(tokenInAddress.toLocaleLowerCase() !== tokenOutAddress.toLocaleLowerCase(), new DuplicateAddressesError());
         assert(maxHops <= MAX_MAX_HOPS, new InvalidMaxHopsError('max hops must be less than or equal to 10'));
         assert(maxHops >= MIN_MAX_HOPS, new InvalidMaxHopsError('max hops must be greater than or equal to 1'));
@@ -15649,63 +15688,63 @@ class Exchange {
         }
         return this.secondaryFees;
     }
-    async getUnsignedSwapTx(fromAddress, tokenInAddress, tokenOutAddress, amount, slippagePercent, maxHops, deadline, tradeType) {
-        Exchange.validate(tokenInAddress, tokenOutAddress, maxHops, slippagePercent, fromAddress);
+    parseTokenLiteral(tokenLiteral, decimals) {
+        if (tokenLiteral === 'native') {
+            return this.nativeToken;
+        }
+        return {
+            type: 'erc20',
+            address: tokenLiteral,
+            chainId: this.chainId,
+            decimals,
+        };
+    }
+    async getUnsignedSwapTx(fromAddress, tokenInLiteral, tokenOutLiteral, amount, slippagePercent, maxHops, deadline, tradeType) {
+        Exchange.validate(tokenInLiteral, tokenOutLiteral, maxHops, slippagePercent, fromAddress);
         // get the decimals of the tokens that will be swapped
         const [tokenInDecimals, tokenOutDecimals, secondaryFees] = await Promise.all([
-            getERC20Decimals(tokenInAddress, this.provider),
-            getERC20Decimals(tokenOutAddress, this.provider),
+            getTokenDecimals(tokenInLiteral, this.provider, this.nativeToken),
+            getTokenDecimals(tokenOutLiteral, this.provider, this.nativeToken),
             this.getSecondaryFees(),
         ]);
-        const tokenIn = {
-            type: 'erc20',
-            address: tokenInAddress,
-            chainId: this.chainId,
-            decimals: tokenInDecimals,
-        };
-        const tokenOut = {
-            type: 'erc20',
-            address: tokenOutAddress,
-            chainId: this.chainId,
-            decimals: tokenOutDecimals,
-        };
+        const tokenIn = this.parseTokenLiteral(tokenInLiteral, tokenInDecimals);
+        const tokenOut = this.parseTokenLiteral(tokenOutLiteral, tokenOutDecimals);
         // determine which amount was specified for the swap from the TradeType
         const [tokenSpecified, otherToken] = tradeType === TradeType.EXACT_INPUT ? [tokenIn, tokenOut] : [tokenOut, tokenIn];
         const amountSpecified = newAmount(amount, tokenSpecified);
         const fees = new Fees(secondaryFees, tokenIn);
         const ourQuoteReqAmount = getOurQuoteReqAmount(amountSpecified, fees, tradeType, this.nativeTokenService);
-        // get quote and gas details
+        // Quotes will always use ERC20s. If the user-specified token is Native, we use the Wrapped Native Token pool
         const [ourQuote, gasPrice] = await Promise.all([
-            this.router.findOptimalRoute(ourQuoteReqAmount, otherToken, tradeType, maxHops),
+            this.router.findOptimalRoute(ourQuoteReqAmount, this.nativeTokenService.maybeWrapToken(otherToken), tradeType, maxHops),
             fetchGasPrice(this.provider, this.nativeToken),
         ]);
         const adjustedQuote = adjustQuoteWithFees(ourQuote, amountSpecified, fees, this.nativeTokenService);
         const swap = getSwap(adjustedQuote, fromAddress, slippagePercent, deadline, this.routerContractAddress, this.secondaryFeeContractAddress, gasPrice, secondaryFees, this.nativeTokenService);
-        const userQuote = prepareUserQuote(otherToken, adjustedQuote, slippagePercent, fees, this.nativeTokenService);
-        const preparedApproval = prepareApproval(tradeType, amountSpecified, userQuote.amountWithMaxSlippage, {
+        const { quotedAmount, quotedAmountWithMaxSlippage } = prepareUserQuote(this.nativeTokenService, adjustedQuote, slippagePercent, otherToken);
+        const preparedApproval = prepareApproval(tradeType, amountSpecified, quotedAmountWithMaxSlippage, {
             routerAddress: this.routerContractAddress,
             secondaryFeeAddress: this.secondaryFeeContractAddress,
         }, secondaryFees);
         // preparedApproval always uses the tokenIn address because we are always selling the tokenIn
-        const approval = await getApproval(this.provider, fromAddress, preparedApproval, gasPrice, this.nativeTokenService);
-        return {
-            approval,
-            swap,
-            quote: userQuote,
-        };
+        const approval = preparedApproval
+            ? await getApproval(this.provider, fromAddress, preparedApproval, gasPrice)
+            : null;
+        const quote = toPublicQuote(quotedAmount, quotedAmountWithMaxSlippage, slippagePercent, fees);
+        return { quote, approval, swap };
     }
     /**
      * Get the unsigned swap transaction given the amount to sell.
      * Includes quote details for the swap.
      *
-     * @param {string} fromAddress The public address that will sign and submit the transaction.
-     * @param {string} tokenInAddress Token address to sell.
-     * @param {string} tokenOutAddress Token address to buy.
-     * @param {ethers.BigNumberish} amountIn Amount to sell.
-     * @param {number} slippagePercent (optional) The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0.
-     * @param {number} maxHops (optional) Maximum hops allowed in optimal route. Default is 2.
-     * @param {number} deadline (optional) Latest time swap can execute. Default is 15 minutes.
-     * @return {TransactionResponse} The result containing the unsigned transaction and details of the swap.
+     * @param {string} fromAddress The public address that will sign and submit the transaction
+     * @param {string} tokenInAddress Token address or 'native' to sell
+     * @param {string} tokenOutAddress Token address or 'native' to buy
+     * @param {ethers.BigNumberish} amountIn Amount to sell in the smallest unit of the token-in
+     * @param {number} slippagePercent (optional) The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0
+     * @param {number} maxHops (optional) Maximum hops allowed in optimal route. Default is 2
+     * @param {number} deadline (optional) Latest time swap can execute. Default is 15 minutes
+     * @return {TransactionResponse} The result containing the unsigned transaction and details of the swap
      */
     async getUnsignedSwapTxFromAmountIn(fromAddress, tokenInAddress, tokenOutAddress, amountIn, slippagePercent = DEFAULT_SLIPPAGE, maxHops = DEFAULT_MAX_HOPS, deadline = DEFAULT_DEADLINE) {
         return await this.getUnsignedSwapTx(fromAddress, tokenInAddress, tokenOutAddress, ethers.BigNumber.from(amountIn), slippagePercent, maxHops, deadline, TradeType.EXACT_INPUT);
@@ -15714,14 +15753,14 @@ class Exchange {
      * Get the unsigned swap transaction given the amount to buy.
      * Includes quote details for the swap.
      *
-     * @param {string} fromAddress The public address that will sign and submit the transaction.
-     * @param {string} tokenInAddress Token address to sell.
-     * @param {string} tokenOutAddress Token address to buy.
-     * @param {ethers.BigNumberish} amountOut Amount to buy.
-     * @param {number} slippagePercent (optional) The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0.
-     * @param {number} maxHops (optional) Maximum hops allowed in optimal route. Default is 2.
-     * @param {number} deadline (optional) Latest time swap can execute. Default is 15 minutes.
-     * @return {TransactionResponse} The result containing the unsigned transaction and details of the swap.
+     * @param {string} fromAddress The public address that will sign and submit the transaction
+     * @param {string} tokenInAddress ERC20 contract address or 'native' to sell
+     * @param {string} tokenOutAddress ERC20 contract address or 'native' to buy
+     * @param {ethers.BigNumberish} amountOut Amount to buy in the smallest unit of the token-out
+     * @param {number} slippagePercent (optional) The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0
+     * @param {number} maxHops (optional) Maximum hops allowed in optimal route. Default is 2
+     * @param {number} deadline (optional) Latest time swap can execute. Default is 15 minutes
+     * @return {TransactionResponse} The result containing the unsigned transaction and details of the swap
      */
     async getUnsignedSwapTxFromAmountOut(fromAddress, tokenInAddress, tokenOutAddress, amountOut, slippagePercent = DEFAULT_SLIPPAGE, maxHops = DEFAULT_MAX_HOPS, deadline = DEFAULT_DEADLINE) {
         return await this.getUnsignedSwapTx(fromAddress, tokenInAddress, tokenOutAddress, ethers.BigNumber.from(amountOut), slippagePercent, maxHops, deadline, TradeType.EXACT_OUTPUT);
@@ -20548,7 +20587,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.27.9',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.27.11',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -21174,6 +21213,14 @@ const $d85ad1457a3f1a83$export$fc55ed5a42b458ba = {
     [($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_MAINNET]: {
         url: "https://explorer.mainnet.immutable.com",
         nativeToken: $d85ad1457a3f1a83$export$6f24f3cef7d501c4.get(($0472f23319457bfb$export$c06e1e7429de6283).IMTBL_ZKEVM_MAINNET).nativeCurrency
+    },
+    [($0472f23319457bfb$export$c06e1e7429de6283).SEPOLIA]: {
+        url: "https://eth-sepolia.blockscout.com",
+        nativeToken: $d85ad1457a3f1a83$export$3e81fc0987227f10.get(($0472f23319457bfb$export$c06e1e7429de6283).SEPOLIA).nativeCurrency
+    },
+    [($0472f23319457bfb$export$c06e1e7429de6283).ETHEREUM]: {
+        url: "https://eth.blockscout.com/",
+        nativeToken: $d85ad1457a3f1a83$export$6f24f3cef7d501c4.get(($0472f23319457bfb$export$c06e1e7429de6283).ETHEREUM).nativeCurrency
     }
 };
 const $d85ad1457a3f1a83$export$db5daa1b5156ccfe = [
@@ -21773,6 +21820,7 @@ const $efe60cea83bfc4e8$export$473cec51305fdae8 = async (config, { type: type =
 
 
 
+
 const $fd8a8472dcc3ec2b$var$CACHE_DATA_TTL = 60; // seconds
 class $fd8a8472dcc3ec2b$export$ef140a6b05dfc786 {
     url;
@@ -21945,18 +21993,23 @@ async function $1564e43dde50bb61$export$60e0fe116a0e6ed0(web3Provider, walletAdd
         type: ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_ERC20_BALANCE_ERROR
     });
 }
-// Blockscout client singleton
-let $1564e43dde50bb61$var$blockscoutClient;
-const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId, rename)=>{
+// Blockscout client singleton per chain id
+const $1564e43dde50bb61$var$blockscoutClientMap = new Map();
+const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId, filterTokens)=>{
     // Shuffle the mapping of the tokens configuration so it is a hashmap
     // for faster access to tokens config objects.
-    const mapRename = Object.assign({}, ...rename.map((t)=>({
+    const shouldFilter = filterTokens.length > 0;
+    const mapFilterTokens = Object.assign({}, ...filterTokens.map((t)=>({
             [t.address || ""]: t
         })));
-    // Ensure singleton is present and match the selected chain
-    if (!$1564e43dde50bb61$var$blockscoutClient || $1564e43dde50bb61$var$blockscoutClient.chainId !== chainId) $1564e43dde50bb61$var$blockscoutClient = new ($fd8a8472dcc3ec2b$export$ef140a6b05dfc786)({
-        chainId: chainId
-    });
+    // Get blockscout client for the given chain
+    let blockscoutClient = $1564e43dde50bb61$var$blockscoutClientMap.get(chainId);
+    if (!blockscoutClient) {
+        blockscoutClient = new ($fd8a8472dcc3ec2b$export$ef140a6b05dfc786)({
+            chainId: chainId
+        });
+        $1564e43dde50bb61$var$blockscoutClientMap.set(chainId, blockscoutClient);
+    }
     // Hold the items in an array for post-fetching processing
     const items = [];
     const tokenType = ($887a00f8f72d61f0$export$5bd1ea2b3d18210).ERC20;
@@ -21966,7 +22019,7 @@ const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId,
     try {
         do {
             // eslint-disable-next-line no-await-in-loop
-            resp = await $1564e43dde50bb61$var$blockscoutClient.getTokensByWalletAddress({
+            resp = await blockscoutClient.getTokensByWalletAddress({
                 walletAddress: walletAddress,
                 tokenType: tokenType,
                 nextPage: resp?.next_page_params
@@ -21984,7 +22037,7 @@ const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId,
         if (err?.code !== (HttpStatusCode).NotFound) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getTokensByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
     }
     try {
-        const respNative = await $1564e43dde50bb61$var$blockscoutClient.getNativeTokenByWalletAddress({
+        const respNative = await blockscoutClient.getNativeTokenByWalletAddress({
             walletAddress: walletAddress
         });
         items.push(respNative);
@@ -21998,24 +22051,26 @@ const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId,
         // or simply an incorrect wallet address was provided.
         if (err?.code !== (HttpStatusCode).NotFound) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getNativeTokenByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
     }
+    const balances = [];
+    items.forEach((item)=>{
+        if (shouldFilter && !mapFilterTokens[item.token.address]) return;
+        const tokenData = item.token || {};
+        const balance = (BigNumber$1).from(item.value);
+        let decimals = parseInt(tokenData.decimals, 10);
+        if (Number.isNaN(decimals)) decimals = ($d85ad1457a3f1a83$export$903389470ba9433c);
+        const token = {
+            ...tokenData,
+            decimals: decimals
+        };
+        const formattedBalance = (utils).formatUnits(item.value, token.decimals);
+        balances.push({
+            balance: balance,
+            formattedBalance: formattedBalance,
+            token: token
+        });
+    });
     return {
-        balances: items.map((item)=>{
-            const tokenData = item.token || {};
-            const balance = (BigNumber$1).from(item.value);
-            const renamed = mapRename[tokenData.address] || {};
-            const token = {
-                ...tokenData,
-                name: renamed.name ?? tokenData.name,
-                symbol: renamed.symbol ?? tokenData.symbol,
-                decimals: parseInt(tokenData.decimals, 10)
-            };
-            const formattedBalance = (utils).formatUnits(item.value, token.decimals);
-            return {
-                balance: balance,
-                formattedBalance: formattedBalance,
-                token: token
-            };
-        })
+        balances: balances
     };
 };
 const $1564e43dde50bb61$export$a3238cee431627c6 = async (config, web3Provider, walletAddress, tokens)=>{
@@ -22046,7 +22101,15 @@ const $1564e43dde50bb61$export$fee49741664a4d7e = async (config, web3Provider, w
         // eslint-disable-next-line no-console
         console.error(err);
     }
-    if (flag && ($fd8a8472dcc3ec2b$export$ef140a6b05dfc786).isChainSupported(chainId)) return await $1564e43dde50bb61$export$8c978679845804d4(walletAddress, chainId, tokens);
+    if (flag && ($fd8a8472dcc3ec2b$export$ef140a6b05dfc786).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
+        // then we would not have fiat conversions.
+        // Please remove this hack once https://immutable.atlassian.net/browse/WT-1710
+        // is done.
+        const isL1Chain = ($4013c5c91bb535f6$export$9b794d067cdd1af6)(config) === chainId;
+        return await $1564e43dde50bb61$export$8c978679845804d4(walletAddress, chainId, isL1Chain ? tokens : []);
+    }
     // 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.
@@ -25020,7 +25083,7 @@ class $a8cb37a3fc8eb863$export$1f60ba4ec72508a0 {
         const tokenList = await $efe60cea83bfc4e8$export$473cec51305fdae8(this.config, {
             type: ($08d5ddc39acd6833$export$fd9b17d87f4121d2).ONRAMP
         });
-        const token = tokenList.tokens.find((t)=>t.address?.toLowerCase() === params.tokenAddress?.toLowerCase());
+        const token = tokenList.tokens?.find((t)=>t.address?.toLowerCase() === params.tokenAddress?.toLowerCase());
         if (token) {
             tokenAmount = params.tokenAmount;
             tokenSymbol = token.symbol;

package/dist/checkout_widgets.d.ts

@@ -25618,7 +25618,7 @@ declare enum IMTBLWidgetEvents {
     IMTBL_SWAP_WIDGET_EVENT = "imtbl-swap-widget",
     IMTBL_BRIDGE_WIDGET_EVENT = "imtbl-bridge-widget",
     IMTBL_ONRAMP_WIDGET_EVENT = "imtbl-onramp-widget",
-    IMTBL_PRIMARY_REVENUE_WIDGET_EVENT = "imtbl-sale-widget"
+    IMTBL_SALE_WIDGET_EVENT = "imtbl-sale-widget"
 }
 /**
  * Represents an event emitted by a widget.