@clober/v2-sdk 0.0.128 → 1.0.0-rc.1

package/dist/esm/calls/market/limit.js

@@ -0,0 +1,219 @@
+import { createPublicClient, formatUnits, http, isAddressEqual, parseUnits, zeroAddress, zeroHash, } from 'viem';
+import { CHAIN_MAP } from '../../constants/chain-configs/chain';
+import { fetchMarket } from '../../entities/market/apis';
+import { formatPrice, parsePrice, invertTick, toPrice } from '../../utils';
+import { calculateUnitSize } from '../../utils/unit-size';
+import { getExpectedOutput } from '../../views';
+import { toBookId } from '../../entities/book/utils/book-id';
+import { buildTransaction } from '../../utils/build-transaction';
+import { CONTRACT_ADDRESSES } from '../../constants/chain-configs/addresses';
+import { CONTROLLER_ABI } from '../../constants/abis/core/controller-abi';
+import { getDeadlineTimestampInSeconds } from '../../utils/time';
+/**
+ * Places a limit order on the specified chain for trading tokens.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user placing the order.
+ * @param {`0x${string}`} inputToken The address of the token to be used as input.
+ * @param {`0x${string}`} outputToken The address of the token to be received as output.
+ * @param {string} amount The amount of input tokens for the order.
+ * @param {string} price The price at which the order should be executed.
+ * @param options {@link DefaultWriteContractOptions} options.
+ * @param {erc20PermitParam} [options.erc20PermitParam] The permit signature for token approval.
+ * @param {boolean} [options.postOnly] A boolean indicating whether the order is only to be made not taken.
+ * @param {bigint} [options.makeTick] The tick for the make order.
+ * @param {bigint} [options.takeLimitTick] The tick for the take order.
+ * @param {boolean} [options.roundingUpMakeBid] A boolean indicating whether to round up the make bid.
+ * @param {boolean} [options.roundingDownMakeAsk] A boolean indicating whether to round down the make ask.
+ * @param {boolean} [options.roundingDownTakenBid] A boolean indicating whether to round down the taken bid.
+ * @param {boolean} [options.roundingUpTakenAsk] A boolean indicating whether to round up the taken ask.
+ * @returns {Promise<{ transaction: Transaction, result: { make: CurrencyFlow, take: CurrencyFlow, spent: CurrencyFlow }>}
+ * Promise resolving to the transaction object representing the limit order with the result of the order.
+ * @example
+ * import { limitOrder } from '@clober/v2-sdk'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ *
+ * const { transaction } = await limitOrder({
+ *   chainId: 421614,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69
+ *   inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   outputToken: '0x0000000000000000000000000000000000000000',
+ *   amount: '100.123', // 100.123 USDC
+ *   price: '4000.01', // price at 4000.01 (ETH/USDC)
+ * })
+ *
+ * @example
+ * import { limitOrder } from '@clober/v2-sdk'
+ *
+ * const { transaction } = await limitOrder({
+ *   chainId: 421614,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69
+ *   inputToken: '0x0000000000000000000000000000000000000000',
+ *   outputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   amount: '0.13', // 0.13 ETH
+ *   price: '4000.01', // price at 4000.01 (ETH/USDC)
+ * })
+ */
+export const limitOrder = async ({ chainId, userAddress, inputToken, outputToken, amount, price, options, }) => {
+    const [roundingUpMakeBid, roundingDownMakeAsk, roundingDownTakenBid, roundingUpTakenAsk,] = [
+        options?.roundingUpMakeBid ? options.roundingUpMakeBid : false,
+        options?.roundingDownMakeAsk ? options.roundingDownMakeAsk : false,
+        options?.roundingDownTakenBid ? options.roundingDownTakenBid : false,
+        options?.roundingUpTakenAsk ? options.roundingUpTakenAsk : false,
+    ];
+    const publicClient = createPublicClient({
+        chain: CHAIN_MAP[chainId],
+        transport: options?.rpcUrl ? http(options.rpcUrl) : http(),
+    });
+    const market = await fetchMarket(publicClient, chainId, [inputToken, outputToken], !!(options && options.useSubgraph));
+    const isBid = isAddressEqual(market.quote.address, inputToken);
+    const [inputCurrency, outputCurrency] = isBid
+        ? [market.quote, market.base]
+        : [market.base, market.quote];
+    if ((isBid && !market.bidBook.isOpened) ||
+        (!isBid && !market.askBook.isOpened)) {
+        throw new Error(`
+       Open the market before placing a limit order.
+       import { openMarket } from '@clober/v2-sdk'
+
+       const transaction = await openMarket({
+            chainId: ${chainId},
+            inputToken: '${inputToken}',
+            outputToken: '${outputToken}',
+       })
+    `);
+    }
+    const { roundingDownTick, roundingUpTick } = parsePrice(Number(price), market.quote.decimals, market.base.decimals);
+    const tokensToSettle = [inputToken, outputToken].filter((address) => !isAddressEqual(address, zeroAddress));
+    const quoteAmount = parseUnits(amount, inputCurrency.decimals);
+    const unitSize = calculateUnitSize(chainId, inputCurrency);
+    const { takenAmount, spentAmount, bookId, events } = await getExpectedOutput({
+        chainId,
+        inputToken,
+        outputToken,
+        amountIn: amount,
+        options: {
+            ...options,
+            limitPrice: price,
+        },
+    });
+    const isETH = isAddressEqual(inputToken, zeroAddress);
+    const makeParam = {
+        id: toBookId(chainId, inputToken, outputToken, unitSize),
+        tick: options?.makeTick
+            ? Number(options.makeTick)
+            : Number(isBid
+                ? roundingUpMakeBid
+                    ? roundingUpTick
+                    : roundingDownTick
+                : invertTick(roundingDownMakeAsk ? roundingDownTick : roundingUpTick)),
+        quoteAmount,
+        hookData: zeroHash,
+    };
+    if (options?.postOnly === true || spentAmount === '0') {
+        return {
+            transaction: await buildTransaction(publicClient, {
+                chain: CHAIN_MAP[chainId],
+                account: userAddress,
+                address: CONTRACT_ADDRESSES[chainId].Controller,
+                abi: CONTROLLER_ABI,
+                functionName: 'make',
+                args: [
+                    [makeParam],
+                    tokensToSettle,
+                    options?.erc20PermitParam ? [options.erc20PermitParam] : [],
+                    getDeadlineTimestampInSeconds(),
+                ],
+                value: isETH ? quoteAmount : 0n,
+            }, options?.gasLimit),
+            result: {
+                make: {
+                    amount: formatUnits(quoteAmount, inputCurrency.decimals),
+                    currency: inputCurrency,
+                    direction: 'in',
+                    price: formatPrice(isBid
+                        ? toPrice(BigInt(makeParam.tick))
+                        : toPrice(invertTick(BigInt(makeParam.tick))), market.quote.decimals, market.base.decimals),
+                },
+                spent: {
+                    amount: '0',
+                    currency: inputCurrency,
+                    direction: 'in',
+                    events: [],
+                },
+                taken: {
+                    amount: '0',
+                    currency: outputCurrency,
+                    direction: 'out',
+                    events: [],
+                },
+            },
+        };
+    }
+    else {
+        // take and make
+        return {
+            transaction: await buildTransaction(publicClient, {
+                chain: CHAIN_MAP[chainId],
+                account: userAddress,
+                address: CONTRACT_ADDRESSES[chainId].Controller,
+                abi: CONTROLLER_ABI,
+                functionName: 'limit',
+                args: [
+                    [
+                        {
+                            takeBookId: bookId,
+                            makeBookId: makeParam.id,
+                            limitPrice: options?.takeLimitTick
+                                ? toPrice(options.takeLimitTick)
+                                : toPrice(isBid
+                                    ? invertTick(roundingUpTakenAsk
+                                        ? roundingUpTick
+                                        : roundingDownTick)
+                                    : roundingDownTakenBid
+                                        ? roundingDownTick
+                                        : roundingUpTick),
+                            tick: makeParam.tick,
+                            quoteAmount,
+                            takeHookData: zeroHash,
+                            makeHookData: makeParam.hookData,
+                        },
+                    ],
+                    tokensToSettle,
+                    options?.erc20PermitParam ? [options.erc20PermitParam] : [],
+                    getDeadlineTimestampInSeconds(),
+                ],
+                value: isETH ? quoteAmount : 0n,
+            }, options?.gasLimit),
+            result: {
+                make: {
+                    amount: formatUnits(quoteAmount - parseUnits(spentAmount, inputCurrency.decimals), inputCurrency.decimals),
+                    currency: inputCurrency,
+                    direction: 'in',
+                    price: formatPrice(isBid
+                        ? toPrice(BigInt(makeParam.tick))
+                        : toPrice(invertTick(BigInt(makeParam.tick))), market.quote.decimals, market.base.decimals),
+                },
+                spent: {
+                    amount: spentAmount,
+                    currency: inputCurrency,
+                    direction: 'in',
+                    events: events.map(({ price, spentAmount }) => ({
+                        price,
+                        amount: spentAmount,
+                    })),
+                },
+                taken: {
+                    amount: takenAmount,
+                    currency: outputCurrency,
+                    direction: 'out',
+                    events: events.map(({ price, takenAmount }) => ({
+                        price,
+                        amount: takenAmount,
+                    })),
+                },
+            },
+        };
+    }
+};
+//# sourceMappingURL=limit.js.map

package/dist/esm/calls/market/limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"limit.js","sourceRoot":"","sources":["../../../../src/calls/market/limit.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,WAAW,EACX,IAAI,EACJ,cAAc,EACd,UAAU,EACV,WAAW,EACX,QAAQ,GACT,MAAM,MAAM,CAAA;AAEb,OAAO,EAAa,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAO1E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAA;AACzE,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,EAC/B,OAAO,EACP,WAAW,EACX,UAAU,EACV,WAAW,EACX,MAAM,EACN,KAAK,EACL,OAAO,GAmBR,EAOE,EAAE;IACH,MAAM,CACJ,iBAAiB,EACjB,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EACnB,GAAG;QACF,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK;QAC9D,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK;QAClE,OAAO,EAAE,oBAAoB,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,KAAK;QACpE,OAAO,EAAE,kBAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK;KACjE,CAAA;IACD,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,YAAY,EACZ,OAAO,EACP,CAAC,UAAU,EAAE,WAAW,CAAC,EACzB,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CACnC,CAAA;IACD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAC9D,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,KAAK;QAC3C,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC;QAC7B,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,IACE,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EACpC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC;;;;;uBAKG,OAAO;2BACH,UAAU;4BACT,WAAW;;KAElC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,EAAE,gBAAgB,EAAE,cAAc,EAAE,GAAG,UAAU,CACrD,MAAM,CAAC,KAAK,CAAC,EACb,MAAM,CAAC,KAAK,CAAC,QAAQ,EACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrB,CAAA;IACD,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,CACnD,CAAA;IACD,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,iBAAiB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAA;IAC1D,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,iBAAiB,CAAC;QAC3E,OAAO;QACP,UAAU;QACV,WAAW;QACX,QAAQ,EAAE,MAAM;QAChB,OAAO,EAAE;YACP,GAAG,OAAO;YACV,UAAU,EAAE,KAAK;SAClB;KACF,CAAC,CAAA;IACF,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;IACrD,MAAM,SAAS,GAAG;QAChB,EAAE,EAAE,QAAQ,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC;QACxD,IAAI,EAAE,OAAO,EAAE,QAAQ;YACrB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC1B,CAAC,CAAC,MAAM,CACJ,KAAK;gBACH,CAAC,CAAC,iBAAiB;oBACjB,CAAC,CAAC,cAAc;oBAChB,CAAC,CAAC,gBAAgB;gBACpB,CAAC,CAAC,UAAU,CACR,mBAAmB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,cAAc,CACxD,CACN;QACL,WAAW;QACX,QAAQ,EAAE,QAAQ;KACnB,CAAA;IACD,IAAI,OAAO,EAAE,QAAQ,KAAK,IAAI,IAAI,WAAW,KAAK,GAAG,EAAE,CAAC;QACtD,OAAO;YACL,WAAW,EAAE,MAAM,gBAAgB,CACjC,YAAY,EACZ;gBACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;gBACzB,OAAO,EAAE,WAAW;gBACpB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;gBAChD,GAAG,EAAE,cAAc;gBACnB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE;oBACJ,CAAC,SAAS,CAAC;oBACX,cAAc;oBACd,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC3D,6BAA6B,EAAE;iBAChC;gBACD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;aAChC,EACD,OAAO,EAAE,QAAQ,CAClB;YACD,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,WAAW,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC;oBACxD,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,WAAW,CAChB,KAAK;wBACH,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;wBACjC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAC/C,MAAM,CAAC,KAAK,CAAC,QAAQ,EACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrB;iBACF;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,GAAG;oBACX,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,EAAE;iBACX;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,GAAG;oBACX,QAAQ,EAAE,cAAc;oBACxB,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,EAAE;iBACX;aACF;SACF,CAAA;IACH,CAAC;SAAM,CAAC;QACN,gBAAgB;QAChB,OAAO;YACL,WAAW,EAAE,MAAM,gBAAgB,CACjC,YAAY,EACZ;gBACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;gBACzB,OAAO,EAAE,WAAW;gBACpB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;gBAChD,GAAG,EAAE,cAAc;gBACnB,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE;oBACJ;wBACE;4BACE,UAAU,EAAE,MAAM;4BAClB,UAAU,EAAE,SAAS,CAAC,EAAE;4BACxB,UAAU,EAAE,OAAO,EAAE,aAAa;gCAChC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;gCAChC,CAAC,CAAC,OAAO,CACL,KAAK;oCACH,CAAC,CAAC,UAAU,CACR,kBAAkB;wCAChB,CAAC,CAAC,cAAc;wCAChB,CAAC,CAAC,gBAAgB,CACrB;oCACH,CAAC,CAAC,oBAAoB;wCACpB,CAAC,CAAC,gBAAgB;wCAClB,CAAC,CAAC,cAAc,CACrB;4BACL,IAAI,EAAE,SAAS,CAAC,IAAI;4BACpB,WAAW;4BACX,YAAY,EAAE,QAAQ;4BACtB,YAAY,EAAE,SAAS,CAAC,QAAQ;yBACjC;qBACF;oBACD,cAAc;oBACd,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC3D,6BAA6B,EAAE;iBAChC;gBACD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE;aAChC,EACD,OAAO,EAAE,QAAQ,CAClB;YACD,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,MAAM,EAAE,WAAW,CACjB,WAAW,GAAG,UAAU,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC,EAC7D,aAAa,CAAC,QAAQ,CACvB;oBACD,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,KAAK,EAAE,WAAW,CAChB,KAAK;wBACH,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;wBACjC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAC/C,MAAM,CAAC,KAAK,CAAC,QAAQ,EACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrB;iBACF;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,cAAc;oBACxB,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;aACF;SACF,CAAA;IACH,CAAC;AACH,CAAC,CAAA"}

package/dist/esm/calls/market/market.js

@@ -0,0 +1,201 @@
+import { createPublicClient, http, isAddressEqual, parseUnits, zeroAddress, zeroHash, } from 'viem';
+import { CHAIN_MAP } from '../../constants/chain-configs/chain';
+import { fetchMarket } from '../../entities/market/apis';
+import { getExpectedInput, getExpectedOutput } from '../../views';
+import { buildTransaction } from '../../utils/build-transaction';
+import { CONTRACT_ADDRESSES } from '../../constants/chain-configs/addresses';
+import { CONTROLLER_ABI } from '../../constants/abis/core/controller-abi';
+import { applyPercent } from '../../utils/bigint';
+import { getDeadlineTimestampInSeconds } from '../../utils/time';
+/**
+ * Executes a market order on the specified chain for trading tokens.
+ * If only `amountIn` is provided, spend the specified amount of input tokens.
+ * If only `amountOut` is provided, take the specified amount of output tokens.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user placing the order.
+ * @param {`0x${string}`} inputToken The address of the token to be used as input.
+ * @param {`0x${string}`} outputToken The address of the token to be received as output.
+ * @param {string} amountIn The amount of input tokens for the order to spend.
+ * @param {string} amountOut The amount of output tokens for the order to take.
+ * @param options {@link DefaultWriteContractOptions} options.
+ * @param {erc20PermitParam} [options.erc20PermitParam] The permit signature for token approval.
+ * @param {number} [options.slippage] The maximum slippage percentage allowed for the order.
+ * @param {boolean} [options.roundingDownTakenBid] A boolean indicating whether to round down the taken bid.
+ * @param {boolean} [options.roundingUpTakenAsk] A boolean indicating whether to round up the taken ask.
+ * if the slippage is not provided, unlimited slippage is allowed.
+ * @returns {Promise<{ transaction: Transaction, result: { spent: CurrencyFlow, taken: CurrencyFlow } }>}
+ * Promise resolving to the transaction object representing the market order with the result of the order.
+ * @example
+ * import { marketOrder } from '@clober/v2-sdk'
+ * import { privateKeyToAccount } from 'viem/accounts'
+ *
+ * const transaction = await marketOrder({
+ *   chainId: 421614,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69
+ *   inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   outputToken: '0x0000000000000000000000000000000000000000',
+ *   amount: '100.123', // 100.123 USDC
+ *   options: { erc20PermitParam }
+ * })
+ *
+ */
+export const marketOrder = async ({ chainId, userAddress, inputToken, outputToken, amountIn, amountOut, options, }) => {
+    if (!amountIn && !amountOut) {
+        throw new Error('Either amountIn or amountOut must be provided');
+    }
+    else if (amountIn && amountOut) {
+        throw new Error('Only one of amountIn or amountOut can be provided');
+    }
+    const publicClient = createPublicClient({
+        chain: CHAIN_MAP[chainId],
+        transport: options?.rpcUrl ? http(options.rpcUrl) : http(),
+    });
+    const market = await fetchMarket(publicClient, chainId, [inputToken, outputToken], !!(options && options.useSubgraph));
+    const isTakingBid = isAddressEqual(market.base.address, inputToken);
+    const [inputCurrency, outputCurrency] = isTakingBid
+        ? [market.base, market.quote]
+        : [market.quote, market.base];
+    if ((isTakingBid && !market.bidBook.isOpened) ||
+        (!isTakingBid && !market.askBook.isOpened)) {
+        throw new Error(`
+       Open the market before placing a market order.
+       import { openMarket } from '@clober/v2-sdk'
+
+       const transaction = await openMarket(
+            ${chainId},
+           '${inputToken}',
+           '${outputToken}',
+       )
+    `);
+    }
+    const tokensToSettle = [inputToken, outputToken].filter((address) => !isAddressEqual(address, zeroAddress));
+    const isETH = isAddressEqual(inputToken, zeroAddress);
+    if (amountIn && !amountOut) {
+        const { bookId, takenAmount, spentAmount, events } = await getExpectedOutput({
+            chainId,
+            inputToken,
+            outputToken,
+            amountIn,
+            options: {
+                ...options,
+                // don't need to check limit price for market order
+            },
+        });
+        const baseAmount = parseUnits(amountIn, inputCurrency.decimals);
+        return {
+            transaction: await buildTransaction(publicClient, {
+                chain: CHAIN_MAP[chainId],
+                account: userAddress,
+                address: CONTRACT_ADDRESSES[chainId].Controller,
+                abi: CONTROLLER_ABI,
+                functionName: 'spend',
+                args: [
+                    [
+                        {
+                            id: bookId,
+                            limitPrice: 0n,
+                            baseAmount,
+                            minQuoteAmount: options?.slippage
+                                ? applyPercent(parseUnits(takenAmount, outputCurrency.decimals), 100 - options.slippage)
+                                : 0n,
+                            hookData: zeroHash,
+                        },
+                    ],
+                    tokensToSettle,
+                    options?.erc20PermitParam ? [options.erc20PermitParam] : [],
+                    getDeadlineTimestampInSeconds(),
+                ],
+                value: isETH ? baseAmount : 0n,
+            }, options?.gasLimit),
+            result: {
+                spent: {
+                    amount: spentAmount,
+                    currency: inputCurrency,
+                    direction: 'in',
+                    events: events.map(({ price, spentAmount }) => ({
+                        price,
+                        amount: spentAmount,
+                    })),
+                },
+                taken: {
+                    amount: takenAmount,
+                    currency: outputCurrency,
+                    direction: 'out',
+                    events: events.map(({ price, takenAmount }) => ({
+                        price,
+                        amount: takenAmount,
+                    })),
+                },
+            },
+        };
+    }
+    else if (!amountIn && amountOut) {
+        const { bookId, spentAmount, takenAmount, events } = await getExpectedInput({
+            chainId,
+            inputToken,
+            outputToken,
+            amountOut,
+            options: {
+                ...options,
+                // don't need to check limit price for market order
+            },
+        });
+        const quoteAmount = parseUnits(amountOut, outputCurrency.decimals);
+        const baseAmount = parseUnits(spentAmount, inputCurrency.decimals);
+        const maxBaseAmount = options?.erc20PermitParam?.permitAmount ??
+            (options?.slippage
+                ? applyPercent(baseAmount, 100 + options.slippage)
+                : isETH
+                    ? baseAmount
+                    : 2n ** 256n - 1n);
+        return {
+            transaction: await buildTransaction(publicClient, {
+                chain: CHAIN_MAP[chainId],
+                account: userAddress,
+                address: CONTRACT_ADDRESSES[chainId].Controller,
+                abi: CONTROLLER_ABI,
+                functionName: 'take',
+                args: [
+                    [
+                        {
+                            id: bookId,
+                            limitPrice: 0n,
+                            quoteAmount,
+                            maxBaseAmount,
+                            hookData: zeroHash,
+                        },
+                    ],
+                    tokensToSettle,
+                    options?.erc20PermitParam ? [options.erc20PermitParam] : [],
+                    getDeadlineTimestampInSeconds(),
+                ],
+                value: isETH ? maxBaseAmount : 0n,
+            }, options?.gasLimit),
+            result: {
+                spent: {
+                    amount: spentAmount,
+                    currency: inputCurrency,
+                    direction: 'in',
+                    events: events.map(({ price, spentAmount }) => ({
+                        price,
+                        amount: spentAmount,
+                    })),
+                },
+                taken: {
+                    amount: takenAmount,
+                    currency: outputCurrency,
+                    direction: 'out',
+                    events: events.map(({ price, takenAmount }) => ({
+                        price,
+                        amount: takenAmount,
+                    })),
+                },
+            },
+        };
+    }
+    else {
+        throw new Error('Either amountIn or amountOut must be provided');
+    }
+};
+//# sourceMappingURL=market.js.map

package/dist/esm/calls/market/market.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"market.js","sourceRoot":"","sources":["../../../../src/calls/market/market.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,cAAc,EACd,UAAU,EACV,WAAW,EACX,QAAQ,GACT,MAAM,MAAM,CAAA;AAEb,OAAO,EAAa,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAO1E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAA;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,EAChC,OAAO,EACP,WAAW,EACX,UAAU,EACV,WAAW,EACX,QAAQ,EACR,SAAS,EACT,OAAO,GAeR,EAgBE,EAAE;IACH,IAAI,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IAClE,CAAC;SAAM,IAAI,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;IACtE,CAAC;IACD,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,YAAY,EACZ,OAAO,EACP,CAAC,UAAU,EAAE,WAAW,CAAC,EACzB,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CACnC,CAAA;IACD,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IACnE,MAAM,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,WAAW;QACjD,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC;QAC7B,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,CAAA;IAC/B,IACE,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;QACzC,CAAC,CAAC,WAAW,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAC1C,CAAC;QACD,MAAM,IAAI,KAAK,CAAC;;;;;cAKN,OAAO;cACP,UAAU;cACV,WAAW;;KAEpB,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,MAAM,CACrD,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,CACnD,CAAA;IACD,MAAM,KAAK,GAAG,cAAc,CAAC,UAAU,EAAE,WAAW,CAAC,CAAA;IAErD,IAAI,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;QAC3B,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,GAChD,MAAM,iBAAiB,CAAC;YACtB,OAAO;YACP,UAAU;YACV,WAAW;YACX,QAAQ;YACR,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,mDAAmD;aACpD;SACF,CAAC,CAAA;QACJ,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;QAC/D,OAAO;YACL,WAAW,EAAE,MAAM,gBAAgB,CACjC,YAAY,EACZ;gBACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;gBACzB,OAAO,EAAE,WAAW;gBACpB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;gBAChD,GAAG,EAAE,cAAc;gBACnB,YAAY,EAAE,OAAO;gBACrB,IAAI,EAAE;oBACJ;wBACE;4BACE,EAAE,EAAE,MAAM;4BACV,UAAU,EAAE,EAAE;4BACd,UAAU;4BACV,cAAc,EAAE,OAAO,EAAE,QAAQ;gCAC/B,CAAC,CAAC,YAAY,CACV,UAAU,CAAC,WAAW,EAAE,cAAc,CAAC,QAAQ,CAAC,EAChD,GAAG,GAAG,OAAO,CAAC,QAAQ,CACvB;gCACH,CAAC,CAAC,EAAE;4BACN,QAAQ,EAAE,QAAQ;yBACnB;qBACF;oBACD,cAAc;oBACd,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC3D,6BAA6B,EAAE;iBAChC;gBACD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;aAC/B,EACD,OAAO,EAAE,QAAQ,CAClB;YACD,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,cAAc;oBACxB,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;aACF;SACF,CAAA;IACH,CAAC;SAAM,IAAI,CAAC,QAAQ,IAAI,SAAS,EAAE,CAAC;QAClC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,MAAM,gBAAgB,CACzE;YACE,OAAO;YACP,UAAU;YACV,WAAW;YACX,SAAS;YACT,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,mDAAmD;aACpD;SACF,CACF,CAAA;QACD,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAA;QAClE,MAAM,UAAU,GAAG,UAAU,CAAC,WAAW,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAA;QAClE,MAAM,aAAa,GACjB,OAAO,EAAE,gBAAgB,EAAE,YAAY;YACvC,CAAC,OAAO,EAAE,QAAQ;gBAChB,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,GAAG,GAAG,OAAO,CAAC,QAAQ,CAAC;gBAClD,CAAC,CAAC,KAAK;oBACL,CAAC,CAAC,UAAU;oBACZ,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,EAAE,CAAC,CAAA;QACxB,OAAO;YACL,WAAW,EAAE,MAAM,gBAAgB,CACjC,YAAY,EACZ;gBACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;gBACzB,OAAO,EAAE,WAAW;gBACpB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;gBAChD,GAAG,EAAE,cAAc;gBACnB,YAAY,EAAE,MAAM;gBACpB,IAAI,EAAE;oBACJ;wBACE;4BACE,EAAE,EAAE,MAAM;4BACV,UAAU,EAAE,EAAE;4BACd,WAAW;4BACX,aAAa;4BACb,QAAQ,EAAE,QAAQ;yBACnB;qBACF;oBACD,cAAc;oBACd,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC3D,6BAA6B,EAAE;iBAChC;gBACD,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;aAClC,EACD,OAAO,EAAE,QAAQ,CAClB;YACD,MAAM,EAAE;gBACN,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,aAAa;oBACvB,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,WAAW;oBACnB,QAAQ,EAAE,cAAc;oBACxB,SAAS,EAAE,KAAK;oBAChB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBAC9C,KAAK;wBACL,MAAM,EAAE,WAAW;qBACpB,CAAC,CAAC;iBACJ;aACF;SACF,CAAA;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IAClE,CAAC;AACH,CAAC,CAAA"}

package/dist/esm/calls/market/open.js

@@ -0,0 +1,65 @@
+import { createPublicClient, http, isAddressEqual, zeroAddress, zeroHash, } from 'viem';
+import { CHAIN_MAP } from '../../constants/chain-configs/chain';
+import { fetchMarket } from '../../entities/market/apis';
+import { calculateUnitSize } from '../../utils/unit-size';
+import { CONTRACT_ADDRESSES } from '../../constants/chain-configs/addresses';
+import { CONTROLLER_ABI } from '../../constants/abis/core/controller-abi';
+import { MAKER_DEFAULT_POLICY, TAKER_DEFAULT_POLICY, } from '../../constants/chain-configs/fee';
+import { getDeadlineTimestampInSeconds } from '../../utils/time';
+import { buildTransaction } from '../../utils/build-transaction';
+/**
+ * Build a transaction to open a market.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param userAddress The address of the user.
+ * @param inputToken The address of the input token.
+ * @param outputToken The address of the output token.
+ * @param options {@link DefaultWriteContractOptions} options.
+ * @returns A Promise resolving to a transaction object. If the market is already open, returns undefined.
+ * @example
+ * import { openMarket } from '@clober/v2-sdk'
+ *
+ * const transaction = await openMarket({
+ *   chainId: 421614,
+ *   userAddress: '0xF8c1869Ecd4df136693C45EcE1b67f85B6bDaE69',
+ *   inputToken: '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *   outputToken: '0x0000000000000000000000000000000000000000'
+ * })
+ */
+export const openMarket = async ({ chainId, userAddress, inputToken, outputToken, options, }) => {
+    const publicClient = createPublicClient({
+        chain: CHAIN_MAP[chainId],
+        transport: options?.rpcUrl ? http(options.rpcUrl) : http(),
+    });
+    const market = await fetchMarket(publicClient, chainId, [inputToken, outputToken], !!(options && options.useSubgraph));
+    const isBid = isAddressEqual(market.quote.address, inputToken);
+    if ((isBid && !market.bidBook.isOpened) ||
+        (!isBid && !market.askBook.isOpened)) {
+        const unitSize = calculateUnitSize(chainId, isBid ? market.quote : market.base);
+        return buildTransaction(publicClient, {
+            chain: CHAIN_MAP[chainId],
+            address: CONTRACT_ADDRESSES[chainId].Controller,
+            account: userAddress,
+            abi: CONTROLLER_ABI,
+            functionName: 'open',
+            args: [
+                [
+                    {
+                        key: {
+                            base: outputToken,
+                            unitSize,
+                            quote: inputToken,
+                            makerPolicy: MAKER_DEFAULT_POLICY[chainId].value,
+                            hooks: zeroAddress,
+                            takerPolicy: TAKER_DEFAULT_POLICY[chainId].value,
+                        },
+                        hookData: zeroHash,
+                    },
+                ],
+                getDeadlineTimestampInSeconds(),
+            ],
+        }, options?.gasLimit);
+    }
+    return undefined;
+};
+//# sourceMappingURL=open.js.map

package/dist/esm/calls/market/open.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"open.js","sourceRoot":"","sources":["../../../../src/calls/market/open.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,cAAc,EACd,WAAW,EACX,QAAQ,GACT,MAAM,MAAM,CAAA;AAEb,OAAO,EAAa,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAA;AACzE,OAAO,EACL,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,6BAA6B,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,EAC/B,OAAO,EACP,WAAW,EACX,UAAU,EACV,WAAW,EACX,OAAO,GASR,EAAoC,EAAE;IACrC,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAA;IACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,YAAY,EACZ,OAAO,EACP,CAAC,UAAU,EAAE,WAAW,CAAC,EACzB,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CACnC,CAAA;IACD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAC9D,IACE,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;QACnC,CAAC,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EACpC,CAAC;QACD,MAAM,QAAQ,GAAG,iBAAiB,CAChC,OAAO,EACP,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CACnC,CAAA;QACD,OAAO,gBAAgB,CACrB,YAAY,EACZ;YACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;YACzB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;YAChD,OAAO,EAAE,WAAW;YACpB,GAAG,EAAE,cAAc;YACnB,YAAY,EAAE,MAAM;YACpB,IAAI,EAAE;gBACJ;oBACE;wBACE,GAAG,EAAE;4BACH,IAAI,EAAE,WAAW;4BACjB,QAAQ;4BACR,KAAK,EAAE,UAAU;4BACjB,WAAW,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC,KAAK;4BAChD,KAAK,EAAE,WAAW;4BAClB,WAAW,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC,KAAK;yBACjD;wBACD,QAAQ,EAAE,QAAQ;qBACnB;iBACF;gBACD,6BAA6B,EAAE;aAChC;SACF,EACD,OAAO,EAAE,QAAQ,CAClB,CAAA;IACH,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA"}

package/dist/esm/calls/pool/burn.js

@@ -0,0 +1,85 @@
+import { createPublicClient, formatUnits, http, parseUnits } from 'viem';
+import { CHAIN_MAP } from '../../constants/chain-configs/chain';
+import { fetchPool } from '../../entities/pool/apis';
+import { applyPercent } from '../../utils/bigint';
+import { buildTransaction } from '../../utils/build-transaction';
+import { CONTRACT_ADDRESSES } from '../../constants/chain-configs/addresses';
+import { REBALANCER_ABI } from '../../constants/abis/rebalancer/rebalancer-abi';
+// @dev: Withdraw amount calculation logic is based on the contract code.
+export const removeLiquidity = async ({ chainId, userAddress, token0, token1, salt, amount, options, }) => {
+    const publicClient = createPublicClient({
+        chain: CHAIN_MAP[chainId],
+        transport: options?.rpcUrl ? http(options.rpcUrl) : http(),
+    });
+    const pool = await fetchPool(publicClient, chainId, [token0, token1], salt, !!(options && options.useSubgraph));
+    if (!pool.isOpened) {
+        throw new Error(`
+       Open the pool before removing liquidity.
+       import { openPool } from '@clober/v2-sdk'
+
+       const transaction = await openPool({
+            chainId: ${chainId},
+            tokenA: '${token0}',
+            tokenB: '${token1}',
+            salt: '0x0000000000000000000000000000000000000000000000000000000000000000',
+       })
+    `);
+    }
+    const burnAmount = parseUnits(amount, pool.currencyLp.decimals);
+    const slippageLimitPercent = options?.slippage ?? 2;
+    const withdrawAmountA = (burnAmount * pool.liquidityA) / pool.totalSupply;
+    const withdrawAmountB = (burnAmount * pool.liquidityB) / pool.totalSupply;
+    const minWithdrawAmountA = applyPercent(withdrawAmountA, 100 - slippageLimitPercent);
+    const minWithdrawAmountB = applyPercent(withdrawAmountB, 100 - slippageLimitPercent);
+    if (burnAmount === 0n) {
+        return {
+            transaction: undefined,
+            result: {
+                currencyA: {
+                    currency: pool.currencyA,
+                    amount: '0',
+                    direction: 'out',
+                },
+                currencyB: {
+                    currency: pool.currencyB,
+                    amount: '0',
+                    direction: 'out',
+                },
+                lpCurrency: {
+                    currency: pool.currencyLp,
+                    amount: '0',
+                    direction: 'in',
+                },
+            },
+        };
+    }
+    const transaction = await buildTransaction(publicClient, {
+        chain: CHAIN_MAP[chainId],
+        account: userAddress,
+        address: CONTRACT_ADDRESSES[chainId].Rebalancer,
+        abi: REBALANCER_ABI,
+        functionName: 'burn',
+        args: [pool.key, burnAmount, minWithdrawAmountA, minWithdrawAmountB],
+    }, options?.gasLimit);
+    return {
+        transaction,
+        result: {
+            currencyA: {
+                currency: pool.currencyA,
+                amount: formatUnits(withdrawAmountA, pool.currencyA.decimals),
+                direction: 'out',
+            },
+            currencyB: {
+                currency: pool.currencyB,
+                amount: formatUnits(withdrawAmountB, pool.currencyB.decimals),
+                direction: 'out',
+            },
+            lpCurrency: {
+                currency: pool.currencyLp,
+                amount: amount,
+                direction: 'in',
+            },
+        },
+    };
+};
+//# sourceMappingURL=burn.js.map

package/dist/esm/calls/pool/burn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"burn.js","sourceRoot":"","sources":["../../../../src/calls/pool/burn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAExE,OAAO,EAAa,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAO1E,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,yCAAyC,CAAA;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAA;AAE/E,yEAAyE;AACzE,MAAM,CAAC,MAAM,eAAe,GAAG,KAAK,EAAE,EACpC,OAAO,EACP,WAAW,EACX,MAAM,EACN,MAAM,EACN,IAAI,EACJ,MAAM,EACN,OAAO,GAYR,EAOE,EAAE;IACH,MAAM,YAAY,GAAG,kBAAkB,CAAC;QACtC,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAA;IACF,MAAM,IAAI,GAAG,MAAM,SAAS,CAC1B,YAAY,EACZ,OAAO,EACP,CAAC,MAAM,EAAE,MAAM,CAAC,EAChB,IAAI,EACJ,CAAC,CAAC,CAAC,OAAO,IAAI,OAAO,CAAC,WAAW,CAAC,CACnC,CAAA;IACD,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC;;;;;uBAKG,OAAO;uBACP,MAAM;uBACN,MAAM;;;KAGxB,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAA;IAC/D,MAAM,oBAAoB,GAAG,OAAO,EAAE,QAAQ,IAAI,CAAC,CAAA;IACnD,MAAM,eAAe,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;IACzE,MAAM,eAAe,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;IACzE,MAAM,kBAAkB,GAAG,YAAY,CACrC,eAAe,EACf,GAAG,GAAG,oBAAoB,CAC3B,CAAA;IACD,MAAM,kBAAkB,GAAG,YAAY,CACrC,eAAe,EACf,GAAG,GAAG,oBAAoB,CAC3B,CAAA;IAED,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;QACtB,OAAO;YACL,WAAW,EAAE,SAAS;YACtB,MAAM,EAAE;gBACN,SAAS,EAAE;oBACT,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,MAAM,EAAE,GAAG;oBACX,SAAS,EAAE,KAAK;iBACjB;gBACD,SAAS,EAAE;oBACT,QAAQ,EAAE,IAAI,CAAC,SAAS;oBACxB,MAAM,EAAE,GAAG;oBACX,SAAS,EAAE,KAAK;iBACjB;gBACD,UAAU,EAAE;oBACV,QAAQ,EAAE,IAAI,CAAC,UAAU;oBACzB,MAAM,EAAE,GAAG;oBACX,SAAS,EAAE,IAAI;iBAChB;aACF;SACF,CAAA;IACH,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,gBAAgB,CACxC,YAAY,EACZ;QACE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC;QACzB,OAAO,EAAE,WAAW;QACpB,OAAO,EAAE,kBAAkB,CAAC,OAAO,CAAE,CAAC,UAAU;QAChD,GAAG,EAAE,cAAc;QACnB,YAAY,EAAE,MAAM;QACpB,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,kBAAkB,EAAE,kBAAkB,CAAC;KACrE,EACD,OAAO,EAAE,QAAQ,CAClB,CAAA;IAED,OAAO;QACL,WAAW;QACX,MAAM,EAAE;YACN,SAAS,EAAE;gBACT,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;gBAC7D,SAAS,EAAE,KAAK;aACjB;YACD,SAAS,EAAE;gBACT,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,MAAM,EAAE,WAAW,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;gBAC7D,SAAS,EAAE,KAAK;aACjB;YACD,UAAU,EAAE;gBACV,QAAQ,EAAE,IAAI,CAAC,UAAU;gBACzB,MAAM,EAAE,MAAM;gBACd,SAAS,EAAE,IAAI;aAChB;SACF;KACF,CAAA;AACH,CAAC,CAAA"}