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

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"
+}