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

package/src/client/clientTypes.ts

@@ -8,23 +8,43 @@ 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;
+  cycles?: Num;
+  blockHash?: Hex;
+  blockNumber?: Num;
+  txIndex?: Num;
+  reason?: string;
 };
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyFilterLike =
   ClientCollectableSearchKeyFilterLike & {
     blockRange?: [NumLike, NumLike] | null;
   };
+/**
+ * @public
+ */
 export class ClientIndexerSearchKeyFilter {
   constructor(
     public script: Script | undefined,
@@ -51,10 +71,16 @@ export class ClientIndexerSearchKeyFilter {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyLike = ClientCollectableSearchKeyLike & {
   filter?: ClientIndexerSearchKeyFilterLike | null;
 };
 
+/**
+ * @public
+ */
 export class ClientIndexerSearchKey {
   constructor(
     public script: Script,
@@ -75,11 +101,17 @@ export class ClientIndexerSearchKey {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientFindCellsResponse = {
   lastCursor: string;
   cells: Cell[];
 };
 
+/**
+ * @public
+ */
 export type ClientIndexerSearchKeyTransactionLike = Omit<
   ClientCollectableSearchKeyLike,
   "withData"
@@ -88,6 +120,9 @@ export type ClientIndexerSearchKeyTransactionLike = Omit<
   groupByTransaction?: boolean | null;
 };
 
+/**
+ * @public
+ */
 export class ClientIndexerSearchKeyTransaction {
   constructor(
     public script: Script,
@@ -110,6 +145,9 @@ export class ClientIndexerSearchKeyTransaction {
   }
 }
 
+/**
+ * @public
+ */
 export type ClientFindTransactionsResponse = {
   lastCursor: string;
   transactions: {
@@ -121,6 +159,9 @@ export type ClientFindTransactionsResponse = {
   }[];
 };
 
+/**
+ * @public
+ */
 export type ClientFindTransactionsGroupedResponse = {
   lastCursor: string;
   transactions: {
@@ -134,6 +175,9 @@ export type ClientFindTransactionsGroupedResponse = {
   }[];
 };
 
+/**
+ * @public
+ */
 export type ClientBlockHeader = {
   compactTarget: Num;
   dao: Hex;
@@ -149,11 +193,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/client/jsonRpc/transformers.ts

@@ -19,7 +19,7 @@ import {
   depTypeFrom,
   hashTypeFrom,
 } from "../../ckb/index.js";
-import { Hex } from "../../hex/index.js";
+import { Hex, HexLike, hexFrom } from "../../hex/index.js";
 import { NumLike, numFrom, numToHex } from "../../num/index.js";
 import { apply } from "../../utils/index.js";
 import {
@@ -172,10 +172,18 @@ export class JsonRpcTransformers {
     });
   }
   static transactionResponseTo({
-    tx_status: { status },
+    cycles,
+    tx_status: { status, block_number, block_hash, tx_index, reason },
     transaction,
   }: {
-    tx_status: { status: TransactionStatus };
+    cycles?: NumLike;
+    tx_status: {
+      status: TransactionStatus;
+      block_hash?: HexLike;
+      tx_index?: NumLike;
+      block_number?: NumLike;
+      reason?: string;
+    };
     transaction: JsonRpcTransaction | null;
   }): ClientTransactionResponse | undefined {
     if (transaction == null) {
@@ -185,6 +193,11 @@ export class JsonRpcTransformers {
     return {
       transaction: JsonRpcTransformers.transactionTo(transaction),
       status,
+      cycles: apply(numFrom, cycles),
+      blockHash: apply(hexFrom, block_hash),
+      blockNumber: apply(numFrom, block_number),
+      txIndex: apply(numFrom, tx_index),
+      reason,
     };
   }
   static blockHeaderTo(header: JsonRpcBlockHeader): ClientBlockHeader {

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,

package/src/num/index.ts

@@ -3,17 +3,20 @@ import { Hex, HexLike, hexFrom } from "../hex/index.js";
 
 /**
  * Represents a numeric value as a bigint.
+ * @public
  */
 export type Num = bigint;
 
 /**
  * Represents a value that can be converted to a numeric value.
  * It can be a string, number, bigint, or HexLike.
+ * @public
  */
 export type NumLike = string | number | bigint | HexLike;
 
 /**
  * Get the max among all numbers.
+ * @public
  *
  * @param numbers - numbers.
  * @returns The max numbers among them.
@@ -36,6 +39,7 @@ export function numMax(a: NumLike, ...numbers: NumLike[]): Num {
 
 /**
  * Converts a NumLike value to a Num (bigint).
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
  * @returns A Num (bigint) representing the value.
@@ -60,6 +64,7 @@ export function numFrom(val: NumLike): Num {
 
 /**
  * Converts a NumLike value to a hexadecimal string.
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
  * @returns A Hex string representing the numeric value.
@@ -75,6 +80,7 @@ export function numToHex(val: NumLike): Hex {
 
 /**
  * Converts a NumLike value to a byte array in little-endian order.
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
  * @param bytes - The number of bytes to use for the representation. If not provided, the exact number of bytes needed is used.
@@ -92,6 +98,7 @@ export function numToBytes(val: NumLike, bytes?: number): Bytes {
 
 /**
  * Converts a NumLike value to a byte array in little-endian order.
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
  * @param bytes - The number of bytes to use for the representation. If not provided, the exact number of bytes needed is used.
@@ -108,6 +115,7 @@ export function numLeToBytes(val: NumLike, bytes?: number): Bytes {
 
 /**
  * Converts a NumLike value to a byte array in big-endian order.
+ * @public
  *
  * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
  * @param bytes - The number of bytes to use for the representation. If not provided, the exact number of bytes needed is used.
@@ -132,6 +140,7 @@ export function numBeToBytes(val: NumLike, bytes?: number): Bytes {
 
 /**
  * Converts a byte array to a Num (bigint) assuming little-endian order.
+ * @public
  *
  * @param val - The byte array to convert.
  * @returns A Num (bigint) representing the numeric value.
@@ -147,6 +156,7 @@ export function numFromBytes(val: BytesLike): Num {
 
 /**
  * Converts a byte array to a Num (bigint) assuming little-endian order.
+ * @public
  *
  * @param val - The byte array to convert.
  * @returns A Num (bigint) representing the numeric value.
@@ -162,6 +172,7 @@ export function numLeFromBytes(val: BytesLike): Num {
 
 /**
  * Converts a byte array to a Num (bigint) assuming big-endian order.
+ * @public
  *
  * @param val - The byte array to convert.
  * @returns A Num (bigint) representing the numeric value.

package/src/signer/btc/signerBtc.ts

@@ -12,6 +12,7 @@ import { Signer, SignerSignType, SignerType } from "../signer/index.js";
  * An abstract class extending the Signer class for Bitcoin-like signing operations.
  * This class provides methods to get Bitcoin account, public key, and internal address,
  * as well as signing transactions.
+ * @public
  */
 export abstract class SignerBtc extends Signer {
   get type(): SignerType {

package/src/signer/btc/signerBtcPublicKeyReadonly.ts

@@ -5,6 +5,7 @@ import { SignerBtc } from "./signerBtc.js";
 /**
  * A class extending SignerBtc that provides read-only access to a Bitcoin public key and account.
  * This class does not support signing operations.
+ * @public
  */
 export class SignerBtcPublicKeyReadonly extends SignerBtc {
   private readonly publicKey: Hex;

package/src/signer/btc/verify.ts

@@ -3,6 +3,9 @@ import { magicHash } from "bitcoinjs-message";
 import { BytesLike, bytesFrom } from "../../bytes/index.js";
 import { hexFrom } from "../../hex/index.js";
 
+/**
+ * @public
+ */
 export function verifyMessageBtcEcdsa(
   message: string | BytesLike,
   signature: string,

package/src/signer/ckb/signerCkbPrivateKey.ts

@@ -7,6 +7,9 @@ import { numBeToBytes } from "../../num/index.js";
 import { SignerCkbPublicKey } from "./signerCkbPublicKey.js";
 import { messageHashCkbSecp256k1 } from "./verifyCkbSecp256k1.js";
 
+/**
+ * @public
+ */
 export class SignerCkbPrivateKey extends SignerCkbPublicKey {
   public readonly privateKey: Hex;
 

package/src/signer/ckb/signerCkbPublicKey.ts

@@ -6,6 +6,9 @@ import { hashCkb } from "../../hasher/index.js";
 import { Hex, HexLike, hexFrom } from "../../hex/index.js";
 import { Signer, SignerSignType, SignerType } from "../signer/index.js";
 
+/**
+ * @public
+ */
 export class SignerCkbPublicKey extends Signer {
   get type(): SignerType {
     return SignerType.CKB;

package/src/signer/ckb/signerCkbScriptReadonly.ts

@@ -6,6 +6,7 @@ import { Signer, SignerSignType, SignerType } from "../signer/index.js";
 /**
  * A class extending Signer that provides read-only access to a CKB script.
  * This class does not support signing operations.
+ * @public
  */
 export class SignerCkbScriptReadonly extends Signer {
   get type(): SignerType {

package/src/signer/ckb/verifyCkbSecp256k1.ts

@@ -4,12 +4,18 @@ import { hashCkb } from "../../hasher/index.js";
 import { Hex, hexFrom } from "../../hex/index.js";
 import { numFrom } from "../../num/index.js";
 
+/**
+ * @public
+ */
 export function messageHashCkbSecp256k1(message: string | BytesLike): Hex {
   const msg = typeof message === "string" ? message : hexFrom(message);
   const buffer = bytesFrom(`Nervos Message:${msg}`, "utf8");
   return hashCkb(buffer);
 }
 
+/**
+ * @public
+ */
 export function verifyMessageCkbSecp256k1(
   message: string | BytesLike,
   signature: string,

package/src/signer/ckb/verifyJoyId.ts

@@ -2,6 +2,9 @@ import { verifySignature } from "@joyid/ckb";
 import { BytesLike } from "../../bytes/index.js";
 import { hexFrom } from "../../hex/index.js";
 
+/**
+ * @public
+ */
 export function verifyMessageJoyId(
   message: string | BytesLike,
   signature: string,

package/src/signer/dummy/alwaysError.ts

@@ -2,6 +2,9 @@ import { Client } from "../../client/index.js";
 import { SignerType } from "../signer/index.js";
 import { SignerDummy } from "./dummy.js";
 
+/**
+ * @public
+ */
 export class SignerAlwaysError extends SignerDummy {
   constructor(
     client: Client,

package/src/signer/dummy/dummy.ts

@@ -2,6 +2,9 @@ import { Address } from "../../address/index.js";
 import { Client } from "../../client/index.js";
 import { Signer, SignerSignType, SignerType } from "../signer/index.js";
 
+/**
+ * @public
+ */
 export abstract class SignerDummy extends Signer {
   get signType(): SignerSignType {
     return SignerSignType.Unknown;

package/src/signer/dummy/openLink.ts

@@ -2,6 +2,9 @@ import { Client } from "../../client/index.js";
 import { SignerType } from "../signer/index.js";
 import { SignerDummy } from "./dummy.js";
 
+/**
+ * @public
+ */
 export class SignerOpenLink extends SignerDummy {
   constructor(
     client: Client,

package/src/signer/evm/signerEvm.ts

@@ -16,6 +16,7 @@ import { Signer, SignerSignType, SignerType } from "../signer/index.js";
 /**
  * An abstract class extending Signer for Ethereum Virtual Machine (EVM) based signing operations.
  * This class provides methods to get EVM account, internal address, and signing transactions.
+ * @public
  */
 export abstract class SignerEvm extends Signer {
   get type(): SignerType {

package/src/signer/evm/signerEvmAddressReadonly.ts

@@ -5,6 +5,7 @@ import { SignerEvm } from "./signerEvm.js";
 /**
  * A class extending SignerEvm that provides read-only access to an EVM address.
  * This class does not support signing operations.
+ * @public
  */
 export class SignerEvmAddressReadonly extends SignerEvm {
   private readonly address: Hex;

package/src/signer/evm/verify.ts

@@ -1,6 +1,9 @@
 import { verifyMessage } from "ethers";
 import { BytesLike, bytesFrom } from "../../bytes/index.js";
 
+/**
+ * @public
+ */
 export function verifyMessageEvmPersonal(
   message: string | BytesLike,
   signature: string,

package/src/signer/nostr/signerNostr.ts

@@ -8,6 +8,9 @@ import { Hex, hexFrom } from "../../hex/index.js";
 import { Signer, SignerSignType, SignerType } from "../signer/index.js";
 import { buildNostrEventFromMessage } from "./verify.js";
 
+/**
+ * @public
+ */
 export interface NostrEvent {
   id?: string;
   pubkey?: string;
@@ -18,6 +21,9 @@ export interface NostrEvent {
   content: string;
 }
 
+/**
+ * @public
+ */
 export abstract class SignerNostr extends Signer {
   static CKB_SIG_HASH_ALL_TAG = "ckb_sighash_all";
   static CKB_UNLOCK_EVENT_KIND = 23334;

package/src/signer/nostr/verify.ts

@@ -5,6 +5,9 @@ import { BytesLike, bytesFrom } from "../../bytes/index.js";
 import { hexFrom } from "../../hex/index.js";
 import { NostrEvent } from "./signerNostr.js";
 
+/**
+ * @public
+ */
 export function buildNostrEventFromMessage(
   message: string | BytesLike,
 ): NostrEvent {