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

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 {

package/src/signer/signer/index.ts

@@ -10,6 +10,9 @@ import { verifyMessageJoyId } from "../ckb/verifyJoyId.js";
 import { verifyMessageEvmPersonal } from "../evm/verify.js";
 import { verifyMessageNostrEvent } from "../nostr/verify.js";
 
+/**
+ * @public
+ */
 export enum SignerSignType {
   Unknown = "Unknown",
   BtcEcdsa = "BtcEcdsa",
@@ -21,6 +24,7 @@ export enum SignerSignType {
 
 /**
  * An enumeration of signer display types in wallet.
+ * @public
  */
 export enum SignerType {
   EVM = "EVM",
@@ -29,23 +33,28 @@ export enum SignerType {
   Nostr = "Nostr",
 }
 
+/**
+ * @public
+ */
 export type NetworkPreference = {
   addressPrefix: string;
   signerType: SignerType;
+  /**
+   * Wallet signers should check if the wallet is using preferred networks.
+   * If not, try to switch to the first preferred network.
+   * If non preferred, let users choose what they want.
+   * BTC: // They made a mess...
+   *   btc
+   *   btcTestnet
+   *   btcSignet // OKX
+   *   fractalBtc // UniSat
+   */
   network: string;
-  /*
-    Wallet signers should check if the wallet is using preferred networks.
-    If not, try to switch to the first preferred network.
-    If non preferred, let users choose what they want.
-
-    BTC: // They made a mess...
-      btc
-      btcTestnet
-      btcSignet // OKX
-      fractalBtc // UniSat
-  */
 };
 
+/**
+ * @public
+ */
 export class Signature {
   constructor(
     public signature: string,
@@ -57,6 +66,7 @@ export class Signature {
 /**
  * An abstract class representing a generic signer.
  * This class provides methods to connect, get addresses, and sign transactions.
+ * @public
  */
 export abstract class Signer {
   constructor(protected client_: Client) {}
@@ -227,7 +237,7 @@ export abstract class Signer {
   /**
    * Signs a message.
    *
-   * @param _ - The message to sign, as a string or BytesLike object.
+   * @param message - The message to sign, as a string or BytesLike object.
    * @returns A promise that resolves to the signature info.
    * @throws Will throw an error if not implemented.
    */
@@ -253,8 +263,8 @@ export abstract class Signer {
   /**
    * Verify a signature.
    *
-   * @param _ - The original message.
-   * @param _ - The signature to verify.
+   * @param message - The original message.
+   * @param signature - The signature to verify.
    * @returns A promise that resolves to the verification result.
    * @throws Will throw an error if not implemented.
    */
@@ -326,6 +336,7 @@ export abstract class Signer {
 
 /**
  * A class representing information about a signer, including its type and the signer instance.
+ * @public
  */
 export class SignerInfo {
   constructor(
@@ -336,6 +347,7 @@ export class SignerInfo {
 
 /**
  * Represents a wallet with a name, icon, and an array of signer information.
+ * @public
  */
 export type Wallet = {
   name: string;

package/src/utils/index.ts

@@ -1,5 +1,6 @@
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -11,6 +12,7 @@ export function apply<T, R>(
 ): undefined;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -19,6 +21,7 @@ export function apply<T, R>(
 export function apply<T, R>(transformer: (val: T) => R, value: null): undefined;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -27,6 +30,7 @@ export function apply<T, R>(transformer: (val: T) => R, value: null): undefined;
 export function apply<T, R>(transformer: (val: T) => R, value: T): R;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -38,6 +42,7 @@ export function apply<T, R>(
 ): R | undefined;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -49,6 +54,7 @@ export function apply<T, R>(
 ): R | undefined;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -61,6 +67,7 @@ export function apply<T, R>(
 /**
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -72,6 +79,7 @@ export function apply<T, R>(
 ): R | undefined;
 /**
  * A type safe way to apply a transformer on a value if it's not empty.
+ * @public
  *
  * @param transformer - The transformer.
  * @param value - The value to be transformed.
@@ -90,6 +98,7 @@ export function apply<T, R>(
 
 /**
  * Similar to Array.reduce, but the accumulator can returns Promise.
+ * @public
  *
  * @param values - The array to be reduced.
  * @param accumulator - A callback to be called for each value. If it returns null, the previous result will be kept.
@@ -104,6 +113,7 @@ export async function reduceAsync<T, V>(
 ): Promise<T>;
 /**
  * Similar to Array.reduce, but the accumulator can returns Promise.
+ * @public
  *
  * @param values - The array to be reduced.
  * @param accumulator - A callback to be called for each value. If it returns null, the previous result will be kept.
@@ -120,6 +130,15 @@ export async function reduceAsync<T, V>(
   ) => Promise<T | undefined | null | void> | T | undefined | null | void,
   init: T | Promise<T>,
 ): Promise<T>;
+/**
+ * Similar to Array.reduce, but the accumulator can returns Promise.
+ * @public
+ *
+ * @param values - The array to be reduced.
+ * @param accumulator - A callback to be called for each value. If it returns null, the previous result will be kept.
+ * @param init - The initial value.
+ * @returns The accumulated result.
+ */
 export async function reduceAsync<T, V>(
   values: (V | T)[],
   accumulator: (
@@ -147,6 +166,9 @@ export async function reduceAsync<T, V>(
   );
 }
 
+/**
+ * @public
+ */
 export function isWebview(userAgent: string): boolean {
   return /webview|wv|ip((?!.*Safari)|(?=.*like Safari))/i.test(userAgent);
 }

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts", "./src/advanced.ts"],
+  "extends": ["../../typedoc.base.json"],
+  "name": "@ckb-ccc core"
+}