feat(core): calculate Nervos DAO profit as input capacity

This fixes fee calculation for DAO withdrawal txs.
If devs don't change the tx composing logic, sending tx will fail.

Author: Hanssen0

.changeset/twenty-pants-itch.md

@@ -0,0 +1,5 @@
+---
+"@ckb-ccc/core": minor
+---
+
+feat(core): calculate Nervos DAO profit as input capacity

packages/core/src/ckb/script.ts

@@ -1,5 +1,6 @@
 import { Bytes, BytesLike, bytesFrom } from "../bytes/index.js";
-import { Client, KnownScript } from "../client/index.js";
+import type { Client } from "../client/index.js";
+import { KnownScript } from "../client/knownScript.js";
 import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import { mol } from "../molecule/index.js";
 import {

packages/core/src/ckb/transaction.ts

@@ -1,6 +1,7 @@
 import { Bytes, BytesLike, bytesFrom } from "../bytes/index.js";
 import type { ClientCollectableSearchKeyFilterLike } from "../client/clientTypes.advanced.js";
-import type { CellDepInfoLike, Client, KnownScript } from "../client/index.js";
+import type { CellDepInfoLike, Client } from "../client/index.js";
+import { KnownScript } from "../client/knownScript.js";
 import {
   Zero,
   fixedPointFrom,
@@ -526,13 +527,15 @@ export class CellInput extends mol.Entity.Base<CellInputLike, CellInput>() {
   }
 
   /**
-   * Complete extra infos in the input. Like the output of the out point.
+   * Complete extra infos in the input. Including
+   * - Previous cell output
+   * - Previous cell data
    * The instance will be modified.
    *
    * @returns true if succeed.
    * @example
    * ```typescript
-   * await cellInput.completeExtraInfos();
+   * await cellInput.completeExtraInfos(client);
    * ```
    */
   async completeExtraInfos(client: Client): Promise<void> {
@@ -549,6 +552,69 @@ export class CellInput extends mol.Entity.Base<CellInputLike, CellInput>() {
     this.outputData = cell.outputData;
   }
 
+  /**
+   * The extra capacity created when consume this input.
+   * This is usually NervosDAO interest, see https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md.
+   * And it can also be miners' income. (But this is not implemented yet)
+   */
+  async getExtraCapacity(client: Client): Promise<Num> {
+    return this.getDaoProfit(client);
+  }
+
+  /**
+   * Gets confirmed Nervos DAO profit of a CellInput
+   * It returns non-zero value only when the cell is in withdrawal phase 2
+   * See https://github.com/nervosnetwork/rfcs/blob/master/rfcs/0023-dao-deposit-withdraw/0023-dao-deposit-withdraw.md
+   *
+   * @param client - A client for searching DAO related headers
+   * @returns Profit
+   *
+   * @example
+   * ```typescript
+   * const profit = await input.getDaoProfit(client);
+   * ```
+   */
+  async getDaoProfit(client: Client): Promise<Num> {
+    await this.completeExtraInfos(client);
+    if (!this.cellOutput || !this.outputData) {
+      throw new Error("Unable to complete input");
+    }
+
+    const daoType = await client.getKnownScript(KnownScript.NervosDao);
+    const type = this.cellOutput.type;
+    if (
+      !type ||
+      type.codeHash !== daoType.codeHash ||
+      type.hashType !== daoType.hashType ||
+      !this.outputData ||
+      numFrom(this.outputData) === Zero
+    ) {
+      // Not a withdrawal phase 2 cell
+      return Zero;
+    }
+
+    const [depositHeader, withdrawRes] = await Promise.all([
+      client.getHeaderByNumber(numFromBytes(this.outputData)),
+      client.getCellWithHeader(this.previousOutput),
+    ]);
+    if (!withdrawRes?.header || !depositHeader) {
+      throw new Error(
+        `Unable to get headers of a Nervos DAO input ${this.previousOutput.txHash}:${this.previousOutput.index.toString()}`,
+      );
+    }
+    const withdrawHeader = withdrawRes.header;
+
+    const occupiedSize = fixedPointFrom(
+      this.cellOutput.occupiedSize + bytesFrom(this.outputData).length,
+    );
+    const profitableSize = this.cellOutput.capacity - occupiedSize;
+
+    return (
+      (profitableSize * withdrawHeader.dao.ar) / depositHeader.dao.ar -
+      profitableSize
+    );
+  }
+
   clone(): CellInput {
     const cloned = super.clone();
     cloned.cellOutput = this.cellOutput;
@@ -1426,15 +1492,33 @@ export class Transaction extends mol.Entity.Base<
     this.setWitnessArgsAt(position, witness);
   }
 
+  async getInputsCapacityExtra(client: Client): Promise<Num> {
+    return reduceAsync(
+      this.inputs,
+      async (acc, input) => {
+        const extraCapacity = await input.getExtraCapacity(client);
+        if (extraCapacity === undefined) {
+          throw new Error("Unable to complete input");
+        }
+
+        return acc + extraCapacity;
+      },
+      numFrom(0),
+    );
+  }
+
+  // This also includes extra amount
   async getInputsCapacity(client: Client): Promise<Num> {
     return reduceAsync(
       this.inputs,
       async (acc, input) => {
+        const extraCapacity = await input.getExtraCapacity(client);
         await input.completeExtraInfos(client);
         if (!input.cellOutput) {
           throw new Error("Unable to complete input");
         }
-        return acc + input.cellOutput.capacity;
+
+        return acc + input.cellOutput.capacity + extraCapacity;
       },
       numFrom(0),
     );

packages/core/src/client/client.ts

@@ -33,10 +33,10 @@ import {
   ClientTransactionResponse,
   ErrorClientMaxFeeRateExceeded,
   ErrorClientWaitTransactionTimeout,
-  KnownScript,
   OutputsValidator,
   ScriptInfo,
 } from "./clientTypes.js";
+import { KnownScript } from "./knownScript.js";
 
 function hasHeaderConfirmed(header: ClientBlockHeader): boolean {
   return numFrom(Date.now()) - header.timestamp >= CONFIRMED_BLOCK_TIME;

packages/core/src/client/clientPublicMainnet.advanced.ts

@@ -1,4 +1,5 @@
-import { KnownScript, ScriptInfoLike } from "./clientTypes.js";
+import { ScriptInfoLike } from "./clientTypes.js";
+import { KnownScript } from "./knownScript.js";
 
 export const MAINNET_SCRIPTS: Record<KnownScript, ScriptInfoLike | undefined> =
   Object.freeze({

packages/core/src/client/clientPublicMainnet.ts

@@ -1,7 +1,8 @@
 import WebSocket from "isomorphic-ws";
 import { MAINNET_SCRIPTS } from "./clientPublicMainnet.advanced.js";
-import { KnownScript, ScriptInfo, ScriptInfoLike } from "./clientTypes.js";
+import { ScriptInfo, ScriptInfoLike } from "./clientTypes.js";
 import { ClientJsonRpc, ClientJsonRpcConfig } from "./jsonRpc/index.js";
+import { KnownScript } from "./knownScript.js";
 
 /**
  * @public

packages/core/src/client/clientPublicTestnet.advanced.ts

@@ -1,4 +1,5 @@
-import { KnownScript, ScriptInfoLike } from "./clientTypes.js";
+import { ScriptInfoLike } from "./clientTypes.js";
+import { KnownScript } from "./knownScript.js";
 
 export const TESTNET_SCRIPTS: Record<KnownScript, ScriptInfoLike> =
   Object.freeze({

packages/core/src/client/clientPublicTestnet.ts

@@ -1,7 +1,8 @@
 import WebSocket from "isomorphic-ws";
 import { TESTNET_SCRIPTS } from "./clientPublicTestnet.advanced.js";
-import { KnownScript, ScriptInfo, ScriptInfoLike } from "./clientTypes.js";
+import { ScriptInfo, ScriptInfoLike } from "./clientTypes.js";
 import { ClientJsonRpc, ClientJsonRpcConfig } from "./jsonRpc/index.js";
+import { KnownScript } from "./knownScript.js";
 
 /**
  * @public

packages/core/src/client/clientTypes.ts

@@ -24,34 +24,6 @@ import {
   clientSearchKeyRangeFrom,
 } from "./clientTypes.advanced.js";
 
-/**
- * @public
- */
-export enum KnownScript {
-  NervosDao = "NervosDao",
-  Secp256k1Blake160 = "Secp256k1Blake160",
-  Secp256k1Multisig = "Secp256k1Multisig",
-  AnyoneCanPay = "AnyoneCanPay",
-  TypeId = "TypeId",
-  XUdt = "XUdt",
-  JoyId = "JoyId",
-  COTA = "COTA",
-  PWLock = "PWLock",
-  OmniLock = "OmniLock",
-  NostrLock = "NostrLock",
-  UniqueType = "UniqueType",
-
-  // ckb-proxy-locks https://github.com/ckb-devrel/ckb-proxy-locks
-  AlwaysSuccess = "AlwaysSuccess",
-  InputTypeProxyLock = "InputTypeProxyLock",
-  OutputTypeProxyLock = "OutputTypeProxyLock",
-  LockProxyLock = "LockProxyLock",
-  SingleUseLock = "SingleUseLock",
-  TypeBurnLock = "TypeBurnLock",
-  EasyToDiscoverType = "EasyToDiscoverType",
-  TimeLock = "TimeLock",
-}
-
 /**
  * @public
  */

packages/core/src/client/index.ts

@@ -4,3 +4,4 @@ export * from "./clientPublicMainnet.js";
 export * from "./clientPublicTestnet.js";
 export * from "./clientTypes.js";
 export * from "./jsonRpc/index.js";
+export * from "./knownScript.js";