@ckb-ccc/joy-id 0.0.5-alpha.7 → 0.0.6-alpha.0

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

@@ -1,31 +1,124 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage";
+/**
+ * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.Signer}
+ */
 export declare class CkbSigner extends ccc.Signer {
     private readonly name;
     private readonly icon;
     private readonly _appUri?;
     private readonly _aggregatorUri?;
     private readonly connectionsRepo;
+    /**
+     * Gets the signer type.
+     * @returns {ccc.SignerType} The type of the signer.
+     */
     get type(): ccc.SignerType;
+    /**
+     * Gets the sign type.
+     * @returns {ccc.SignerSignType} 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.
+     */
     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.
+     */
     constructor(client: ccc.Client, name: string, icon: string, _appUri?: string | undefined, _aggregatorUri?: string | undefined, connectionsRepo?: ConnectionsRepo);
-    replaceClient(client: ccc.Client): Promise<CkbSigner>;
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     private getConfig;
+    /**
+     * Gets the aggregator URI.
+     * @private
+     * @returns {string} The aggregator URI.
+     */
     private getAggregatorUri;
+    /**
+     * Connects to the provider by requesting authentication.
+     * @returns {Promise<void>} 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.
+     */
     isConnected(): Promise<boolean>;
+    /**
+     * Gets the internal address.
+     * @returns {Promise<string>} 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.
+     */
     getIdentity(): Promise<string>;
+    /**
+     * Gets the address object.
+     * @returns {Promise<ccc.Address>} 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.
+     */
     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.
+     */
     prepareTransaction(txLike: ccc.TransactionLike): Promise<ccc.Transaction>;
+    /**
+     * Prepares a transaction for a sub key.
+     * @private
+     * @param {ccc.Transaction} tx - The transaction object.
+     * @param {ccc.WitnessArgs} witness - The witness arguments.
+     * @returns {Promise<void>}
+     * @throws Will throw an error if no COTA cells are found for the sub key wallet.
+     */
     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.
+     */
     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.
+     */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     private saveConnection;
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     private restoreConnection;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist.commonjs/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,uBAAuB,CAAC;AAE/B,qBAAa,SAAU,SAAQ,GAAG,CAAC,MAAM;IAqBrC,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;IAxBlC,IAAI,IAAI,IAAI,GAAG,CAAC,UAAU,CAEzB;IAED,IAAI,QAAQ,IAAI,GAAG,CAAC,cAAc,CAEjC;IAED,OAAO,CAAC,UAAU,CAAC,CAAa;YAElB,gBAAgB;gBAS5B,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;IAKjF,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAW3D,OAAO,CAAC,SAAS;IAYjB,OAAO,CAAC,gBAAgB;IAUlB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQ/B,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC,WAAW,IAAI,OAAO,CAAC,MAAM,CAAC;IAQ9B,aAAa,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAOrC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAIxC,kBAAkB,CACtB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;YAgBb,2BAA2B;IAuCnC,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IAyBrB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;YA2BxD,cAAc;YAUd,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,uBAAuB,CAAC;AAE/B;;;;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;IAgB9B;;;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;IAkB3B;;;;;;;OAOG;YACW,2BAA2B;IAuCzC;;;;OAIG;IACG,mBAAmB,CACvB,MAAM,EAAE,GAAG,CAAC,eAAe,GAC1B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;IA6B3B;;;;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"}

package/dist.commonjs/ckb/index.js

@@ -6,19 +6,47 @@ const ckb_1 = require("@joyid/ckb");
 const common_1 = require("@joyid/common");
 const common_2 = require("../common");
 const connectionsStorage_1 = require("../connectionsStorage");
+/**
+ * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.Signer}
+ */
 class CkbSigner extends core_1.ccc.Signer {
+    /**
+     * Gets the signer type.
+     * @returns {ccc.SignerType} The type of the signer.
+     */
     get type() {
         return core_1.ccc.SignerType.CKB;
     }
+    /**
+     * Gets the sign type.
+     * @returns {ccc.SignerSignType} The sign type.
+     */
     get signType() {
         return core_1.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.
+     */
     async assertConnection() {
         if (!(await this.isConnected()) || !this.connection) {
             throw new Error("Not connected");
         }
         return this.connection;
     }
+    /**
+     * 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.
+     */
     constructor(client, name, icon, _appUri, _aggregatorUri, connectionsRepo = new connectionsStorage_1.ConnectionsRepoLocalStorage()) {
         super(client);
         this.name = name;
@@ -27,9 +55,11 @@ class CkbSigner extends core_1.ccc.Signer {
         this._aggregatorUri = _aggregatorUri;
         this.connectionsRepo = connectionsRepo;
     }
-    async replaceClient(client) {
-        return new CkbSigner(client, this.name, this.icon, this._appUri, this._aggregatorUri, this.connectionsRepo);
-    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     getConfig() {
         return {
             redirectURL: location.href,
@@ -40,6 +70,11 @@ class CkbSigner extends core_1.ccc.Signer {
             logo: this.icon,
         };
     }
+    /**
+     * Gets the aggregator URI.
+     * @private
+     * @returns {string} The aggregator URI.
+     */
     getAggregatorUri() {
         if (this._aggregatorUri) {
             return this._aggregatorUri;
@@ -48,6 +83,10 @@ class CkbSigner extends core_1.ccc.Signer {
             ? "https://cota.nervina.dev/mainnet-aggregator"
             : "https://cota.nervina.dev/aggregator";
     }
+    /**
+     * Connects to the provider by requesting authentication.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     async connect() {
         const config = this.getConfig();
         const res = await (0, common_2.createPopup)((0, common_1.buildJoyIDURL)(config, "popup", "/auth"), {
@@ -61,10 +100,10 @@ class CkbSigner extends core_1.ccc.Signer {
         };
         await this.saveConnection();
     }
-    async disconnect() {
-        this.connection = undefined;
-        await this.saveConnection();
-    }
+    /**
+     * Checks if the signer is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     async isConnected() {
         if (this.connection) {
             return true;
@@ -72,9 +111,17 @@ class CkbSigner extends core_1.ccc.Signer {
         await this.restoreConnection();
         return this.connection !== undefined;
     }
+    /**
+     * Gets the internal address.
+     * @returns {Promise<string>} 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.
+     */
     async getIdentity() {
         const connection = await this.assertConnection();
         return JSON.stringify({
@@ -82,12 +129,25 @@ class CkbSigner extends core_1.ccc.Signer {
             publicKey: connection.publicKey.slice(2),
         });
     }
+    /**
+     * Gets the address object.
+     * @returns {Promise<ccc.Address>} A promise that resolves to the address object.
+     */
     async getAddressObj() {
         return await core_1.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.
+     */
     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.
+     */
     async prepareTransaction(txLike) {
         const tx = core_1.ccc.Transaction.from(txLike);
         const position = await tx.findInputIndexByLock((await this.getAddressObj()).script, this.client);
@@ -97,8 +157,17 @@ class CkbSigner extends core_1.ccc.Signer {
         const witness = tx.getWitnessArgsAt(position) ?? core_1.ccc.WitnessArgs.from({});
         witness.lock = "0x";
         await this.prepareTransactionForSubKey(tx, witness);
-        return tx.setWitnessArgsAt(position, witness);
+        tx.setWitnessArgsAt(position, witness);
+        return tx;
     }
+    /**
+     * Prepares a transaction for a sub key.
+     * @private
+     * @param {ccc.Transaction} tx - The transaction object.
+     * @param {ccc.WitnessArgs} witness - The witness arguments.
+     * @returns {Promise<void>}
+     * @throws Will throw an error if no COTA cells are found for the sub key wallet.
+     */
     async prepareTransactionForSubKey(tx, witness) {
         if (this.connection?.keyType !== "sub_key") {
             return [];
@@ -127,6 +196,11 @@ class CkbSigner extends core_1.ccc.Signer {
         }
         tx.cellDeps.unshift(...cotaDeps);
     }
+    /**
+     * Signs a transaction.
+     * @param {ccc.TransactionLike} txLike - The transaction-like object.
+     * @returns {Promise<ccc.Transaction>} A promise that resolves to the signed transaction.
+     */
     async signOnlyTransaction(txLike) {
         const tx = core_1.ccc.Transaction.from(txLike);
         const { script } = await this.getAddressObj();
@@ -136,12 +210,18 @@ class CkbSigner extends core_1.ccc.Signer {
             tx: JSON.parse(tx.stringify()),
             signerAddress: (await this.assertConnection()).address,
             witnessIndex: await tx.findInputIndexByLock(script, this.client),
+            witnessLastIndex: await tx.findLastInputIndexByLock(script, this.client),
         }, "popup", "/sign-ckb-raw-tx"), {
             ...config,
             type: common_1.DappRequestType.SignCkbRawTx,
         });
         return core_1.ccc.Transaction.from(res.tx);
     }
+    /**
+     * 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.
+     */
     async signMessageRaw(message) {
         const { address } = await this.assertConnection();
         const challenge = typeof message === "string" ? message : core_1.ccc.hexFrom(message).slice(2);
@@ -158,12 +238,22 @@ class CkbSigner extends core_1.ccc.Signer {
             message: res.message,
         });
     }
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async saveConnection() {
         return this.connectionsRepo.set({
             uri: this.getConfig().joyidAppURL,
             addressType: "ckb",
         }, this.connection);
     }
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({
             uri: this.getConfig().joyidAppURL,

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

@@ -1,4 +1,8 @@
 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;
     [DappRequestType.SignMessage]: SignMessageResponseData;
@@ -18,6 +22,15 @@ export interface PopupReturnType {
     [DappRequestType.SignMiniAppMessage]: any;
     [DappRequestType.EvmWeb2Login]: EvmWeb2LoginResponse;
 }
+/**
+ * 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.
+ * @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.
+ */
 export declare function createPopup<T extends DappRequestType>(url: string, config: PopupConfigOptions<T> & {
     joyidAppURL: string;
 }): Promise<PopupReturnType[T]>;

package/dist.commonjs/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,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,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;;;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"}

package/dist.commonjs/common/index.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPopup = void 0;
 const common_1 = require("@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.
+ * @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.
+ */
 async function createPopup(url, config) {
     if (config.popup == null) {
         config.popup = (0, common_1.openPopup)("");

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

@@ -1,23 +1,81 @@
 import { ccc } from "@ckb-ccc/core";
+/**
+ * Type representing an account selector with a URI and address type.
+ * @typedef {Object} AccountSelector
+ * @property {string} uri - The URI of the account.
+ * @property {string} addressType - The address type of the account.
+ */
 export type AccountSelector = {
     uri: string;
     addressType: string;
 };
+/**
+ * Checks if two AccountSelectors are equal.
+ * @param {AccountSelector} a - The first account selector.
+ * @param {AccountSelector} b - The second account selector.
+ * @returns {boolean} True if the selectors are equal, false otherwise.
+ */
 export declare function isSelectorEq(a: AccountSelector, b: AccountSelector): boolean;
+/**
+ * Type representing a connection with an address, public key, and key type.
+ * @typedef {Object} Connection
+ * @property {string} address - The address of the connection.
+ * @property {ccc.Hex} publicKey - The public key of the connection.
+ * @property {string} keyType - The key type of the connection.
+ */
 export type Connection = {
     readonly address: string;
     readonly publicKey: ccc.Hex;
     readonly keyType: string;
 };
+/**
+ * Interface representing a repository for managing connections.
+ * @interface
+ */
 export interface ConnectionsRepo {
+    /**
+     * Gets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     */
     get(selector: AccountSelector): Promise<Connection | undefined>;
+    /**
+     * Sets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @param {Connection | undefined} connection - The connection to set.
+     * @returns {Promise<void>} A promise that resolves when the connection is set.
+     */
     set(selector: AccountSelector, connection: Connection | undefined): Promise<void>;
 }
+/**
+ * Class representing a local storage-based repository for managing connections.
+ * @class
+ * @implements {ConnectionsRepo}
+ */
 export declare class ConnectionsRepoLocalStorage implements ConnectionsRepo {
     private readonly storageKey;
+    /**
+     * Creates an instance of ConnectionsRepoLocalStorage.
+     * @param {string} [storageKey="ccc-joy-id-signer"] - The local storage key.
+     */
     constructor(storageKey?: string);
+    /**
+     * Reads all connections from local storage.
+     * @returns {Promise<[AccountSelector, Connection][]>} A promise that resolves to an array of selectors and connections.
+     */
     readConnections(): Promise<[AccountSelector, Connection][]>;
+    /**
+     * Gets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     */
     get(selector: AccountSelector): Promise<Connection | undefined>;
+    /**
+     * Sets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @param {Connection | undefined} connection - The connection to set.
+     * @returns {Promise<void>}
+     */
     set(selector: AccountSelector, connection: Connection | undefined): Promise<void>;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectionsStorage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,eAAe,WAElE;AAED,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAChE,GAAG,CACD,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED,qBAAa,2BAA4B,YAAW,eAAe;IACrD,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,SAAsB;IAEvD,eAAe,IAAI,OAAO,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,CAAC;IAI3D,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAM/D,GAAG,CAAC,QAAQ,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,GAAG,SAAS;CAkBxE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/connectionsStorage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,eAAe,EAAE,CAAC,EAAE,eAAe,GAAG,OAAO,CAE5E;AAED;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC;IAC5B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEhE;;;;;OAKG;IACH,GAAG,CACD,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,2BAA4B,YAAW,eAAe;IAKrD,OAAO,CAAC,QAAQ,CAAC,UAAU;IAJvC;;;OAGG;gBAC0B,UAAU,SAAsB;IAE7D;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,CAAC,eAAe,EAAE,UAAU,CAAC,EAAE,CAAC;IAIjE;;;;OAIG;IACG,GAAG,CAAC,QAAQ,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAMrE;;;;;OAKG;IACG,GAAG,CACP,QAAQ,EAAE,eAAe,EACzB,UAAU,EAAE,UAAU,GAAG,SAAS,GACjC,OAAO,CAAC,IAAI,CAAC;CAkBjB"}

package/dist.commonjs/connectionsStorage/index.js

@@ -1,20 +1,50 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectionsRepoLocalStorage = exports.isSelectorEq = void 0;
+/**
+ * Checks if two AccountSelectors are equal.
+ * @param {AccountSelector} a - The first account selector.
+ * @param {AccountSelector} b - The second account selector.
+ * @returns {boolean} True if the selectors are equal, false otherwise.
+ */
 function isSelectorEq(a, b) {
     return a.uri === b.uri && a.addressType === b.addressType;
 }
 exports.isSelectorEq = isSelectorEq;
+/**
+ * Class representing a local storage-based repository for managing connections.
+ * @class
+ * @implements {ConnectionsRepo}
+ */
 class ConnectionsRepoLocalStorage {
+    /**
+     * Creates an instance of ConnectionsRepoLocalStorage.
+     * @param {string} [storageKey="ccc-joy-id-signer"] - The local storage key.
+     */
     constructor(storageKey = "ccc-joy-id-signer") {
         this.storageKey = storageKey;
     }
+    /**
+     * Reads all connections from local storage.
+     * @returns {Promise<[AccountSelector, Connection][]>} A promise that resolves to an array of selectors and connections.
+     */
     async readConnections() {
         return JSON.parse(window.localStorage.getItem(this.storageKey) ?? "[]");
     }
+    /**
+     * Gets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+     */
     async get(selector) {
         return (await this.readConnections()).find(([s]) => isSelectorEq(selector, s))?.[1];
     }
+    /**
+     * Sets a connection for the given selector.
+     * @param {AccountSelector} selector - The account selector.
+     * @param {Connection | undefined} connection - The connection to set.
+     * @returns {Promise<void>}
+     */
     async set(selector, connection) {
         const connections = await this.readConnections();
         if (connection) {

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

@@ -1,20 +1,70 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage";
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export declare class EvmSigner extends ccc.SignerEvm {
     private readonly name;
     private readonly icon;
     private readonly appUri;
     private readonly connectionsRepo;
     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.
+     */
     private assertConnection;
+    /**
+     * Creates an instance of 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.
+     * @param {string} [appUri="https://app.joy.id"] - The application URI.
+     * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+     */
     constructor(client: ccc.Client, name: string, icon: string, appUri?: string, connectionsRepo?: ConnectionsRepo);
-    replaceClient(client: ccc.Client): Promise<EvmSigner>;
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     private getConfig;
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     getEvmAccount(): Promise<string>;
+    /**
+     * Connects to the provider by requesting authentication.
+     * @returns {Promise<void>} 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.
+     */
     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.
+     */
     signMessageRaw(message: string | ccc.BytesLike): Promise<ccc.Hex>;
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     private saveConnection;
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     private restoreConnection;
 }
 //# sourceMappingURL=index.d.ts.map

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,uBAAuB,CAAC;AAE/B,qBAAa,SAAU,SAAQ,GAAG,CAAC,SAAS;IAaxC,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAflC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC,OAAO,CAAC,gBAAgB;gBAStB,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,SAAuB,EAC7B,eAAe,GAAE,eAAmD;IAKjF,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAU3D,OAAO,CAAC,SAAS;IAUX,aAAa;IAIb,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgBxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQ/B,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;YAuBzD,cAAc;YAUd,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,uBAAuB,CAAC;AAE/B;;;;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,MAAM;IACvB,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,MAAM,SAAuB,EAC7B,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAUjB;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB9B;;;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"}