@ckb-ccc/core 0.0.4-alpha.1 → 0.0.4-alpha.3

package/dist/fixedPoint/index.js

@@ -1,5 +1,22 @@
+/**
+ * Represents a fixed point value as a bigint.
+ */
+/**
+ * Converts a FixedPointLike value to its string representation with fixed-point decimals.
+ *
+ * @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.
+ * @returns A string representing the fixed-point value.
+ *
+ * @example
+ * ```typescript
+ * const str = fixedPointToString(123456789n, 8); // Outputs "1.23456789"
+ * const strFromString = fixedPointToString("123456789", 8); // Outputs "1.23456789"
+ * const strFromNumber = fixedPointToString(123456789, 8); // Outputs "1.23456789"
+ * ```
+ */
 export function fixedPointToString(val, decimals = 8) {
-    const str = val.toString();
+    const str = fixedPointFrom(val).toString();
     const l = str.length <= decimals ? "0" : str.slice(0, -decimals);
     const r = str.slice(-decimals).padStart(decimals, "0").replace(/0*$/, "");
     if (r === "") {
@@ -7,6 +24,20 @@ export function fixedPointToString(val, decimals = 8) {
     }
     return `${l}.${r}`;
 }
+/**
+ * Converts a FixedPointLike value to a FixedPoint (bigint) with fixed-point decimals.
+ *
+ * @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.
+ * @returns A FixedPoint (bigint) representing the value with fixed-point decimals.
+ *
+ * @example
+ * ```typescript
+ * const fixedPoint = fixedPointFrom(1.23456789, 8); // Outputs 123456789n
+ * const fixedPointFromString = fixedPointFrom("1.23456789", 8); // Outputs 123456789n
+ * const fixedPointFromNumber = fixedPointFrom(1.23456789, 8); // Outputs 123456789n
+ * ```
+ */
 export function fixedPointFrom(val, decimals = 8) {
     if (typeof val === "bigint") {
         return val;
@@ -18,5 +49,12 @@ export function fixedPointFrom(val, decimals = 8) {
     }
     return lVal + BigInt(r.slice(0, decimals).padEnd(decimals, "0"));
 }
+/**
+ * Represents the fixed point value of zero as a bigint.
+ */
 export const Zero = 0n;
+/**
+ * Represents the fixed point value of one as a FixedPoint (bigint).
+ * Equivalent to 1 in fixed-point representation with default decimals (8).
+ */
 export const One = fixedPointFrom("1");

package/dist/hasher/index.d.ts

@@ -1,11 +1,52 @@
-import { Blake2b } from "blake2b";
 import { BytesLike } from "../bytes";
 import { Hex } from "../hex";
 export declare class Hasher {
-    hasher: Blake2b;
+    private readonly hasher;
+    /**
+     * Creates an instance of Hasher.
+     *
+     * @param outLength - The output length of the hash in bytes. Default is 32.
+     * @param personal - The personal string for the Blake2b algorithm. Default is CKB_BLAKE2B_PERSONAL.
+     */
     constructor(outLength?: number, personal?: string);
+    /**
+     * Updates the hash with the given data.
+     *
+     * @param data - The data to update the hash with.
+     * @returns The current Hasher instance for chaining.
+     *
+     * @example
+     * ```typescript
+     * const hasher = new Hasher();
+     * hasher.update("some data").update("more data");
+     * const hash = hasher.digest();
+     * ```
+     */
     update(data: BytesLike): Hasher;
+    /**
+     * Finalizes the hash and returns the digest as a hexadecimal string.
+     *
+     * @returns The hexadecimal string representation of the hash.
+     *
+     * @example
+     * ```typescript
+     * const hasher = new Hasher();
+     * hasher.update("some data");
+     * const hash = hasher.digest(); // Outputs something like "0x..."
+     * ```
+     */
     digest(): Hex;
 }
+/**
+ * Computes the CKB hash of the given data using the Blake2b algorithm.
+ *
+ * @param data - The data to hash.
+ * @returns The hexadecimal string representation of the hash.
+ *
+ * @example
+ * ```typescript
+ * const hash = ckbHash("some data"); // Outputs something like "0x..."
+ * ```
+ */
 export declare function ckbHash(data: BytesLike): Hex;
 //# sourceMappingURL=index.d.ts.map

package/dist/hasher/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hasher/index.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAa,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAG7B,qBAAa,MAAM;IACjB,MAAM,EAAE,OAAO,CAAC;gBAEJ,SAAS,SAAK,EAAE,QAAQ,SAAuB;IAS3D,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAK/B,MAAM,IAAI,GAAG;CAGd;AAED,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG,CAE5C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hasher/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAa,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAG7B,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;IAEjC;;;;;OAKG;gBAES,SAAS,SAAK,EAAE,QAAQ,SAAuB;IAS3D;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM;IAK/B;;;;;;;;;;;OAWG;IAEH,MAAM,IAAI,GAAG;CAGd;AAED;;;;;;;;;;GAUG;AAEH,wBAAgB,OAAO,CAAC,IAAI,EAAE,SAAS,GAAG,GAAG,CAE5C"}

package/dist/hasher/index.js

@@ -2,17 +2,59 @@ import blake2b from "blake2b";
 import { bytesFrom } from "../bytes";
 import { CKB_BLAKE2B_PERSONAL } from "./advanced";
 export class Hasher {
+    /**
+     * Creates an instance of Hasher.
+     *
+     * @param outLength - The output length of the hash in bytes. Default is 32.
+     * @param personal - The personal string for the Blake2b algorithm. Default is CKB_BLAKE2B_PERSONAL.
+     */
     constructor(outLength = 32, personal = CKB_BLAKE2B_PERSONAL) {
         this.hasher = blake2b(outLength, undefined, undefined, bytesFrom(personal, "utf8"));
     }
+    /**
+     * Updates the hash with the given data.
+     *
+     * @param data - The data to update the hash with.
+     * @returns The current Hasher instance for chaining.
+     *
+     * @example
+     * ```typescript
+     * const hasher = new Hasher();
+     * hasher.update("some data").update("more data");
+     * const hash = hasher.digest();
+     * ```
+     */
     update(data) {
         this.hasher.update(bytesFrom(data));
         return this;
     }
+    /**
+     * Finalizes the hash and returns the digest as a hexadecimal string.
+     *
+     * @returns The hexadecimal string representation of the hash.
+     *
+     * @example
+     * ```typescript
+     * const hasher = new Hasher();
+     * hasher.update("some data");
+     * const hash = hasher.digest(); // Outputs something like "0x..."
+     * ```
+     */
     digest() {
         return `0x${this.hasher.digest("hex")}`;
     }
 }
+/**
+ * Computes the CKB hash of the given data using the Blake2b algorithm.
+ *
+ * @param data - The data to hash.
+ * @returns The hexadecimal string representation of the hash.
+ *
+ * @example
+ * ```typescript
+ * const hash = ckbHash("some data"); // Outputs something like "0x..."
+ * ```
+ */
 export function ckbHash(data) {
     return new Hasher().update(data).digest();
 }

package/dist/hex/index.d.ts

@@ -1,5 +1,24 @@
 import { BytesLike } from "../bytes";
+/**
+ * Represents a hexadecimal string prefixed with "0x".
+ */
 export type Hex = `0x${string}`;
+/**
+ * Represents a value that can be converted to a hexadecimal string.
+ * It extends the BytesLike type.
+ */
 export type HexLike = BytesLike;
+/**
+ * Converts a HexLike value to a Hex string.
+ *
+ * @param hex - The value to convert, which can be a string, Uint8Array, ArrayBuffer, or number array.
+ * @returns A Hex string representing the value.
+ *
+ * @example
+ * ```typescript
+ * const hexString = hexFrom("68656c6c6f"); // Outputs "0x68656c6c6f"
+ * const hexStringFromBytes = hexFrom(new Uint8Array([104, 101, 108, 108, 111])); // Outputs "0x68656c6c6f"
+ * ```
+ */
 export declare function hexFrom(hex: HexLike): Hex;
 //# sourceMappingURL=index.d.ts.map

package/dist/hex/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hex/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,SAAS,EAAW,MAAM,UAAU,CAAC;AAEzD,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAChC,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC;AAEhC,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAEzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/hex/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,SAAS,EAAW,MAAM,UAAU,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,KAAK,MAAM,EAAE,CAAC;AAChC;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,CAAC;AAEhC;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAEzC"}

package/dist/hex/index.js

@@ -1,4 +1,16 @@
 import { bytesFrom, bytesTo } from "../bytes";
+/**
+ * Converts a HexLike value to a Hex string.
+ *
+ * @param hex - The value to convert, which can be a string, Uint8Array, ArrayBuffer, or number array.
+ * @returns A Hex string representing the value.
+ *
+ * @example
+ * ```typescript
+ * const hexString = hexFrom("68656c6c6f"); // Outputs "0x68656c6c6f"
+ * const hexStringFromBytes = hexFrom(new Uint8Array([104, 101, 108, 108, 111])); // Outputs "0x68656c6c6f"
+ * ```
+ */
 export function hexFrom(hex) {
     return `0x${bytesTo(bytesFrom(hex), "hex")}`;
 }

package/dist/num/index.d.ts

@@ -1,13 +1,112 @@
 import { Bytes, BytesLike } from "../bytes";
 import { Hex, HexLike } from "../hex";
+/**
+ * Represents a numeric value as a bigint.
+ */
 export type Num = bigint;
+/**
+ * Represents a value that can be converted to a numeric value.
+ * It can be a string, number, bigint, or HexLike.
+ */
 export type NumLike = string | number | bigint | HexLike;
+/**
+ * Converts a NumLike value to a Num (bigint).
+ *
+ * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
+ * @returns A Num (bigint) representing the value.
+ *
+ * @example
+ * ```typescript
+ * const num = numFrom("12345"); // Outputs 12345n
+ * const numFromHex = numFrom("0x3039"); // Outputs 12345n
+ * ```
+ */
 export declare function numFrom(val: NumLike): Num;
+/**
+ * Converts a NumLike value to a hexadecimal string.
+ *
+ * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
+ * @returns A Hex string representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const hex = numToHex(12345); // Outputs "0x3039"
+ * ```
+ */
 export declare function numToHex(val: NumLike): Hex;
+/**
+ * Converts a NumLike value to a byte array in little-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numToBytes(12345, 4); // Outputs Uint8Array [57, 48, 0, 0]
+ * ```
+ */
 export declare function numToBytes(val: NumLike, bytes?: number): Bytes;
+/**
+ * Converts a NumLike value to a byte array in little-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numLeToBytes(12345, 4); // Outputs Uint8Array [57, 48, 0, 0]
+ * ```
+ */
 export declare function numLeToBytes(val: NumLike, bytes?: number): Bytes;
+/**
+ * Converts a NumLike value to a byte array in big-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numBeToBytes(12345, 4); // Outputs Uint8Array [0, 0, 48, 57]
+ * ```
+ */
 export declare function numBeToBytes(val: NumLike, bytes?: number): Bytes;
+/**
+ * Converts a byte array to a Num (bigint) assuming little-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numFromBytes(new Uint8Array([57, 48, 0, 0])); // Outputs 12345n
+ * ```
+ */
 export declare function numFromBytes(val: BytesLike): Num;
+/**
+ * Converts a byte array to a Num (bigint) assuming little-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numLeFromBytes(new Uint8Array([57, 48, 0, 0])); // Outputs 12345n
+ * ```
+ */
 export declare function numLeFromBytes(val: BytesLike): Num;
+/**
+ * Converts a byte array to a Num (bigint) assuming big-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numBeFromBytes(new Uint8Array([0, 0, 48, 57])); // Outputs 12345n
+ * ```
+ */
 export declare function numBeFromBytes(val: BytesLike): Num;
 //# sourceMappingURL=index.d.ts.map

package/dist/num/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/num/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAA0B,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,QAAQ,CAAC;AAE/C,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AACzB,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEzD,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAUzC;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAE1C;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAE9D;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAEhE;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAUhE;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAEhD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAElD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAElD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/num/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,SAAS,EAA0B,MAAM,UAAU,CAAC;AACpE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,QAAQ,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEzD;;;;;;;;;;;GAWG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAUzC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,CAE1C;AAED;;;;;;;;;;;GAWG;AAEH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAE9D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAEhE;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,KAAK,CAUhE;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAEhD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAElD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,SAAS,GAAG,GAAG,CAElD"}

package/dist/num/index.js

@@ -1,5 +1,17 @@
 import { bytesConcat, bytesFrom } from "../bytes";
 import { hexFrom } from "../hex";
+/**
+ * Converts a NumLike value to a Num (bigint).
+ *
+ * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
+ * @returns A Num (bigint) representing the value.
+ *
+ * @example
+ * ```typescript
+ * const num = numFrom("12345"); // Outputs 12345n
+ * const numFromHex = numFrom("0x3039"); // Outputs 12345n
+ * ```
+ */
 export function numFrom(val) {
     if (typeof val === "bigint") {
         return val;
@@ -9,15 +21,62 @@ export function numFrom(val) {
     }
     return BigInt(hexFrom(val));
 }
+/**
+ * Converts a NumLike value to a hexadecimal string.
+ *
+ * @param val - The value to convert, which can be a string, number, bigint, or HexLike.
+ * @returns A Hex string representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const hex = numToHex(12345); // Outputs "0x3039"
+ * ```
+ */
 export function numToHex(val) {
     return `0x${numFrom(val).toString(16)}`;
 }
+/**
+ * Converts a NumLike value to a byte array in little-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numToBytes(12345, 4); // Outputs Uint8Array [57, 48, 0, 0]
+ * ```
+ */
 export function numToBytes(val, bytes) {
     return numLeToBytes(val, bytes);
 }
+/**
+ * Converts a NumLike value to a byte array in little-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numLeToBytes(12345, 4); // Outputs Uint8Array [57, 48, 0, 0]
+ * ```
+ */
 export function numLeToBytes(val, bytes) {
     return numBeToBytes(val, bytes).reverse();
 }
+/**
+ * Converts a NumLike value to a byte array in big-endian order.
+ *
+ * @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.
+ * @returns A Uint8Array containing the byte representation of the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const bytes = numBeToBytes(12345, 4); // Outputs Uint8Array [0, 0, 48, 57]
+ * ```
+ */
 export function numBeToBytes(val, bytes) {
     const rawBytes = bytesFrom(numFrom(val).toString(16));
     if (bytes == null) {
@@ -25,12 +84,45 @@ export function numBeToBytes(val, bytes) {
     }
     return bytesConcat(Array.from(Array(bytes - rawBytes.length), () => 0), rawBytes);
 }
+/**
+ * Converts a byte array to a Num (bigint) assuming little-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numFromBytes(new Uint8Array([57, 48, 0, 0])); // Outputs 12345n
+ * ```
+ */
 export function numFromBytes(val) {
     return numLeFromBytes(val);
 }
+/**
+ * Converts a byte array to a Num (bigint) assuming little-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numLeFromBytes(new Uint8Array([57, 48, 0, 0])); // Outputs 12345n
+ * ```
+ */
 export function numLeFromBytes(val) {
     return numBeFromBytes(bytesFrom(val).reverse());
 }
+/**
+ * Converts a byte array to a Num (bigint) assuming big-endian order.
+ *
+ * @param val - The byte array to convert.
+ * @returns A Num (bigint) representing the numeric value.
+ *
+ * @example
+ * ```typescript
+ * const num = numBeFromBytes(new Uint8Array([0, 0, 48, 57])); // Outputs 12345n
+ * ```
+ */
 export function numBeFromBytes(val) {
     return numFrom(bytesFrom(val));
 }

package/dist/signer/btc/signerBtc.d.ts

@@ -1,12 +1,43 @@
 import { Address } from "../../address";
-import { Transaction } from "../../ckb";
+import { Transaction, TransactionLike } from "../../ckb";
 import { HexLike } from "../../hex";
 import { Signer } from "../signer";
+/**
+ * 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.
+ */
 export declare abstract class SignerBtc extends Signer {
+    /**
+     * Gets the Bitcoin account associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the Bitcoin account.
+     */
     abstract getBtcAccount(): Promise<string>;
+    /**
+     * Gets the Bitcoin public key associated with the signer.
+     *
+     * @returns A promise that resolves to a HexLike value representing the Bitcoin public key.
+     */
     abstract getBtcPublicKey(): Promise<HexLike>;
+    /**
+     * Gets the internal address, which is the Bitcoin account in this case.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     */
     getInternalAddress(): Promise<string>;
+    /**
+     * Gets an array of Address objects representing the known script addresses for the signer.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     */
     getAddressObjs(): Promise<Address[]>;
-    signOnlyTransaction(tx: Transaction): Promise<Transaction>;
+    /**
+     * Signs a transaction without modifying it.
+     *
+     * @param txLike - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to a signed Transaction object.
+     */
+    signOnlyTransaction(txLike: TransactionLike): Promise<Transaction>;
 }
 //# sourceMappingURL=signerBtc.d.ts.map

package/dist/signer/btc/signerBtc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signerBtc.d.ts","sourceRoot":"","sources":["../../../src/signer/btc/signerBtc.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAe,MAAM,WAAW,CAAC;AAErD,OAAO,EAAE,OAAO,EAAW,MAAM,WAAW,CAAC;AAG7C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,8BAAsB,SAAU,SAAQ,MAAM;IAC5C,QAAQ,CAAC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAEzC,QAAQ,CAAC,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAEtC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAapC,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;CA+BjE"}
+{"version":3,"file":"signerBtc.d.ts","sourceRoot":"","sources":["../../../src/signer/btc/signerBtc.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAe,MAAM,WAAW,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAW,MAAM,WAAW,CAAC;AAG7C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC;;;;GAIG;AACH,8BAAsB,SAAU,SAAQ,MAAM;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAEzC;;;;OAIG;IACH,QAAQ,CAAC,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAE5C;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAa1C;;;;;OAKG;IACG,mBAAmB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAgCzE"}

package/dist/signer/btc/signerBtc.js

@@ -2,16 +2,31 @@ import { ripemd160 } from "@noble/hashes/ripemd160";
 import { sha256 } from "@noble/hashes/sha256";
 import { Address } from "../../address";
 import { bytesConcat, bytesFrom } from "../../bytes";
-import { WitnessArgs } from "../../ckb";
+import { Transaction, WitnessArgs } from "../../ckb";
 import { KnownScript } from "../../client";
 import { hexFrom } from "../../hex";
 import { numToBytes } from "../../num";
 import { getSignHashInfo } from "../helpers";
 import { Signer } from "../signer";
+/**
+ * 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.
+ */
 export class SignerBtc extends Signer {
+    /**
+     * Gets the internal address, which is the Bitcoin account in this case.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     */
     async getInternalAddress() {
         return this.getBtcAccount();
     }
+    /**
+     * Gets an array of Address objects representing the known script addresses for the signer.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     */
     async getAddressObjs() {
         const publicKey = await this.getBtcPublicKey();
         const hash = ripemd160(sha256(bytesFrom(publicKey)));
@@ -19,9 +34,16 @@ export class SignerBtc extends Signer {
             await Address.fromKnownScript(KnownScript.OmniLock, hexFrom([0x04, ...hash, 0x00]), this.client),
         ];
     }
-    async signOnlyTransaction(tx) {
+    /**
+     * Signs a transaction without modifying it.
+     *
+     * @param txLike - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to a signed Transaction object.
+     */
+    async signOnlyTransaction(txLike) {
+        const tx = Transaction.from(txLike);
         const { script } = await this.getRecommendedAddressObj();
-        const info = await getSignHashInfo(tx, script);
+        const info = await getSignHashInfo(tx, script, this.client);
         if (!info) {
             return tx;
         }

package/dist/signer/btc/signerBtcPublicKeyReadonly.d.ts

@@ -1,12 +1,48 @@
 import { Client } from "../../client";
 import { Hex, HexLike } from "../../hex";
 import { SignerBtc } from "./signerBtc";
+/**
+ * A class extending SignerBtc that provides read-only access to a Bitcoin public key and account.
+ * This class does not support signing operations.
+ */
 export declare class SignerBtcPublicKeyReadonly extends SignerBtc {
     private readonly account;
     private readonly publicKey;
+    /**
+     * Creates an instance of SignerBtcPublicKeyReadonly.
+     *
+     * @param client - The client instance used for communication.
+     * @param account - The Bitcoin account associated with the signer.
+     * @param publicKey - The public key associated with the signer.
+     */
     constructor(client: Client, account: string, publicKey: HexLike);
+    /**
+     * Connects to the client. This implementation does nothing as the class is read-only.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     */
     connect(): Promise<void>;
+    /**
+     * Gets the Bitcoin account associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the Bitcoin account.
+     *
+     * @example
+     * ```typescript
+     * const account = await signer.getBtcAccount(); // Outputs the Bitcoin account
+     * ```
+     */
     getBtcAccount(): Promise<string>;
+    /**
+     * Gets the Bitcoin public key associated with the signer.
+     *
+     * @returns A promise that resolves to a Hex string representing the Bitcoin public key.
+     *
+     * @example
+     * ```typescript
+     * const publicKey = await signer.getBtcPublicKey(); // Outputs the Bitcoin public key
+     * ```
+     */
     getBtcPublicKey(): Promise<Hex>;
 }
 //# sourceMappingURL=signerBtcPublicKeyReadonly.d.ts.map

package/dist/signer/btc/signerBtcPublicKeyReadonly.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signerBtcPublicKeyReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/btc/signerBtcPublicKeyReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,qBAAa,0BAA2B,SAAQ,SAAS;IAKrD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAJ1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAM;gBAG9B,MAAM,EAAE,MAAM,EACG,OAAO,EAAE,MAAM,EAChC,SAAS,EAAE,OAAO;IAOd,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAExB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAIhC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;CAGtC"}
+{"version":3,"file":"signerBtcPublicKeyReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/btc/signerBtcPublicKeyReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAW,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,qBAAa,0BAA2B,SAAQ,SAAS;IAYrD,OAAO,CAAC,QAAQ,CAAC,OAAO;IAX1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAM;IAEhC;;;;;;OAMG;gBAED,MAAM,EAAE,MAAM,EACG,OAAO,EAAE,MAAM,EAChC,SAAS,EAAE,OAAO;IAOpB;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;;;;;;;OASG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;CAGtC"}