@ckb-ccc/core 0.0.12-alpha.1 → 0.0.12

package/src/ckb/transaction.ts

@@ -1,4 +1,3 @@
-import type { TransactionSkeletonType } from "@ckb-lumos/helpers";
 import { ClientCollectableSearchKeyFilterLike } from "../advancedBarrel.js";
 import { Bytes, BytesLike, bytesFrom } from "../bytes/index.js";
 import { CellDepInfoLike, Client, KnownScript } from "../client/index.js";
@@ -22,12 +21,20 @@ import { apply, reduceAsync } from "../utils/index.js";
 import * as mol from "./molecule.advanced/index.js";
 import { Script, ScriptLike } from "./script.js";
 import { DEP_TYPE_TO_NUM, NUM_TO_DEP_TYPE } from "./transaction.advanced.js";
+import { LumosTransactionSkeletonType } from "./transactionLumos.js";
 
+/**
+ * @public
+ */
 export type DepTypeLike = string | number | bigint;
+/**
+ * @public
+ */
 export type DepType = "depGroup" | "code";
 
 /**
  * Converts a DepTypeLike value to a DepType.
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, or bigint.
  * @returns The corresponding DepType.
@@ -61,6 +68,7 @@ export function depTypeFrom(val: DepTypeLike): DepType {
 
 /**
  * Converts a DepTypeLike value to its corresponding byte representation.
+ * @public
  *
  * @param depType - The dep type value to convert.
  * @returns A Uint8Array containing the byte representation of the dep type.
@@ -77,6 +85,7 @@ export function depTypeToBytes(depType: DepTypeLike): Bytes {
 
 /**
  * Converts a byte-like value to a DepType.
+ * @public
  *
  * @param bytes - The byte-like value to convert.
  * @returns The corresponding DepType.
@@ -93,10 +102,16 @@ export function depTypeFromBytes(bytes: BytesLike): DepType {
   return NUM_TO_DEP_TYPE[bytesFrom(bytes)[0]];
 }
 
+/**
+ * @public
+ */
 export type OutPointLike = {
   txHash: HexLike;
   index: NumLike;
 };
+/**
+ * @public
+ */
 export class OutPoint {
   /**
    * Creates an instance of OutPoint.
@@ -211,11 +226,17 @@ export class OutPoint {
   }
 }
 
+/**
+ * @public
+ */
 export type CellOutputLike = {
   capacity: NumLike;
   lock: ScriptLike;
   type?: ScriptLike | null;
 };
+/**
+ * @public
+ */
 export class CellOutput {
   /**
    * Creates an instance of CellOutput.
@@ -331,11 +352,17 @@ export class CellOutput {
   }
 }
 
+/**
+ * @public
+ */
 export type CellLike = {
   outPoint: OutPointLike;
   cellOutput: CellOutputLike;
   outputData: HexLike;
 };
+/**
+ * @public
+ */
 export class Cell {
   /**
    * Creates an instance of Cell.
@@ -389,12 +416,18 @@ export class Cell {
   }
 }
 
+/**
+ * @public
+ */
 export type CellInputLike = {
   previousOutput: OutPointLike;
   since?: NumLike | null;
   cellOutput?: CellOutputLike | null;
   outputData?: HexLike | null;
 };
+/**
+ * @public
+ */
 export class CellInput {
   /**
    * Creates an instance of CellInput.
@@ -535,10 +568,16 @@ export class CellInput {
   }
 }
 
+/**
+ * @public
+ */
 export type CellDepLike = {
   outPoint: OutPointLike;
   depType: DepTypeLike;
 };
+/**
+ * @public
+ */
 export class CellDep {
   /**
    * Creates an instance of CellDep.
@@ -662,11 +701,17 @@ export class CellDep {
   }
 }
 
+/**
+ * @public
+ */
 export type WitnessArgsLike = {
   lock?: HexLike | null;
   inputType?: HexLike | null;
   outputType?: HexLike | null;
 };
+/**
+ * @public
+ */
 export class WitnessArgs {
   /**
    * Creates an instance of WitnessArgs.
@@ -765,6 +810,9 @@ export class WitnessArgs {
   }
 }
 
+/**
+ * @public
+ */
 export function udtBalanceFrom(dataLike: BytesLike): Num {
   const data = bytesFrom(dataLike).slice(0, 16);
   if (data.length !== 16) {
@@ -774,6 +822,9 @@ export function udtBalanceFrom(dataLike: BytesLike): Num {
   return numFromBytes(data);
 }
 
+/**
+ * @public
+ */
 export type TransactionLike = {
   version?: NumLike | null;
   cellDeps?: CellDepLike[] | null;
@@ -786,6 +837,9 @@ export type TransactionLike = {
   outputsData?: HexLike[] | null;
   witnesses?: HexLike[] | null;
 };
+/**
+ * @public
+ */
 export class Transaction {
   /**
    * Creates an instance of Transaction.
@@ -936,7 +990,9 @@ export class Transaction {
    * ```
    */
 
-  static fromLumosSkeleton(skeleton: TransactionSkeletonType): Transaction {
+  static fromLumosSkeleton(
+    skeleton: LumosTransactionSkeletonType,
+  ): Transaction {
     return Transaction.from({
       version: 0n,
       cellDeps: skeleton.cellDeps.toArray(),
@@ -1124,10 +1180,10 @@ export class Transaction {
    * ```
    */
   async findInputIndexByLockId(
-    scriptLike: Pick<ScriptLike, "codeHash" | "hashType">,
+    scriptIdLike: Pick<ScriptLike, "codeHash" | "hashType">,
     client: Client,
   ): Promise<number | undefined> {
-    const script = Script.from({ ...scriptLike, args: "0x" });
+    const script = Script.from({ ...scriptIdLike, args: "0x" });
 
     for (let i = 0; i < this.inputs.length; i += 1) {
       const input = this.inputs[i];
@@ -1217,8 +1273,8 @@ export class Transaction {
    * tx.addCellDeps(cellDep);
    * ```
    */
-  addCellDeps(...cellDepsLike: (CellDepLike | CellDepLike[])[]): void {
-    cellDepsLike.flat().forEach((cellDepLike) => {
+  addCellDeps(...cellDepLikes: (CellDepLike | CellDepLike[])[]): void {
+    cellDepLikes.flat().forEach((cellDepLike) => {
       const cellDep = CellDep.from(cellDepLike);
       if (this.cellDeps.some((c) => c.eq(cellDep))) {
         return;
@@ -1238,8 +1294,8 @@ export class Transaction {
    * tx.addCellDepsAtBegin(cellDep);
    * ```
    */
-  addCellDepsAtStart(...cellDepsLike: (CellDepLike | CellDepLike[])[]): void {
-    cellDepsLike.flat().forEach((cellDepLike) => {
+  addCellDepsAtStart(...cellDepLikes: (CellDepLike | CellDepLike[])[]): void {
+    cellDepLikes.flat().forEach((cellDepLike) => {
       const cellDep = CellDep.from(cellDepLike);
       if (this.cellDeps.some((c) => c.eq(cellDep))) {
         return;
@@ -1253,7 +1309,7 @@ export class Transaction {
    * Add cell dep from infos if they are not existed
    *
    * @param client - A client for searching cell deps
-   * @param cellDepLikes - The cell dep infos to add
+   * @param cellDepInfoLikes - The cell dep infos to add
    *
    * @example
    * ```typescript
@@ -1262,9 +1318,9 @@ export class Transaction {
    */
   async addCellDepInfos(
     client: Client,
-    ...cellDepInfosLike: (CellDepInfoLike | CellDepInfoLike[])[]
+    ...cellDepInfoLikes: (CellDepInfoLike | CellDepInfoLike[])[]
   ): Promise<void> {
-    this.addCellDeps(await client.getCellDeps(...cellDepInfosLike));
+    this.addCellDeps(await client.getCellDeps(...cellDepInfoLikes));
   }
 
   /**
@@ -1302,10 +1358,10 @@ export class Transaction {
    *
    * @example
    * ```typescript
-   * await tx.setOutputData(0, "0x00");
+   * await tx.setOutputDataAt(0, "0x00");
    * ```
    */
-  setOutputDataAt(index: number, data: HexLike): void {
+  setOutputDataAt(index: number, witness: HexLike): void {
     if (this.outputsData.length < index) {
       this.outputsData.push(
         ...Array.from(
@@ -1315,14 +1371,14 @@ export class Transaction {
       );
     }
 
-    this.outputsData[index] = hexFrom(data);
+    this.outputsData[index] = hexFrom(witness);
   }
 
   /**
    * Add output
    *
-   * @param output - The cell output to add
-   * @param data - optional output data
+   * @param outputLike - The cell output to add
+   * @param outputData - optional output data
    *
    * @example
    * ```typescript

package/src/ckb/transactionLumos.ts

@@ -0,0 +1,26 @@
+import { CellDepLike, CellOutputLike, HexLike, OutPointLike } from "../barrel";
+
+export interface LumosTransactionSkeletonType {
+  cellDeps: {
+    toArray(): CellDepLike[];
+  };
+  headerDeps: {
+    toArray(): HexLike[];
+  };
+  inputs: {
+    toArray(): {
+      outPoint?: OutPointLike;
+      cellOutput: CellOutputLike;
+      data: HexLike;
+    }[];
+  };
+  inputSinces: {
+    get(i: number, defaultVal: string): HexLike;
+  };
+  outputs: {
+    toArray(): { cellOutput: CellOutputLike; data: HexLike }[];
+  };
+  witnesses: {
+    toArray(): HexLike[];
+  };
+}

package/src/client/client.ts

@@ -28,6 +28,9 @@ import {
   OutputsValidator,
 } from "./clientTypes.js";
 
+/**
+ * @public
+ */
 export enum KnownScript {
   Secp256k1Blake160 = "Secp256k1Blake160",
   Secp256k1Multisig = "Secp256k1Multisig",
@@ -44,11 +47,17 @@ export enum KnownScript {
   OutputTypeProxyLock = "OutputTypeProxyLock",
 }
 
+/**
+ * @public
+ */
 export type CellDepInfoLike = {
   cellDep: CellDepLike;
   type?: ScriptLike | null;
 };
 
+/**
+ * @public
+ */
 export class CellDepInfo {
   constructor(
     public cellDep: CellDep,
@@ -63,6 +72,9 @@ export class CellDepInfo {
   }
 }
 
+/**
+ * @public
+ */
 export abstract class Client {
   private readonly cachedTransactions: Transaction[] = [];
   private readonly unusableOutPoints: OutPoint[] = [];
@@ -190,7 +202,7 @@ export abstract class Client {
   /**
    * Find cells by search key designed for collectable cells.
    *
-   * @param key - The search key.
+   * @param keyLike - The search key.
    * @returns A async generator for yielding cells.
    */
   async *findCellsByCollectableSearchKey(

package/src/client/clientPublicMainnet.ts

@@ -3,6 +3,9 @@ import { CellDepInfo, KnownScript } from "./client.js";
 import { MAINNET_SCRIPTS } from "./clientPublicMainnet.advanced.js";
 import { ClientJsonRpc } from "./jsonRpc/index.js";
 
+/**
+ * @public
+ */
 export class ClientPublicMainnet extends ClientJsonRpc {
   constructor(
     url = "https://mainnet.ckb.dev/",

package/src/client/clientPublicTestnet.ts

@@ -3,6 +3,9 @@ import { CellDepInfo, KnownScript } from "./client.js";
 import { TESTNET_SCRIPTS } from "./clientPublicTestnet.advanced.js";
 import { ClientJsonRpc } from "./jsonRpc/index.js";
 
+/**
+ * @public
+ */
 export class ClientPublicTestnet extends ClientJsonRpc {
   constructor(
     url = "https://testnet.ckb.dev/",

package/src/client/clientTypes.ts

@@ -8,23 +8,38 @@ import {
   clientSearchKeyRangeFrom,
 } from "./clientTypes.advanced.js";
 
+/**
+ * @public
+ */
 export type OutputsValidator = "passthrough" | "well_known_scripts_only";
 
+/**
+ * @public
+ */
 export type TransactionStatus =
   | "pending"
   | "proposed"
   | "committed"
   | "unknown"
   | "rejected";
+/**
+ * @public
+ */
 export type ClientTransactionResponse = {
   transaction: Transaction;
   status: TransactionStatus;
 };
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyFilterLike =
   ClientCollectableSearchKeyFilterLike & {
     blockRange?: [NumLike, NumLike] | null;
   };
+/**
+ * @public
+ */
 export class ClientIndexerSearchKeyFilter {
   constructor(
     public script: Script | undefined,
@@ -51,10 +66,16 @@ export class ClientIndexerSearchKeyFilter {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyLike = ClientCollectableSearchKeyLike & {
   filter?: ClientIndexerSearchKeyFilterLike | null;
 };
 
+/**
+ * @public
+ */
 export class ClientIndexerSearchKey {
   constructor(
     public script: Script,
@@ -75,11 +96,17 @@ export class ClientIndexerSearchKey {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientFindCellsResponse = {
   lastCursor: string;
   cells: Cell[];
 };
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyTransactionLike = Omit<
   ClientCollectableSearchKeyLike,
   "withData"
@@ -88,6 +115,9 @@ export type ClientIndexerSearchKeyTransactionLike = Omit<
   groupByTransaction?: boolean | null;
 };
 
+/**
+ * @public
+ */
 export class ClientIndexerSearchKeyTransaction {
   constructor(
     public script: Script,
@@ -110,6 +140,9 @@ export class ClientIndexerSearchKeyTransaction {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientFindTransactionsResponse = {
   lastCursor: string;
   transactions: {
@@ -121,6 +154,9 @@ export type ClientFindTransactionsResponse = {
   }[];
 };
 
+/**
+ * @public
+ */
 export type ClientFindTransactionsGroupedResponse = {
   lastCursor: string;
   transactions: {
@@ -134,6 +170,9 @@ export type ClientFindTransactionsGroupedResponse = {
   }[];
 };
 
+/**
+ * @public
+ */
 export type ClientBlockHeader = {
   compactTarget: Num;
   dao: Hex;
@@ -149,11 +188,17 @@ export type ClientBlockHeader = {
   version: Num;
 };
 
+/**
+ * @public
+ */
 export type ClientBlockUncle = {
   header: ClientBlockHeader;
   proposals: Hex[];
 };
 
+/**
+ * @public
+ */
 export type ClientBlock = {
   header: ClientBlockHeader;
   proposals: Hex[];

package/src/client/jsonRpc/index.ts

@@ -5,7 +5,6 @@ import { Hex, HexLike, hexFrom } from "../../hex/index.js";
 import { Num, NumLike, numFrom, numToHex } from "../../num/index.js";
 import { Client } from "../client.js";
 import {
-  ClientBlock,
   ClientFindCellsResponse,
   ClientIndexerSearchKeyLike,
   ClientTransactionResponse,
@@ -46,7 +45,7 @@ export abstract class ClientJsonRpc extends Client {
   /**
    * Creates an instance of ClientJsonRpc.
    *
-   * @param url - The URL of the JSON-RPC server.
+   * @param url_ - The URL of the JSON-RPC server.
    * @param timeout - The timeout for requests in milliseconds, default is 30000.
    */
 
@@ -84,26 +83,26 @@ export abstract class ClientJsonRpc extends Client {
    *
    * @param blockNumber - The block number.
    * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
-   * @param with_cycles - whether the return cycles of block transactions. (Optional, default false.)
+   * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
    * @returns Block
    */
   getBlockByNumber = this.buildSender(
     "get_block_by_number",
     [(v: NumLike) => numToHex(numFrom(v))],
     (b) => apply(JsonRpcTransformers.blockTo, b),
-  ) as () => Promise<ClientBlock | undefined>;
+  ) as Client["getBlockByNumber"];
 
   /**
    * Get block by block hash
    *
    * @param blockHash - The block hash.
    * @param verbosity - result format which allows 0 and 2. (Optional, the default is 2.)
-   * @param with_cycles - whether the return cycles of block transactions. (Optional, default false.)
+   * @param withCycles - whether the return cycles of block transactions. (Optional, default false.)
    * @returns Block
    */
   getBlockByHash = this.buildSender("get_block", [hexFrom], (b) =>
     apply(JsonRpcTransformers.blockTo, b),
-  ) as () => Promise<ClientBlock | undefined>;
+  ) as Client["getBlockByHash"];
 
   /**
    * Send a transaction to node.

package/src/fixedPoint/index.ts

@@ -1,5 +1,6 @@
 /**
  * Represents a fixed point value as a bigint.
+ * @public
  */
 
 export type FixedPoint = bigint;
@@ -7,12 +8,14 @@ export type FixedPoint = bigint;
 /**
  * Represents a value that can be converted to a fixed point value.
  * It can be a bigint, string, or number.
+ * @public
  */
 
 export type FixedPointLike = bigint | string | number;
 
 /**
  * Converts a FixedPointLike value to its string representation with fixed-point decimals.
+ * @public
  *
  * @param val - The value to convert, which can be a bigint, string, or number.
  * @param decimals - The number of decimal places for the fixed-point representation. Default is 8.
@@ -43,6 +46,7 @@ export function fixedPointToString(val: FixedPointLike, decimals = 8): string {
 
 /**
  * Converts a FixedPointLike value to a FixedPoint (bigint) with fixed-point decimals.
+ * @public
  *
  * @param val - The value to convert, which can be a bigint, string, or number.
  * @param decimals - The number of decimal places for the fixed-point representation. Default is 8.
@@ -74,6 +78,7 @@ export function fixedPointFrom(val: FixedPointLike, decimals = 8): FixedPoint {
 
 /**
  * Represents the fixed point value of zero as a bigint.
+ * @public
  */
 
 export const Zero: FixedPoint = 0n;
@@ -81,6 +86,7 @@ export const Zero: FixedPoint = 0n;
 /**
  * Represents the fixed point value of one as a FixedPoint (bigint).
  * Equivalent to 1 in fixed-point representation with default decimals (8).
+ * @public
  */
 
 export const One: FixedPoint = fixedPointFrom("1");

package/src/hasher/hasher.ts

@@ -1,6 +1,9 @@
 import { BytesLike } from "../bytes/index.js";
 import { Hex } from "../hex/index.js";
 
+/**
+ * @public
+ */
 export interface Hasher {
   /**
    * Updates the hash with the given data.

package/src/hasher/hasherCkb.ts

@@ -6,6 +6,9 @@ import { NumLike, numLeToBytes } from "../num/index.js";
 import { CKB_BLAKE2B_PERSONAL } from "./advanced.js";
 import { Hasher } from "./hasher.js";
 
+/**
+ * @public
+ */
 export class HasherCkb implements Hasher {
   private readonly hasher: ReturnType<(typeof blake2b)["create"]>;
 
@@ -62,6 +65,7 @@ export class HasherCkb implements Hasher {
 
 /**
  * Computes the CKB hash of the given data using the Blake2b algorithm.
+ * @public
  *
  * @param data - The data to hash.
  * @returns The hexadecimal string representation of the hash.
@@ -80,8 +84,9 @@ export function hashCkb(...data: BytesLike[]): Hex {
 
 /**
  * Computes the Type ID hash of the given data.
+ * @public
  *
- * @param cellInput - The first cell input of the transaction.
+ * @param cellInputLike - The first cell input of the transaction.
  * @param outputIndex - The output index of the Type ID cell.
  * @returns The hexadecimal string representation of the hash.
  *

package/src/hasher/hasherKeecak256.ts

@@ -3,6 +3,9 @@ import { BytesLike, bytesFrom } from "../bytes/index.js";
 import { Hex, hexFrom } from "../hex/index.js";
 import { Hasher } from "./hasher.js";
 
+/**
+ * @public
+ */
 export class HasherKeecak256 implements Hasher {
   private readonly hasher: ReturnType<(typeof keccak_256)["create"]>;
 

package/src/hex/index.ts

@@ -2,16 +2,19 @@ import { bytesFrom, BytesLike, bytesTo } from "../bytes/index.js";
 
 /**
  * Represents a hexadecimal string prefixed with "0x".
+ * @public
  */
 export type Hex = `0x${string}`;
 /**
  * Represents a value that can be converted to a hexadecimal string.
  * It extends the BytesLike type.
+ * @public
  */
 export type HexLike = BytesLike;
 
 /**
  * Converts a HexLike value to a Hex string.
+ * @public
  *
  * @param hex - The value to convert, which can be a string, Uint8Array, ArrayBuffer, or number array.
  * @returns A Hex string representing the value.

package/src/keystore/index.ts

@@ -18,6 +18,9 @@ function mac(derivedKey: Bytes, cipherText: Bytes) {
   ).slice(2);
 }
 
+/**
+ * @public
+ */
 export async function keystoreEncrypt(
   privateKeyLike: BytesLike,
   chainCodeLike: BytesLike,
@@ -79,6 +82,9 @@ export async function keystoreEncrypt(
   };
 }
 
+/**
+ * @public
+ */
 export async function keystoreDecrypt(
   keystore: unknown,
   password: string,