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

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @ckb-ccc/joy-id
+
+## 0.0.13-alpha.0
+
+### Patch Changes
+
+- Updated dependencies [[`600cc13`](https://github.com/ckb-ecofund/ccc/commit/600cc137ac6eb7c5b2533670de6df29d82f1b9e1)]:
+  - @ckb-ccc/core@0.0.13-alpha.0
+
+## 0.0.12
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @ckb-ccc/core@0.0.12

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://ckbccc-demo.vercel.app/">
+  <a href="https://app.ckbccc.com/">
     <img alt="Logo" src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/logo.svg" width="20%" />
   </a>
 </p>
@@ -14,9 +14,12 @@
   /></a>
   <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/ckb-ecofund/ccc" />
   <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/ckb-ecofund/ccc/master" />
-  <img alt="GitHub deployments" src="https://img.shields.io/github/deployments/ckb-ecofund/ccc/production" />
-  <a href="https://ckbccc-demo.vercel.app/"><img
-    alt="Demo" src="https://img.shields.io/website?url=https%3A%2F%2Fckbccc-demo.vercel.app%2F&label=Demo"
+  <img alt="GitHub branch check runs" src="https://img.shields.io/github/check-runs/ckb-ecofund/ccc/master" />
+  <a href="https://app.ckbccc.com/"><img
+    alt="App" src="https://img.shields.io/website?url=https%3A%2F%2Fapp.ckbccc.com%2F&label=App"
+  /></a>
+  <a href="https://docs.ckbccc.com/"><img
+    alt="Docs" src="https://img.shields.io/website?url=https%3A%2F%2Fdocs.ckbccc.com%2F&label=Docs"
   /></a>
 </p>
 
@@ -33,13 +36,13 @@
 ## Preview
 
 <p align="center">
-  <a href="https://ckbccc-demo.vercel.app/">
+  <a href="https://app.ckbccc.com/">
     <img src="https://raw.githubusercontent.com/ckb-ecofund/ccc/master/assets/preview.png" width="30%" />
   </a>
 </p>
 
-This project is still under active development, and we are looking forward to your feedback. [Try its demo now here](https://ckbccc-demo.vercel.app/). It showcases how to use CCC for some basic scenarios in CKB.
+This project is still under active development, and we are looking forward to your feedback. [Try its demo now here](https://app.ckbccc.com/). It showcases how to use CCC for some basic scenarios in CKB.
 
 <h3 align="center">
-  Read more about CCC on its <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.
+  Read more about CCC on <a href="https://docs.ckbccc.com">our website</a> or <a href="https://github.com/ckb-ecofund/ccc">GitHub Repo</a>.
 </h3>

package/dist/btc/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } 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 declare class BitcoinSigner extends ccc.SignerBtc {
     readonly name: string;
@@ -16,9 +15,8 @@ export declare class BitcoinSigner extends ccc.SignerBtc {
     private network;
     /**
      * 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;
     /**
@@ -33,35 +31,34 @@ export declare class BitcoinSigner extends ccc.SignerBtc {
     constructor(client: ccc.Client, name: string, icon: string, preferredNetworks?: ccc.NetworkPreference[], addressType?: "auto" | "p2wpkh" | "p2tr", _appUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     private getConfig;
     disconnect(): Promise<void>;
     /**
      * 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.
      */
     getBtcAccount(): Promise<string>;
     /**
      * 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.
      */
     getBtcPublicKey(): 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>;
     /**
      * 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 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.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;aA6B5B,IAAI,EAAE,MAAM;aACZ,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAYlB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA5ClC,OAAO,CAAC,UAAU,CAAC,CAAa;IAChC,OAAO,CAAC,OAAO,CAAgB;IAE/B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACX,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD,EACe,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAC/C,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IA6BX,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IASjC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAKzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAYrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAsBvE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/btc/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;aA4B5B,IAAI,EAAE,MAAM;aACZ,IAAI,EAAE,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,iBAAiB;aAYlB,WAAW,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM;IACvD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA3ClC,OAAO,CAAC,UAAU,CAAC,CAAa;IAChC,OAAO,CAAC,OAAO,CAAgB;IAE/B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACX,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD,EACe,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAC/C,OAAO,CAAC,oBAAQ,EAChB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IA6BX,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IASjC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKtC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAKzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAYrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAsBvE"}

package/dist/btc/index.js

@@ -3,16 +3,14 @@ import { DappRequestType, buildJoyIDURL } from "@joyid/common";
 import { createPopup } from "../common/index.js";
 import { ConnectionsRepoLocalStorage, } 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 {
     /**
      * 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) {
@@ -52,7 +50,6 @@ export class BitcoinSigner extends ccc.SignerBtc {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     getConfig() {
@@ -82,7 +79,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() {
         const { address } = this.assertConnection();
@@ -90,7 +87,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() {
         const { publicKey } = this.assertConnection();
@@ -98,7 +95,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() {
         const config = this.getConfig();
@@ -124,7 +121,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() {
         if (this.connection) {
@@ -138,8 +135,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) {
         const { address } = this.assertConnection();

package/dist/ckb/index.d.ts

@@ -1,9 +1,8 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } 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 declare class CkbSigner extends ccc.Signer {
     private readonly name;
@@ -13,84 +12,80 @@ export declare class CkbSigner extends ccc.Signer {
     private readonly connectionsRepo;
     /**
      * Gets the signer type.
-     * @returns {ccc.SignerType} The type of the signer.
+     * @returns The type of the signer.
      */
     get type(): ccc.SignerType;
     /**
      * Gets the sign type.
-     * @returns {ccc.SignerSignType} The sign type.
+     * @returns The sign type.
      */
     get signType(): ccc.SignerSignType;
     private connection?;
     /**
      * 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 assertConnection;
     /**
      * 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, name: string, icon: string, _appUri?: string | undefined, _aggregatorUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     private getConfig;
     /**
      * Gets the aggregator URI.
-     * @private
-     * @returns {string} The aggregator URI.
+     * @returns The aggregator URI.
      */
     private getAggregatorUri;
     /**
      * 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>;
     /**
      * Gets the internal address.
-     * @returns {Promise<string>} A promise that resolves to the internal address.
+     * @returns A promise that resolves to the internal address.
      */
     getInternalAddress(): Promise<string>;
     /**
      * Gets the identity of the signer.
-     * @returns {Promise<string>} A promise that resolves to the identity.
+     * @returns A promise that resolves to the identity.
      */
     getIdentity(): Promise<string>;
     /**
      * 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.
      */
     getAddressObj(): Promise<ccc.Address>;
     /**
      * 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.
      */
     getAddressObjs(): Promise<ccc.Address[]>;
     /**
      * 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.
      */
     prepareTransaction(txLike: ccc.TransactionLike): Promise<ccc.Transaction>;
     /**
      * 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.
@@ -98,26 +93,24 @@ export declare class CkbSigner extends ccc.Signer {
     private prepareTransactionForSubKey;
     /**
      * 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.
      */
     signOnlyTransaction(txLike: ccc.TransactionLike): Promise<ccc.Transaction>;
     /**
      * 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.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private saveConnection;
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     private restoreConnection;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ckb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM;IA4CrC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IA/ClC;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAAC,UAAU,CAEzB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAAC,cAAc,CAEjC;IAED,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;YACW,gBAAgB;IAQ9B;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,cAAc,CAAC,oBAAQ,EACvB,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAYjB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;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;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO3C;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAI9C;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAmB3B;;;;;;OAMG;YACW,2BAA2B;IA0CzC;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IA8C3B;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BtE;;;;OAIG;YACW,cAAc;IAU5B;;;;OAIG;YACW,iBAAiB;CAMhC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ckb/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC,OAAO,EAEL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;;GAGG;AACH,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM;IA2CrC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC;IAChC,OAAO,CAAC,QAAQ,CAAC,eAAe;IA9ClC;;;OAGG;IACH,IAAI,IAAI,IAAI,GAAG,CAAC,UAAU,CAEzB;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAAC,cAAc,CAEjC;IAED,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;OAIG;YACW,gBAAgB;IAQ9B;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,oBAAQ,EAChB,cAAc,CAAC,oBAAQ,EACvB,eAAe,GAAE,eAAmD;IAKvF;;;OAGG;IACH,OAAO,CAAC,SAAS;IAYjB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;;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;;;OAGG;IACG,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAI3C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAO3C;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAI9C;;;;OAIG;IACG,kBAAkB,CACtB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAmB3B;;;;;OAKG;YACW,2BAA2B;IA0CzC;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IA8C3B;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IA2BtE;;;OAGG;YACW,cAAc;IAU5B;;;OAGG;YACW,iBAAiB;CAMhC"}

package/dist/ckb/index.js

@@ -4,30 +4,28 @@ import { DappRequestType, buildJoyIDURL } from "@joyid/common";
 import { createPopup } from "../common/index.js";
 import { ConnectionsRepoLocalStorage, } 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() {
         return ccc.SignerType.CKB;
     }
     /**
      * Gets the sign type.
-     * @returns {ccc.SignerSignType} The sign type.
+     * @returns The sign type.
      */
     get signType() {
         return ccc.SignerSignType.JoyId;
     }
     /**
      * 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.
      */
     async assertConnection() {
         if (!(await this.isConnected()) || !this.connection) {
@@ -37,12 +35,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, name, icon, _appUri, _aggregatorUri, connectionsRepo = new ConnectionsRepoLocalStorage()) {
         super(client);
@@ -54,7 +52,6 @@ export class CkbSigner extends ccc.Signer {
     }
     /**
      * Gets the configuration for JoyID.
-     * @private
      * @returns The configuration object.
      */
     getConfig() {
@@ -69,8 +66,7 @@ export class CkbSigner extends ccc.Signer {
     }
     /**
      * Gets the aggregator URI.
-     * @private
-     * @returns {string} The aggregator URI.
+     * @returns The aggregator URI.
      */
     getAggregatorUri() {
         if (this._aggregatorUri) {
@@ -82,7 +78,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() {
         const config = this.getConfig();
@@ -104,7 +100,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() {
         if (this.connection) {
@@ -115,14 +111,14 @@ 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() {
         return (await this.assertConnection()).address;
     }
     /**
      * 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() {
         const connection = await this.assertConnection();
@@ -133,22 +129,22 @@ 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() {
         return await ccc.Address.fromString(await this.getInternalAddress(), this.client);
     }
     /**
      * 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() {
         return [await this.getAddressObj()];
     }
     /**
      * 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) {
         const tx = ccc.Transaction.from(txLike);
@@ -165,7 +161,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.
@@ -198,8 +193,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) {
         const tx = ccc.Transaction.from(txLike);
@@ -233,8 +228,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) {
         const { address } = await this.assertConnection();
@@ -254,8 +249,7 @@ export class CkbSigner extends ccc.Signer {
     }
     /**
      * Saves the current connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async saveConnection() {
         return this.connectionsRepo.set({
@@ -265,8 +259,7 @@ export class CkbSigner extends ccc.Signer {
     }
     /**
      * Restores the previous connection.
-     * @private
-     * @returns {Promise<void>}
+     * @returns
      */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({

package/dist/common/index.d.ts

@@ -1,7 +1,6 @@
 import { AuthResponseData, DappRequestType, EvmWeb2LoginResponse, PopupConfigOptions, SignCkbTxResponseData, SignCotaNFTResponseData, SignEvmTxResponseData, SignMessageResponseData, SignNostrEventData } from "@joyid/common";
 /**
  * Interface representing the return type for various Dapp request types.
- * @interface
  */
 export interface PopupReturnType {
     [DappRequestType.Auth]: AuthResponseData;
@@ -24,9 +23,9 @@ export interface PopupReturnType {
 }
 /**
  * Creates a popup window for JoyID Dapp requests.
- * @param {string} url - The URL to open in the popup.
- * @param {PopupConfigOptions<T> & { joyidAppURL: string }} config - The popup configuration options.
- * @returns {Promise<PopupReturnType[T]>} A promise that resolves to the response data of the requested type.
+ * @param url - The URL to open in the popup.
+ * @param config - The popup configuration options.
+ * @returns A promise that resolves to the response data of the requested type.
  * @throws {PopupNotSupportedError} If popups are not supported in the current browser.
  * @throws {PopupCancelledError} If the popup is closed by the user.
  * @throws {PopupTimeoutError} If the popup operation times out.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EAEpB,kBAAkB,EAGlB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAInB,MAAM,eAAe,CAAC;AAEvB;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACzC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IACjD,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAClD,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE;QAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACtD,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACrD,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IACnC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IACtC,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAC1C,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,SAAS,eAAe,EACzD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CA0D7B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/common/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EAEpB,kBAAkB,EAGlB,qBAAqB,EACrB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAInB,MAAM,eAAe,CAAC;AAEvB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACzC,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC;IACjD,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IAClD,CAAC,eAAe,CAAC,aAAa,CAAC,EAAE;QAC/B,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,CAAC,eAAe,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC;IACnD,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,uBAAuB,CAAC;IACvD,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACtD,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,kBAAkB,CAAC;IACrD,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAAE,GAAG,CAAC;IAC3C,CAAC,eAAe,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC;IACnC,CAAC,eAAe,CAAC,cAAc,CAAC,EAAE,GAAG,CAAC;IACtC,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAC1C,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACtD;AAED;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAAC,CAAC,SAAS,eAAe,EACzD,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,GACtD,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CA0D7B"}

package/dist/common/index.js

@@ -1,9 +1,9 @@
 import { DappRequestType, PopupCancelledError, PopupNotSupportedError, PopupTimeoutError, createBlockDialog, isStandaloneBrowser, openPopup, } from "@joyid/common";
 /**
  * Creates a popup window for JoyID Dapp requests.
- * @param {string} url - The URL to open in the popup.
- * @param {PopupConfigOptions<T> & { joyidAppURL: string }} config - The popup configuration options.
- * @returns {Promise<PopupReturnType[T]>} A promise that resolves to the response data of the requested type.
+ * @param url - The URL to open in the popup.
+ * @param config - The popup configuration options.
+ * @returns A promise that resolves to the response data of the requested type.
  * @throws {PopupNotSupportedError} If popups are not supported in the current browser.
  * @throws {PopupCancelledError} If the popup is closed by the user.
  * @throws {PopupTimeoutError} If the popup operation times out.