@imtbl/sdk 0.45.2 → 0.45.4

package/dist/index.cjs

@@ -10641,7 +10641,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.45.2' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.45.4' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -10713,7 +10713,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.45.2',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.45.4',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -11152,7 +11152,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.45.2',
+    sdkVersion: 'ts-immutable-sdk-0.45.4',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -36482,7 +36482,7 @@ class ApproveError extends ExchangeError {
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-const _abi$3 = [
+const _abi$4 = [
     {
         constant: true,
         inputs: [],
@@ -36705,19 +36705,19 @@ const _abi$3 = [
     },
 ];
 class ERC20__factory {
-    static abi = _abi$3;
+    static abi = _abi$4;
     static createInterface() {
-        return new ethers.utils.Interface(_abi$3);
+        return new ethers.utils.Interface(_abi$4);
     }
     static connect(address, signerOrProvider) {
-        return new ethers.Contract(address, _abi$3, signerOrProvider);
+        return new ethers.Contract(address, _abi$4, signerOrProvider);
     }
 }
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-const _abi$2 = [
+const _abi$3 = [
     {
         inputs: [
             {
@@ -37491,7 +37491,7 @@ class ImmutableSwapProxy__factory extends ethers.ContractFactory {
             super(...args);
         }
         else {
-            super(_abi$2, _bytecode$2, args[0]);
+            super(_abi$3, _bytecode$2, args[0]);
         }
     }
     deploy(_admin, _uniRouter, _wimx, overrides) {
@@ -37507,19 +37507,19 @@ class ImmutableSwapProxy__factory extends ethers.ContractFactory {
         return super.connect(signer);
     }
     static bytecode = _bytecode$2;
-    static abi = _abi$2;
+    static abi = _abi$3;
     static createInterface() {
-        return new ethers.utils.Interface(_abi$2);
+        return new ethers.utils.Interface(_abi$3);
     }
     static connect(address, signerOrProvider) {
-        return new ethers.Contract(address, _abi$2, signerOrProvider);
+        return new ethers.Contract(address, _abi$3, signerOrProvider);
     }
 }
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-const _abi$1 = [
+const _abi$2 = [
     {
         inputs: [],
         name: "getCurrentBlockTimestamp",
@@ -37619,7 +37619,7 @@ class Multicall__factory extends ethers.ContractFactory {
             super(...args);
         }
         else {
-            super(_abi$1, _bytecode$1, args[0]);
+            super(_abi$2, _bytecode$1, args[0]);
         }
     }
     deploy(overrides) {
@@ -37635,19 +37635,19 @@ class Multicall__factory extends ethers.ContractFactory {
         return super.connect(signer);
     }
     static bytecode = _bytecode$1;
-    static abi = _abi$1;
+    static abi = _abi$2;
     static createInterface() {
-        return new ethers.utils.Interface(_abi$1);
+        return new ethers.utils.Interface(_abi$2);
     }
     static connect(address, signerOrProvider) {
-        return new ethers.Contract(address, _abi$1, signerOrProvider);
+        return new ethers.Contract(address, _abi$2, signerOrProvider);
     }
 }
 
 /* Autogenerated file. Do not edit manually. */
 /* tslint:disable */
 /* eslint-disable */
-const _abi = [
+const _abi$1 = [
     {
         inputs: [],
         stateMutability: "nonpayable",
@@ -38643,7 +38643,7 @@ class UniswapV3Pool__factory extends ethers.ContractFactory {
             super(...args);
         }
         else {
-            super(_abi, _bytecode, args[0]);
+            super(_abi$1, _bytecode, args[0]);
         }
     }
     deploy(overrides) {
@@ -38659,6 +38659,298 @@ class UniswapV3Pool__factory extends ethers.ContractFactory {
         return super.connect(signer);
     }
     static bytecode = _bytecode;
+    static abi = _abi$1;
+    static createInterface() {
+        return new ethers.utils.Interface(_abi$1);
+    }
+    static connect(address, signerOrProvider) {
+        return new ethers.Contract(address, _abi$1, signerOrProvider);
+    }
+}
+
+/* Autogenerated file. Do not edit manually. */
+/* tslint:disable */
+/* eslint-disable */
+const _abi = [
+    {
+        constant: true,
+        inputs: [],
+        name: "name",
+        outputs: [
+            {
+                name: "",
+                type: "string",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        constant: false,
+        inputs: [
+            {
+                name: "guy",
+                type: "address",
+            },
+            {
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "approve",
+        outputs: [
+            {
+                name: "",
+                type: "bool",
+            },
+        ],
+        payable: false,
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        constant: true,
+        inputs: [],
+        name: "totalSupply",
+        outputs: [
+            {
+                name: "",
+                type: "uint256",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        constant: false,
+        inputs: [
+            {
+                name: "src",
+                type: "address",
+            },
+            {
+                name: "dst",
+                type: "address",
+            },
+            {
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "transferFrom",
+        outputs: [
+            {
+                name: "",
+                type: "bool",
+            },
+        ],
+        payable: false,
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        constant: false,
+        inputs: [
+            {
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "withdraw",
+        outputs: [],
+        payable: false,
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        constant: true,
+        inputs: [],
+        name: "decimals",
+        outputs: [
+            {
+                name: "",
+                type: "uint8",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        constant: true,
+        inputs: [
+            {
+                name: "",
+                type: "address",
+            },
+        ],
+        name: "balanceOf",
+        outputs: [
+            {
+                name: "",
+                type: "uint256",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        constant: true,
+        inputs: [],
+        name: "symbol",
+        outputs: [
+            {
+                name: "",
+                type: "string",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        constant: false,
+        inputs: [
+            {
+                name: "dst",
+                type: "address",
+            },
+            {
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "transfer",
+        outputs: [
+            {
+                name: "",
+                type: "bool",
+            },
+        ],
+        payable: false,
+        stateMutability: "nonpayable",
+        type: "function",
+    },
+    {
+        constant: false,
+        inputs: [],
+        name: "deposit",
+        outputs: [],
+        payable: true,
+        stateMutability: "payable",
+        type: "function",
+    },
+    {
+        constant: true,
+        inputs: [
+            {
+                name: "",
+                type: "address",
+            },
+            {
+                name: "",
+                type: "address",
+            },
+        ],
+        name: "allowance",
+        outputs: [
+            {
+                name: "",
+                type: "uint256",
+            },
+        ],
+        payable: false,
+        stateMutability: "view",
+        type: "function",
+    },
+    {
+        payable: true,
+        stateMutability: "payable",
+        type: "fallback",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                name: "src",
+                type: "address",
+            },
+            {
+                indexed: true,
+                name: "guy",
+                type: "address",
+            },
+            {
+                indexed: false,
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "Approval",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                name: "src",
+                type: "address",
+            },
+            {
+                indexed: true,
+                name: "dst",
+                type: "address",
+            },
+            {
+                indexed: false,
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "Transfer",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                name: "dst",
+                type: "address",
+            },
+            {
+                indexed: false,
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "Deposit",
+        type: "event",
+    },
+    {
+        anonymous: false,
+        inputs: [
+            {
+                indexed: true,
+                name: "src",
+                type: "address",
+            },
+            {
+                indexed: false,
+                name: "wad",
+                type: "uint256",
+            },
+        ],
+        name: "Withdrawal",
+        type: "event",
+    },
+];
+class WIMX__factory {
     static abi = _abi;
     static createInterface() {
         return new ethers.utils.Interface(_abi);
@@ -39287,6 +39579,13 @@ class NativeTokenService {
     maybeWrapAmount(amount) {
         return newAmount(amount.value, this.maybeWrapToken(amount.token));
     }
+    isWrappedNative(token) {
+        return token.type === 'erc20' && token.address.toLowerCase() === this.wrappedToken.address.toLowerCase();
+    }
+    isWrapOrUnwrap(tokenIn, tokenOut) {
+        return ((tokenIn === this.nativeToken && (this.isWrappedNative(tokenOut))) ||
+            ((this.isWrappedNative(tokenIn)) && tokenOut === this.nativeToken));
+    }
 }
 
 // slippageToPercent takes the slippage as a percentage (e.g. 0.1) and
@@ -39385,6 +39684,16 @@ class Fees {
     }
 }
 
+// 45038 is the upper bound of the gas estimate for the deposit function.
+// This upper bound is reached when a user is wrapping for the first time (cold + unused storage slot)
+// The lower bound is 27,938, so the difference is 17,100 gas. If transactions are 10 gwei IMX,
+// this is about 0.000171 IMX difference. In order to avoid an extra remote call, we just use the upper bound instead.
+const IMX_WRAP_GAS_COST = 45038;
+// 35216 is the upper bound of the gas estimate for the withdraw function.
+// The differenfce between upper and normal is less than 0.0001 IMX, so we just use the upper bound
+// to avoid an extra remote call.
+const IMX_UNWRAP_GAS_COST = 35216;
+
 const IMMUTABLE_TESTNET_RPC_URL = 'https://rpc.testnet.immutable.com';
 const IMMUTABLE_TESTNET_CHAIN_ID = 13473;
 
@@ -39898,6 +40207,67 @@ class Exchange {
             decimals,
         };
     }
+    async getUnwrapTransaction(fromAddress, tokenAmount, wimxInterface, gasPrice) {
+        const calldata = wimxInterface.encodeFunctionData('withdraw', [tokenAmount]);
+        const gasEstimate = ethers.ethers.BigNumber.from(IMX_UNWRAP_GAS_COST);
+        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(gasPrice, gasEstimate)) : null;
+        // This transaction is for calling calling `withdraw` on the WETH/WIMX contract.
+        const transactionDetails = {
+            transaction: {
+                data: calldata,
+                to: this.wrappedNativeToken.address,
+                from: fromAddress,
+            },
+            gasFeeEstimate,
+        };
+        return {
+            transaction: transactionDetails,
+            approval: null,
+        };
+    }
+    getWrapTransaction(fromAddress, tokenAmount, wimxInterface, gasPrice) {
+        const calldata = wimxInterface.encodeFunctionData('deposit');
+        const gasEstimate = ethers.ethers.BigNumber.from(IMX_WRAP_GAS_COST);
+        const gasFeeEstimate = gasPrice ? toPublicAmount(calculateGasFee(gasPrice, gasEstimate)) : null;
+        // This transaction is for calling calling `deposit` on the WETH/WIMX contract.
+        const transactionDetails = {
+            transaction: {
+                data: calldata,
+                to: this.wrappedNativeToken.address,
+                value: tokenAmount,
+                from: fromAddress,
+            },
+            gasFeeEstimate,
+        };
+        return {
+            transaction: transactionDetails,
+            approval: null,
+        };
+    }
+    async getUnsignedWrapUnwrapTx(tokenSpecified, amountIn, fromAddress, gasPrice) {
+        const isWrap = amountIn.token.type === 'native';
+        const quoteToken = tokenSpecified.type === 'native' ? this.wrappedNativeToken : this.nativeToken;
+        const otherTokenCoinAmount = {
+            token: quoteToken,
+            value: amountIn.value,
+        };
+        // The quote is always 1:1 (0 {price impact, slippage}) when wrapping/unwrapping.
+        const quote = {
+            amount: toPublicAmount(otherTokenCoinAmount),
+            amountWithMaxSlippage: toPublicAmount(otherTokenCoinAmount),
+            slippage: 0,
+            fees: [],
+        };
+        const wimxInterface = WIMX__factory.createInterface();
+        let transactionDetails;
+        if (isWrap) {
+            transactionDetails = this.getWrapTransaction(fromAddress, otherTokenCoinAmount.value, wimxInterface, gasPrice);
+        }
+        else {
+            transactionDetails = await this.getUnwrapTransaction(fromAddress, otherTokenCoinAmount.value, wimxInterface, gasPrice);
+        }
+        return { quote, approval: transactionDetails.approval, swap: transactionDetails.transaction };
+    }
     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
@@ -39913,6 +40283,11 @@ class Exchange {
         // determine which amount was specified for the swap from the TradeType
         const [tokenSpecified, otherToken] = tradeType === Uniswap.TradeType.EXACT_INPUT ? [tokenIn, tokenOut] : [tokenOut, tokenIn];
         const amountSpecified = newAmount(amount, tokenSpecified);
+        if (this.nativeTokenService.isWrapOrUnwrap(tokenIn, tokenOut)) {
+            // If the user is swapping between the native token and the wrapped native token,
+            // we want to just wrap/unwrap the native token instead of swapping
+            return this.getUnsignedWrapUnwrapTx(tokenSpecified, newAmount(amount, tokenIn), fromAddress, gasPrice);
+        }
         const fees = new Fees(secondaryFees, tokenIn);
         const ourQuoteReqAmount = getOurQuoteReqAmount(amountSpecified, fees, tradeType, this.nativeTokenService);
         // Quotes will always use ERC20s. If the user-specified token is Native, we use the Wrapped Native Token pool
@@ -40199,6 +40574,7 @@ var WalletAction;
     WalletAction["ADD_NETWORK"] = "wallet_addEthereumChain";
     WalletAction["SWITCH_NETWORK"] = "wallet_switchEthereumChain";
     WalletAction["GET_CHAINID"] = "eth_chainId";
+    WalletAction["REQUEST_PERMISSIONS"] = "wallet_requestPermissions";
 })(WalletAction || (WalletAction = {}));
 /**
  * Enum representing the platform filters used in {@link GetWalletAllowListParams}.
@@ -40909,7 +41285,7 @@ const IMMUTABLE_ZKVEM_GAS_OVERRIDES = {
     maxPriorityFeePerGas: ethers.BigNumber.from(10e9),
 };
 
-const SDK_VERSION_MARKER = '0.45.2';
+const SDK_VERSION_MARKER = '0.45.4';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
@@ -41493,6 +41869,21 @@ async function connectSite(web3Provider) {
     }, { type: CheckoutErrorType.USER_REJECTED_REQUEST_ERROR });
     return web3Provider;
 }
+async function requestPermissions(web3Provider) {
+    if (!web3Provider || !web3Provider.provider?.request) {
+        throw new CheckoutError('Incompatible provider', CheckoutErrorType.PROVIDER_REQUEST_MISSING_ERROR, { details: 'Attempting to connect with an incompatible provider' });
+    }
+    await withCheckoutError(async () => {
+        if (!web3Provider.provider.request)
+            return;
+        await web3Provider.provider.request({
+            method: WalletAction.REQUEST_PERMISSIONS,
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            params: [{ eth_accounts: {} }],
+        });
+    }, { type: CheckoutErrorType.USER_REJECTED_REQUEST_ERROR });
+    return web3Provider;
+}
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
 async function getMetaMaskProvider() {
@@ -44641,7 +45032,12 @@ class Checkout {
      */
     async connect(params) {
         const web3Provider = await validateProvider(this.config, params.provider, { allowUnsupportedProvider: true });
-        await connectSite(web3Provider);
+        if (params.requestWalletPermissions && !web3Provider.provider?.isPassport) {
+            await requestPermissions(web3Provider);
+        }
+        else {
+            await connectSite(web3Provider);
+        }
         return { provider: web3Provider };
     }
     /**

package/dist/index.d.ts

@@ -28391,9 +28391,11 @@ type ChainTokensConfig = {
 /**
  * Interface representing the params of {@link Checkout.connect}.
  * @property {Web3Provider} provider - The provider used to connect to the network.
+ * @property {boolean | undefined} requestWalletPermissions - A boolean that will trigger a permission request for wallet connection.
  */
 interface ConnectParams {
     provider: Web3Provider;
+    requestWalletPermissions?: boolean;
 }
 /**
  * Interface representing the result of {@link Checkout.connect}.
@@ -28411,7 +28413,7 @@ interface CheckConnectionParams {
 }
 /**
  * Interface representing the result of {@link Checkout.checkIsWalletConnected}.
- * @property {boolean} isConnected - A boolean indicating the connection status of th Web3 provider.
+ * @property {boolean} isConnected - A boolean indicating the connection status of the Web3 provider.
  * @property {string} walletAddress - The wallet address used to check the connection.
  */
 interface CheckConnectionResult {