@ckb-ccc/joy-id 0.0.12-alpha.0 → 0.0.12

package/dist.commonjs/evm/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerEvm}
+ * Class representing an EVM signer that extends SignerEvm
+ * @public
  */
 export declare class EvmSigner extends ccc.SignerEvm {
     private readonly name;
@@ -13,9 +12,8 @@ export declare class EvmSigner extends ccc.SignerEvm {
     private connection?;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     private assertConnection;
     /**
@@ -23,14 +21,13 @@ export declare class EvmSigner extends ccc.SignerEvm {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     private getConfig;
     /**
@@ -40,31 +37,29 @@ export declare class EvmSigner extends ccc.SignerEvm {
     getEvmAccount(): Promise<ccc.Hex>;
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     /**
      * Signs a raw message with the EVM account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<ccc.Hex>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

package/dist.commonjs/evm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/evm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IA2BxC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA7BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAuBvE;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/evm/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IA0BxC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIvC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAuBvE;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist.commonjs/evm/index.js

@@ -6,16 +6,14 @@ const common_1 = require("@joyid/common");
 const index_js_1 = require("../common/index.js");
 const index_js_2 = require("../connectionsStorage/index.js");
 /**
- * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerEvm}
+ * Class representing an EVM signer that extends SignerEvm
+ * @public
  */
 class EvmSigner extends core_1.ccc.SignerEvm {
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
@@ -28,7 +26,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client, name, icon, _appUri, connectionsRepo = new index_js_2.ConnectionsRepoLocalStorage()) {
@@ -40,8 +38,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     getConfig() {
         return {
@@ -63,7 +60,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         const config = this.getConfig();
@@ -85,7 +82,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (this.connection) {
@@ -96,8 +93,8 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Signs a raw message with the EVM account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     async signMessageRaw(message) {
         const { address } = this.assertConnection();
@@ -113,8 +110,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -124,8 +120,7 @@ class EvmSigner extends core_1.ccc.SignerEvm {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

package/dist.commonjs/nostr/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage/index.js";
 /**
- * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerNostr}
+ * Class representing a Nostr signer that extends SignerNostr
+ * @public
  */
 export declare class NostrSigner extends ccc.SignerNostr {
     private readonly name;
@@ -13,9 +12,8 @@ export declare class NostrSigner extends ccc.SignerNostr {
     private connection?;
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     private assertConnection;
     /**
@@ -23,39 +21,36 @@ export declare class NostrSigner extends ccc.SignerNostr {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     private getConfig;
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     getNostrPublicKey(): Promise<ccc.Hex>;
     signNostrEvent(event: ccc.NostrEvent): Promise<Required<ccc.NostrEvent>>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

package/dist.commonjs/nostr/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nostr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,GAAG,CAAC,WAAW;IA2B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA7BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAexB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAYpC;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nostr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,WAAY,SAAQ,GAAG,CAAC,WAAW;IA0B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAajB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAexB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAOjC;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAS/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAYpC;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist.commonjs/nostr/index.js

@@ -6,16 +6,14 @@ const common_1 = require("@joyid/common");
 const index_js_1 = require("../common/index.js");
 const index_js_2 = require("../connectionsStorage/index.js");
 /**
- * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerNostr}
+ * Class representing a Nostr signer that extends SignerNostr
+ * @public
  */
 class NostrSigner extends core_1.ccc.SignerNostr {
     /**
      * Ensures that the signer is connected and returns the connection.
-     * @private
      * @throws Will throw an error if not connected.
-     * @returns {Connection} The current connection.
+     * @returns The current connection.
      */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
@@ -28,7 +26,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
      * @param client - The client instance.
      * @param name - The name of the signer.
      * @param icon - The icon URL of the signer.
-     * @param appUri - The application URI.
+     * @param _appUri - The application URI.
      * @param connectionsRepo - The connections repository.
      */
     constructor(client, name, icon, _appUri, connectionsRepo = new index_js_2.ConnectionsRepoLocalStorage()) {
@@ -40,8 +38,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
-     * @returns {object} The configuration object.
+     * @returns The configuration object.
      */
     getConfig() {
         return {
@@ -56,7 +53,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
     }
     /**
      * Connects to the provider by requesting authentication.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         const config = this.getConfig();
@@ -78,7 +75,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (this.connection) {
@@ -100,8 +97,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -111,8 +107,7 @@ class NostrSigner extends core_1.ccc.SignerNostr {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

package/dist.commonjs/signerFactory/index.d.ts

@@ -3,10 +3,12 @@ import { ccc } from "@ckb-ccc/core";
  * Gets the JoyID signers based on the client, name, and icon.
  * If the browser is standalone or a webview, returns SignerAlwaysError instances.
  * Otherwise, returns instances of CkbSigner, BitcoinSigner, and EvmSigner.
- * @param {ccc.Client} client - The client instance.
- * @param {string} name - The name of the signer.
- * @param {string} icon - The icon URL of the signer.
- * @returns {ccc.SignerInfo[]} An array of signer information objects.
+ * @public
+ *
+ * @param client - The client instance.
+ * @param name - The name of the signer.
+ * @param icon - The icon URL of the signer.
+ * @returns An array of signer information objects.
  */
 export declare function getJoyIdSigners(client: ccc.Client, name: string, icon: string, preferredNetworks?: ccc.NetworkPreference[]): ccc.SignerInfo[];
 //# sourceMappingURL=index.d.ts.map

package/dist.commonjs/signerFactory/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CA8ClB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CA8ClB"}

package/dist.commonjs/signerFactory/index.js

@@ -11,10 +11,12 @@ const index_js_4 = require("../nostr/index.js");
  * Gets the JoyID signers based on the client, name, and icon.
  * If the browser is standalone or a webview, returns SignerAlwaysError instances.
  * Otherwise, returns instances of CkbSigner, BitcoinSigner, and EvmSigner.
- * @param {ccc.Client} client - The client instance.
- * @param {string} name - The name of the signer.
- * @param {string} icon - The icon URL of the signer.
- * @returns {ccc.SignerInfo[]} An array of signer information objects.
+ * @public
+ *
+ * @param client - The client instance.
+ * @param name - The name of the signer.
+ * @param icon - The icon URL of the signer.
+ * @returns An array of signer information objects.
  */
 function getJoyIdSigners(client, name, icon, preferredNetworks) {
     if ((0, common_1.isStandaloneBrowser)() || core_1.ccc.isWebview(window.navigator.userAgent)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/joy-id",
-  "version": "0.0.12-alpha.0",
+  "version": "0.0.12",
   "description": "Connector's support for JoyID",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -18,11 +18,6 @@
       "default": "./dist.commonjs/index.js"
     }
   },
-  "scripts": {
-    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
-    "lint": "eslint",
-    "format": "prettier --write . && eslint --fix"
-  },
   "devDependencies": {
     "@eslint/js": "^9.1.1",
     "copyfiles": "^2.4.1",
@@ -39,9 +34,13 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.12-alpha.0",
     "@joyid/ckb": "^1.0.1",
-    "@joyid/common": "^0.2.0"
+    "@joyid/common": "^0.2.0",
+    "@ckb-ccc/core": "0.0.12"
   },
-  "gitHead": "171a9941a56575dd5db2e3fad21d04bff8ec3fc5"
-}
+  "scripts": {
+    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
+    "lint": "eslint",
+    "format": "prettier --write . && eslint --fix"
+  }
+}

package/src/btc/index.ts

@@ -8,9 +8,8 @@ import {
 } from "../connectionsStorage/index.js";
 
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export class BitcoinSigner extends ccc.SignerBtc {
   private connection?: Connection;
@@ -18,9 +17,8 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Ensures that the signer is connected and returns the connection.
-   * @private
    * @throws Will throw an error if not connected.
-   * @returns {Connection} The current connection.
+   * @returns The current connection.
    */
   private assertConnection(): Connection {
     if (!this.isConnected() || !this.connection) {
@@ -64,7 +62,6 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Gets the configuration for JoyID.
-   * @private
    * @returns The configuration object.
    */
   private getConfig() {
@@ -107,7 +104,7 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Gets the Bitcoin account address.
-   * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+   * @returns A promise that resolves to the Bitcoin account address.
    */
   async getBtcAccount(): Promise<string> {
     const { address } = this.assertConnection();
@@ -116,7 +113,7 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Gets the Bitcoin public key.
-   * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+   * @returns A promise that resolves to the Bitcoin public key.
    */
   async getBtcPublicKey(): Promise<ccc.Hex> {
     const { publicKey } = this.assertConnection();
@@ -125,7 +122,7 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Connects to the provider by requesting authentication.
-   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   * @returns A promise that resolves when the connection is established.
    */
   async connect(): Promise<void> {
     const config = this.getConfig();
@@ -160,7 +157,7 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Checks if the signer is connected.
-   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   * @returns A promise that resolves to true if connected, false otherwise.
    */
   async isConnected(): Promise<boolean> {
     if (this.connection) {
@@ -176,8 +173,8 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * Signs a raw message with the Bitcoin account.
-   * @param {string | ccc.BytesLike} message - The message to sign.
-   * @returns {Promise<string>} A promise that resolves to the signed message.
+   * @param message - The message to sign.
+   * @returns A promise that resolves to the signed message.
    */
   async signMessageRaw(message: string | ccc.BytesLike): Promise<string> {
     const { address } = this.assertConnection();

package/src/ckb/index.ts

@@ -9,14 +9,13 @@ import {
 } from "../connectionsStorage/index.js";
 
 /**
- * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
- * @class
- * @extends {ccc.Signer}
+ * Class representing a CKB signer that extends Signer
+ * @public
  */
 export class CkbSigner extends ccc.Signer {
   /**
    * Gets the signer type.
-   * @returns {ccc.SignerType} The type of the signer.
+   * @returns The type of the signer.
    */
   get type(): ccc.SignerType {
     return ccc.SignerType.CKB;
@@ -24,7 +23,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the sign type.
-   * @returns {ccc.SignerSignType} The sign type.
+   * @returns The sign type.
    */
   get signType(): ccc.SignerSignType {
     return ccc.SignerSignType.JoyId;
@@ -34,9 +33,8 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Ensures that the signer is connected and returns the connection.
-   * @private
    * @throws Will throw an error if not connected.
-   * @returns {Promise<Connection>} A promise that resolves to the current connection.
+   * @returns A promise that resolves to the current connection.
    */
   private async assertConnection(): Promise<Connection> {
     if (!(await this.isConnected()) || !this.connection) {
@@ -48,12 +46,12 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Creates an instance of CkbSigner.
-   * @param {ccc.Client} client - The client instance.
-   * @param {string} name - The name of the signer.
-   * @param {string} icon - The icon URL of the signer.
-   * @param {string} [_appUri] - The application URI.
-   * @param {string} [_aggregatorUri] - The aggregator URI.
-   * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+   * @param client - The client instance.
+   * @param name - The name of the signer.
+   * @param icon - The icon URL of the signer.
+   * @param _appUri - The application URI.
+   * @param _aggregatorUri - The aggregator URI.
+   * @param connectionsRepo - The connections repository.
    */
   constructor(
     client: ccc.Client,
@@ -68,7 +66,6 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the configuration for JoyID.
-   * @private
    * @returns The configuration object.
    */
   private getConfig() {
@@ -85,8 +82,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the aggregator URI.
-   * @private
-   * @returns {string} The aggregator URI.
+   * @returns The aggregator URI.
    */
   private getAggregatorUri(): string {
     if (this._aggregatorUri) {
@@ -100,7 +96,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Connects to the provider by requesting authentication.
-   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   * @returns A promise that resolves when the connection is established.
    */
   async connect(): Promise<void> {
     const config = this.getConfig();
@@ -127,7 +123,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Checks if the signer is connected.
-   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   * @returns A promise that resolves to true if connected, false otherwise.
    */
   async isConnected(): Promise<boolean> {
     if (this.connection) {
@@ -139,7 +135,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the internal address.
-   * @returns {Promise<string>} A promise that resolves to the internal address.
+   * @returns A promise that resolves to the internal address.
    */
   async getInternalAddress(): Promise<string> {
     return (await this.assertConnection()).address;
@@ -147,7 +143,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the identity of the signer.
-   * @returns {Promise<string>} A promise that resolves to the identity.
+   * @returns A promise that resolves to the identity.
    */
   async getIdentity(): Promise<string> {
     const connection = await this.assertConnection();
@@ -159,7 +155,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the address object.
-   * @returns {Promise<ccc.Address>} A promise that resolves to the address object.
+   * @returns A promise that resolves to the address object.
    */
   async getAddressObj(): Promise<ccc.Address> {
     return await ccc.Address.fromString(
@@ -170,7 +166,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Gets the address objects.
-   * @returns {Promise<ccc.Address[]>} A promise that resolves to an array of address objects.
+   * @returns A promise that resolves to an array of address objects.
    */
   async getAddressObjs(): Promise<ccc.Address[]> {
     return [await this.getAddressObj()];
@@ -178,8 +174,8 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Prepares a transaction.
-   * @param {ccc.TransactionLike} txLike - The transaction-like object.
-   * @returns {Promise<ccc.Transaction>} A promise that resolves to the prepared transaction.
+   * @param txLike - The transaction-like object.
+   * @returns A promise that resolves to the prepared transaction.
    */
   async prepareTransaction(
     txLike: ccc.TransactionLike,
@@ -204,7 +200,6 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Prepares a transaction for a sub key.
-   * @private
    * @param tx - The transaction object.
    * @param witness - The witness arguments.
    * @throws Will throw an error if no COTA cells are found for the sub key wallet.
@@ -253,8 +248,8 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Signs a transaction.
-   * @param {ccc.TransactionLike} txLike - The transaction-like object.
-   * @returns {Promise<ccc.Transaction>} A promise that resolves to the signed transaction.
+   * @param txLike - The transaction-like object.
+   * @returns A promise that resolves to the signed transaction.
    */
   async signOnlyTransaction(
     txLike: ccc.TransactionLike,
@@ -306,8 +301,8 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Signs a raw message with the account.
-   * @param {string | ccc.BytesLike} message - The message to sign.
-   * @returns {Promise<string>} A promise that resolves to the signed message.
+   * @param message - The message to sign.
+   * @returns A promise that resolves to the signed message.
    */
   async signMessageRaw(message: string | ccc.BytesLike): Promise<string> {
     const { address } = await this.assertConnection();
@@ -338,8 +333,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Saves the current connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async saveConnection(): Promise<void> {
     return this.connectionsRepo.set(
@@ -353,8 +347,7 @@ export class CkbSigner extends ccc.Signer {
 
   /**
    * Restores the previous connection.
-   * @private
-   * @returns {Promise<void>}
+   * @returns
    */
   private async restoreConnection(): Promise<void> {
     this.connection = await this.connectionsRepo.get({