feat(core): Client.getCellLive

.changeset/neat-months-drive.md

@@ -0,0 +1,5 @@
+---
+"@ckb-ccc/core": patch
+---
+
+feat(core): Client.getCellLive

.changeset/pre.json

@@ -1,5 +1,5 @@
 {
-  "mode": "pre",
+  "mode": "exit",
   "tag": "alpha",
   "initialVersions": {
     "@ckb-ccc/ccc": "0.0.12",

packages/core/src/client/client.ts

@@ -155,6 +155,27 @@ export abstract class Client {
     return cell;
   }
 
+  abstract getCellLiveNoCache(
+    outPointLike: OutPointLike,
+    withData?: boolean | null,
+    includeTxPool?: boolean | null,
+  ): Promise<Cell | undefined>;
+  async getCellLive(
+    outPointLike: OutPointLike,
+    withData?: boolean | null,
+    includeTxPool?: boolean | null,
+  ): Promise<Cell | undefined> {
+    const cell = await this.getCellLiveNoCache(
+      outPointLike,
+      withData,
+      includeTxPool,
+    );
+    if (withData && cell) {
+      await this.cache.recordCells(cell);
+    }
+    return cell;
+  }
+
   abstract findCellsPagedNoCache(
     key: ClientIndexerSearchKeyLike,
     order?: "asc" | "desc",

packages/core/src/client/clientTypes.ts

@@ -240,18 +240,16 @@ export type ClientBlock = {
 };
 
 export interface ErrorClientBaseLike {
-  message: string;
-  code: number;
+  message?: string;
+  code?: number;
   data: string;
 }
 export class ErrorClientBase extends Error {
-  public readonly message: string;
-  public readonly code: number;
+  public readonly code?: number;
   public readonly data: string;
 
   constructor(origin: ErrorClientBaseLike) {
     super(origin.message);
-    this.message = origin.message;
     this.code = origin.code;
     this.data = origin.data;
   }

packages/core/src/client/jsonRpc/index.ts

@@ -1,4 +1,9 @@
-import { OutPoint, TransactionLike } from "../../ckb/index.js";
+import {
+  Cell,
+  OutPoint,
+  OutPointLike,
+  TransactionLike,
+} from "../../ckb/index.js";
 import { Hex, HexLike, hexFrom } from "../../hex/index.js";
 import { Num, NumLike, numFrom, numToHex } from "../../num/index.js";
 import { apply } from "../../utils/index.js";
@@ -19,7 +24,7 @@ import {
   Transport,
   transportFromUri,
 } from "../transports/advanced.js";
-import { JsonRpcTransformers } from "./advanced.js";
+import { JsonRpcCellOutput, JsonRpcTransformers } from "./advanced.js";
 
 /**
  * Applies a transformation function to a value if the transformer is provided.
@@ -207,6 +212,48 @@ export abstract class ClientJsonRpc extends Client {
     JsonRpcTransformers.transactionResponseTo,
   ) as (txHash: HexLike) => Promise<ClientTransactionResponse | undefined>;
 
+  /**
+   * Get a live cell from node.
+   *
+   * @param outPoint - The out point of the cell.
+   * @param withData - Include data in the response.
+   * @param includeTxPool - Include cells in the tx pool.
+   * @returns The cell
+   */
+  getCellLiveNoCache(
+    outPoint: OutPointLike,
+    withData?: boolean | null,
+    includeTxPool?: boolean | null,
+  ) {
+    return this.buildSender(
+      "get_live_cell",
+      [JsonRpcTransformers.outPointFrom],
+      ({
+        cell,
+      }: {
+        cell?: {
+          output: JsonRpcCellOutput;
+          data?: { content: HexLike; hash: HexLike };
+        };
+      }) =>
+        apply(
+          ({
+            output,
+            data,
+          }: {
+            output: JsonRpcCellOutput;
+            data?: { content: HexLike; hash: HexLike };
+          }) =>
+            Cell.from({
+              cellOutput: JsonRpcTransformers.cellOutputTo(output),
+              outputData: data?.content ?? "0x",
+              outPoint,
+            }),
+          cell,
+        ),
+    )(outPoint, withData ?? true, includeTxPool) as Promise<Cell | undefined>;
+  }
+
   /**
    * find cells from node.
    *
@@ -296,7 +343,12 @@ export abstract class ClientJsonRpc extends Client {
       try {
         return transform(await this.send(payload), outTransformer);
       } catch (errAny: unknown) {
-        if (typeof errAny !== "object" || errAny === null) {
+        if (
+          typeof errAny !== "object" ||
+          errAny === null ||
+          !("data" in errAny) ||
+          typeof errAny.data !== "string"
+        ) {
           throw errAny;
         }
         const err = errAny as ErrorClientBaseLike;