@clober/v2-sdk 0.0.1-b → 0.0.1-dev

package/dist/esm/view.js

@@ -0,0 +1,177 @@
+import { formatUnits, isAddressEqual, parseUnits } from 'viem';
+import { fetchMarket } from './apis/market';
+import { parsePrice } from './utils/prices';
+import { MAX_PRICE } from './constants/price';
+import { fetchOpenOrder, fetchOpenOrders } from './apis/open-order';
+/**
+ * Get market information by chain id and token addresses
+ * @param chainId - chain id from {@link CHAIN_IDS}
+ * @param token0 - token0 address
+ * @param token1 - token1 address
+ * @param options
+ * @param options.rpcUrl - RPC URL of the blockchain
+ * @returns A market {@link Market}
+ *
+ * @example
+ * import { getMarket } from '@clober/v2-sdk'
+ *
+ * const market = await getMarket(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ * )
+ */
+export const getMarket = async (chainId, token0, token1, options) => {
+    if (isAddressEqual(token0, token1)) {
+        throw new Error('Token0 and token1 must be different');
+    }
+    const market = await fetchMarket(chainId, [token0, token1], options?.rpcUrl);
+    return {
+        chainId,
+        quote: market.quote,
+        base: market.base,
+        makerFee: market.makerFee,
+        takerFee: market.takerFee,
+        bids: market.bids,
+        bidBookOpen: market.bidBookOpen,
+        asks: market.asks,
+        askBookOpen: market.askBookOpen,
+    };
+};
+/**
+ * Calculates the expected output for a given input amount, based on the provided market data.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param inputToken The address of the input token.
+ * @param outputToken The address of the output token.
+ * @param amountIn The amount of expected input amount. (ex 1.2 ETH -> 1.2)
+ * @param options
+ * @param options.limitPrice The maximum limit price to spend.
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns A Promise resolving to an object containing the taken amount, spend amount and result of the calculation.
+ * @example
+ * import { getExpectedOutput } from '@clober/v2-sdk'
+ *
+ * const { takenAmount, spendAmount } = await getExpectedOutput(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ *  '1000.123', // spend 1000.123 USDC
+ * )
+ */
+export const getExpectedOutput = async (chainId, inputToken, outputToken, amountIn, options) => {
+    const market = await fetchMarket(chainId, [inputToken, outputToken], options?.rpcUrl);
+    const isBid = isAddressEqual(market.quote.address, inputToken);
+    const rawLimitPrice = options && options.limitPrice
+        ? parsePrice(Number(options.limitPrice), market.quote.decimals, market.base.decimals)
+        : isBid
+            ? MAX_PRICE
+            : 0n;
+    const inputCurrency = isBid ? market.quote : market.base;
+    const result = market.spend({
+        spendBase: !isBid,
+        limitPrice: rawLimitPrice,
+        amountIn: parseUnits(amountIn, inputCurrency.decimals),
+    });
+    const { takenAmount, spendAmount } = Object.values(result).reduce((acc, { takenAmount, spendAmount }) => ({
+        takenAmount: acc.takenAmount + takenAmount,
+        spendAmount: acc.spendAmount + spendAmount,
+    }), { takenAmount: 0n, spendAmount: 0n });
+    return {
+        takenAmount: formatUnits(takenAmount, isBid ? market.base.decimals : market.quote.decimals),
+        spendAmount: formatUnits(spendAmount, isBid ? market.quote.decimals : market.base.decimals),
+        result: Object.entries(result).map(([bookId, { takenAmount, spendAmount }]) => ({
+            bookId: BigInt(bookId),
+            takenAmount,
+            spendAmount,
+        })),
+    };
+};
+/**
+ * Calculates the expected input for a given output amount, based on the provided market data.
+ *
+ * @param chainId The chain ID of the blockchain.
+ * @param inputToken The address of the input token.
+ * @param outputToken The address of the output token.
+ * @param amountOut The amount of expected output amount. (ex 1.2 ETH -> 1.2)
+ * @param options
+ * @param options.limitPrice The maximum limit price to take.
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns A Promise resolving to an object containing the taken amount, spend amount and result of the calculation.
+ * @example
+ * import { getExpectedInput } from '@clober/v2-sdk'
+ *
+ * const { takenAmount, spendAmount } = await getExpectedInput(
+ *   421614,
+ *  '0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0',
+ *  '0x0000000000000000000000000000000000000000',
+ *  '0.1', // take 0.1 ETH
+ * )
+ */
+export const getExpectedInput = async (chainId, inputToken, outputToken, amountOut, options) => {
+    const market = await fetchMarket(chainId, [inputToken, outputToken], options?.rpcUrl);
+    const isBid = isAddressEqual(market.quote.address, inputToken);
+    const rawLimitPrice = options && options.limitPrice
+        ? parsePrice(Number(options.limitPrice), market.quote.decimals, market.base.decimals)
+        : isBid
+            ? MAX_PRICE
+            : 0n;
+    const outputCurrency = isBid ? market.base : market.quote;
+    const result = market.take({
+        takeQuote: !isBid,
+        limitPrice: rawLimitPrice,
+        amountOut: parseUnits(amountOut, outputCurrency.decimals),
+    });
+    const { takenAmount, spendAmount } = Object.values(result).reduce((acc, { takenAmount, spendAmount }) => ({
+        takenAmount: acc.takenAmount + takenAmount,
+        spendAmount: acc.spendAmount + spendAmount,
+    }), { takenAmount: 0n, spendAmount: 0n });
+    return {
+        takenAmount: formatUnits(takenAmount, isBid ? market.base.decimals : market.quote.decimals),
+        spendAmount: formatUnits(spendAmount, isBid ? market.quote.decimals : market.base.decimals),
+        result: Object.entries(result).map(([bookId, { takenAmount, spendAmount }]) => ({
+            bookId: BigInt(bookId),
+            takenAmount,
+            spendAmount,
+        })),
+    };
+};
+/**
+ * Retrieves the open order with the specified ID on the given chain.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {string} id The ID of the open order.
+ * @param options
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns {Promise<OpenOrder>} Promise resolving to the open order object, or undefined if not found.
+ * @example
+ * import { getOpenOrder } from '@clober/v2-sdk'
+ *
+ * const openOrder = await getOpenOrder(
+ *   421614,
+ *  '46223845323662364279893361453861711542636620039907198451770258805035840307200'
+ * )
+ */
+export const getOpenOrder = async (chainId, id, options) => {
+    return fetchOpenOrder(chainId, id, options?.rpcUrl);
+};
+/**
+ * Retrieves open orders for the specified user on the given chain.
+ *
+ * @param {CHAIN_IDS} chainId The chain ID.
+ * @param {`0x${string}`} userAddress The Ethereum address of the user.
+ * @param options
+ * @param options.rpcUrl The RPC URL of the blockchain.
+ * @returns {Promise<OpenOrder[]>} Promise resolving to an array of open orders.
+ * @example
+ * import { getOpenOrders } from '@clober/v2-sdk'
+ *
+ * const openOrders = await getOpenOrders(
+ *   421614,
+ *  '0x5F79EE8f8fA862E98201120d83c4eC39D9468D49'
+ * )
+ */
+export const getOpenOrders = async (chainId, userAddress, options) => {
+    return fetchOpenOrders(chainId, userAddress, options?.rpcUrl);
+};
+//# sourceMappingURL=view.js.map

package/dist/esm/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../src/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAE9D,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAG3C,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAGnE;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,EAC5B,OAAkB,EAClB,MAAqB,EACrB,MAAqB,EACrB,OAA6B,EACZ,EAAE;IACnB,IAAI,cAAc,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;IACxD,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC5E,OAAO;QACL,OAAO;QACP,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,OAAkB,EAClB,UAAyB,EACzB,WAA0B,EAC1B,QAAgB,EAChB,OAAkD,EAKjD,EAAE;IACH,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,OAAO,EACP,CAAC,UAAU,EAAE,WAAW,CAAC,EACzB,OAAO,EAAE,MAAM,CAChB,CAAA;IACD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAC9D,MAAM,aAAa,GACjB,OAAO,IAAI,OAAO,CAAC,UAAU;QAC3B,CAAC,CAAC,UAAU,CACR,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAC1B,MAAM,CAAC,KAAK,CAAC,QAAQ,EACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrB;QACH,CAAC,CAAC,KAAK;YACL,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,EAAE,CAAA;IACV,MAAM,aAAa,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAA;IACxD,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,SAAS,EAAE,CAAC,KAAK;QACjB,UAAU,EAAE,aAAa;QACzB,QAAQ,EAAE,UAAU,CAAC,QAAQ,EAAE,aAAa,CAAC,QAAQ,CAAC;KACvD,CAAC,CAAA;IACF,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,WAAW,EAAE,GAAG,CAAC,WAAW,GAAG,WAAW;QAC1C,WAAW,EAAE,GAAG,CAAC,WAAW,GAAG,WAAW;KAC3C,CAAC,EACF,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CACrC,CAAA;IACD,OAAO;QACL,WAAW,EAAE,WAAW,CACtB,WAAW,EACX,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CACrD;QACD,WAAW,EAAE,WAAW,CACtB,WAAW,EACX,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrD;QACD,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAChC,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,WAAW;YACX,WAAW;SACZ,CAAC,CACH;KACF,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EACnC,OAAkB,EAClB,UAAyB,EACzB,WAA0B,EAC1B,SAAiB,EACjB,OAAkD,EAKjD,EAAE;IACH,MAAM,MAAM,GAAG,MAAM,WAAW,CAC9B,OAAO,EACP,CAAC,UAAU,EAAE,WAAW,CAAC,EACzB,OAAO,EAAE,MAAM,CAChB,CAAA;IACD,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,CAAC,CAAA;IAC9D,MAAM,aAAa,GACjB,OAAO,IAAI,OAAO,CAAC,UAAU;QAC3B,CAAC,CAAC,UAAU,CACR,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAC1B,MAAM,CAAC,KAAK,CAAC,QAAQ,EACrB,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrB;QACH,CAAC,CAAC,KAAK;YACL,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,EAAE,CAAA;IACV,MAAM,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAA;IACzD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;QACzB,SAAS,EAAE,CAAC,KAAK;QACjB,UAAU,EAAE,aAAa;QACzB,SAAS,EAAE,UAAU,CAAC,SAAS,EAAE,cAAc,CAAC,QAAQ,CAAC;KAC1D,CAAC,CAAA;IACF,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAC/D,CAAC,GAAG,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;QACtC,WAAW,EAAE,GAAG,CAAC,WAAW,GAAG,WAAW;QAC1C,WAAW,EAAE,GAAG,CAAC,WAAW,GAAG,WAAW;KAC3C,CAAC,EACF,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,CACrC,CAAA;IACD,OAAO;QACL,WAAW,EAAE,WAAW,CACtB,WAAW,EACX,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CACrD;QACD,WAAW,EAAE,WAAW,CACtB,WAAW,EACX,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CACrD;QACD,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAChC,CAAC,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;YAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACtB,WAAW;YACX,WAAW;SACZ,CAAC,CACH;KACF,CAAA;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAC/B,OAAkB,EAClB,EAAU,EACV,OAA6B,EACT,EAAE;IACtB,OAAO,cAAc,CAAC,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;AACrD,CAAC,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,EAChC,OAAkB,EAClB,WAA0B,EAC1B,OAA6B,EACP,EAAE;IACxB,OAAO,eAAe,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;AAC/D,CAAC,CAAA"}