@ckb-ccc/core 0.0.13-alpha.5 → 0.0.13-alpha.7

package/src/ckb/transaction.ts

@@ -1,5 +1,5 @@
 import { ClientCollectableSearchKeyFilterLike } from "../advancedBarrel.js";
-import { Bytes, BytesLike, bytesFrom } from "../bytes/index.js";
+import { Bytes, BytesLike, bytesConcat, bytesFrom } from "../bytes/index.js";
 import { CellDepInfoLike, Client, KnownScript } from "../client/index.js";
 import {
   Zero,
@@ -11,8 +11,11 @@ import { Hex, HexLike, hexFrom } from "../hex/index.js";
 import {
   Num,
   NumLike,
+  numBeToBytes,
   numFrom,
   numFromBytes,
+  numLeFromBytes,
+  numLeToBytes,
   numToBytes,
   numToHex,
 } from "../num/index.js";
@@ -416,12 +419,162 @@ export class Cell {
   }
 }
 
+/**
+ * @public
+ */
+export type EpochLike = [NumLike, NumLike, NumLike];
+/**
+ * @public
+ */
+export type Epoch = [Num, Num, Num];
+/**
+ * @public
+ */
+export function epochFrom(epochLike: EpochLike): Epoch {
+  return [numFrom(epochLike[0]), numFrom(epochLike[1]), numFrom(epochLike[2])];
+}
+/**
+ * @public
+ */
+export function epochFromHex(hex: HexLike): Epoch {
+  const bytes = bytesFrom(hexFrom(hex));
+
+  return [
+    numFrom(bytes.slice(4, 7)),
+    numFrom(bytes.slice(2, 4)),
+    numFrom(bytes.slice(0, 2)),
+  ];
+}
+/**
+ * @public
+ */
+export function epochToHex(epochLike: EpochLike): Hex {
+  const epoch = epochFrom(epochLike);
+
+  return hexFrom(
+    bytesConcat(
+      numBeToBytes(epoch[2], 2),
+      numBeToBytes(epoch[1], 2),
+      numBeToBytes(epoch[0], 3),
+    ),
+  );
+}
+
+/**
+ * @public
+ */
+export type SinceLike =
+  | {
+      relative: "absolute" | "relative";
+      metric: "blockNumber" | "epoch" | "timestamp";
+      value: NumLike;
+    }
+  | NumLike;
+/**
+ * @public
+ */
+export class Since {
+  /**
+   * Creates an instance of Since.
+   *
+   * @param relative - Absolute or relative
+   * @param metric - The metric of since
+   * @param value - The value of since
+   */
+
+  constructor(
+    public relative: "absolute" | "relative",
+    public metric: "blockNumber" | "epoch" | "timestamp",
+    public value: Num,
+  ) {}
+
+  /**
+   * Clone a Since.
+   *
+   * @returns A cloned Since instance.
+   *
+   * @example
+   * ```typescript
+   * const since1 = since0.clone();
+   * ```
+   */
+  clone(): Since {
+    return new Since(this.relative, this.metric, this.value);
+  }
+
+  /**
+   * Creates a Since instance from a SinceLike object.
+   *
+   * @param since - A SinceLike object or an instance of Since.
+   * @returns A Since instance.
+   *
+   * @example
+   * ```typescript
+   * const since = Since.from("0x1234567812345678");
+   * ```
+   */
+  static from(since: SinceLike): Since {
+    if (since instanceof Since) {
+      return since;
+    }
+
+    if (typeof since === "object" && "relative" in since) {
+      return new Since(since.relative, since.metric, numFrom(since.value));
+    }
+
+    return Since.fromNum(since);
+  }
+
+  /**
+   * Converts the Since instance to num.
+   *
+   * @returns A num
+   *
+   * @example
+   * ```typescript
+   * const num = since.toNum();
+   * ```
+   */
+
+  toNum(): Num {
+    const flag =
+      ((this.relative === "absolute" ? 0 : 1) << 7) |
+      ({ blockNumber: 0, epoch: 1, timestamp: 2 }[this.metric] << 5);
+
+    return numFrom(bytesConcat([flag], numLeToBytes(this.value, 7)));
+  }
+
+  /**
+   * Creates a Since instance from a num-like value.
+   *
+   * @param numLike - The num-like value to convert.
+   * @returns A Since instance.
+   *
+   * @example
+   * ```typescript
+   * const since = Since.fromNum("0x0");
+   * ```
+   */
+
+  static fromNum(numLike: NumLike): Since {
+    const bytes = numBeToBytes(numLike, 8);
+
+    const relative = bytes[0] >> 7 === 0 ? "absolute" : "relative";
+    const metric = (["blockNumber", "epoch", "timestamp"] as Since["metric"][])[
+      (bytes[0] >> 5) & 3
+    ];
+    const value = numLeFromBytes(bytes.slice(1, 8));
+
+    return new Since(relative, metric, value);
+  }
+}
+
 /**
  * @public
  */
 export type CellInputLike = {
   previousOutput: OutPointLike;
-  since?: NumLike | null;
+  since?: SinceLike | NumLike | null;
   cellOutput?: CellOutputLike | null;
   outputData?: HexLike | null;
 };
@@ -485,7 +638,7 @@ export class CellInput {
 
     return new CellInput(
       OutPoint.from(cellInput.previousOutput),
-      numFrom(cellInput.since ?? 0),
+      Since.from(cellInput.since ?? 0).toNum(),
       apply(CellOutput.from, cellInput.cellOutput),
       apply(hexFrom, cellInput.outputData),
     );
@@ -1536,45 +1689,33 @@ export class Transaction {
     addedCount: number;
     accumulated?: T;
   }> {
-    const scripts = (await from.getAddressObjs()).map(({ script }) => script);
     const collectedCells = [];
 
     let acc: T = init;
     let fulfilled = false;
-    for (const script of scripts) {
-      for await (const cell of from.client.findCellsByCollectableSearchKey({
-        script,
-        scriptType: "lock",
-        filter,
-        scriptSearchMode: "exact",
-        withData: true,
-      })) {
-        if (
-          this.inputs.some(({ previousOutput }) =>
-            previousOutput.eq(cell.outPoint),
-          )
-        ) {
-          continue;
-        }
-        const i = collectedCells.push(cell);
-        const next = await Promise.resolve(
-          accumulator(acc, cell, i - 1, collectedCells),
-        );
-        if (next === undefined) {
-          fulfilled = true;
-          break;
-        }
+    for await (const cell of from.findCells(filter, true)) {
+      if (
+        this.inputs.some(({ previousOutput }) =>
+          previousOutput.eq(cell.outPoint),
+        )
+      ) {
+        continue;
       }
-      if (fulfilled) {
+      const i = collectedCells.push(cell);
+      const next = await Promise.resolve(
+        accumulator(acc, cell, i - 1, collectedCells),
+      );
+      if (next === undefined) {
+        fulfilled = true;
         break;
       }
+      acc = next;
     }
 
     this.inputs.push(
       ...collectedCells.map(({ outPoint, outputData, cellOutput }) =>
         CellInput.from({
           previousOutput: outPoint,
-          since: 0,
           outputData,
           cellOutput,
         }),

package/src/client/client.ts

@@ -18,6 +18,7 @@ import { ClientCacheMemory } from "./cache/memory.js";
 import { ClientCollectableSearchKeyLike } from "./clientTypes.advanced.js";
 import {
   ClientBlock,
+  ClientBlockHeader,
   ClientFindCellsResponse,
   ClientFindTransactionsGroupedResponse,
   ClientFindTransactionsResponse,
@@ -45,6 +46,7 @@ export enum KnownScript {
   UniqueType = "UniqueType",
   SingleUseLock = "SingleUseLock",
   OutputTypeProxyLock = "OutputTypeProxyLock",
+  NervosDao = "NervosDao",
 }
 
 /**
@@ -92,6 +94,7 @@ export abstract class Client {
   >;
 
   abstract getTip(): Promise<Num>;
+  abstract getTipHeader(verbosity?: number | null): Promise<ClientBlockHeader>;
   abstract getBlockByNumber(
     blockNumber: NumLike,
     verbosity?: number | null,
@@ -102,6 +105,20 @@ export abstract class Client {
     verbosity?: number | null,
     withCycles?: boolean | null,
   ): Promise<ClientBlock | undefined>;
+  abstract getHeaderByNumber(
+    blockNumber: NumLike,
+    verbosity?: number | null,
+  ): Promise<ClientBlockHeader | undefined>;
+  abstract getHeaderByHash(
+    blockHash: HexLike,
+    verbosity?: number | null,
+  ): Promise<ClientBlockHeader | undefined>;
+
+  abstract estimateCycles(transaction: TransactionLike): Promise<Num>;
+  abstract sendTransactionDry(
+    transaction: TransactionLike,
+    validator?: OutputsValidator,
+  ): Promise<Num>;
 
   abstract sendTransactionNoCache(
     transaction: TransactionLike,
@@ -155,7 +172,7 @@ export abstract class Client {
     return res;
   }
 
-  async *findCells(
+  async *findCellsOnChin(
     key: ClientIndexerSearchKeyLike,
     order?: "asc" | "desc",
     limit = 10,
@@ -185,7 +202,7 @@ export abstract class Client {
    * @param keyLike - The search key.
    * @returns A async generator for yielding cells.
    */
-  async *findCellsByCollectableSearchKey(
+  async *findCells(
     keyLike: ClientCollectableSearchKeyLike,
     order?: "asc" | "desc",
     limit = 10,
@@ -198,7 +215,7 @@ export abstract class Client {
       yield cell;
     }
 
-    for await (const cell of this.findCells(key, order, limit)) {
+    for await (const cell of this.findCellsOnChin(key, order, limit)) {
       if (
         (await this.cache.isUnusable(cell.outPoint)) ||
         foundedOutPoints.some((founded) => founded.eq(cell.outPoint))
@@ -217,7 +234,7 @@ export abstract class Client {
     order?: "asc" | "desc",
     limit = 10,
   ): AsyncGenerator<Cell> {
-    return this.findCellsByCollectableSearchKey(
+    return this.findCells(
       {
         script: lock,
         scriptType: "lock",
@@ -238,7 +255,7 @@ export abstract class Client {
     order?: "asc" | "desc",
     limit = 10,
   ): AsyncGenerator<Cell> {
-    return this.findCellsByCollectableSearchKey(
+    return this.findCells(
       {
         script: type,
         scriptType: "type",

package/src/client/clientPublicMainnet.advanced.ts

@@ -254,4 +254,21 @@ export const MAINNET_SCRIPTS: Record<
       },
     ],
   },
+  [KnownScript.NervosDao]: {
+    codeHash:
+      "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e",
+    hashType: "type",
+    cellDeps: [
+      {
+        cellDep: {
+          outPoint: {
+            txHash:
+              "0xe2fb199810d49a4d8beec56718ba2593b665db9d52299a0f9e6e75416d73ff5c",
+            index: 2,
+          },
+          depType: "code",
+        },
+      },
+    ],
+  },
 });

package/src/client/clientPublicTestnet.advanced.ts

@@ -265,4 +265,21 @@ export const TESTNET_SCRIPTS: Record<
       },
     ],
   },
+  [KnownScript.NervosDao]: {
+    codeHash:
+      "0x82d76d1b75fe2fd9a27dfbaa65a039221a380d76c926f378d3f81cf3e7e13f2e",
+    hashType: "type",
+    cellDeps: [
+      {
+        cellDep: {
+          outPoint: {
+            txHash:
+              "0x8f8c79eb6671709633fe6a46de93c0fedc9c1b8a6527a18d3983879542635c9f",
+            index: 2,
+          },
+          depType: "code",
+        },
+      },
+    ],
+  },
 });

package/src/client/clientTypes.ts

@@ -1,4 +1,4 @@
-import { Cell, Script, Transaction } from "../ckb/index.js";
+import { Cell, Epoch, Script, Transaction } from "../ckb/index.js";
 import { Hex, hexFrom } from "../hex/index.js";
 import { Num, NumLike } from "../num/index.js";
 import { apply } from "../utils/index.js";
@@ -181,8 +181,28 @@ export type ClientFindTransactionsGroupedResponse = {
  */
 export type ClientBlockHeader = {
   compactTarget: Num;
-  dao: Hex;
-  epoch: Num;
+  dao: {
+    /**
+     * C_i: the total issuance up to and including block i.
+     */
+    c: Num;
+    /**
+     * AR_i: the current accumulated rate at block i.
+     * AR_j / AR_i reflects the CKByte amount if one deposit 1 CKB to Nervos DAO at block i, and withdraw at block j.
+     */
+    ar: Num;
+    /**
+     * S_i: the total unissued secondary issuance up to and including block i,
+     * including unclaimed Nervos DAO compensation and treasury funds.
+     */
+    s: Num;
+    /**
+     * U_i: the total occupied capacities currently in the blockchain up to and including block i.
+     * Occupied capacity is the sum of capacities used to store all cells.
+     */
+    u: Num;
+  };
+  epoch: Epoch;
   extraHash: Hex;
   hash: Hex;
   nonce: Num;

package/src/client/jsonRpc/index.ts

@@ -88,7 +88,17 @@ export abstract class ClientJsonRpc extends Client {
   ) as () => Promise<Num>;
 
   /**
-   * Get block by block hash
+   * Get tip block header
+   *
+   * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+   * @returns BlockHeader
+   */
+  getTipHeader = this.buildSender("get_tip_header", [], (b) =>
+    apply(JsonRpcTransformers.blockHeaderTo, b),
+  ) as Client["getTipHeader"];
+
+  /**
+   * Get block by block number
    *
    * @param blockNumber - The block number.
    * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
@@ -113,6 +123,56 @@ export abstract class ClientJsonRpc extends Client {
     apply(JsonRpcTransformers.blockTo, b),
   ) as Client["getBlockByHash"];
 
+  /**
+   * Get header by block number
+   *
+   * @param blockNumber - The block number.
+   * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+   * @returns BlockHeader
+   */
+  getHeaderByNumber = this.buildSender(
+    "get_header_by_number",
+    [(v: NumLike) => numToHex(numFrom(v))],
+    (b) => apply(JsonRpcTransformers.blockHeaderTo, b),
+  ) as Client["getHeaderByNumber"];
+
+  /**
+   * Get header by block hash
+   *
+   * @param blockHash - The block hash.
+   * @param verbosity - result format which allows 0 and 1. (Optional, the default is 1.)
+   * @returns BlockHeader
+   */
+  getHeaderByHash = this.buildSender("get_header", [hexFrom], (b) =>
+    apply(JsonRpcTransformers.blockHeaderTo, b),
+  ) as Client["getHeaderByHash"];
+
+  /**
+   * Estimate cycles of a transaction.
+   *
+   * @param transaction - The transaction to estimate.
+   * @returns Consumed cycles
+   */
+  estimateCycles = this.buildSender(
+    "estimate_cycles",
+    [JsonRpcTransformers.transactionFrom],
+    ({ cycles }: { cycles: NumLike }) => numFrom(cycles),
+  ) as Client["estimateCycles"];
+
+  /**
+   * Test a transaction.
+   *
+   * @param transaction - The transaction to test.
+   * @param validator - "passthrough": Disable validation. "well_known_scripts_only": Only accept well known scripts in the transaction.
+   * @returns Consumed cycles
+   */
+
+  sendTransactionDry = this.buildSender(
+    "test_tx_pool_accept",
+    [JsonRpcTransformers.transactionFrom],
+    ({ cycles }: { cycles: NumLike }) => numFrom(cycles),
+  ) as Client["sendTransactionDry"];
+
   /**
    * Send a transaction to node.
    *

package/src/client/jsonRpc/transformers.ts

@@ -1,3 +1,4 @@
+import { bytesFrom } from "../../bytes/index.js";
 import {
   Cell,
   CellDep,
@@ -17,10 +18,11 @@ import {
   Transaction,
   TransactionLike,
   depTypeFrom,
+  epochFromHex,
   hashTypeFrom,
 } from "../../ckb/index.js";
 import { Hex, HexLike, hexFrom } from "../../hex/index.js";
-import { NumLike, numFrom, numToHex } from "../../num/index.js";
+import { NumLike, numFrom, numLeFromBytes, numToHex } from "../../num/index.js";
 import { apply } from "../../utils/index.js";
 import {
   ClientBlock,
@@ -201,10 +203,16 @@ export class JsonRpcTransformers {
     };
   }
   static blockHeaderTo(header: JsonRpcBlockHeader): ClientBlockHeader {
+    const dao = bytesFrom(header.dao);
     return {
       compactTarget: numFrom(header.compact_target),
-      dao: header.dao,
-      epoch: numFrom(header.epoch),
+      dao: {
+        c: numLeFromBytes(dao.slice(0, 8)),
+        ar: numLeFromBytes(dao.slice(8, 16)),
+        s: numLeFromBytes(dao.slice(16, 24)),
+        u: numLeFromBytes(dao.slice(24, 32)),
+      },
+      epoch: epochFromHex(header.epoch),
       extraHash: header.extra_hash,
       hash: header.hash,
       nonce: numFrom(header.nonce),

package/src/signer/signer/index.ts

@@ -1,6 +1,7 @@
 import { Address } from "../../address/index.js";
+import { ClientCollectableSearchKeyFilterLike } from "../../advancedBarrel.js";
 import { BytesLike } from "../../bytes/index.js";
-import { Transaction, TransactionLike } from "../../ckb/index.js";
+import { Cell, Transaction, TransactionLike } from "../../ckb/index.js";
 import { Client } from "../../client/index.js";
 import { Hex } from "../../hex/index.js";
 import { Num } from "../../num/index.js";
@@ -46,7 +47,8 @@ export type NetworkPreference = {
    * BTC: // They made a mess...
    *   btc
    *   btcTestnet
-   *   btcSignet // OKX
+   *   btcTestnet4 // UTXO Global
+   *   btcSignet // OKX & UTXO Global
    *   fractalBtc // UniSat
    */
   network: string;
@@ -82,9 +84,10 @@ export abstract class Signer {
   // undefined otherwise
   matchNetworkPreference(
     preferences: NetworkPreference[],
-    currentNetwork: string,
+    currentNetwork: string | undefined,
   ): NetworkPreference | undefined {
     if (
+      currentNetwork !== undefined &&
       preferences.some(({ signerType, addressPrefix, network }) => {
         signerType === this.type &&
           addressPrefix === this.client.addressPrefix &&
@@ -223,6 +226,24 @@ export abstract class Signer {
     );
   }
 
+  async *findCells(
+    filter: ClientCollectableSearchKeyFilterLike,
+    withData?: boolean | null,
+  ): AsyncGenerator<Cell> {
+    const scripts = await this.getAddressObjs();
+    for (const { script } of scripts) {
+      for await (const cell of this.client.findCells({
+        script,
+        scriptType: "lock",
+        filter,
+        scriptSearchMode: "exact",
+        withData,
+      })) {
+        yield cell;
+      }
+    }
+  }
+
   /**
    * Gets balance of all addresses
    *