fix: injectNeededCapacity rare border capacity issue (#133)

sporeprotocol · Aug 21, 2024 · 51f978c · 51f978c
1 parent 0a71917
commit 51f978c
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 18 deletions.
diff --git a/packages/core/src/api/joints/spore/injectLiveSporeCell.ts b/packages/core/src/api/joints/spore/injectLiveSporeCell.ts
@@ -48,12 +48,14 @@ export async function injectLiveSporeCell(props: {
     input: sporeCell,
     addOutput: props.addOutput,
     updateOutput(cell) {
-      if (props.capacityMargin !== void 0) {
-        cell = setAbsoluteCapacityMargin(cell, props.capacityMargin);
-      }
+      // May contain code about changing scripts, which causes the change of cell's occupied capacity,
+      // so here should be processed at first
       if (props.updateOutput instanceof Function) {
         cell = props.updateOutput(cell);
       }
+      if (props.capacityMargin !== void 0) {
+        cell = setAbsoluteCapacityMargin(cell, props.capacityMargin);
+      }
       return cell;
     },
     defaultWitness: props.defaultWitness,

diff --git a/packages/core/src/helpers/capacity.ts b/packages/core/src/helpers/capacity.ts
@@ -170,23 +170,23 @@ export function calculateNeededCapacity(props: {
   let txSkeleton = props.txSkeleton;
 
   const snapshot = createCapacitySnapshotFromTransactionSkeleton(txSkeleton);
-  const changeLock = helpers.parseAddress(props.changeAddress, { config: props.config });
+  // const changeLock = helpers.parseAddress(props.changeAddress, { config: props.config });
 
   const extraCapacity = BI.from(props.extraCapacity ?? 0);
-  const minChangeCapacity = minimalCellCapacityByLock(changeLock).add(extraCapacity);
+  // const minChangeCapacity = minimalCellCapacityByLock(changeLock).add(extraCapacity);
 
   let exceedCapacity = snapshot.inputsRemainCapacity;
   let neededCapacity = snapshot.outputsRemainCapacity.add(extraCapacity);
 
-  // Collect one more cell if:
-  // 1. Has sufficient capacity for transaction construction
-  // 2. Has insufficient capacity for adding a change cell to Transaction.outputs
-  const sufficientForTransaction = neededCapacity.lte(0) && exceedCapacity.gt(0);
-  const insufficientForChangeCell = exceedCapacity.lt(minChangeCapacity);
-  if (sufficientForTransaction && insufficientForChangeCell) {
-    neededCapacity = minChangeCapacity;
-    exceedCapacity = BI.from(0);
-  }
+  // // Collect one more cell if:
+  // // 1. Has sufficient capacity for transaction construction
+  // // 2. Has insufficient capacity for adding a change cell to Transaction.outputs
+  // const sufficientForTransaction = neededCapacity.lte(0) && exceedCapacity.gt(0);
+  // const insufficientForChangeCell = exceedCapacity.lt(minChangeCapacity);
+  // if (sufficientForTransaction && insufficientForChangeCell) {
+  //   neededCapacity = minChangeCapacity.sub(exceedCapacity);
+  //   exceedCapacity = BI.from(0);
+  // }
 
   if (neededCapacity.lt(0)) {
     neededCapacity = BI.from(0);
@@ -213,7 +213,6 @@ export async function injectNeededCapacity(props: {
   config?: Config;
   extraCapacity?: BIish;
   changeAddress?: Address;
-  enableDeductCapacity?: boolean;
 }): Promise<{
   txSkeleton: helpers.TransactionSkeletonType;
   before: CapacitySnapshot;
@@ -244,7 +243,7 @@ export async function injectNeededCapacity(props: {
       props.changeAddress,
       void 0,
       {
-        enableDeductCapacity: props.enableDeductCapacity,
+        enableDeductCapacity: true, // Set adding extra capacity to the last output cell as a default option
         config: props.config,
       },
     );

diff --git a/packages/core/src/helpers/fee.ts b/packages/core/src/helpers/fee.ts
@@ -3,9 +3,10 @@ import { Address, Transaction } from '@ckb-lumos/base';
 import { BI, Header, helpers, RPC } from '@ckb-lumos/lumos';
 import { BIish } from '@ckb-lumos/bi';
 import { getSporeConfig, SporeConfig } from '../config';
-import { injectNeededCapacity, returnExceededCapacity } from './capacity';
+import { injectNeededCapacity, minimalCellCapacityByLock, returnExceededCapacity } from './capacity';
 import { CapacitySnapshot, createCapacitySnapshotFromTransactionSkeleton } from './capacity';
 import { getTransactionSize, getTransactionSkeletonSize } from './transaction';
+import { fromInfoToAddress } from './address';
 
 /**
  * Get minimal acceptable fee rate from RPC.
@@ -154,7 +155,6 @@ export async function injectCapacityAndPayFee(props: {
   feeRate?: BIish;
   extraCapacity?: BIish;
   changeAddress?: Address;
-  enableDeductCapacity?: boolean;
   updateTxSkeletonAfterCollection?: (
     txSkeleton: helpers.TransactionSkeletonType,
   ) => Promise<helpers.TransactionSkeletonType> | helpers.TransactionSkeletonType;
@@ -166,6 +166,19 @@ export async function injectCapacityAndPayFee(props: {
   // Env
   const config = props.config ?? getSporeConfig();
 
+  // Add a new change cell for receiving change capacity as default
+  const changeAddress = fromInfoToAddress(props.changeAddress ?? props.fromInfos[0], config.lumos);
+  const changeLock = helpers.addressToScript(changeAddress, { config: config.lumos });
+  props.txSkeleton = props.txSkeleton.update('outputs', (outputs) => {
+    return outputs.push({
+      cellOutput: {
+        capacity: minimalCellCapacityByLock(changeLock).toHexString(),
+        lock: changeLock,
+      },
+      data: '0x',
+    });
+  });
+
   // Collect capacity
   const injectNeededCapacityResult = await injectNeededCapacity({
     ...props,