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

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

@@ -1,12 +1,60 @@
 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);
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    replaceClient(client: Client): Promise<SignerBtcPublicKeyReadonly>;
+    /**
+     * 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>;
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * 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,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAIxE;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAIrC;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;;;;;;;OASG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC;CAGtC"}

package/dist/signer/btc/signerBtcPublicKeyReadonly.js

@@ -1,15 +1,68 @@
 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);
     }
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    async replaceClient(client) {
+        return new SignerBtcPublicKeyReadonly(client, this.account, this.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() { }
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    async isConnected() {
+        return true;
+    }
+    ;
+    /**
+     * 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,58 @@ 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);
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    replaceClient(client: Client): Promise<SignerCkbScriptReadonly>;
+    /**
+     * 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>;
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * 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,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIrE;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAIrC;;;;;;;;;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,67 @@
 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);
     }
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    async replaceClient(client) {
+        return new SignerCkbScriptReadonly(client, this.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() { }
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    async isConnected() {
+        return true;
+    }
+    ;
+    /**
+     * 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,42 @@
 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>;
+    /**
+     * prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param txLike - The transaction to prepare, represented as a TransactionLike object.
+     * @returns A promise that resolves to the prepared Transaction object.
+     */
+    prepareTransaction(txLike: TransactionLike): 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,kBAAkB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;IAKvE;;;;;OAKG;IACG,mBAAmB,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,CAAC;CAgCzE"}

package/dist/signer/evm/signerEvm.js

@@ -1,24 +1,55 @@
 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 { getSignHashInfo, prepareSighashAllWitness } 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) {
+    /**
+     * prepare a transaction before signing. This method is not implemented and should be overridden by subclasses.
+     *
+     * @param txLike - The transaction to prepare, represented as a TransactionLike object.
+     * @returns A promise that resolves to the prepared Transaction object.
+     */
+    async prepareTransaction(txLike) {
         const { script } = await this.getRecommendedAddressObj();
-        const info = await getSignHashInfo(tx, script);
+        return prepareSighashAllWitness(txLike, script, 85, this.client);
+    }
+    /**
+     * 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, this.client);
         if (!info) {
             return tx;
         }

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

@@ -1,10 +1,52 @@
 import { Client } from "../../client";
 import { HexLike } from "../../hex";
 import { SignerEvm } from "./signerEvm";
-export declare abstract class SignerEvmAddressReadonly extends SignerEvm {
+/**
+ * A class extending SignerEvm that provides read-only access to an EVM address.
+ * This class does not support signing operations.
+ */
+export declare 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);
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    replaceClient(client: Client): Promise<SignerEvmAddressReadonly>;
+    /**
+     * 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>;
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    isConnected(): Promise<boolean>;
+    /**
+     * 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,qBAAa,wBAAyB,SAAQ,SAAS;IACrD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAM;IAE9B;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO;IAM5C;;;;OAIG;IACG,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAItE;;;;;;;;;OASG;IAEG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAE9B;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAIrC;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;CAGvC"}

package/dist/signer/evm/signerEvmAddressReadonly.js

@@ -1,11 +1,58 @@
 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);
     }
+    /**
+     * Construct a new signer with the client replaced.
+     *
+     * @returns A promise that resolves the new Signer.
+     */
+    async replaceClient(client) {
+        return new SignerEvmAddressReadonly(client, this.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() { }
+    /**
+     * Check if the signer is connected.
+     *
+     * @returns A promise that resolves the connection status.
+     */
+    async isConnected() {
+        return true;
+    }
+    ;
+    /**
+     * 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,7 +1,40 @@
-import { ScriptLike, TransactionLike } from "../ckb";
+import { ScriptLike, Transaction, 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.
+ * @param client - The client for complete extra infos in the transaction.
+ * @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, client);
+ * 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>;
+/**
+ * Prepare dummy witness for sighash all method
+ *
+ * @param txLike - The transaction to prepare, represented as a TransactionLike object.
+ * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
+ * @param client - The client for complete extra infos in the transaction.
+ * @returns A promise that resolves to the prepared transaction
+ *
+ * @example
+ * ```typescript
+ * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
+ * ```
+ */
+export declare function prepareSighashAllWitness(txLike: TransactionLike, scriptLike: ScriptLike, lockLen: number, client: Client): Promise<Transaction>;
 //# sourceMappingURL=helpers.d.ts.map

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,EAEL,UAAU,EACV,WAAW,EACX,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,GAAG,EAAW,MAAM,QAAQ,CAAC;AAEtC;;;;;;;;;;;;;;;;;GAiBG;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;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,wBAAwB,CAC5C,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,UAAU,EACtB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,CA6BtB"}

package/dist/signer/helpers.js

@@ -1,19 +1,38 @@
-import { Script, Transaction } from "../ckb";
+import { Script, Transaction, WitnessArgs, } from "../ckb";
 import { Hasher } from "../hasher";
-export async function getSignHashInfo(txLike, scriptLike) {
+import { hexFrom } from "../hex";
+/**
+ * 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.
+ * @param client - The client for complete extra infos in the transaction.
+ * @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, client);
+ * 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)) {
-                return;
+            if (!script.eq(input.cellOutput.lock)) {
+                continue;
             }
             if (position === -1) {
                 position = i;
@@ -22,8 +41,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;
     }
@@ -32,3 +51,40 @@ export async function getSignHashInfo(txLike, scriptLike) {
         position,
     };
 }
+/**
+ * Prepare dummy witness for sighash all method
+ *
+ * @param txLike - The transaction to prepare, represented as a TransactionLike object.
+ * @param scriptLike - The script associated with the transaction, represented as a ScriptLike object.
+ * @param client - The client for complete extra infos in the transaction.
+ * @returns A promise that resolves to the prepared transaction
+ *
+ * @example
+ * ```typescript
+ * const tx = await prepareSighashAllWitness(transactionLike, scriptLike, client);
+ * ```
+ */
+export async function prepareSighashAllWitness(txLike, scriptLike, lockLen, client) {
+    const tx = Transaction.from(txLike);
+    const script = Script.from(scriptLike);
+    let position = -1;
+    for (let i = 0; i < tx.inputs.length; i += 1) {
+        const input = await tx.inputs[i].completeExtraInfos(client);
+        if (!input.cellOutput) {
+            throw Error("Unable to resolve inputs info");
+        }
+        if (script.eq(input.cellOutput.lock)) {
+            position = i;
+            break;
+        }
+    }
+    if (position === -1) {
+        return tx;
+    }
+    const witness = tx.witnesses[position]
+        ? WitnessArgs.fromBytes(tx.witnesses[position])
+        : WitnessArgs.from({});
+    witness.lock = hexFrom(Array.from(new Array(lockLen), () => 0));
+    tx.witnesses[position] = hexFrom(witness.toBytes());
+    return tx;
+}