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

package/dist/connectionsStorage/index.js

@@ -1,16 +1,46 @@
+/**
+ * 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 function isSelectorEq(a, b) {
     return a.uri === b.uri && a.addressType === b.addressType;
 }
+/**
+ * Class representing a local storage-based repository for managing connections.
+ * @class
+ * @implements {ConnectionsRepo}
+ */
 export 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/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/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"}

package/dist/evm/index.js

@@ -2,13 +2,32 @@ import { ccc } from "@ckb-ccc/core";
 import { DappRequestType, buildJoyIDURL } from "@joyid/common";
 import { createPopup } from "../common";
 import { ConnectionsRepoLocalStorage, } from "../connectionsStorage";
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export class EvmSigner extends 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.
+     */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
             throw new Error("Not connected");
         }
         return this.connection;
     }
+    /**
+     * 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, name, icon, appUri = "https://app.joy.id", connectionsRepo = new ConnectionsRepoLocalStorage()) {
         super(client);
         this.name = name;
@@ -16,9 +35,11 @@ export class EvmSigner extends ccc.SignerEvm {
         this.appUri = appUri;
         this.connectionsRepo = connectionsRepo;
     }
-    async replaceClient(client) {
-        return new EvmSigner(client, this.name, this.icon, this.appUri, this.connectionsRepo);
-    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     getConfig() {
         return {
             redirectURL: location.href,
@@ -28,11 +49,19 @@ export class EvmSigner extends ccc.SignerEvm {
             logo: this.icon,
         };
     }
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     async getEvmAccount() {
         return this.assertConnection().address;
     }
+    /**
+     * Connects to the provider by requesting authentication.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     async connect() {
-        const config = await this.getConfig();
+        const config = this.getConfig();
         const res = await createPopup(buildJoyIDURL(config, "popup", "/auth"), {
             ...config,
             type: DappRequestType.Auth,
@@ -44,6 +73,10 @@ export class EvmSigner extends ccc.SignerEvm {
         };
         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;
@@ -51,6 +84,11 @@ export class EvmSigner extends ccc.SignerEvm {
         await this.restoreConnection();
         return this.connection !== undefined;
     }
+    /**
+     * 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.
+     */
     async signMessageRaw(message) {
         const { address } = this.assertConnection();
         const challenge = typeof message === "string" ? message : ccc.hexFrom(message).slice(2);
@@ -63,12 +101,22 @@ export class EvmSigner extends ccc.SignerEvm {
         }, "popup", "/sign-message"), { ...config, type: DappRequestType.SignMessage });
         return ccc.hexFrom(signature);
     }
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async saveConnection() {
         return this.connectionsRepo.set({
             uri: this.getConfig().joyidAppURL,
             addressType: "ethereum",
         }, this.connection);
     }
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({
             uri: this.getConfig().joyidAppURL,

package/dist/nostr/index.d.ts

@@ -0,0 +1,51 @@
+import { ccc } from "@ckb-ccc/core";
+import { ConnectionsRepo } from "../connectionsStorage";
+/**
+ * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerNostr}
+ */
+export declare class NostrSigner extends ccc.SignerNostr {
+    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 NostrSigner.
+     * @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);
+    static isValidClient(client: ccc.Client): boolean;
+    replaceClient(client: ccc.Client): Promise<boolean>;
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
+    private getConfig;
+    /**
+     * 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>;
+    getNostrPublicKey(): Promise<ccc.Hex>;
+    signNostrEvent(event: ccc.NostrEvent): Promise<Required<ccc.NostrEvent>>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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,uBAAuB,CAAC;AAE/B;;;;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,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,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO;IAI3C,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzD;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAUjB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAY/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAQrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;CAWrC"}

package/dist/nostr/index.js

@@ -0,0 +1,106 @@
+import { ccc } from "@ckb-ccc/core";
+import { DappRequestType, buildJoyIDURL } from "@joyid/common";
+import { createPopup } from "../common";
+import { ConnectionsRepoLocalStorage, } from "../connectionsStorage";
+/**
+ * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerNostr}
+ */
+export class NostrSigner extends 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.
+     */
+    assertConnection() {
+        if (!this.isConnected() || !this.connection) {
+            throw new Error("Not connected");
+        }
+        return this.connection;
+    }
+    /**
+     * Creates an instance of NostrSigner.
+     * @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, name, icon, appUri = "https://app.joy.id", connectionsRepo = new ConnectionsRepoLocalStorage()) {
+        super(client);
+        this.name = name;
+        this.icon = icon;
+        this.appUri = appUri;
+        this.connectionsRepo = connectionsRepo;
+    }
+    static isValidClient(client) {
+        return client.addressPrefix === "ckt";
+    }
+    async replaceClient(client) {
+        if (!NostrSigner.isValidClient(client)) {
+            return false;
+        }
+        return super.replaceClient(client);
+    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
+    getConfig() {
+        return {
+            redirectURL: location.href,
+            joyidAppURL: this.appUri,
+            requestNetwork: "nostr",
+            name: this.name,
+            logo: this.icon,
+        };
+    }
+    /**
+     * 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 createPopup(buildJoyIDURL(config, "popup", "/auth"), {
+            ...config,
+            type: DappRequestType.Auth,
+        });
+        this.connection = {
+            address: "",
+            publicKey: ccc.hexFrom(res.nostrPubkey),
+            keyType: res.keyType,
+        };
+        await this.connectionsRepo.set({ uri: this.appUri, addressType: "nostr" }, this.connection);
+    }
+    /**
+     * 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;
+        }
+        this.connection = await this.connectionsRepo.get({
+            uri: this.appUri,
+            addressType: "nostr",
+        });
+        return this.connection !== undefined;
+    }
+    async getNostrPublicKey() {
+        if (!this.connection) {
+            throw new Error("Not connected");
+        }
+        return this.connection.publicKey;
+    }
+    async signNostrEvent(event) {
+        const config = this.getConfig();
+        const res = await createPopup(buildJoyIDURL({ ...config, event }, "popup", "/sign-nostr-event"), {
+            ...config,
+            type: DappRequestType.SignNostrEvent,
+        });
+        return res.event;
+    }
+}

package/dist/signerFactory/index.d.ts

@@ -1,3 +1,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.
+ */
 export declare function getJoyIdSigners(client: ccc.Client, name: string, icon: string): ccc.SignerInfo[];
 //# sourceMappingURL=index.d.ts.map

package/dist/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;AAMpC,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,GAAG,CAAC,UAAU,EAAE,CA2BlB"}
+{"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,GACX,GAAG,CAAC,UAAU,EAAE,CAwClB"}

package/dist/signerFactory/index.js

@@ -1,10 +1,24 @@
+import { ccc } from "@ckb-ccc/core";
 import { isStandaloneBrowser } from "@joyid/common";
 import { BitcoinSigner } from "../btc";
 import { CkbSigner } from "../ckb";
 import { EvmSigner } from "../evm";
+import { NostrSigner } from "../nostr";
+/**
+ * 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.
+ */
 export function getJoyIdSigners(client, name, icon) {
-    if (isStandaloneBrowser()) {
-        return [];
+    if (isStandaloneBrowser() || ccc.isWebview(window.navigator.userAgent)) {
+        return [ccc.SignerType.CKB, ccc.SignerType.EVM, ccc.SignerType.BTC].map((type) => ({
+            name: type,
+            signer: new ccc.SignerAlwaysError(client, type, "JoyID can only be used with standard browsers"),
+        }));
     }
     return [
         {
@@ -15,6 +29,10 @@ export function getJoyIdSigners(client, name, icon) {
             name: "BTC",
             signer: new BitcoinSigner(client, name, icon),
         },
+        {
+            name: "Nostr",
+            signer: new NostrSigner(client, name, icon),
+        },
         {
             name: "EVM",
             signer: new EvmSigner(client, name, icon),

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

@@ -1,5 +1,10 @@
 import { ccc } from "@ckb-ccc/core";
 import { ConnectionsRepo } from "../connectionsStorage";
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export declare class BitcoinSigner extends ccc.SignerBtc {
     private readonly name;
     private readonly icon;
@@ -7,14 +12,54 @@ export declare class BitcoinSigner extends ccc.SignerBtc {
     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 BitcoinSigner.
+     * @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 {"auto" | "p2wpkh" | "p2tr"} [addressType="auto"] - The address type.
+     * @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, addressType?: "auto" | "p2wpkh" | "p2tr", appUri?: string, connectionsRepo?: ConnectionsRepo);
-    replaceClient(client: ccc.Client): Promise<BitcoinSigner>;
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     private getConfig;
+    /**
+     * Gets the Bitcoin account address.
+     * @returns {Promise<string>} 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.
+     */
     getBtcPublicKey(): Promise<ccc.Hex>;
+    /**
+     * 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 Bitcoin 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>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist.commonjs/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,uBAAuB,CAAC;AAE/B,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;IAa5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,eAAe;IAhBlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC,OAAO,CAAC,gBAAgB;gBAStB,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAChD,MAAM,SAAuB,EAC7B,eAAe,GAAE,eAAmD;IAKjF,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAW/D,OAAO,CAAC,SAAS;IAUX,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAKhC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAKnC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAY/B,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,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,qBAAa,aAAc,SAAQ,GAAG,CAAC,SAAS;IA4B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA/BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;;OAQG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,WAAW,GAAE,MAAM,GAAG,QAAQ,GAAG,MAAe,EAChD,MAAM,SAAuB,EAC7B,eAAe,GAAE,eAAmD;IAKvF;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAUjB;;;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.commonjs/btc/index.js

@@ -5,13 +5,33 @@ const core_1 = require("@ckb-ccc/core");
 const common_1 = require("@joyid/common");
 const common_2 = require("../common");
 const connectionsStorage_1 = require("../connectionsStorage");
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 class BitcoinSigner extends core_1.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.
+     */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
             throw new Error("Not connected");
         }
         return this.connection;
     }
+    /**
+     * Creates an instance of BitcoinSigner.
+     * @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 {"auto" | "p2wpkh" | "p2tr"} [addressType="auto"] - The address type.
+     * @param {string} [appUri="https://app.joy.id"] - The application URI.
+     * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+     */
     constructor(client, name, icon, addressType = "auto", appUri = "https://app.joy.id", connectionsRepo = new connectionsStorage_1.ConnectionsRepoLocalStorage()) {
         super(client);
         this.name = name;
@@ -20,9 +40,11 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
         this.appUri = appUri;
         this.connectionsRepo = connectionsRepo;
     }
-    async replaceClient(client) {
-        return new BitcoinSigner(client, this.name, this.icon, this.addressType, this.appUri, this.connectionsRepo);
-    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     getConfig() {
         return {
             redirectURL: location.href,
@@ -32,14 +54,26 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
             logo: this.icon,
         };
     }
+    /**
+     * Gets the Bitcoin account address.
+     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     */
     async getBtcAccount() {
         const { address } = this.assertConnection();
         return address;
     }
+    /**
+     * Gets the Bitcoin public key.
+     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     */
     async getBtcPublicKey() {
         const { publicKey } = this.assertConnection();
         return publicKey;
     }
+    /**
+     * 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"), {
@@ -62,6 +96,10 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
             this.connectionsRepo.set({ uri: this.appUri, addressType: "btc-auto" }, this.connection),
         ]);
     }
+    /**
+     * 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,6 +110,11 @@ class BitcoinSigner extends core_1.ccc.SignerBtc {
         });
         return this.connection !== undefined;
     }
+    /**
+     * 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.
+     */
     async signMessageRaw(message) {
         const { address } = this.assertConnection();
         const challenge = typeof message === "string" ? message : core_1.ccc.hexFrom(message).slice(2);