@imtbl/sdk 0.36.5 → 0.37.0

package/dist/index.js

@@ -4234,7 +4234,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.36.5' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.37.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -4294,7 +4294,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.36.5',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.37.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4733,7 +4733,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.5',
+    sdkVersion: 'ts-immutable-sdk-0.37.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -12232,13 +12232,13 @@ var ProtocolData;
     })(ProtocolData.order_type || (ProtocolData.order_type = {}));
 })(ProtocolData || (ProtocolData = {}));
 
-var FeeType;
+var FeeType$1;
 (function (FeeType) {
     FeeType["MAKER_ECOSYSTEM"] = "MAKER_ECOSYSTEM";
     FeeType["TAKER_ECOSYSTEM"] = "TAKER_ECOSYSTEM";
     FeeType["PROTOCOL"] = "PROTOCOL";
     FeeType["ROYALTY"] = "ROYALTY";
-})(FeeType || (FeeType = {}));
+})(FeeType$1 || (FeeType$1 = {}));
 var TransactionPurpose;
 (function (TransactionPurpose) {
     TransactionPurpose["APPROVAL"] = "APPROVAL";
@@ -12800,7 +12800,7 @@ class ImmutableApiClient {
                 ],
                 fees: makerFees.map((x) => ({
                     amount: x.amount,
-                    type: FeeType.MAKER_ECOSYSTEM,
+                    type: FeeType$1.MAKER_ECOSYSTEM,
                     recipient_address: x.recipientAddress,
                 })),
                 end_at: new Date(parseInt(`${orderComponents.endTime.toString()}000`, 10)).toISOString(),
@@ -13014,7 +13014,7 @@ class Orderbook {
                 order_id: listingId,
                 fees: takerFees.map((fee) => ({
                     amount: fee.amount,
-                    type: FeeType.TAKER_ECOSYSTEM,
+                    type: FeeType$1.TAKER_ECOSYSTEM,
                     recipient_address: fee.recipientAddress,
                 })),
             },
@@ -13037,7 +13037,7 @@ class Orderbook {
             order_id: listingRequest.listingId,
             fees: listingRequest.takerFees.map((fee) => ({
                 amount: fee.amount,
-                type: FeeType.TAKER_ECOSYSTEM,
+                type: FeeType$1.TAKER_ECOSYSTEM,
                 recipient_address: fee.recipientAddress,
             })),
         })));
@@ -13168,7 +13168,7 @@ const constants = {
 var orderbook = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get ActionType () { return ActionType; },
-    get FeeType () { return FeeType; },
+    get FeeType () { return FeeType$1; },
     get OrderStatusName () { return OrderStatusName; },
     Orderbook: Orderbook,
     get SignablePurpose () { return SignablePurpose; },
@@ -35053,6 +35053,21 @@ var RoutingOutcomeType;
     RoutingOutcomeType["NO_ROUTES_FOUND"] = "NO_ROUTES_FOUND";
     RoutingOutcomeType["NO_ROUTE_OPTIONS"] = "NO_ROUTE_OPTIONS";
 })(RoutingOutcomeType || (RoutingOutcomeType = {}));
+/**
+ * An enum representing the funding step types
+ * @enum {string}
+ * @property {string} GAS - If the fee is a gas fee.
+ * @property {string} BRIDGE_FEE - If the fee is a bridge fee.
+ * @property {string} SWAP_FEE - If the fee is a swap fee.
+ * @property {string} IMMUTABLE_FEE - If the fee is an immutable fee.
+ */
+var FeeType;
+(function (FeeType) {
+    FeeType["GAS"] = "GAS";
+    FeeType["BRIDGE_FEE"] = "BRIDGE_FEE";
+    FeeType["SWAP_FEE"] = "SWAP_FEE";
+    FeeType["IMMUTABLE_FEE"] = "IMMUTABLE_FEE";
+})(FeeType || (FeeType = {}));
 /**
  * An enum representing the funding step types
  * @enum {string}
@@ -35658,7 +35673,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.36.5';
+const SDK_VERSION_MARKER = '0.37.0';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -36552,8 +36567,8 @@ const erc20ItemAggregator = (itemRequirements) => {
             aggregatedItemRequirements.push(itemRequirement);
             return;
         }
-        const { contractAddress, spenderAddress, amount } = itemRequirement;
-        const key = `${contractAddress}${spenderAddress}`;
+        const { tokenAddress, spenderAddress, amount } = itemRequirement;
+        const key = `${tokenAddress}${spenderAddress}`;
         const aggregateItem = aggregatedMap.get(key);
         if (aggregateItem && aggregateItem.type === ItemType.ERC20) {
             aggregateItem.amount = BigNumber$1.from(aggregateItem.amount).add(amount);
@@ -36619,10 +36634,10 @@ const hasERC20Allowances = async (provider, ownerAddress, itemRequirements) => {
     for (const itemRequirement of itemRequirements) {
         if (itemRequirement.type !== ItemType.ERC20)
             continue;
-        const { contractAddress, spenderAddress } = itemRequirement;
-        const key = `${contractAddress}${spenderAddress}`;
+        const { tokenAddress, spenderAddress } = itemRequirement;
+        const key = `${tokenAddress}${spenderAddress}`;
         erc20s.set(key, itemRequirement);
-        allowancePromises.set(key, getERC20Allowance(provider, ownerAddress, contractAddress, spenderAddress));
+        allowancePromises.set(key, getERC20Allowance(provider, ownerAddress, tokenAddress, spenderAddress));
     }
     const allowances = await Promise.all(allowancePromises.values());
     const allowancePromiseIds = Array.from(allowancePromises.keys());
@@ -36641,8 +36656,8 @@ const hasERC20Allowances = async (provider, ownerAddress, itemRequirements) => {
             continue;
         }
         sufficient = false; // Set sufficient false on the root of the return object when an ERC20 is insufficient
-        const { contractAddress, spenderAddress } = itemRequirement;
-        const key = `${contractAddress}${spenderAddress}`;
+        const { tokenAddress, spenderAddress } = itemRequirement;
+        const key = `${tokenAddress}${spenderAddress}`;
         const delta = itemRequirement.amount.sub(allowances[index]);
         // Create maps for both the insufficient ERC20 data and the transaction promises using the same key so the results can be merged
         insufficientERC20s.set(key, {
@@ -36652,7 +36667,7 @@ const hasERC20Allowances = async (provider, ownerAddress, itemRequirements) => {
             itemRequirement,
             approvalTransaction: undefined,
         });
-        transactionPromises.set(key, getERC20ApprovalTransaction(provider, ownerAddress, contractAddress, spenderAddress, delta));
+        transactionPromises.set(key, getERC20ApprovalTransaction(provider, ownerAddress, tokenAddress, spenderAddress, delta));
     }
     // Resolves the approval transactions and merges them with the insufficient ERC20 data
     const transactions = await Promise.all(transactionPromises.values());
@@ -36837,8 +36852,8 @@ const erc20BalanceAggregator = (itemRequirements) => {
             aggregatedItemRequirements.push(itemRequirement);
             return;
         }
-        const { contractAddress, amount } = itemRequirement;
-        const key = `${contractAddress}`;
+        const { tokenAddress, amount } = itemRequirement;
+        const key = `${tokenAddress}`;
         const aggregateItem = aggregatedMap.get(key);
         if (aggregateItem && aggregateItem.type === ItemType.ERC20) {
             aggregateItem.amount = BigNumber$1.from(aggregateItem.amount).add(amount);
@@ -36871,14 +36886,21 @@ const balanceAggregator = (itemRequirements) => erc721BalanceAggregator(erc20Bal
 /* eslint-disable arrow-body-style */
 const getTokensFromRequirements = (itemRequirements) => itemRequirements
     .map((itemRequirement) => {
-    if (itemRequirement.type === ItemType.NATIVE) {
-        return {
-            address: NATIVE,
-        };
+    switch (itemRequirement.type) {
+        case ItemType.ERC20:
+            return {
+                address: itemRequirement.tokenAddress,
+            };
+        case ItemType.NATIVE:
+            return {
+                address: NATIVE,
+            };
+        case ItemType.ERC721:
+        default:
+            return {
+                address: itemRequirement.contractAddress,
+            };
     }
-    return {
-        address: itemRequirement.contractAddress,
-    };
 });
 /**
  * Gets the balance requirement with delta for an ERC721 requirement.
@@ -36928,7 +36950,7 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
     // Get the requirements related balance
     if (itemRequirement.type === ItemType.ERC20) {
         itemBalanceResult = balances.find((balance) => {
-            return balance.token?.address === itemRequirement.contractAddress;
+            return balance.token?.address === itemRequirement.tokenAddress;
         });
     }
     else if (itemRequirement.type === ItemType.NATIVE) {
@@ -36992,7 +37014,7 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
             token: {
                 name,
                 symbol,
-                address: itemRequirement.contractAddress,
+                address: itemRequirement.tokenAddress,
                 decimals,
             },
         };
@@ -37151,7 +37173,7 @@ const getGasItemRequirement = (gas, transactionOrGas) => {
     return {
         type: ItemType.ERC20,
         amount: gas,
-        contractAddress: transactionOrGas.gasToken.contractAddress,
+        tokenAddress: transactionOrGas.gasToken.tokenAddress,
         spenderAddress: '',
     };
 };
@@ -37374,36 +37396,37 @@ const quoteFetcher = async (config, chainId, walletAddress, requiredToken, swapp
     }
 };
 
-const constructFees$1 = (approvalGasFees, swapGasFees, swapFees) => {
+const constructFees$1 = (approvalGasFee, swapGasFee, swapFees) => {
     let approvalGasFeeAmount = BigNumber$1.from(0);
     let approvalGasFeeFormatted = '0';
     let approvalToken;
-    if (approvalGasFees) {
-        approvalGasFeeAmount = approvalGasFees.value;
-        approvalGasFeeFormatted = utils$2.formatUnits(approvalGasFees.value, approvalGasFees.token.decimals);
+    if (approvalGasFee) {
+        approvalGasFeeAmount = approvalGasFee.value;
+        approvalGasFeeFormatted = utils$2.formatUnits(approvalGasFee.value, approvalGasFee.token.decimals);
         approvalToken = {
-            name: approvalGasFees.token.name ?? '',
-            symbol: approvalGasFees.token.symbol ?? '',
-            address: approvalGasFees.token.address,
-            decimals: approvalGasFees.token.decimals,
+            name: approvalGasFee.token.name ?? '',
+            symbol: approvalGasFee.token.symbol ?? '',
+            address: approvalGasFee.token.address,
+            decimals: approvalGasFee.token.decimals,
         };
     }
     let swapGasFeeAmount = BigNumber$1.from(0);
     let swapGasFeeFormatted = '0';
     let swapGasToken;
-    if (swapGasFees) {
-        swapGasFeeAmount = swapGasFees.value;
-        swapGasFeeFormatted = utils$2.formatUnits(swapGasFees.value, swapGasFees.token.decimals);
+    if (swapGasFee) {
+        swapGasFeeAmount = swapGasFee.value;
+        swapGasFeeFormatted = utils$2.formatUnits(swapGasFee.value, swapGasFee.token.decimals);
         swapGasToken = {
-            name: swapGasFees.token.name ?? '',
-            symbol: swapGasFees.token.symbol ?? '',
-            address: swapGasFees.token.address,
-            decimals: swapGasFees.token.decimals,
+            name: swapGasFee.token.name ?? '',
+            symbol: swapGasFee.token.symbol ?? '',
+            address: swapGasFee.token.address,
+            decimals: swapGasFee.token.decimals,
         };
     }
     const fees = [];
     for (const swapFee of swapFees) {
         fees.push({
+            type: FeeType.SWAP_FEE,
             amount: swapFee.amount.value,
             formattedAmount: utils$2.formatUnits(swapFee.amount.value, swapFee.amount.token.decimals),
             token: {
@@ -37415,12 +37438,14 @@ const constructFees$1 = (approvalGasFees, swapGasFees, swapFees) => {
         });
     }
     return {
-        approvalGasFees: {
+        approvalGasFee: {
+            type: FeeType.GAS,
             amount: approvalGasFeeAmount,
             formattedAmount: approvalGasFeeFormatted,
             token: approvalToken,
         },
-        swapGasFees: {
+        swapGasFee: {
+            type: FeeType.GAS,
             amount: swapGasFeeAmount,
             formattedAmount: swapGasFeeFormatted,
             token: swapGasToken,
@@ -37505,7 +37530,7 @@ const checkUserCanCoverApprovalFees = (l2Balances, approval) => {
     // The user has enough to cover approval gas fees
     return { sufficient: true, approvalGasFee, approvalGasTokenAddress };
 };
-const checkUserCanCoverSwapFees = (l2Balances, approvalFees, swapGasFees, swapFees, tokenBeingSwapped) => {
+const checkUserCanCoverSwapFees = (l2Balances, approvalFees, swapGasFee, swapFees, tokenBeingSwapped) => {
     // Set up a map of token addresses to amounts for each of the swap fees
     const feeMap = new Map();
     // Add the approval fee to list of fees
@@ -37513,13 +37538,13 @@ const checkUserCanCoverSwapFees = (l2Balances, approvalFees, swapGasFees, swapFe
         feeMap.set(approvalFees.approvalGasTokenAddress, approvalFees.approvalGasFee);
     }
     // Add the swap gas fee to list of fees
-    if (swapGasFees) {
-        const fee = feeMap.get(swapGasFees.token.address);
+    if (swapGasFee) {
+        const fee = feeMap.get(swapGasFee.token.address);
         if (fee) {
-            feeMap.set(swapGasFees.token.address, fee.add(swapGasFees.value));
+            feeMap.set(swapGasFee.token.address, fee.add(swapGasFee.value));
         }
         else {
-            feeMap.set(swapGasFees.token.address, swapGasFees.value);
+            feeMap.set(swapGasFee.token.address, swapGasFee.value);
         }
     }
     // Add the token being swapped to list of fees to ensure the user can cover the fee + the token swap
@@ -37773,31 +37798,39 @@ const hasSufficientL1Eth = (tokenBalanceResult, totalFees) => {
     const balance = getEthBalance(tokenBalanceResult);
     return balance.gte(totalFees);
 };
-const constructFees = (bridgeGasFees, bridgeFee, imtblFee, approvalGasFees, token) => {
+const constructFees = (bridgeGasFee, bridgeFee, imtblFee, approvalGasFee, token) => {
     const bridgeFeeDecimals = token?.decimals ?? DEFAULT_TOKEN_DECIMALS$1;
+    const bridgeFees = [];
+    if (bridgeFee.gt(0)) {
+        bridgeFees.push({
+            type: FeeType.BRIDGE_FEE,
+            amount: bridgeFee,
+            formattedAmount: utils$2.formatUnits(bridgeFee, bridgeFeeDecimals),
+            token,
+        });
+    }
+    if (imtblFee.gt(0)) {
+        bridgeFees.push({
+            type: FeeType.IMMUTABLE_FEE,
+            amount: imtblFee,
+            formattedAmount: utils$2.formatUnits(imtblFee, bridgeFeeDecimals),
+            token,
+        });
+    }
     return {
-        approvalGasFees: {
-            amount: approvalGasFees,
-            formattedAmount: utils$2.formatUnits(approvalGasFees, DEFAULT_TOKEN_DECIMALS$1),
+        approvalGasFee: {
+            type: FeeType.GAS,
+            amount: approvalGasFee,
+            formattedAmount: utils$2.formatUnits(approvalGasFee, DEFAULT_TOKEN_DECIMALS$1),
             token,
         },
-        bridgeGasFees: {
-            amount: bridgeGasFees,
-            formattedAmount: utils$2.formatUnits(bridgeGasFees, DEFAULT_TOKEN_DECIMALS$1),
+        bridgeGasFee: {
+            type: FeeType.GAS,
+            amount: bridgeGasFee,
+            formattedAmount: utils$2.formatUnits(bridgeGasFee, DEFAULT_TOKEN_DECIMALS$1),
             token,
         },
-        bridgeFees: [
-            {
-                amount: bridgeFee,
-                formattedAmount: utils$2.formatUnits(bridgeFee, bridgeFeeDecimals),
-                token,
-            },
-            {
-                amount: imtblFee,
-                formattedAmount: utils$2.formatUnits(imtblFee, bridgeFeeDecimals),
-                token,
-            },
-        ],
+        bridgeFees,
     };
 };
 const constructBridgeFundingRoute = (chainId, balance, bridgeRequirement, itemType, fees) => ({
@@ -38656,13 +38689,13 @@ const calculateFees = (orderFees, weiAmount, decimals = 18) => {
     return calculateFeesResult;
 };
 
-const getItemRequirement = (type, contractAddress, amount, spenderAddress) => {
+const getItemRequirement = (type, tokenAddress, amount, spenderAddress) => {
     switch (type) {
         case ItemType.ERC20:
             return {
                 type,
                 amount,
-                contractAddress,
+                tokenAddress,
                 spenderAddress,
             };
         case ItemType.NATIVE:
@@ -38885,7 +38918,7 @@ const getBuyToken = (buyToken, decimals = 18) => {
     return {
         type: ItemType.ERC20,
         amount: bnAmount.toString(),
-        contractAddress: buyToken.contractAddress,
+        contractAddress: buyToken.tokenAddress,
     };
 };
 const sell = async (config, provider, orders) => {
@@ -38899,7 +38932,7 @@ const sell = async (config, provider, orders) => {
     let decimals = 18;
     if (buyToken.type === ItemType.ERC20) {
         // get this from the allowed list
-        const buyTokenContract = new Contract$1(buyToken.contractAddress, JSON.stringify(ERC20ABI), provider);
+        const buyTokenContract = new Contract$1(buyToken.tokenAddress, JSON.stringify(ERC20ABI), provider);
         decimals = await measureAsyncExecution(config, 'Time to get decimals of token contract for the buy token', buyTokenContract.decimals());
     }
     const buyTokenOrNative = getBuyToken(buyToken, decimals);
@@ -39051,8 +39084,8 @@ async function getItemRequirementsFromRequirements(provider, requirements) {
     const decimalPromises = [];
     requirements.forEach((itemRequirementParam) => {
         if (itemRequirementParam.type === ItemType.ERC20) {
-            const { contractAddress } = itemRequirementParam;
-            decimalPromises.push(getTokenContract(contractAddress, ERC20ABI, provider).decimals());
+            const { tokenAddress } = itemRequirementParam;
+            decimalPromises.push(getTokenContract(tokenAddress, ERC20ABI, provider).decimals());
         }
     });
     const decimals = await Promise.all(decimalPromises);
@@ -39367,7 +39400,7 @@ class Checkout {
         try {
             itemRequirements = await getItemRequirementsFromRequirements(web3Provider, params.itemRequirements);
         }
-        catch {
+        catch (error) {
             throw new CheckoutError('Failed to map item requirements', CheckoutErrorType.ITEM_REQUIREMENTS_ERROR);
         }
         return await smartCheckout(this.config, web3Provider, itemRequirements, params.transactionOrGasAmount);
@@ -39448,6 +39481,7 @@ var checkout = /*#__PURE__*/Object.freeze({
     get ConnectEventType () { return ConnectEventType; },
     get ConnectTargetLayer () { return ConnectTargetLayer; },
     get ExchangeType () { return ExchangeType; },
+    get FeeType () { return FeeType; },
     get FundingStepType () { return FundingStepType; },
     get GasEstimateType () { return GasEstimateType; },
     get GasTokenType () { return GasTokenType; },

package/dist/passport.js

@@ -2349,7 +2349,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.36.5' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.37.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2405,7 +2405,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.36.5',
+    sdkVersion: 'ts-immutable-sdk-0.37.0',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.36.5",
+  "version": "0.37.0",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",