@imtbl/sdk 0.41.0-alpha → 0.41.2

package/dist/checkout.d.ts

@@ -11451,6 +11451,16 @@ type ExchangeContracts = {
     swapRouter: string;
     immutableSwapProxy: string;
 };
+/**
+ * Type representing the secondary fees for a swap
+ * @property {string} recipient - The fee recipient address
+ * @property {number} basisPoints - The fee percentage in basis points
+ * @example 100 basis points = 1%
+ */
+type SecondaryFee = {
+    recipient: string;
+    basisPoints: number;
+};
 /**
  * Type representing an ERC20 token
  * @property {string} type - The token type, used to discriminate between {@link ERC20} and {@link Native}
@@ -11610,6 +11620,8 @@ type DexConfig = {
     overrides?: ExchangeOverrides;
     /** An array of tokens compatible with the DEX. */
     tokens?: TokenInfo[];
+    /** An array of secondary fees to be applied to swaps */
+    secondaryFees?: SecondaryFee[];
 };
 /**
  * A type representing the configuration for the Bridge for all the supported chains.

package/dist/checkout.js

@@ -25851,7 +25851,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.41.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.41.2',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -27201,7 +27201,7 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.41.0-alpha';
+const SDK_VERSION_MARKER = '0.41.2';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -27348,6 +27348,8 @@ class CheckoutConfiguration {
     }
 }
 
+const isMatchingAddress = (addressA = '', addressB = '') => (addressA.toLowerCase() === addressB.toLowerCase());
+
 const getTokenAllowList = async (config, { type = TokenFilterTypes.ALL, chainId, exclude, }) => {
     let tokens = [];
     let onRampConfig;
@@ -27383,7 +27385,7 @@ const getTokenAllowList = async (config, { type = TokenFilterTypes.ALL, chainId,
         tokens: tokens.filter((token) => !exclude.map((e) => e.address).includes(token.address || '')),
     };
 };
-const isNativeToken = (address) => !address || address.toLocaleLowerCase() === NATIVE;
+const isNativeToken = (address) => !address || isMatchingAddress(address, NATIVE);
 async function getERC20TokenInfo(web3Provider, tokenAddress) {
     return await withCheckoutError(async () => {
         const contract = new Contract$1(tokenAddress, JSON.stringify(ERC20ABI), web3Provider);
@@ -27673,7 +27675,7 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
         // For some reason isNativeToken always returns undefined.
         // We have spent way too much time figuring out why this is happening.
         // That we have given up -- keep it as it is for now.
-        if (!token.address || token.address.toLocaleLowerCase() === NATIVE) {
+        if (!token.address || isMatchingAddress(token.address, NATIVE)) {
             allBalancePromises.push(getBalance(config, web3Provider, walletAddress));
         }
         else {
@@ -27687,7 +27689,7 @@ const getBalances = async (config, web3Provider, walletAddress, tokens) => {
         // For some reason isNativeToken always returns undefined.
         // We have spent way too much time figuring out why this is happening.
         // That we have given up -- keep it as it is for now.
-        if (!token.address || token.address.toLocaleLowerCase() === NATIVE)
+        if (!token.address || isMatchingAddress(token.address, NATIVE))
             resp.value.token.address = NATIVE;
         return resp.value;
     });
@@ -27950,6 +27952,7 @@ async function createExchangeInstance(chainId, config) {
             environment: config.environment,
         }),
         overrides: dexConfig?.overrides,
+        secondaryFees: dexConfig?.secondaryFees,
     });
 }
 function createOrderbookInstance(config) {
@@ -28449,7 +28452,7 @@ const getERC721BalanceRequirement = (itemRequirement, balances) => {
     // Find the requirements related balance
     const itemBalanceResult = balances.find((balance) => {
         const balanceERC721Result = balance;
-        return balanceERC721Result.contractAddress === itemRequirement.contractAddress
+        return isMatchingAddress(balanceERC721Result.contractAddress, itemRequirement.contractAddress)
             && balanceERC721Result.id === itemRequirement.id;
     });
     // Calculate the balance delta
@@ -28489,7 +28492,7 @@ const getTokenBalanceRequirement = (itemRequirement, balances) => {
     // Get the requirements related balance
     if (itemRequirement.type === ItemType.ERC20) {
         itemBalanceResult = balances.find((balance) => {
-            return balance.token?.address === itemRequirement.tokenAddress;
+            return isMatchingAddress(balance.token?.address, itemRequirement.tokenAddress);
         });
     }
     else if (itemRequirement.type === ItemType.NATIVE) {
@@ -28611,7 +28614,7 @@ const getERC721Balances = async (provider, ownerAddress, itemRequirements) => {
         erc721Owners.forEach((erc721OwnerAddress, index) => {
             const itemRequirement = erc721s.get(erc721OwnersPromiseIds[index]);
             let itemCount = 0;
-            if (itemRequirement && ownerAddress === erc721OwnerAddress) {
+            if (itemRequirement && isMatchingAddress(ownerAddress, erc721OwnerAddress)) {
                 itemCount = 1;
             }
             erc721Balances.push({
@@ -29051,7 +29054,7 @@ const checkUserCanCoverApprovalFees = (l2Balances, approval) => {
     }
     // Find the users balance of the approval token
     const l2BalanceOfApprovalToken = l2Balances.find((balance) => (isNativeToken(balance.token.address) && isNativeToken(approvalGasTokenAddress))
-        || balance.token.address === approvalGasTokenAddress);
+        || isMatchingAddress(balance.token.address, approvalGasTokenAddress));
     if (!l2BalanceOfApprovalToken)
         return { sufficient: false, approvalGasFee, approvalGasTokenAddress };
     // If the user does not have enough of the token to cover approval fees then return sufficient false
@@ -29106,7 +29109,7 @@ const checkUserCanCoverSwapFees = (l2Balances, approvalFees, swapGasFee, swapFee
         if (fee === BigNumber$1.from(0))
             continue;
         const l2BalanceOfFeeToken = l2Balances.find((balance) => (isNativeToken(balance.token.address) && isNativeToken(tokenAddress))
-            || balance.token.address === tokenAddress);
+            || isMatchingAddress(balance.token.address, tokenAddress));
         if (!l2BalanceOfFeeToken) {
             return false;
         }
@@ -29127,7 +29130,8 @@ const checkIfUserCanCoverRequirement = (l2balance, balanceRequirements, quoteTok
     let requirementExists = false;
     balanceRequirements.balanceRequirements.forEach((requirement) => {
         if (requirement.type === ItemType.NATIVE || requirement.type === ItemType.ERC20) {
-            if (requirement.required.token.address === quoteTokenAddress) {
+            if (requirement.required.token.address
+                && isMatchingAddress(requirement.required.token.address, quoteTokenAddress)) {
                 balanceRequirementToken = requirement.required.token.address;
                 requirementExists = true;
                 // Get the balance that would remain if the requirement was removed from the users balance
@@ -29139,12 +29143,12 @@ const checkIfUserCanCoverRequirement = (l2balance, balanceRequirements, quoteTok
     if (!requirementExists)
         return true;
     // Remove approval fees from the remainder if token matches as these need to be taken out to cover the swap
-    if (approvalFees.approvalGasTokenAddress === balanceRequirementToken) {
+    if (isMatchingAddress(approvalFees.approvalGasTokenAddress, balanceRequirementToken)) {
         remainingBalance = remainingBalance.sub(approvalFees.approvalGasFee);
     }
     // Remove swap fees from the remainder if token matches as these need to be taken out to cover the swap
     for (const swapFee of swapFees) {
-        if (swapFee.amount.token.address === balanceRequirementToken) {
+        if (isMatchingAddress(swapFee.amount.token.address, balanceRequirementToken)) {
             remainingBalance = remainingBalance.sub(swapFee.amount.value);
         }
     }
@@ -29175,7 +29179,7 @@ const swapRoute = async (config, availableRoutingOptions, walletAddress, balance
         if (!quote)
             continue;
         // Find the balance the user has for this quoted token
-        const userBalanceOfQuotedToken = l2Balances.find((balance) => balance.token.address === quoteTokenAddress);
+        const userBalanceOfQuotedToken = l2Balances.find((balance) => isMatchingAddress(balance.token.address, quoteTokenAddress));
         // If no balance found on L2 for this quoted token then continue
         if (!userBalanceOfQuotedToken)
             continue;
@@ -29208,7 +29212,8 @@ const filterTokens = (allowedTokens, balances) => {
     if (balances && balances.success) {
         return allowedTokens.filter((token) => {
             if ('address' in token) {
-                return balances.balances.find((balance) => balance.token.address === token.address && balance.balance.gt(0));
+                return balances.balances.find((balance) => isMatchingAddress(balance.token.address, token.address)
+                    && balance.balance.gt(0));
             }
             return balances.balances.find((balance) => !('address' in balance.token) && balance.balance.gt(0));
         });
@@ -29308,9 +29313,8 @@ const fetchL1Representation = async (config, l2address) => {
         chainName,
         contractAddress: l2address,
     });
-    // TODO: When bridge is ready we need to understand how L2 ETH will be mapped back to L1 ETH
     const l1address = tokenData.result.root_contract_address;
-    if (l1address === INDEXER_ETH_ROOT_CONTRACT_ADDRESS) {
+    if (isMatchingAddress(l1address ?? '', INDEXER_ETH_ROOT_CONTRACT_ADDRESS)) {
         return {
             l1address: 'native',
             l2address,
@@ -29412,7 +29416,7 @@ const bridgeRoute = async (config, readOnlyProviders, availableRoutingOptions, b
         if (!allowedL1TokenList.find((token) => isNativeToken(token.address)))
             return undefined;
     }
-    else if (!allowedL1TokenList.find((token) => token.address === l1address)) {
+    else if (!allowedL1TokenList.find((token) => isMatchingAddress(token.address, l1address))) {
         return undefined;
     }
     const feesFromBridge = await getBridgeFeeEstimate(config, readOnlyProviders, l1ChainId, l2ChainId);
@@ -29431,7 +29435,7 @@ const bridgeRoute = async (config, readOnlyProviders, availableRoutingOptions, b
         return undefined;
     }
     // Find the balance of the L1 representation of the token and check if the balance covers the delta
-    const erc20balance = tokenBalanceResult.balances.find((balance) => balance.token.address === l1address);
+    const erc20balance = tokenBalanceResult.balances.find((balance) => isMatchingAddress(balance.token.address, l1address));
     if (erc20balance && erc20balance.balance.gte(bridgeRequirement.amount)) {
         const bridgeFees = constructFees(sourceChainGas, bridgeFee, imtblFee, approvalGas, nativeToken);
         return constructBridgeFundingRoute(l1ChainId, erc20balance, bridgeRequirement, ItemType.ERC20, bridgeFees);
@@ -29469,12 +29473,12 @@ const getBalancesByChain = (config, tokenBalances) => {
 const getFeesForTokenAddress = (dexQuote, tokenAddress) => {
     let fees = BigNumber$1.from(0);
     dexQuote.quote.fees.forEach((fee) => {
-        if (fee.amount.token.address === tokenAddress) {
+        if (isMatchingAddress(fee.amount.token.address, tokenAddress)) {
             fees = fees.add(fee.amount.value);
         }
     });
     if (dexQuote.approval) {
-        if (dexQuote.approval.token.address === tokenAddress) {
+        if (isMatchingAddress(dexQuote.approval.token.address, tokenAddress)) {
             fees = fees.add(dexQuote.approval.value);
         }
     }
@@ -29487,7 +29491,7 @@ const getAmountFromBalanceRequirement = (balanceRequirements, quotedTokenAddress
     // Find if there is an existing balance requirement of the token attempting to be bridged->swapped
     for (const requirement of balanceRequirements.balanceRequirements) {
         if (requirement.type === ItemType.NATIVE || requirement.type === ItemType.ERC20) {
-            if (requirement.required.token.address === quotedTokenAddress) {
+            if (isMatchingAddress(requirement.required.token.address, quotedTokenAddress)) {
                 return requirement.required.balance;
             }
         }
@@ -29525,8 +29529,8 @@ const constructBridgeRequirements = (dexQuotes, l1balances, l2balances, l1tol2ad
     const bridgeRequirements = [];
     for (const [tokenAddress, quote] of dexQuotes) {
         // Get the L2 balance for the token address
-        const l2balance = l2balances.find((balance) => balance.token.address === tokenAddress);
-        const l1tol2TokenMapping = l1tol2addresses.find((token) => token.l2address === tokenAddress);
+        const l2balance = l2balances.find((balance) => isMatchingAddress(balance.token.address, tokenAddress));
+        const l1tol2TokenMapping = l1tol2addresses.find((token) => isMatchingAddress(token.l2address, tokenAddress));
         if (!l1tol2TokenMapping)
             continue;
         const { l1address, l2address } = l1tol2TokenMapping;
@@ -29535,10 +29539,10 @@ const constructBridgeRequirements = (dexQuotes, l1balances, l2balances, l1tol2ad
         // If the user does not have any L1 balance for this token then cannot bridge
         const l1balance = l1balances.find((balance) => {
             if (balance.token.address === undefined
-                && l1address === INDEXER_ETH_ROOT_CONTRACT_ADDRESS) {
+                && isMatchingAddress(l1address, INDEXER_ETH_ROOT_CONTRACT_ADDRESS)) {
                 return true;
             }
-            return balance.token.address === l1address;
+            return isMatchingAddress(balance.token.address, l1address);
         });
         if (!l1balance)
             continue;
@@ -29618,9 +29622,9 @@ const filterSwappableTokensByBridgeableAddresses = (requiredTokenAddress, bridge
         if (!bridgeableTokens.includes(addresses.l1address))
             continue;
         // Filter out the token that is required from the swappable tokens list
-        if (addresses.l2address === requiredTokenAddress)
+        if (isMatchingAddress(addresses.l2address, requiredTokenAddress))
             continue;
-        const tokenInfo = swappableTokens.find((token) => token.address === addresses.l2address);
+        const tokenInfo = swappableTokens.find((token) => isMatchingAddress(token.address, addresses.l2address));
         if (!tokenInfo)
             continue;
         filteredSwappableTokens.push(tokenInfo);
@@ -29657,7 +29661,7 @@ const modifyTokenBalancesWithBridgedAmount = (config, tokenBalances, l2balances,
         if (currentBalance)
             l2balance = currentBalance.balance;
         const newBalance = l2balance.add(amount);
-        const tokenInfo = swappableTokens.find((token) => token.address === l2address);
+        const tokenInfo = swappableTokens.find((token) => isMatchingAddress(token.address, l2address));
         balanceMap.set(l2address, {
             balance: newBalance,
             formattedBalance: utils$2.formatUnits(newBalance, tokenInfo.decimals),
@@ -29683,7 +29687,7 @@ const reapplyOriginalSwapBalances = (tokenBalances, swapRoutes) => {
             continue;
         let originalBalance = BigNumber$1.from(0);
         let originalFormattedBalance = '0';
-        const l2balance = tokenBalance.balances.find((balance) => balance.token.address === fundingItem.token.address);
+        const l2balance = tokenBalance.balances.find((balance) => isMatchingAddress(balance.token.address, fundingItem.token.address));
         if (l2balance) {
             originalBalance = l2balance.balance;
             originalFormattedBalance = l2balance.formattedBalance;
@@ -29701,13 +29705,14 @@ const constructBridgeAndSwapRoutes = (bridgeFundingSteps, swapFundingSteps, l1to
             continue;
         const mapping = l1tol2Addresses.find((addresses) => {
             if (bridgeFundingStep.fundingItem.token.address === undefined) {
-                return addresses.l1address === INDEXER_ETH_ROOT_CONTRACT_ADDRESS && addresses.l2address;
+                return isMatchingAddress(addresses.l1address, INDEXER_ETH_ROOT_CONTRACT_ADDRESS) && addresses.l2address;
             }
-            return addresses.l1address === bridgeFundingStep.fundingItem.token.address && addresses.l2address;
+            return (isMatchingAddress(addresses.l1address, bridgeFundingStep.fundingItem.token.address)
+                && addresses.l2address);
         });
         if (!mapping)
             continue;
-        const swapFundingStep = swapFundingSteps.find((step) => step.fundingItem.token.address === mapping.l2address);
+        const swapFundingStep = swapFundingSteps.find((step) => isMatchingAddress(step.fundingItem.token.address, mapping.l2address));
         if (!swapFundingStep)
             continue;
         bridgeAndSwapRoutes.push({
@@ -29799,7 +29804,7 @@ const onRampRoute = async (config, availableRoutingOptions, balanceRequirement)
         if (!required.token)
             return;
         if (isNativeToken(required.token.address)
-            || token.address.toLowerCase() === required.token.address?.toLowerCase()) {
+            || isMatchingAddress(token.address, required.token.address)) {
             hasAllowList = true;
         }
     });
@@ -31046,7 +31051,7 @@ class Checkout {
             email = userInfo?.email;
         }
         const tokenList = await getTokenAllowList(this.config, { type: TokenFilterTypes.ONRAMP });
-        const token = tokenList.tokens?.find((t) => t.address?.toLowerCase() === params.tokenAddress?.toLowerCase());
+        const token = tokenList.tokens?.find((t) => isMatchingAddress(t.address, params.tokenAddress));
         if (token) {
             tokenAmount = params.tokenAmount;
             tokenSymbol = token.symbol;

package/dist/immutablex_client.js

@@ -17,7 +17,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.41.0-alpha',
+    sdkVersion: 'ts-immutable-sdk-0.41.2',
 });
 /**
  * Sets `sdkVersion` at the time of build