update order error message

nervina-labs · Feb 8, 2024 · 50511e6 · 50511e6
1 parent 16c1fcd
commit 50511e6
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 13 deletions.
diff --git a/src/collector/index.ts b/src/collector/index.ts
@@ -2,7 +2,7 @@ import axios from 'axios'
 import CKB from '@nervosnetwork/ckb-sdk-core'
 import { toCamelcase } from '../utils/case-parser'
 import { IndexerCell, CollectResult, IndexerCapacity, CollectXudtResult } from '../types/collector'
-import { MIN_CAPACITY } from '../constants'
+import { CKB_UNIT, MIN_CAPACITY } from '../constants'
 import { CapacityNotEnoughException, IndexerException, XudtAmountNotEnoughException } from '../exceptions'
 import { leToU128 } from '../utils'
 
@@ -117,7 +117,7 @@ export class Collector {
     }
   }
 
-  collectInputs(liveCells: IndexerCell[], needCapacity: bigint, fee: bigint, minCapacity?: bigint): CollectResult {
+  collectInputs(liveCells: IndexerCell[], needCapacity: bigint, fee: bigint, minCapacity?: bigint, errMsg?: string): CollectResult {
     const changeCapacity = minCapacity ?? MIN_CAPACITY
     let inputs: CKBComponents.CellInput[] = []
     let sum = BigInt(0)
@@ -134,11 +134,9 @@ export class Collector {
         break
       }
     }
-    if (sum < needCapacity + fee) {
-      throw new CapacityNotEnoughException('Capacity not enough')
-    }
-    if (sum < needCapacity + changeCapacity + fee && sum !== needCapacity + fee) {
-      throw new CapacityNotEnoughException('Capacity not enough for change')
+    if (sum < needCapacity + changeCapacity + fee) {
+      const message = errMsg ?? 'Insufficient free CKB balance'
+      throw new CapacityNotEnoughException(message)
     }
     return { inputs, capacity: sum }
   }
@@ -162,7 +160,7 @@ export class Collector {
       }
     }
     if (sumAmount < needAmount) {
-      throw new XudtAmountNotEnoughException('Capacity not enough')
+      throw new XudtAmountNotEnoughException('Insufficient Xudt balance')
     }
     return { inputs, capacity: sumCapacity, amount: sumAmount }
   }

diff --git a/src/order/cancel.ts b/src/order/cancel.ts
@@ -1,5 +1,13 @@
 import { addressToScript, blake160, getTransactionSize, serializeScript, serializeWitnessArgs } from '@nervosnetwork/ckb-sdk-utils'
-import { getCotaTypeScript, getXudtDep, getJoyIDCellDep, getDexCellDep, MAX_FEE, JOYID_ESTIMATED_WITNESS_LOCK_SIZE } from '../constants'
+import {
+  getCotaTypeScript,
+  getXudtDep,
+  getJoyIDCellDep,
+  getDexCellDep,
+  MAX_FEE,
+  JOYID_ESTIMATED_WITNESS_LOCK_SIZE,
+  CKB_UNIT,
+} from '../constants'
 import { CancelParams, SubkeyUnlockReq, TakerResult } from '../types'
 import { append0x } from '../utils'
 import { XudtException, NoCotaCellException, NoLiveCellException } from '../exceptions'
@@ -46,7 +54,15 @@ export const buildCancelTx = async ({ collector, joyID, seller, orderOutPoints,
   const outputsData = xudtOutputsData
 
   const minCellCapacity = calculateEmptyCellMinCapacity(sellerLock)
-  const { inputs: emptyInputs, capacity: inputsCapacity } = collector.collectInputs(emptyCells, minCellCapacity, txFee, minCellCapacity)
+  const needCapacity = ((minCellCapacity + minCellCapacity + CKB_UNIT) / CKB_UNIT).toString()
+  const errMsg = `At least ${needCapacity} free CKB (refundable) is required to cancel the sell order.`
+  const { inputs: emptyInputs, capacity: inputsCapacity } = collector.collectInputs(
+    emptyCells,
+    minCellCapacity,
+    txFee,
+    minCellCapacity,
+    errMsg,
+  )
   const orderInputs: CKBComponents.CellInput[] = outPoints.map(outPoint => ({
     previousOutput: outPoint,
     since: '0x0',

diff --git a/src/order/maker.ts b/src/order/maker.ts
@@ -1,6 +1,14 @@
 import { addressToScript, blake160, getTransactionSize, serializeScript, serializeWitnessArgs } from '@nervosnetwork/ckb-sdk-utils'
 import { blockchain } from '@ckb-lumos/base'
-import { getDexLockScript, getCotaTypeScript, getXudtDep, getJoyIDCellDep, MAX_FEE, JOYID_ESTIMATED_WITNESS_LOCK_SIZE } from '../constants'
+import {
+  getDexLockScript,
+  getCotaTypeScript,
+  getXudtDep,
+  getJoyIDCellDep,
+  MAX_FEE,
+  JOYID_ESTIMATED_WITNESS_LOCK_SIZE,
+  CKB_UNIT,
+} from '../constants'
 import { Hex, SubkeyUnlockReq, MakerParams, MakerResult } from '../types'
 import { append0x, u128ToLe } from '../utils'
 import { XudtException, NoCotaCellException, NoLiveCellException } from '../exceptions'
@@ -36,11 +44,14 @@ export const buildMakerTx = async ({
   const orderCellCapacity = calculateXudtCellCapacity(orderLock, xudtTypeScript)
 
   const minCellCapacity = calculateEmptyCellMinCapacity(sellerLock)
+  const needCapacity = ((orderCellCapacity + minCellCapacity + CKB_UNIT) / CKB_UNIT).toString()
+  const errMsg = `At least ${needCapacity} free CKB (refundable) is required to place a sell order.`
   const { inputs: emptyInputs, capacity: emptyInputsCapacity } = collector.collectInputs(
     emptyCells,
     orderCellCapacity,
     txFee,
     minCellCapacity,
+    errMsg,
   )
 
   const xudtCells = await collector.getCells({

diff --git a/src/order/taker.ts b/src/order/taker.ts
@@ -1,5 +1,13 @@
 import { addressToScript, blake160, getTransactionSize, serializeScript, serializeWitnessArgs } from '@nervosnetwork/ckb-sdk-utils'
-import { getCotaTypeScript, getXudtDep, getJoyIDCellDep, getDexCellDep, MAX_FEE, JOYID_ESTIMATED_WITNESS_LOCK_SIZE } from '../constants'
+import {
+  getCotaTypeScript,
+  getXudtDep,
+  getJoyIDCellDep,
+  getDexCellDep,
+  MAX_FEE,
+  JOYID_ESTIMATED_WITNESS_LOCK_SIZE,
+  CKB_UNIT,
+} from '../constants'
 import { Hex, SubkeyUnlockReq, TakerParams, TakerResult } from '../types'
 import { append0x } from '../utils'
 import { XudtException, NoCotaCellException, NoLiveCellException } from '../exceptions'
@@ -62,7 +70,15 @@ export const buildTakerTx = async ({ collector, joyID, buyer, orderOutPoints, fe
   const outputsData = [...orderOutputsData, ...xudtOutputsData]
 
   const minCellCapacity = calculateEmptyCellMinCapacity(buyerLock)
-  const { inputs: emptyInputs, capacity: inputsCapacity } = collector.collectInputs(emptyCells, needInputsCapacity, txFee, minCellCapacity)
+  const needCapacity = ((needInputsCapacity + minCellCapacity + CKB_UNIT) / CKB_UNIT).toString()
+  const errMsg = `At least ${needCapacity} free CKB is required to take the order.`
+  const { inputs: emptyInputs, capacity: inputsCapacity } = collector.collectInputs(
+    emptyCells,
+    needInputsCapacity,
+    txFee,
+    minCellCapacity,
+    errMsg,
+  )
   const orderInputs: CKBComponents.CellInput[] = outPoints.map(outPoint => ({
     previousOutput: outPoint,
     since: '0x0',