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

package/dist/signer/btc/signerBtcPublicKeyReadonly.js

@@ -1,15 +1,51 @@
 import { hexFrom } 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 class SignerBtcPublicKeyReadonly extends SignerBtc {
+    /**
+     * 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, account, publicKey) {
         super(client);
         this.account = account;
         this.publicKey = hexFrom(publicKey);
     }
+    /**
+     * Connects to the client. This implementation does nothing as the class is read-only.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     */
     async connect() { }
+    /**
+     * 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
+     * ```
+     */
     async getBtcAccount() {
         return this.account;
     }
+    /**
+     * 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
+     * ```
+     */
     async getBtcPublicKey() {
         return this.publicKey;
     }

package/dist/signer/ckb/signerCkbScriptReadonly.d.ts

@@ -2,11 +2,46 @@ import { Address } from "../../address";
 import { ScriptLike } from "../../ckb";
 import { Client } from "../../client";
 import { Signer } from "../signer";
+/**
+ * A class extending Signer that provides read-only access to a CKB script.
+ * This class does not support signing operations.
+ */
 export declare class SignerCkbScriptReadonly extends Signer {
     private readonly script;
+    /**
+     * Creates an instance of SignerCkbScriptReadonly.
+     *
+     * @param client - The client instance used for communication.
+     * @param script - The script associated with the signer.
+     */
     constructor(client: Client, script: ScriptLike);
+    /**
+     * 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 internal address for the script.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     *
+     * @example
+     * ```typescript
+     * const internalAddress = await signer.getInternalAddress(); // Outputs the internal address
+     * ```
+     */
     getInternalAddress(): Promise<string>;
+    /**
+     * Gets an array of Address objects representing the script address.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     *
+     * @example
+     * ```typescript
+     * const addressObjs = await signer.getAddressObjs(); // Outputs the array of Address objects
+     * ```
+     */
     getAddressObjs(): Promise<Address[]>;
 }
 //# sourceMappingURL=signerCkbScriptReadonly.d.ts.map

package/dist/signer/ckb/signerCkbScriptReadonly.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signerCkbScriptReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/ckb/signerCkbScriptReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAU,UAAU,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,qBAAa,uBAAwB,SAAQ,MAAM;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU;IAMxC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAExB,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;CAG3C"}
+{"version":3,"file":"signerCkbScriptReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/ckb/signerCkbScriptReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACxC,OAAO,EAAU,UAAU,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,MAAM;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU;IAM9C;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;;;;;;OASG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;;;;;;OASG;IAEG,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;CAG3C"}

package/dist/signer/ckb/signerCkbScriptReadonly.js

@@ -1,15 +1,50 @@
 import { Address } from "../../address";
 import { Script } from "../../ckb";
 import { Signer } from "../signer";
+/**
+ * A class extending Signer that provides read-only access to a CKB script.
+ * This class does not support signing operations.
+ */
 export class SignerCkbScriptReadonly extends Signer {
+    /**
+     * Creates an instance of SignerCkbScriptReadonly.
+     *
+     * @param client - The client instance used for communication.
+     * @param script - The script associated with the signer.
+     */
     constructor(client, script) {
         super(client);
         this.script = Script.from(script);
     }
+    /**
+     * Connects to the client. This implementation does nothing as the class is read-only.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     */
     async connect() { }
+    /**
+     * Gets the internal address for the script.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     *
+     * @example
+     * ```typescript
+     * const internalAddress = await signer.getInternalAddress(); // Outputs the internal address
+     * ```
+     */
     async getInternalAddress() {
         return this.getRecommendedAddress();
     }
+    /**
+     * Gets an array of Address objects representing the script address.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     *
+     * @example
+     * ```typescript
+     * const addressObjs = await signer.getAddressObjs(); // Outputs the array of Address objects
+     * ```
+     */
     async getAddressObjs() {
         return [await Address.fromScript(this.script, this.client)];
     }

package/dist/signer/evm/signerEvm.d.ts

@@ -1,10 +1,35 @@
 import { Address } from "../../address";
-import { Transaction } from "../../ckb";
+import { Transaction, TransactionLike } from "../../ckb";
 import { Signer } from "../signer";
+/**
+ * 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.
+ */
 export declare abstract class SignerEvm extends Signer {
+    /**
+     * Gets the EVM account associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the EVM account.
+     */
     abstract getEvmAccount(): Promise<string>;
+    /**
+     * Gets the internal address, which is the EVM 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=signerEvm.d.ts.map

package/dist/signer/evm/signerEvm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signerEvm.d.ts","sourceRoot":"","sources":["../../../src/signer/evm/signerEvm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAe,MAAM,WAAW,CAAC;AAKrD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,8BAAsB,SAAU,SAAQ,MAAM;IAC5C,QAAQ,CAAC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAEnC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAWpC,mBAAmB,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;CA8BjE"}
+{"version":3,"file":"signerEvm.d.ts","sourceRoot":"","sources":["../../../src/signer/evm/signerEvm.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAe,MAAM,WAAW,CAAC;AAKtE,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC;;;GAGG;AACH,8BAAsB,SAAU,SAAQ,MAAM;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAEzC;;;;OAIG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAW1C;;;;;OAKG;IACG,mBAAmB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAgCzE"}

package/dist/signer/evm/signerEvm.js

@@ -1,24 +1,45 @@
 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 Signer for Ethereum Virtual Machine (EVM) based signing operations.
+ * This class provides methods to get EVM account, internal address, and signing transactions.
+ */
 export class SignerEvm extends Signer {
+    /**
+     * Gets the internal address, which is the EVM account in this case.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     */
     async getInternalAddress() {
         return this.getEvmAccount();
     }
+    /**
+     * 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 account = await this.getEvmAccount();
         return [
             await Address.fromKnownScript(KnownScript.OmniLock, hexFrom([0x12, ...bytesFrom(account), 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/evm/signerEvmAddressReadonly.d.ts

@@ -1,10 +1,40 @@
 import { Client } from "../../client";
 import { HexLike } from "../../hex";
 import { SignerEvm } from "./signerEvm";
+/**
+ * A class extending SignerEvm that provides read-only access to an EVM address.
+ * This class does not support signing operations.
+ */
 export declare abstract class SignerEvmAddressReadonly extends SignerEvm {
     private readonly address;
+    /**
+     * Creates an instance of SignerEvmAddressReadonly.
+     *
+     * @param client - The client instance used for communication.
+     * @param address - The EVM address associated with the signer.
+     */
     constructor(client: Client, address: 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.
+     *
+     * @example
+     * ```typescript
+     * await signer.connect();
+     * ```
+     */
     connect(): Promise<void>;
+    /**
+     * Gets the EVM account associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the EVM account.
+     *
+     * @example
+     * ```typescript
+     * const account = await signer.getEvmAccount(); // Outputs the EVM account
+     * ```
+     */
     getEvmAccount(): Promise<string>;
 }
 //# sourceMappingURL=signerEvmAddressReadonly.d.ts.map

package/dist/signer/evm/signerEvmAddressReadonly.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signerEvmAddressReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/evm/signerEvmAddressReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAO,OAAO,EAAW,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,8BAAsB,wBAAyB,SAAQ,SAAS;IAC9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAM;gBAElB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAMtC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAExB,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;CAGvC"}
+{"version":3,"file":"signerEvmAddressReadonly.d.ts","sourceRoot":"","sources":["../../../src/signer/evm/signerEvmAddressReadonly.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAO,OAAO,EAAW,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC;;;GAGG;AACH,8BAAsB,wBAAyB,SAAQ,SAAS;IAC9D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAM;IAE9B;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAM5C;;;;;;;;;OASG;IAEG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;CAGvC"}

package/dist/signer/evm/signerEvmAddressReadonly.js

@@ -1,11 +1,41 @@
 import { hexFrom } from "../../hex";
 import { SignerEvm } from "./signerEvm";
+/**
+ * A class extending SignerEvm that provides read-only access to an EVM address.
+ * This class does not support signing operations.
+ */
 export class SignerEvmAddressReadonly extends SignerEvm {
+    /**
+     * Creates an instance of SignerEvmAddressReadonly.
+     *
+     * @param client - The client instance used for communication.
+     * @param address - The EVM address associated with the signer.
+     */
     constructor(client, address) {
         super(client);
         this.address = hexFrom(address);
     }
+    /**
+     * Connects to the client. This implementation does nothing as the class is read-only.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     *
+     * @example
+     * ```typescript
+     * await signer.connect();
+     * ```
+     */
     async connect() { }
+    /**
+     * Gets the EVM account associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the EVM account.
+     *
+     * @example
+     * ```typescript
+     * const account = await signer.getEvmAccount(); // Outputs the EVM account
+     * ```
+     */
     async getEvmAccount() {
         return this.address;
     }

package/dist/signer/helpers.d.ts

@@ -1,6 +1,24 @@
 import { ScriptLike, TransactionLike } from "../ckb";
+import { Client } from "../client";
 import { Hex } from "../hex";
-export declare function getSignHashInfo(txLike: TransactionLike, scriptLike: ScriptLike): Promise<{
+/**
+ * Computes the signing hash information for a given transaction and script.
+ *
+ * @param txLike - The transaction to sign, represented as a TransactionLike object.
+ * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
+ * @returns A promise that resolves to an object containing the signing message and the witness position,
+ *          or undefined if no matching input is found.
+ *
+ * @example
+ * ```typescript
+ * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike);
+ * if (signHashInfo) {
+ *   console.log(signHashInfo.message); // Outputs the signing message
+ *   console.log(signHashInfo.position); // Outputs the witness position
+ * }
+ * ```
+ */
+export declare function getSignHashInfo(txLike: TransactionLike, scriptLike: ScriptLike, client: Client): Promise<{
     message: Hex;
     position: number;
 } | undefined>;

package/dist/signer/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/signer/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,UAAU,EAAe,eAAe,EAAE,MAAM,QAAQ,CAAC;AAE1E,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAsCzD"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/signer/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAU,UAAU,EAAe,eAAe,EAAE,MAAM,QAAQ,CAAC;AAC1E,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,OAAO,EAAE,GAAG,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAuCzD"}

package/dist/signer/helpers.js

@@ -1,18 +1,35 @@
 import { Script, Transaction } from "../ckb";
 import { Hasher } from "../hasher";
-export async function getSignHashInfo(txLike, scriptLike) {
+/**
+ * Computes the signing hash information for a given transaction and script.
+ *
+ * @param txLike - The transaction to sign, represented as a TransactionLike object.
+ * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
+ * @returns A promise that resolves to an object containing the signing message and the witness position,
+ *          or undefined if no matching input is found.
+ *
+ * @example
+ * ```typescript
+ * const signHashInfo = await getSignHashInfo(transactionLike, scriptLike);
+ * if (signHashInfo) {
+ *   console.log(signHashInfo.message); // Outputs the signing message
+ *   console.log(signHashInfo.position); // Outputs the witness position
+ * }
+ * ```
+ */
+export async function getSignHashInfo(txLike, scriptLike, client) {
     const tx = Transaction.from(txLike);
     const script = Script.from(scriptLike);
     let position = -1;
     const hasher = new Hasher();
     hasher.update(tx.hash());
-    tx.witnesses.forEach((witness, i) => {
-        const input = tx.inputs[i];
-        if (input) {
-            if (!input.cellOutput?.lock) {
-                throw Error("Incomplete inputs info");
+    for (let i = 0; i < tx.witnesses.length; i += 1) {
+        if (tx.inputs[i]) {
+            const input = await tx.inputs[i].completeExtraInfos(client);
+            if (!input.cellOutput) {
+                throw Error("Unable to resolve inputs info");
             }
-            if (!script.eq(input.cellOutput?.lock)) {
+            if (!script.eq(input.cellOutput.lock)) {
                 return;
             }
             if (position === -1) {
@@ -22,8 +39,8 @@ export async function getSignHashInfo(txLike, scriptLike) {
         if (position === -1) {
             return undefined;
         }
-        Transaction.hashWitnessToHasher(witness, hasher);
-    });
+        Transaction.hashWitnessToHasher(tx.witnesses[i], hasher);
+    }
     if (position === -1) {
         return undefined;
     }

package/dist/signer/signer.d.ts

@@ -1,31 +1,102 @@
 import { Address } from "../address";
 import { BytesLike } from "../bytes";
-import { Transaction } from "../ckb";
+import { Transaction, TransactionLike } from "../ckb";
 import { Client } from "../client";
 import { Hex } from "../hex";
+/**
+ * An abstract class representing a generic signer.
+ * This class provides methods to connect, get addresses, and sign transactions.
+ */
 export declare abstract class Signer {
     readonly client: Client;
     constructor(client: Client);
+    /**
+     * Connects to the client.
+     *
+     * @returns A promise that resolves when the connection is complete.
+     */
     abstract connect(): Promise<void>;
+    /**
+     * Gets the internal address associated with the signer.
+     *
+     * @returns A promise that resolves to a string representing the internal address.
+     */
     abstract getInternalAddress(): Promise<string>;
+    /**
+     * Gets an array of Address objects associated with the signer.
+     *
+     * @returns A promise that resolves to an array of Address objects.
+     */
     abstract getAddressObjs(): Promise<Address[]>;
+    /**
+     * Gets the recommended Address object for the signer.
+     *
+     * @param _preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended Address object.
+     */
     getRecommendedAddressObj(_preference?: unknown): Promise<Address>;
+    /**
+     * Gets the recommended address for the signer as a string.
+     *
+     * @param preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended address as a string.
+     */
     getRecommendedAddress(preference?: unknown): Promise<string>;
+    /**
+     * Gets an array of addresses associated with the signer as strings.
+     *
+     * @returns A promise that resolves to an array of addresses as strings.
+     */
     getAddresses(): Promise<string[]>;
+    /**
+     * Signs a message. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The message to sign, as a string or BytesLike object.
+     * @returns A promise that resolves to the signed message as a string.
+     * @throws Will throw an error if not implemented.
+     */
     signMessage(_: string | BytesLike): Promise<string>;
-    sendTransaction(tx: Transaction): Promise<Hex>;
-    signTransaction(tx: Transaction): Promise<Transaction>;
-    signOnlyTransaction(_: Transaction): Promise<Transaction>;
+    /**
+     * Sends a transaction after signing it.
+     *
+     * @param tx - The transaction to send, represented as a TransactionLike object.
+     * @returns A promise that resolves to the transaction hash as a Hex string.
+     */
+    sendTransaction(tx: TransactionLike): Promise<Hex>;
+    /**
+     * Signs a transaction.
+     *
+     * @param tx - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     */
+    signTransaction(tx: TransactionLike): Promise<Transaction>;
+    /**
+     * Signs a transaction without sending it. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
+    signOnlyTransaction(_: TransactionLike): Promise<Transaction>;
 }
+/**
+ * An enumeration of signer types.
+ */
 export declare enum SignerType {
     EVM = "EVM",
     BTC = "BTC"
 }
+/**
+ * A class representing information about a signer, including its type and the signer instance.
+ */
 export declare class SignerInfo {
     type: SignerType;
     signer: Signer;
     constructor(type: SignerType, signer: Signer);
 }
+/**
+ * Represents a wallet with a name, icon, and an array of signer information.
+ */
 export type Wallet = {
     name: string;
     icon: string;

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

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B,8BAAsB,MAAM;aACE,MAAM,EAAE,MAAM;gBAAd,MAAM,EAAE,MAAM;IAE1C,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAE9C,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IACvC,wBAAwB,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIjE,qBAAqB,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAG5D,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAMvC,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAI7C,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAI9C,eAAe,CAAC,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAI5D,mBAAmB,CAAC,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;CAG1D;AAED,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED,qBAAa,UAAU;IAEZ,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM;gBADd,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM;CAExB;AAED,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC;AAE7B;;;GAGG;AACH,8BAAsB,MAAM;aACE,MAAM,EAAE,MAAM;gBAAd,MAAM,EAAE,MAAM;IAE1C;;;;OAIG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,CAAC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAE7C;;;;;OAKG;IACG,wBAAwB,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE;;;;;OAKG;IACG,qBAAqB,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlE;;;;OAIG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAMvC;;;;;;OAMG;IACH,WAAW,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAInD;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IAIxD;;;;;OAKG;IACG,eAAe,CAAC,EAAE,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAIhE;;;;;;OAMG;IACH,mBAAmB,CAAC,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAG9D;AAED;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,QAAQ;IACX,GAAG,QAAQ;CACZ;AAED;;GAEG;AACH,qBAAa,UAAU;IAEZ,IAAI,EAAE,UAAU;IAChB,MAAM,EAAE,MAAM;gBADd,IAAI,EAAE,UAAU,EAChB,MAAM,EAAE,MAAM;CAExB;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,UAAU,EAAE,CAAC;CACvB,CAAC"}

package/dist/signer/signer.js

@@ -1,34 +1,87 @@
+/**
+ * An abstract class representing a generic signer.
+ * This class provides methods to connect, get addresses, and sign transactions.
+ */
 export class Signer {
     constructor(client) {
         this.client = client;
     }
+    /**
+     * Gets the recommended Address object for the signer.
+     *
+     * @param _preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended Address object.
+     */
     async getRecommendedAddressObj(_preference) {
         return (await this.getAddressObjs())[0];
     }
+    /**
+     * Gets the recommended address for the signer as a string.
+     *
+     * @param preference - Optional preference parameter.
+     * @returns A promise that resolves to the recommended address as a string.
+     */
     async getRecommendedAddress(preference) {
         return (await this.getRecommendedAddressObj(preference)).toString();
     }
+    /**
+     * Gets an array of addresses associated with the signer as strings.
+     *
+     * @returns A promise that resolves to an array of addresses as strings.
+     */
     async getAddresses() {
         return this.getAddressObjs().then((addresses) => addresses.map((address) => address.toString()));
     }
+    /**
+     * Signs a message. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The message to sign, as a string or BytesLike object.
+     * @returns A promise that resolves to the signed message as a string.
+     * @throws Will throw an error if not implemented.
+     */
     signMessage(_) {
         throw Error("Signer.signMessage not implemented");
     }
+    /**
+     * Sends a transaction after signing it.
+     *
+     * @param tx - The transaction to send, represented as a TransactionLike object.
+     * @returns A promise that resolves to the transaction hash as a Hex string.
+     */
     async sendTransaction(tx) {
         return this.client.sendTransaction(await this.signTransaction(tx));
     }
+    /**
+     * Signs a transaction.
+     *
+     * @param tx - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     */
     async signTransaction(tx) {
         return this.signOnlyTransaction(tx);
     }
+    /**
+     * Signs a transaction without sending it. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param _ - The transaction to sign, represented as a TransactionLike object.
+     * @returns A promise that resolves to the signed Transaction object.
+     * @throws Will throw an error if not implemented.
+     */
     signOnlyTransaction(_) {
         throw Error("Signer.signOnlyTransaction not implemented");
     }
 }
+/**
+ * An enumeration of signer types.
+ */
 export var SignerType;
 (function (SignerType) {
     SignerType["EVM"] = "EVM";
     SignerType["BTC"] = "BTC";
 })(SignerType || (SignerType = {}));
+/**
+ * A class representing information about a signer, including its type and the signer instance.
+ */
 export class SignerInfo {
     constructor(type, signer) {
         this.type = type;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/core",
-  "version": "0.0.4-alpha.1",
+  "version": "0.0.4-alpha.3",
   "description": "Common Chains Connector Core",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -23,7 +23,6 @@
     "format": "prettier --write . && eslint --fix"
   },
   "devDependencies": {
-    "@ckb-lumos/helpers": "^0.22.2",
     "@eslint/js": "^9.1.1",
     "@types/blake2b": "^2.1.3",
     "eslint": "^9.1.0",
@@ -40,6 +39,7 @@
     "access": "public"
   },
   "dependencies": {
+    "@ckb-lumos/helpers": "^0.22.2",
     "@noble/hashes": "^1.4.0",
     "abort-controller": "^3.0.0",
     "bech32": "^2.0.0",
@@ -47,5 +47,5 @@
     "buffer": "^6.0.3",
     "cross-fetch": "^4.0.0"
   },
-  "gitHead": "7dab1a1d6e3e380b26f43d0d0308bd4da1617029"
+  "gitHead": "7eed10c29d8bb17e6b767197e36cede3180b1b2d"
 }