Merge pull request #28 from clober-dex/fix/limit-result

Fix/limit result

Author: graykode

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clober/v2-sdk",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "description": "🛠 An SDK for building applications on top of Clober V2",
   "files": [
     "dist"

src/call.ts

@@ -111,7 +111,7 @@ export const openMarket = decorator(
  * @param {string} [options.rpcUrl] The RPC URL of the blockchain.
  * @param {number} [options.gasLimit] The gas limit to use for the transaction.
  * @param {boolean} [options.useSubgraph] A boolean indicating whether to use the subgraph for fetching orders.
- * @returns {Promise<{ transaction: Transaction, result: { make: CurrencyFlow, take: CurrencyFlow } }>}
+ * @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 { signERC20Permit, limitOrder } from '@clober/v2-sdk'
@@ -171,6 +171,7 @@ export const limitOrder = decorator(
     result: {
       make: CurrencyFlow
       taken: CurrencyFlow
+      spent: CurrencyFlow
     }
   }> => {
     const market = await fetchMarket(chainId, [inputToken, outputToken])
@@ -201,7 +202,7 @@ export const limitOrder = decorator(
       (address) => !isAddressEqual(address, zeroAddress),
     )
     const quoteAmount = parseUnits(amount, inputCurrency.decimals)
-    const [unit, { spentAmount, bookId }] = await Promise.all([
+    const [unit, { takenAmount, spentAmount, bookId }] = await Promise.all([
       calculateUnit(chainId, inputCurrency),
       getExpectedOutput({
         chainId,
@@ -247,6 +248,11 @@ export const limitOrder = decorator(
             currency: inputCurrency,
             direction: 'in',
           },
+          spent: {
+            amount: '0',
+            currency: inputCurrency,
+            direction: 'out',
+          },
           taken: {
             amount: '0',
             currency: outputCurrency,
@@ -287,12 +293,20 @@ export const limitOrder = decorator(
         ),
         result: {
           make: {
-            amount: formatUnits(quoteAmount, inputCurrency.decimals),
+            amount: formatUnits(
+              quoteAmount - parseUnits(spentAmount, inputCurrency.decimals),
+              inputCurrency.decimals,
+            ),
             currency: inputCurrency,
             direction: 'in',
           },
-          taken: {
+          spent: {
             amount: spentAmount,
+            currency: inputCurrency,
+            direction: 'out',
+          },
+          taken: {
+            amount: takenAmount,
             currency: outputCurrency,
             direction: 'out',
           },

test/limit-order.test.ts

@@ -62,7 +62,7 @@ test('make bid order', async () => {
   })
   const {
     transaction,
-    result: { make, taken },
+    result: { make, taken, spent },
   } = await limitOrder({
     chainId: cloberTestChain.id,
     userAddress: account.address,
@@ -128,6 +128,10 @@ test('make bid order', async () => {
   expect(make.currency.address).toEqual(
     getAddress('0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'),
   )
+  expect(spent.amount).toEqual('0')
+  expect(spent.currency.address).toEqual(
+    getAddress('0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'),
+  )
   expect(taken.amount).toEqual('0')
   expect(taken.currency.address).toEqual(
     '0x0000000000000000000000000000000000000000',
@@ -140,7 +144,7 @@ test('make ask order', async () => {
 
   const {
     transaction,
-    result: { make, taken },
+    result: { make, taken, spent },
   } = await limitOrder({
     chainId: cloberTestChain.id,
     userAddress: account.address,
@@ -202,6 +206,10 @@ test('make ask order', async () => {
   expect(make.currency.address).toEqual(
     '0x0000000000000000000000000000000000000000',
   )
+  expect(spent.amount).toEqual('0')
+  expect(spent.currency.address).toEqual(
+    '0x0000000000000000000000000000000000000000',
+  )
   expect(taken.amount).toEqual('0')
   expect(taken.currency.address).toEqual(
     getAddress('0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'),
@@ -245,7 +253,7 @@ test('limit bid order', async () => {
   })
   const {
     transaction,
-    result: { make, taken },
+    result: { make, taken, spent },
   } = await limitOrder({
     chainId: cloberTestChain.id,
     userAddress: account.address,
@@ -298,14 +306,15 @@ test('limit bid order', async () => {
   ).toEqual(28440764694968336000)
   expect(afterMarket.asks.length).toEqual(beforeMarket.asks.length - 1)
   expect(afterMarket.bids.length).toEqual(beforeMarket.bids.length + 1)
-  expect(make.amount).toEqual('100000')
+  expect(make.amount).toEqual('99649.86826')
   expect(make.currency.address).toEqual(
     getAddress('0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'),
   )
-  expect(taken.amount).toEqual('350.13174')
+  expect(taken.amount).toEqual('0.09992997')
   expect(taken.currency.address).toEqual(
     '0x0000000000000000000000000000000000000000',
   )
+  expect(Number(make.amount) + Number(spent.amount)).toEqual(100000)
 })
 
 test('limit ask order', async () => {
@@ -322,7 +331,7 @@ test('limit ask order', async () => {
 
   const {
     transaction,
-    result: { make, taken },
+    result: { make, taken, spent },
   } = await limitOrder({
     chainId: cloberTestChain.id,
     userAddress: account.address,
@@ -396,12 +405,13 @@ test('limit ask order', async () => {
   ).toEqual(1008553000000000000)
   expect(afterMarket.bids.length).toEqual(beforeMarket.bids.length - 1)
   expect(afterMarket.asks.length).toEqual(beforeMarket.asks.length + 1)
-  expect(make.amount).toEqual('2')
+  expect(make.amount).toEqual('1.008250484573137286')
   expect(make.currency.address).toEqual(
     '0x0000000000000000000000000000000000000000',
   )
-  expect(taken.amount).toEqual('0.991749515426862714')
+  expect(taken.amount).toEqual('3467.57027')
   expect(taken.currency.address).toEqual(
     getAddress('0x00bfd44e79fb7f6dd5887a9426c8ef85a0cd23e0'),
   )
+  expect(Number(make.amount) + Number(spent.amount)).toEqual(2)
 })