@imtbl/sdk 0.4.4-alpha.1 → 0.6.0-alpha

package/dist/checkout_sdk.d.ts

@@ -607,7 +607,7 @@ type FungibleToken = Address | 'NATIVE';
  */
 declare enum ChainId {
     IMTBL_ZKEVM_MAINNET = 13371,
-    IMTBL_ZKEVM_TESTNET = 13372,
+    IMTBL_ZKEVM_TESTNET = 13472,
     IMTBL_ZKEVM_DEVNET = 13433,
     ETHEREUM = 1,
     SEPOLIA = 11155111

package/dist/checkout_sdk.js

@@ -23,6 +23,63 @@ class ImmutableConfiguration {
     }
 }
 
+/**
+ * @constant {string} ETH_SEPOLIA_CHAIN_ID - The chain ID for the Ethereum Sepolia testnet (EIP-155 compatible format).
+ */
+const ETH_SEPOLIA_CHAIN_ID = '11155111';
+/**
+ * @constant {string} ETH_MAINNET_CHAIN_ID - The chain ID for the Ethereum mainnet (EIP-155 compatible format).
+ */
+const ETH_MAINNET_CHAIN_ID = '1';
+/**
+ * @constant {string} ZKEVM_DEVNET_CHAIN_ID - The chain ID for the zkEVM devnet (EIP-155 compatible format).
+ */
+const ZKEVM_DEVNET_CHAIN_ID = '13433';
+/**
+/**
+ * @constant {string} ZKEVM_TESTNET_CHAIN_ID - The chain ID for the zkEVM testnet (EIP-155 compatible format).
+ */
+const ZKEVM_TESTNET_CHAIN_ID = '13472';
+/**
+ * @constant {string} ZKEVM_MAINNET_CHAIN_ID - The chain ID for the zkEVM mainnet (EIP-155 compatible format).
+ */
+const ZKEVM_MAINNET_CHAIN_ID = '13371';
+/**
+ * @constant {string} L2_STATE_SENDER_ADDRESS - Address of bridge contract to the rootchain
+ */
+const L2_STATE_SENDER_ADDRESS = '0x0000000000000000000000000000000000001002';
+/**
+ * The constant value representing the native token in the token bridge context.
+ * The key is used to indicate the native token of a blockchain network (like Ether in Ethereum)
+ *  in methods that normally require a token address.
+ * @constant {string}
+ */
+const NATIVE_TOKEN_BRIDGE_KEY = '0x0000000000000000000000000000000000000001';
+/**
+ * @constant {BridgeInstance} ETH_SEPOLIA_TO_ZKEVM_DEVNET - A bridge instance configuration for bridging between
+ * the Ethereum Sepolia testnet and the zkEVM devnet.
+ */
+const ETH_SEPOLIA_TO_ZKEVM_DEVNET = {
+    rootChainID: ETH_SEPOLIA_CHAIN_ID,
+    childChainID: ZKEVM_DEVNET_CHAIN_ID,
+};
+/**
+ * @constant {BridgeInstance} ETH_SEPOLIA_TO_ZKEVM_TESTNET - A bridge instance configuration for bridging
+ * between the Ethereum Sepolia testnet and the zkEVM testnet.
+ */
+const ETH_SEPOLIA_TO_ZKEVM_TESTNET = {
+    rootChainID: ETH_SEPOLIA_CHAIN_ID,
+    childChainID: ZKEVM_TESTNET_CHAIN_ID,
+};
+/**
+ * @constant {BridgeInstance} ETH_MAINNET_TO_ZKEVM_MAINNET - A bridge instance configuration for bridging
+ * between the Ethereum mainnet and the zkEVM mainnet.
+ */
+const ETH_MAINNET_TO_ZKEVM_MAINNET = {
+    rootChainID: ETH_MAINNET_CHAIN_ID,
+    childChainID: ZKEVM_MAINNET_CHAIN_ID,
+};
+
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -10888,63 +10945,6 @@ function decodeExtraData(extraData) {
     return blockExtraData;
 }
 
-/**
- * @constant {string} ETH_SEPOLIA_CHAIN_ID - The chain ID for the Ethereum Sepolia testnet (EIP-155 compatible format).
- */
-const ETH_SEPOLIA_CHAIN_ID = '11155111';
-/**
- * @constant {string} ETH_MAINNET_CHAIN_ID - The chain ID for the Ethereum mainnet (EIP-155 compatible format).
- */
-const ETH_MAINNET_CHAIN_ID = '1';
-/**
- * @constant {string} ZKEVM_DEVNET_CHAIN_ID - The chain ID for the zkEVM devnet (EIP-155 compatible format).
- */
-const ZKEVM_DEVNET_CHAIN_ID = '13433';
-/**
-/**
- * @constant {string} ZKEVM_TESTNET_CHAIN_ID - The chain ID for the zkEVM testnet (EIP-155 compatible format).
- */
-const ZKEVM_TESTNET_CHAIN_ID = '13372';
-/**
- * @constant {string} ZKEVM_MAINNET_CHAIN_ID - The chain ID for the zkEVM mainnet (EIP-155 compatible format).
- */
-const ZKEVM_MAINNET_CHAIN_ID = '13371';
-/**
- * @constant {string} L2_STATE_SENDER_ADDRESS - Address of bridge contract to the rootchain
- */
-const L2_STATE_SENDER_ADDRESS = '0x0000000000000000000000000000000000001002';
-/**
- * The constant value representing the native token in the token bridge context.
- * The key is used to indicate the native token of a blockchain network (like Ether in Ethereum)
- *  in methods that normally require a token address.
- * @constant {string}
- */
-const NATIVE_TOKEN_BRIDGE_KEY = '0x0000000000000000000000000000000000000001';
-/**
- * @constant {BridgeInstance} ETH_SEPOLIA_TO_ZKEVM_DEVNET - A bridge instance configuration for bridging between
- * the Ethereum Sepolia testnet and the zkEVM devnet.
- */
-const ETH_SEPOLIA_TO_ZKEVM_DEVNET = {
-    rootChainID: ETH_SEPOLIA_CHAIN_ID,
-    childChainID: ZKEVM_DEVNET_CHAIN_ID,
-};
-/**
- * @constant {BridgeInstance} ETH_SEPOLIA_TO_ZKEVM_TESTNET - A bridge instance configuration for bridging
- * between the Ethereum Sepolia testnet and the zkEVM testnet.
- */
-const ETH_SEPOLIA_TO_ZKEVM_TESTNET = {
-    rootChainID: ETH_SEPOLIA_CHAIN_ID,
-    childChainID: ZKEVM_TESTNET_CHAIN_ID,
-};
-/**
- * @constant {BridgeInstance} ETH_MAINNET_TO_ZKEVM_MAINNET - A bridge instance configuration for bridging
- * between the Ethereum mainnet and the zkEVM mainnet.
- */
-const ETH_MAINNET_TO_ZKEVM_MAINNET = {
-    rootChainID: ETH_MAINNET_CHAIN_ID,
-    childChainID: ZKEVM_MAINNET_CHAIN_ID,
-};
-
 const L2_STATE_SENDER = [
     {
         anonymous: false,
@@ -11940,13 +11940,13 @@ class TokenBridge {
         const reqTokenAddress = (req.rootToken === 'NATIVE') ? NATIVE_TOKEN_BRIDGE_KEY : req.rootToken;
         // Validate the request token address
         if (!isAddress(reqTokenAddress)) {
-            throw new BridgeError(`recipient address ${reqTokenAddress} is not a valid address`, BridgeErrorType.INVALID_ADDRESS);
+            throw new BridgeError(`token address ${reqTokenAddress} is not a valid address`, BridgeErrorType.INVALID_ADDRESS);
         }
         // Create an instance of the root ERC20 predicate contract
         const childTokenAddress = await withBridgeError(async () => {
             const rootERC20Predicate = new Contract(this.config.bridgeContracts.rootChainERC20Predicate, ROOT_ERC20_PREDICATE, this.config.rootProvider);
-            return await rootERC20Predicate.getChildToken(reqTokenAddress);
-        }, BridgeErrorType.PROVIDER_ERROR, 'failed to query getChildToken mapping');
+            return await rootERC20Predicate.rootTokenToChildToken(reqTokenAddress);
+        }, BridgeErrorType.PROVIDER_ERROR, 'failed to query rootTokenToChildToken mapping');
         // Return the child token address
         return {
             childToken: childTokenAddress,
@@ -12222,7 +12222,7 @@ class TokenBridge {
             throw new Error('failed to find child deposit event');
         if (!childDepositEvent.args)
             throw new Error('child deposit event has no args');
-        if (!childDepositEvent.args.status)
+        if (childDepositEvent.args.status == null)
             throw new Error('child deposit event has no status');
         // If the event's status argument is present, we consider that the state sync operation was successful
         if (childDepositEvent.args.status) {
@@ -12324,10 +12324,10 @@ const CONTRACTS_FOR_BRIDGE = new Map()
     childChainStateReceiver: '0x0000000000000000000000000000000000001001',
 })
     .set(ETH_SEPOLIA_TO_ZKEVM_TESTNET, {
-    rootChainERC20Predicate: '0x0C15a8359865867CdCC44f98b2F3fd5DF098C7E0',
-    rootChainStateSender: '0x4C80001188db53dbc2eaAb32d5ef825feEedECA5',
-    rootChainCheckpointManager: '0x0F3157bc91f66C350f87172bBB28d9417167074F',
-    rootChainExitHelper: '0xB057A6C4e951a315E9f2DAe6d28B83cD0480e873',
+    rootChainERC20Predicate: '0x1118Cc83780d07ef99F84fD1C0E10CEd49AF3613',
+    rootChainStateSender: '0x41716a0DD85ae257DD011A97cE1470F609871270',
+    rootChainCheckpointManager: '0xfD69e3FCd72C6374623eeb156dd2C4159eBa7327',
+    rootChainExitHelper: '0x270D2B290c8183De23eCD17C7DaAE59fd084fE70',
     childChainERC20Predicate: '0x0000000000000000000000000000000000001004',
     childChainStateReceiver: '0x0000000000000000000000000000000000001001',
 })
@@ -12913,31 +12913,18 @@ function isValidNonZeroAddress(address) {
     }
 }
 const tokenInfoToUniswapToken = (tokenInfo) => new Token(tokenInfo.chainId, tokenInfo.address, tokenInfo.decimals, tokenInfo.symbol, tokenInfo.name);
+const uniswapTokenToTokenInfo = (token) => ({
+    chainId: token.chainId,
+    address: token.address,
+    decimals: token.decimals,
+    symbol: token.symbol,
+    name: token.name,
+});
 const toBigNumber = (amount) => (ethers.BigNumber.from(amount.multiply(amount.decimalScale).toExact()));
-
-// 0.1% default slippage
-const DEFAULT_SLIPPAGE = 0.1;
-// 15 minutes from the current Unix time
-const DEFAULT_DEADLINE = Math.floor(Date.now() / 1000) + 60 * 15;
-// most swaps will be able to resolve with 2 hops
-const DEFAULT_MAX_HOPS = 2;
-// after 10 hops, it is very unlikely a route will be available
-const MAX_MAX_HOPS = 10;
-// a max hop of 1 will require a direct swap with no intermediary pools
-const MIN_MAX_HOPS = 1;
-// precision used to calculate percentage from basis points
-const BASIS_POINT_PRECISION = 10000;
-// 10% maximum secondary fee
-const MAX_SECONDARY_FEE_BASIS_POINTS = 10000;
-
-function calculateFees(amount, secondaryFees) {
-    let totalFees = ethers.BigNumber.from(0);
-    for (let i = 0; i < secondaryFees.length; i++) {
-        const feeAmount = amount.mul(secondaryFees[i].feeBasisPoints).div(BASIS_POINT_PRECISION);
-        totalFees = totalFees.add(feeAmount);
-    }
-    return totalFees;
-}
+const newAmount = (amount, token) => ({
+    value: amount,
+    token,
+});
 
 // slippageToPercent takes the slippage as a percentage (e.g. 0.1) and
 // converts it to the Uniswap equivalent type
@@ -12977,7 +12964,7 @@ function applySlippage(tradeType, amount, slippage) {
     const amountWithSlippage = maybeInverted.multiply(amount.toString()).quotient;
     return ethers.BigNumber.from(amountWithSlippage.toString());
 }
-function prepareUserQuote(otherCurrency, tradeInfo, slippage) {
+function prepareUserQuote(otherCurrency, tradeInfo, slippage, fees) {
     const resultToken = otherCurrency.wrapped;
     const tokenInfo = {
         chainId: resultToken.chainId,
@@ -12995,32 +12982,32 @@ function prepareUserQuote(otherCurrency, tradeInfo, slippage) {
             value: amountWithSlippage,
         },
         slippage,
+        fees: fees.withAmounts(),
     };
 }
-function getOurQuoteReqAmount(amount, secondaryFees, tradeType) {
+function getOurQuoteReqAmount(amount, fees, tradeType) {
     if (tradeType === TradeType.EXACT_OUTPUT) {
         // For an exact output swap, we do not need to subtract fees from the given amount
         return amount;
     }
-    const totalFees = calculateFees(toBigNumber(amount), secondaryFees);
-    const totalFeesCurrencyAmount = CurrencyAmount.fromRawAmount(amount.currency, totalFees.toString());
-    // Subtract the fee amount from the given amount
-    return amount.subtract(totalFeesCurrencyAmount);
+    fees.addAmount(toBigNumber(amount));
+    return CurrencyAmount.fromRawAmount(amount.currency, fees.amountLessFees().toString());
 }
 
-const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
-const IMMUTABLE_TESTNET_CHAIN_ID = 13372;
-
-const TIMX_IMMUTABLE_TESTNET = {
-    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
-    address: '0x0000000000000000000000000000000000001010',
-    decimals: 18,
-    symbol: 'tIMX',
-    name: 'Immutable Testnet Token',
-};
-const IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS = [
-    TIMX_IMMUTABLE_TESTNET,
-];
+// 0.1% default slippage
+const DEFAULT_SLIPPAGE = 0.1;
+// 15 minutes from the current Unix time
+const DEFAULT_DEADLINE = Math.floor(Date.now() / 1000) + 60 * 15;
+// most swaps will be able to resolve with 2 hops
+const DEFAULT_MAX_HOPS = 2;
+// after 10 hops, it is very unlikely a route will be available
+const MAX_MAX_HOPS = 10;
+// a max hop of 1 will require a direct swap with no intermediary pools
+const MIN_MAX_HOPS = 1;
+// precision used to calculate percentage from basis points
+const BASIS_POINT_PRECISION = 10000;
+// 10% maximum secondary fee
+const MAX_SECONDARY_FEE_BASIS_POINTS = 10000;
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
@@ -15050,6 +15037,60 @@ startCurrencyIn = currencyIn) => {
     return routes;
 };
 
+class Fees {
+    secondaryFees;
+    token;
+    amount = ethers.BigNumber.from(0);
+    constructor(secondaryFees, token) {
+        this.secondaryFees = secondaryFees;
+        this.token = token;
+    }
+    addAmount(amount) {
+        this.amount = this.amount.add(amount);
+    }
+    amountWithFeesApplied() {
+        return this.amount.add(this.total());
+    }
+    amountLessFees() {
+        return this.amount.sub(this.total());
+    }
+    withAmounts() {
+        return this.secondaryFees.map((fee) => {
+            const feeAmount = this.amount
+                .mul(fee.feeBasisPoints)
+                .div(BASIS_POINT_PRECISION);
+            return {
+                ...fee,
+                amount: newAmount(feeAmount, this.token),
+            };
+        });
+    }
+    total() {
+        let totalFees = ethers.BigNumber.from(0);
+        for (let i = 0; i < this.secondaryFees.length; i++) {
+            const feeAmount = this.amount
+                .mul(this.secondaryFees[i].feeBasisPoints)
+                .div(BASIS_POINT_PRECISION);
+            totalFees = totalFees.add(feeAmount);
+        }
+        return totalFees;
+    }
+}
+
+const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
+const IMMUTABLE_TESTNET_CHAIN_ID = 13472;
+
+const TIMX_IMMUTABLE_TESTNET = {
+    chainId: IMMUTABLE_TESTNET_CHAIN_ID,
+    address: '0x0000000000000000000000000000000000001010',
+    decimals: 18,
+    symbol: 'tIMX',
+    name: 'Immutable Testnet Token',
+};
+const IMMUTABLE_TESTNET_COMMON_ROUTING_TOKENS = [
+    TIMX_IMMUTABLE_TESTNET,
+];
+
 const zeroNativeCurrencyValue = '0x00';
 const multicallWithDeadlineFunctionSignature = 'multicall(uint256,bytes[])';
 function buildSwapParametersForSinglePoolSwap(fromAddress, trade, route, amountIn, amountOut, secondaryFees, secondaryFeeContract) {
@@ -15161,33 +15202,36 @@ function getSwap(nativeToken, adjustedQuote, fromAddress, slippage, deadline, pe
         gasFeeEstimate,
     };
 }
-function prepareSwap(ourQuote, amountSpecified, secondaryFees) {
-    const fees = ourQuote.tradeType === TradeType.EXACT_INPUT
-        ? ethers.BigNumber.from(0) // no fees on exact input
-        : calculateFees(ourQuote.amountIn, secondaryFees);
-    const amountIn = ourQuote.tradeType === TradeType.EXACT_INPUT
-        ? amountSpecified
-        : ourQuote.amountIn.add(fees);
-    const amountOut = ourQuote.tradeType === TradeType.EXACT_INPUT
-        ? ourQuote.amountOut
-        : amountSpecified;
+function prepareSwap(ourQuote, amountSpecified, fees) {
+    if (ourQuote.tradeType === TradeType.EXACT_OUTPUT) {
+        fees.addAmount(ourQuote.amountIn);
+        return {
+            gasEstimate: ourQuote.gasEstimate,
+            route: ourQuote.route,
+            tokenIn: ourQuote.tokenIn,
+            tokenOut: ourQuote.tokenOut,
+            amountIn: fees.amountWithFeesApplied(),
+            amountOut: amountSpecified,
+            tradeType: ourQuote.tradeType,
+        };
+    }
     return {
         gasEstimate: ourQuote.gasEstimate,
         route: ourQuote.route,
         tokenIn: ourQuote.tokenIn,
         tokenOut: ourQuote.tokenOut,
-        amountIn,
-        amountOut,
+        amountIn: amountSpecified,
+        amountOut: ourQuote.amountOut,
         tradeType: ourQuote.tradeType,
     };
 }
 
 const CONTRACTS_FOR_CHAIN_ID = {
     [IMMUTABLE_TESTNET_CHAIN_ID]: {
-        multicall: '0xb18c44b211065E69844FbA9AE146DA362104AfBf',
-        coreFactory: '0x12739A8f1A8035F439092D016DAE19A2874F30d2',
-        quoterV2: '0xF674847fBcca5C80315e3AE37043Dce99F6CC529',
-        peripheryRouter: '0x0Afe6F5f4DC34461A801420634239FFaD50A2e44',
+        multicall: '0xD17c98b38bA28c7eA1080317EB9AB2b9663BEd92',
+        coreFactory: '0x8AC26EfCbf5D700b37A27aA00E6934e6904e7B8e',
+        quoterV2: '0x0Afe6F5f4DC34461A801420634239FFaD50A2e44',
+        peripheryRouter: '0x87854A7D4b9BaC3D37f4516A1Ac7F36fB5ad539f',
         secondaryFee: '0x8dBE1f0900C5e92ad87A54521902a33ba1598C51',
     },
 };
@@ -15317,13 +15361,14 @@ class Exchange {
             amountSpecified = CurrencyAmount.fromRawAmount(tokenOut, amount.toString());
             otherToken = tokenIn;
         }
-        const ourQuoteReqAmount = getOurQuoteReqAmount(amountSpecified, this.secondaryFees, tradeType);
+        const fees = new Fees(this.secondaryFees, uniswapTokenToTokenInfo(tokenIn));
+        const ourQuoteReqAmount = getOurQuoteReqAmount(amountSpecified, fees, tradeType);
         const ourQuote = await this.router.findOptimalRoute(ourQuoteReqAmount, otherToken, tradeType, maxHops);
         // get gas details
         const gasPrice = await fetchGasPrice(this.provider);
-        const adjustedQuote = prepareSwap(ourQuote, amount, this.secondaryFees);
+        const adjustedQuote = prepareSwap(ourQuote, amount, fees);
         const swap = getSwap(this.nativeToken, adjustedQuote, fromAddress, slippagePercent, deadline, this.router.routingContracts.peripheryRouterAddress, this.router.routingContracts.secondaryFeeAddress, gasPrice, this.secondaryFees);
-        const userQuote = prepareUserQuote(otherToken, adjustedQuote, slippagePercent);
+        const userQuote = prepareUserQuote(otherToken, adjustedQuote, slippagePercent, fees);
         const preparedApproval = prepareApproval(tradeType, amount, userQuote.amountWithMaxSlippage.value, this.router.routingContracts, this.secondaryFees);
         // we always use the tokenIn address because we are always selling the tokenIn
         const approval = await getApproval(this.nativeToken, this.provider, fromAddress, tokenInAddress, preparedApproval, gasPrice);
@@ -15441,7 +15486,7 @@ const $762782b6c862d954$export$db5daa1b5156ccfe = [
  */ var $0472f23319457bfb$export$c06e1e7429de6283;
 (function(ChainId) {
     ChainId[ChainId["IMTBL_ZKEVM_MAINNET"] = 13371] = "IMTBL_ZKEVM_MAINNET";
-    ChainId[ChainId["IMTBL_ZKEVM_TESTNET"] = 13372] = "IMTBL_ZKEVM_TESTNET";
+    ChainId[ChainId["IMTBL_ZKEVM_TESTNET"] = 13472] = "IMTBL_ZKEVM_TESTNET";
     ChainId[ChainId["IMTBL_ZKEVM_DEVNET"] = 13433] = "IMTBL_ZKEVM_DEVNET";
     ChainId[ChainId["ETHEREUM"] = 1] = "ETHEREUM";
     ChainId[ChainId["SEPOLIA"] = 11155111] = "SEPOLIA";

package/dist/checkout_widgets.js

@@ -4,7 +4,7 @@ import { useEffect } from 'react';
 function $parcel$export(e, n, v, s) {
   Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
 }
-const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.4.4-alpha.1";
+const $d663162fd5a0853f$export$38a083d9fb5551ca = "0.6.0-alpha";
 const $d663162fd5a0853f$export$83bf90b30cdfd29f = ()=>false;
 const $d663162fd5a0853f$export$1169f5475725171b = ()=>$d663162fd5a0853f$export$38a083d9fb5551ca;
 

package/dist/immutablex_client.js

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