@imtbl/sdk 0.27.12 → 0.27.14

package/dist/index.cjs

@@ -3632,7 +3632,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.27.12' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.27.14' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -3692,7 +3692,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.27.12',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.27.14',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4103,7 +4103,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.27.12',
+    sdkVersion: 'ts-immutable-sdk-0.27.14',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -4119,9 +4119,9 @@ const production = () => createImmutableXConfiguration({
  */
 const sandbox = () => createImmutableXConfiguration({
     basePath: 'https://api.sandbox.x.immutable.com',
-    chainID: 5,
-    coreContractAddress: '0x7917eDb51ecD6CdB3F9854c3cc593F33de10c623',
-    registrationContractAddress: '0x1C97Ada273C9A52253f463042f29117090Cd7D83',
+    chainID: 11155111,
+    coreContractAddress: '0x2d5C349fD8464DA06a3f90b4B0E9195F3d1b7F98',
+    registrationContractAddress: '0xDbA6129C02E69405622fAdc3d5A7f8d23eac3b97',
 });
 class ImxConfiguration {
     immutableXConfig;
@@ -28458,8 +28458,9 @@ const doesChainSupportEIP1559 = (fee) => {
 /**
  * Fetch the current gas price estimate. Supports both EIP-1559 and non-EIP1559 chains
  * @param {JsonRpcProvider} provider - The JSON RPC provider used to fetch fee data
+ * @param {Coin} nativeToken - The native token of the chain. Gas prices will be denominated in this token
  * @returns {Amount | null} - The gas price in the smallest denomination of the chain's currency,
- * or null if no gas price is available
+ *  or null if no gas price is available
  */
 const fetchGasPrice = async (provider, nativeToken) => {
     const feeData = await provider.getFeeData().catch(() => null);
@@ -28473,8 +28474,8 @@ const fetchGasPrice = async (provider, nativeToken) => {
 /**
  * Calculate the gas fee from the gas price and gas units used for the transaction
  *
- * @param {Amount} gasPriceInWei - The price of gas
- * @param {BigNumber} gasUsed - The total gas units that will be used for the transaction
+ * @param {Amount} gasPrice - The price of gas
+ * @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) => 
@@ -28818,21 +28819,19 @@ function buildSwapParametersForMultiPoolSwap(fromAddress, trade, route, amountIn
  * @param options additional swap options
  * @returns calldata for the swap
  */
-function buildSwapParameters(fromAddress, trade, options, secondaryFees, secondaryFeeContract) {
+function buildSwapParameters(fromAddress, trade, options, secondaryFees, secondaryFeeContract, maximumAmountIn, minimumAmountOut) {
     // @dev we don't support multiple swaps in a single transaction
     // there will always be only one swap in the trade regardless of the trade type
-    const { route, inputAmount, outputAmount } = trade.swaps[0];
-    const amountIn = v3Sdk.toHex(trade.maximumAmountIn(options.slippageTolerance, inputAmount).quotient);
-    const amountOut = v3Sdk.toHex(trade.minimumAmountOut(options.slippageTolerance, outputAmount).quotient);
+    const { route } = trade.swaps[0];
     const isSinglePoolSwap = route.pools.length === 1;
     if (isSinglePoolSwap) {
-        return buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, amountIn, amountOut, secondaryFees, secondaryFeeContract);
+        return buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, maximumAmountIn, minimumAmountOut, secondaryFees, secondaryFeeContract);
     }
-    return buildSwapParametersForMultiPoolSwap(fromAddress, trade, route, amountIn, amountOut, secondaryFees, secondaryFeeContract);
+    return buildSwapParametersForMultiPoolSwap(fromAddress, trade, route, maximumAmountIn, minimumAmountOut, secondaryFees, secondaryFeeContract);
 }
-function createSwapCallParametersWithFees(trade, fromAddress, swapOptions, secondaryFees) {
+function createSwapCallParametersWithFees(trade, fromAddress, swapOptions, secondaryFees, maximumAmountIn, minimumAmountOut) {
     const secondaryFeeContract = SecondaryFee__factory.createInterface();
-    const swapWithFeesCalldata = buildSwapParameters(fromAddress, trade, swapOptions, secondaryFees, secondaryFeeContract);
+    const swapWithFeesCalldata = buildSwapParameters(fromAddress, trade, swapOptions, secondaryFees, secondaryFeeContract, maximumAmountIn, minimumAmountOut);
     return secondaryFeeContract.encodeFunctionData(multicallWithDeadlineFunctionSignature, [
         swapOptions.deadlineOrPreviousBlockhash,
         [swapWithFeesCalldata],
@@ -28852,25 +28851,34 @@ function createSwapParameters(adjustedQuote, fromAddress, slippage, deadline, se
         recipient: fromAddress,
         deadlineOrPreviousBlockhash: deadline,
     };
+    // If the trade type is EXACT_INPUT, then the maximum amount-in is the user-specified amount (no slippage applied)
+    // https://github.com/Uniswap/v3-sdk/blob/81d66099f07d1ec350767f497ef73222575fe032/src/entities/trade.ts#L456
+    const maximumAmountIn = v3Sdk.toHex(uncheckedTrade.maximumAmountIn(options.slippageTolerance).quotient);
+    const minimumAmountOut = v3Sdk.toHex(uncheckedTrade.minimumAmountOut(options.slippageTolerance).quotient);
     if (secondaryFees.length === 0) {
         // Generate swap parameters without secondary fee contract details
-        return routerSdk.SwapRouter.swapCallParameters([uncheckedTrade], options).calldata;
+        return { calldata: routerSdk.SwapRouter.swapCallParameters([uncheckedTrade], options).calldata, maximumAmountIn };
     }
-    return createSwapCallParametersWithFees(uncheckedTrade, fromAddress, options, secondaryFees);
+    return {
+        calldata: createSwapCallParametersWithFees(uncheckedTrade, fromAddress, options, secondaryFees, maximumAmountIn, minimumAmountOut),
+        maximumAmountIn,
+    };
 }
-function getSwap(adjustedQuote, fromAddress, slippage, deadline, peripheryRouterAddress, secondaryFeesAddress, gasPrice, secondaryFees, nativeTokenService) {
-    const calldata = createSwapParameters(adjustedQuote, fromAddress, slippage, deadline, secondaryFees);
+const getTransactionValue = (tokenIn, maximumAmountIn) => tokenIn.type === 'native' ? maximumAmountIn : zeroNativeCurrencyValue;
+function getSwap(tokenIn, adjustedQuote, fromAddress, slippage, deadline, peripheryRouterAddress, secondaryFeesAddress, gasPrice, secondaryFees) {
+    // TODO: TP-1651: Include `refundETH` transaction as final step for native Exact Output swaps
+    const { calldata, maximumAmountIn } = createSwapParameters(adjustedQuote, fromAddress, slippage, deadline, secondaryFees);
     // TODO: Add additional gas fee estimates for secondary fees
     const gasFeeEstimate = gasPrice ? calculateGasFee(gasPrice, adjustedQuote.gasEstimate) : null;
+    const transactionValue = getTransactionValue(tokenIn, maximumAmountIn);
     return {
         transaction: {
             data: calldata,
             to: secondaryFees.length > 0 ? secondaryFeesAddress : peripheryRouterAddress,
-            value: zeroNativeCurrencyValue,
+            value: transactionValue,
             from: fromAddress,
         },
-        // TODO: TP-1649: Remove the wrapping here
-        gasFeeEstimate: gasFeeEstimate ? nativeTokenService.maybeWrapAmount(gasFeeEstimate) : null,
+        gasFeeEstimate: gasFeeEstimate ? toPublicAmount(gasFeeEstimate) : null,
     };
 }
 const adjustAmountIn = (ourQuote, amountSpecified, fees, nativeTokenService) => {
@@ -28967,7 +28975,7 @@ class ExchangeConfiguration {
     baseConfig;
     chain;
     secondaryFees = [];
-    constructor({ chainId, baseConfig, secondaryFees, overrides, }) {
+    constructor({ chainId, baseConfig, secondaryFees, overrides }) {
         this.baseConfig = baseConfig;
         this.secondaryFees = secondaryFees || [];
         validateSecondaryFees(this.secondaryFees);
@@ -29080,7 +29088,7 @@ class Exchange {
             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 swap = getSwap(tokenIn, adjustedQuote, fromAddress, slippagePercent, deadline, this.routerContractAddress, this.secondaryFeeContractAddress, gasPrice, secondaryFees);
         const { quotedAmount, quotedAmountWithMaxSlippage } = prepareUserQuote(this.nativeTokenService, adjustedQuote, slippagePercent, otherToken);
         const preparedApproval = prepareApproval(tradeType, amountSpecified, quotedAmountWithMaxSlippage, {
             routerAddress: this.routerContractAddress,
@@ -29652,6 +29660,7 @@ var $e055e79256bbc1dd$export$80f4da0d409a629d;
     CheckoutErrorType["ORDER_FEE_ERROR"] = "ORDER_FEE_ERROR";
     CheckoutErrorType["ITEM_REQUIREMENTS_ERROR"] = "ITEM_REQUIREMENTS_ERROR";
     CheckoutErrorType["API_ERROR"] = "API_ERROR";
+    CheckoutErrorType["ORDER_EXPIRED_ERROR"] = "ORDER_EXPIRED_ERROR";
 })($a8bc256d81a5e2c1$export$e3dc0620abde7f5a || ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a = {}));
 class $a8bc256d81a5e2c1$export$b722478a3cbfa3bc extends Error {
     message;
@@ -30178,44 +30187,53 @@ const $1564e43dde50bb61$export$8c978679845804d4 = async (walletAddress, chainId,
     // Hold the items in an array for post-fetching processing
     const items = [];
     const tokenType = ($887a00f8f72d61f0$export$5bd1ea2b3d18210).ERC20;
-    // Given that the widgets aren't yet designed to support pagination,
-    // fetch all the possible tokens associated to a given wallet address.
-    let resp;
-    try {
-        do {
-            // eslint-disable-next-line no-await-in-loop
-            resp = await blockscoutClient.getTokensByWalletAddress({
-                walletAddress: walletAddress,
-                tokenType: tokenType,
-                nextPage: resp?.next_page_params
+    const erc20Balances = async (client)=>{
+        // Given that the widgets aren't yet designed to support pagination,
+        // fetch all the possible tokens associated to a given wallet address.
+        let resp;
+        try {
+            do {
+                // eslint-disable-next-line no-await-in-loop
+                resp = await client.getTokensByWalletAddress({
+                    walletAddress: walletAddress,
+                    tokenType: tokenType,
+                    nextPage: resp?.next_page_params
+                });
+                items.push(...resp.items);
+            }while (resp.next_page_params);
+        } catch (err) {
+            // In case of a 404, the wallet is a new wallet that hasn't been indexed by
+            // the Blockscout just yet. This happens when a wallet hasn't had any
+            // activity on the chain. In this case, simply ignore the error and return
+            // no currencies.
+            // In case of a malformed wallet address, Blockscout returns a 422, which
+            // 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 ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getTokensByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
+        }
+    };
+    const nativeBalances = async (client)=>{
+        try {
+            const respNative = await client.getNativeTokenByWalletAddress({
+                walletAddress: walletAddress
             });
-            items.push(...resp.items);
-        }while (resp.next_page_params);
-    } catch (err) {
-        // In case of a 404, the wallet is a new wallet that hasn't been indexed by
-        // the Blockscout just yet. This happens when a wallet hasn't had any
-        // activity on the chain. In this case, simply ignore the error and return
-        // no currencies.
-        // In case of a malformed wallet address, Blockscout returns a 422, which
-        // 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 ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getTokensByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
-    }
-    try {
-        const respNative = await blockscoutClient.getNativeTokenByWalletAddress({
-            walletAddress: walletAddress
-        });
-        items.push(respNative);
-    } catch (err) {
-        // In case of a 404, the wallet is a new wallet that hasn't been indexed by
-        // the Blockscout just yet. This happens when a wallet hasn't had any
-        // activity on the chain. In this case, simply ignore the error and return
-        // no currencies.
-        // In case of a malformed wallet address, Blockscout returns a 422, which
-        // 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 ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getNativeTokenByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
-    }
+            items.push(respNative);
+        } catch (err) {
+            // In case of a 404, the wallet is a new wallet that hasn't been indexed by
+            // the Blockscout just yet. This happens when a wallet hasn't had any
+            // activity on the chain. In this case, simply ignore the error and return
+            // no currencies.
+            // In case of a malformed wallet address, Blockscout returns a 422, which
+            // 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 ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)(err.message || "InternalServerError | getNativeTokenByWalletAddress", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).GET_INDEXER_BALANCE_ERROR, err);
+        }
+    };
+    // Promise all() rather than allSettled() so that the function can fail fast.
+    await Promise.all([
+        erc20Balances(blockscoutClient),
+        nativeBalances(blockscoutClient)
+    ]);
     const balances = [];
     items.forEach((item)=>{
         if (shouldFilter && !mapFilterTokens[item.token.address]) return;
@@ -32735,16 +32753,24 @@ const $64863c39386de592$export$7f8e2b98eca5a7f0 = async (config, provider, order
     let unsignedApprovalTransactions = [];
     let unsignedFulfillmentTransactions = [];
     let orderActions = [];
-    const fulfillOrderStartTime = new Date().getTime();
+    const fulfillOrderStartTime = performance.now();
     try {
         const fulfillerAddress = await (0, $458d407830d66110$export$5280dbcb91c8b391)(config, "Time to get the address from the provider", provider.getSigner().getAddress());
         const { actions: actions } = await (0, $458d407830d66110$export$5280dbcb91c8b391)(config, "Time to call fulfillOrder from the orderbook", orderbook.fulfillOrder(id, fulfillerAddress, fees));
         orderActions = actions;
         unsignedApprovalTransactions = await (0, $458d407830d66110$export$5280dbcb91c8b391)(config, "Time to construct the unsigned approval transactions", (0, $a7367d01c6e76b1c$export$f64a20a30eb98855)(actions));
     } catch (err) {
-        // Silently ignore error as this is usually thrown if user does not have enough balance
-        const elapsedTimeInSeconds = (new Date().getTime() - fulfillOrderStartTime) / 1000;
+        const elapsedTimeInSeconds = (performance.now() - fulfillOrderStartTime) / 1000;
         ($458d407830d66110$export$e6a390ea6399b7d8)(config, "Time to call fulfillOrder from the orderbook", elapsedTimeInSeconds);
+        if (err.message.includes((OrderStatusName).EXPIRED)) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("Order is expired", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).ORDER_EXPIRED_ERROR, {
+            orderId: id
+        });
+        // The balances error will be handled by bulk order fulfillment but for now we
+        // need to assert on this string to check that the error is not a balances error
+        if (!err.message.includes("The fulfiller does not have the balances needed to fulfill")) throw new ($a8bc256d81a5e2c1$export$b722478a3cbfa3bc)("Error occurred while trying to fulfill the order", ($a8bc256d81a5e2c1$export$e3dc0620abde7f5a).FULFILL_ORDER_LISTING_ERROR, {
+            orderId: id,
+            message: err.message
+        });
     }
     try {
         unsignedFulfillmentTransactions = await (0, $458d407830d66110$export$5280dbcb91c8b391)(config, "Time to construct the unsigned fulfillment transactions", (0, $a7367d01c6e76b1c$export$396bd6ce7d3ab533)(orderActions));
@@ -33329,7 +33355,7 @@ var $045213b18e9f1f94$export$75be0f6af9650f2c;
 })($045213b18e9f1f94$export$75be0f6af9650f2c || ($045213b18e9f1f94$export$75be0f6af9650f2c = {}));
 
 
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.27.12";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.27.14";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/index.d.ts

@@ -16406,7 +16406,7 @@ type ERC20BuyToken = {
     contractAddress: string;
 };
 /**
- * Interface of the SellToken
+ * The SellToken type
  * @property {string} id - The ERC721 token id
  * @property {string} collectionAddress - The ERC721 collection address
  */
@@ -16737,9 +16737,9 @@ type UserBalance = {
  * Represents the transaction requirement for a transaction.
  * @property {ItemType} type - The type of the transaction requirement.
  * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
- * @property {TransactionRequirementItem} required - The required item balance.
- * @property {TransactionRequirementItem} current - The current item balance.
- * @property {TransactionRequirementDelta} delta - The delta between the required and current balances.
+ * @property {ItemBalance} required - The required item balance.
+ * @property {ItemBalance} current - The current item balance.
+ * @property {BalanceDelta} delta - The delta between the required and current balances.
  */
 type TransactionRequirement = {
     type: ItemType;
@@ -16750,6 +16750,7 @@ type TransactionRequirement = {
 };
 /**
  * Represents the balance for either a native or ERC20 token.
+ * @property {ItemType.NATIVE | ItemType.ERC20} type - Type to indicate this is a native or ERC20 token.
  * @property {BigNumber} balance - The balance of the item.
  * @property {string} formattedBalance - The formatted balance of the item.
  * @property {TokenInfo} token - The token info of the item.
@@ -16761,18 +16762,20 @@ type TokenBalance = {
     token: TokenInfo;
 };
 /**
- * Represents the balance for an ERC20.
+ * Represents the balance for an ERC721.
+ * @property {ItemType.ERC721} type - Type to indicate this is an ERC721 token.
  * @property {BigNumber} balance - The balance of the item.
  * @property {string} formattedBalance - The formatted balance of the item.
- * @property {TokenInfo} token - The token info of the item.
+ * @property {string} contractAddress - The contract address of the ERC721 collection.
+ * @property {string} id - The ID of the ERC721 in the collection.
  */
-interface ERC721Balance {
+type ERC721Balance = {
     type: ItemType.ERC721;
     balance: BigNumber;
     formattedBalance: string;
     contractAddress: string;
     id: string;
-}
+};
 /**
  * Type representing the balance of an item.
  */
@@ -16789,6 +16792,9 @@ type BalanceDelta = {
 /**
  * A type representing the Smart Checkout routing options available for a user
  * if they are configured and enabled (not geo-blocked etc.)
+ * @property {boolean | undefined} onRamp - If the user can use onramp
+ * @property {boolean | undefined} swap - If the user can use swap
+ * @property {boolean | undefined} bridge - If the user can use bridge
  */
 type AvailableRoutingOptions = {
     onRamp?: boolean;
@@ -17311,7 +17317,8 @@ declare enum CheckoutErrorType {
     BRIDGE_GAS_ESTIMATE_ERROR = "BRIDGE_GAS_ESTIMATE_ERROR",
     ORDER_FEE_ERROR = "ORDER_FEE_ERROR",
     ITEM_REQUIREMENTS_ERROR = "ITEM_REQUIREMENTS_ERROR",
-    API_ERROR = "API_ERROR"
+    API_ERROR = "API_ERROR",
+    ORDER_EXPIRED_ERROR = "ORDER_EXPIRED_ERROR"
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.