@ckb-ccc/eip6963 0.0.5-alpha.8 → 0.0.6-alpha.0

package/dist/eip1193.advanced.d.ts

@@ -1,28 +1,88 @@
 import { Hex } from "@ckb-ccc/core";
+/**
+ * Interface representing a provider for interacting with Ethereum-compatible wallets.
+ * @interface
+ */
 export interface Provider {
+    /**
+     * Sends a request to the provider.
+     * @type {RequestMethod}
+     */
     request: RequestMethod;
+    /**
+     * Adds an event listener to the provider.
+     * @type {OnMethod}
+     */
     on: OnMethod;
+    /**
+     * Removes an event listener from the provider.
+     * @param {string} eventName - The name of the event to remove the listener from.
+     * @param {(...args: unknown[]) => unknown} listener - The listener function to remove.
+     * @returns {Provider} The provider instance.
+     */
     removeListener(eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }
+/**
+ * Interface representing a method to send requests to the provider.
+ * @interface
+ */
 export interface RequestMethod {
+    /**
+     * Signs a message with the personal account.
+     * @param {object} request - The request object.
+     * @param {"personal_sign"} request.method - The method name.
+     * @param {[string, Hex]} request.params - The method parameters.
+     * @returns {Promise<Hex>} A promise that resolves to the signed message.
+     */
     (request: {
         method: "personal_sign";
         params: [string, Hex];
     }): Promise<Hex>;
+    /**
+     * Requests the accounts from the provider.
+     * @param {object} request - The request object.
+     * @param {"eth_requestAccounts"} request.method - The method name.
+     * @param {undefined} [request.params] - The optional method parameters.
+     * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+     */
     (request: {
         method: "eth_requestAccounts";
         params?: undefined;
     }): Promise<Hex[]>;
+    /**
+     * Gets the accounts from the provider.
+     * @param {object} request - The request object.
+     * @param {"eth_accounts"} request.method - The method name.
+     * @param {undefined} [request.params] - The optional method parameters.
+     * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+     */
     (request: {
         method: "eth_accounts";
         params?: undefined;
     }): Promise<Hex[]>;
+    /**
+     * Sends a generic request to the provider.
+     * @param {object} request - The request object.
+     * @param {string} request.method - The method name.
+     * @param {Array<unknown> | Record<string, unknown>} [request.params] - The optional method parameters.
+     * @returns {Promise<unknown>} A promise that resolves to the response from the provider.
+     */
     (request: {
         method: string;
         params?: Array<unknown> | Record<string, unknown>;
     }): Promise<unknown>;
 }
+/**
+ * Interface representing a method to add event listeners to the provider.
+ * @interface
+ */
 export interface OnMethod {
+    /**
+     * Adds an event listener to the provider.
+     * @param {string} eventName - The name of the event.
+     * @param {(...args: unknown[]) => unknown} listener - The listener function.
+     * @returns {Provider} The provider instance.
+     */
     (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }
 //# sourceMappingURL=eip1193.advanced.d.ts.map

package/dist/eip1193.advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eip1193.advanced.d.ts","sourceRoot":"","sources":["../src/eip1193.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,EAAE,EAAE,QAAQ,CAAC;IACb,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GACxC,QAAQ,CAAC;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,qBAAqB,CAAC;QAC9B,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACnB,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1E,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnD,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}
+{"version":3,"file":"eip1193.advanced.d.ts","sourceRoot":"","sources":["../src/eip1193.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;;OAGG;IACH,EAAE,EAAE,QAAQ,CAAC;IAEb;;;;;OAKG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GACxC,QAAQ,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE5E;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,qBAAqB,CAAC;QAC9B,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAE1E;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnD,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}

package/dist/eip6963.advanced.d.ts

@@ -1,15 +1,55 @@
 import { Provider as EIP1193Provider } from "./eip1193.advanced";
+/**
+ * Interface representing an event announcing a provider.
+ * @interface
+ */
 export interface AnnounceProviderEvent {
+    /**
+     * The detail of the provider.
+     * @type {ProviderDetail}
+     */
     detail: ProviderDetail;
 }
+/**
+ * Interface representing the details of a provider.
+ * @interface
+ */
 export interface ProviderDetail {
+    /**
+     * The information about the provider.
+     * @type {ProviderInfo}
+     */
     info: ProviderInfo;
+    /**
+     * The provider instance compliant with EIP-1193.
+     * @type {EIP1193Provider}
+     */
     provider: EIP1193Provider;
 }
+/**
+ * Interface representing information about a provider.
+ * @interface
+ */
 export interface ProviderInfo {
+    /**
+     * The reverse DNS name of the provider.
+     * @type {string}
+     */
     rdns: string;
+    /**
+     * The UUID of the provider.
+     * @type {string}
+     */
     uuid: string;
+    /**
+     * The name of the provider.
+     * @type {string}
+     */
     name: string;
+    /**
+     * The icon URL of the provider.
+     * @type {string}
+     */
     icon: string;
 }
 //# sourceMappingURL=eip6963.advanced.d.ts.map

package/dist/eip6963.advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eip6963.advanced.d.ts","sourceRoot":"","sources":["../src/eip6963.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEjE,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"eip6963.advanced.d.ts","sourceRoot":"","sources":["../src/eip6963.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist/signer.d.ts

@@ -1,12 +1,38 @@
 import { ccc } from "@ckb-ccc/core";
 import { ProviderDetail as EIP6963ProviderDetail } from "./eip6963.advanced";
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export declare class Signer extends ccc.SignerEvm {
     readonly detail: EIP6963ProviderDetail;
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {EIP6963ProviderDetail} detail - The provider detail.
+     */
     constructor(client: ccc.Client, detail: EIP6963ProviderDetail);
-    replaceClient(client: ccc.Client): Promise<Signer>;
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     getEvmAccount(): Promise<`0x${string}`>;
+    /**
+     * Connects to the provider by requesting accounts.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     connect(): Promise<void>;
+    /**
+     * Checks if the provider is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     isConnected(): Promise<boolean>;
+    /**
+     * Signs a raw message with the personal 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>;
 }
 //# sourceMappingURL=signer.d.ts.map

package/dist/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE7E,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAGrB,MAAM,EAAE,qBAAqB;gBAD7C,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,MAAM,EAAE,qBAAqB;IAKzC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,aAAa;IAIb,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAO/B,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;CAUxE"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,MAAM,EAAE,qBAAqB;IAP/C;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,MAAM,EAAE,qBAAqB;IAK/C;;;OAGG;IACG,aAAa;IAInB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;CAUxE"}

package/dist/signer.js

@@ -1,22 +1,46 @@
 import { ccc } from "@ckb-ccc/core";
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export class Signer extends ccc.SignerEvm {
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {EIP6963ProviderDetail} detail - The provider detail.
+     */
     constructor(client, detail) {
         super(client);
         this.detail = detail;
     }
-    async replaceClient(client) {
-        return new Signer(client, this.detail);
-    }
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     async getEvmAccount() {
         return (await this.detail.provider.request({ method: "eth_accounts" }))[0];
     }
+    /**
+     * Connects to the provider by requesting accounts.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     async connect() {
         await this.detail.provider.request({ method: "eth_requestAccounts" });
     }
+    /**
+     * Checks if the provider is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     async isConnected() {
         return ((await this.detail.provider.request({ method: "eth_accounts" }))
             .length !== 0);
     }
+    /**
+     * Signs a raw message with the personal 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 challenge = typeof message === "string" ? ccc.bytesFrom(message, "utf8") : message;
         const address = await this.getEvmAccount();

package/dist/signersFactory.d.ts

@@ -1,9 +1,22 @@
 import { ccc } from "@ckb-ccc/core";
 import { Signer as EIP6963Signer } from "./signer";
+/**
+ * Class representing a factory for creating and managing Signer instances.
+ * @class
+ */
 export declare class SignerFactory {
     private readonly client;
     private readonly existedUuids;
+    /**
+     * Creates an instance of SignerFactory.
+     * @param {ccc.Client} client - The client instance.
+     */
     constructor(client: ccc.Client);
+    /**
+     * Subscribes to new signers and triggers a callback when a new signer is available.
+     * @param {(newSigner: EIP6963Signer) => unknown} callback - The callback to trigger with the new signer.
+     * @returns {() => void} A function to unsubscribe from the signer events.
+     */
     subscribeSigners(callback: (newSigner: EIP6963Signer) => unknown): () => void;
 }
 //# sourceMappingURL=signersFactory.d.ts.map

package/dist/signersFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,UAAU,CAAC;AAEnD,qBAAa,aAAa;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;gBAEhB,MAAM,EAAE,GAAG,CAAC,MAAM;IAE/C,gBAAgB,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO;CAmBjE"}
+{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,qBAAa,aAAa;IAOZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IANnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C;;;OAGG;gBAC0B,MAAM,EAAE,GAAG,CAAC,MAAM;IAE/C;;;;OAIG;IACH,gBAAgB,CACd,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO,GAC9C,MAAM,IAAI;CAoBd"}

package/dist/signersFactory.js

@@ -1,14 +1,27 @@
 import { Signer as EIP6963Signer } from "./signer";
+/**
+ * Class representing a factory for creating and managing Signer instances.
+ * @class
+ */
 export class SignerFactory {
+    /**
+     * Creates an instance of SignerFactory.
+     * @param {ccc.Client} client - The client instance.
+     */
     constructor(client) {
         this.client = client;
         this.existedUuids = [];
     }
+    /**
+     * Subscribes to new signers and triggers a callback when a new signer is available.
+     * @param {(newSigner: EIP6963Signer) => unknown} callback - The callback to trigger with the new signer.
+     * @returns {() => void} A function to unsubscribe from the signer events.
+     */
     subscribeSigners(callback) {
         const onNewProvider = (event) => {
             const { detail } = event;
             const { uuid } = detail.info;
-            if (this.existedUuids.indexOf(uuid) !== -1) {
+            if (this.existedUuids.includes(uuid)) {
                 return;
             }
             this.existedUuids.push(uuid);

package/dist.commonjs/eip1193.advanced.d.ts

@@ -1,28 +1,88 @@
 import { Hex } from "@ckb-ccc/core";
+/**
+ * Interface representing a provider for interacting with Ethereum-compatible wallets.
+ * @interface
+ */
 export interface Provider {
+    /**
+     * Sends a request to the provider.
+     * @type {RequestMethod}
+     */
     request: RequestMethod;
+    /**
+     * Adds an event listener to the provider.
+     * @type {OnMethod}
+     */
     on: OnMethod;
+    /**
+     * Removes an event listener from the provider.
+     * @param {string} eventName - The name of the event to remove the listener from.
+     * @param {(...args: unknown[]) => unknown} listener - The listener function to remove.
+     * @returns {Provider} The provider instance.
+     */
     removeListener(eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }
+/**
+ * Interface representing a method to send requests to the provider.
+ * @interface
+ */
 export interface RequestMethod {
+    /**
+     * Signs a message with the personal account.
+     * @param {object} request - The request object.
+     * @param {"personal_sign"} request.method - The method name.
+     * @param {[string, Hex]} request.params - The method parameters.
+     * @returns {Promise<Hex>} A promise that resolves to the signed message.
+     */
     (request: {
         method: "personal_sign";
         params: [string, Hex];
     }): Promise<Hex>;
+    /**
+     * Requests the accounts from the provider.
+     * @param {object} request - The request object.
+     * @param {"eth_requestAccounts"} request.method - The method name.
+     * @param {undefined} [request.params] - The optional method parameters.
+     * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+     */
     (request: {
         method: "eth_requestAccounts";
         params?: undefined;
     }): Promise<Hex[]>;
+    /**
+     * Gets the accounts from the provider.
+     * @param {object} request - The request object.
+     * @param {"eth_accounts"} request.method - The method name.
+     * @param {undefined} [request.params] - The optional method parameters.
+     * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+     */
     (request: {
         method: "eth_accounts";
         params?: undefined;
     }): Promise<Hex[]>;
+    /**
+     * Sends a generic request to the provider.
+     * @param {object} request - The request object.
+     * @param {string} request.method - The method name.
+     * @param {Array<unknown> | Record<string, unknown>} [request.params] - The optional method parameters.
+     * @returns {Promise<unknown>} A promise that resolves to the response from the provider.
+     */
     (request: {
         method: string;
         params?: Array<unknown> | Record<string, unknown>;
     }): Promise<unknown>;
 }
+/**
+ * Interface representing a method to add event listeners to the provider.
+ * @interface
+ */
 export interface OnMethod {
+    /**
+     * Adds an event listener to the provider.
+     * @param {string} eventName - The name of the event.
+     * @param {(...args: unknown[]) => unknown} listener - The listener function.
+     * @returns {Provider} The provider instance.
+     */
     (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }
 //# sourceMappingURL=eip1193.advanced.d.ts.map

package/dist.commonjs/eip1193.advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eip1193.advanced.d.ts","sourceRoot":"","sources":["../src/eip1193.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,MAAM,WAAW,QAAQ;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,EAAE,EAAE,QAAQ,CAAC;IACb,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GACxC,QAAQ,CAAC;CACb;AAED,MAAM,WAAW,aAAa;IAC5B,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,qBAAqB,CAAC;QAC9B,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACnB,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1E,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnD,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}
+{"version":3,"file":"eip1193.advanced.d.ts","sourceRoot":"","sources":["../src/eip1193.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,OAAO,EAAE,aAAa,CAAC;IAEvB;;;OAGG;IACH,EAAE,EAAE,QAAQ,CAAC;IAEb;;;;;OAKG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GACxC,QAAQ,CAAC;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAE5E;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,qBAAqB,CAAC;QAC9B,MAAM,CAAC,EAAE,SAAS,CAAC;KACpB,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAEnB;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IAE1E;;;;;;OAMG;IACH,CAAC,OAAO,EAAE;QACR,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnD,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;OAKG;IACH,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}

package/dist.commonjs/eip6963.advanced.d.ts

@@ -1,15 +1,55 @@
 import { Provider as EIP1193Provider } from "./eip1193.advanced";
+/**
+ * Interface representing an event announcing a provider.
+ * @interface
+ */
 export interface AnnounceProviderEvent {
+    /**
+     * The detail of the provider.
+     * @type {ProviderDetail}
+     */
     detail: ProviderDetail;
 }
+/**
+ * Interface representing the details of a provider.
+ * @interface
+ */
 export interface ProviderDetail {
+    /**
+     * The information about the provider.
+     * @type {ProviderInfo}
+     */
     info: ProviderInfo;
+    /**
+     * The provider instance compliant with EIP-1193.
+     * @type {EIP1193Provider}
+     */
     provider: EIP1193Provider;
 }
+/**
+ * Interface representing information about a provider.
+ * @interface
+ */
 export interface ProviderInfo {
+    /**
+     * The reverse DNS name of the provider.
+     * @type {string}
+     */
     rdns: string;
+    /**
+     * The UUID of the provider.
+     * @type {string}
+     */
     uuid: string;
+    /**
+     * The name of the provider.
+     * @type {string}
+     */
     name: string;
+    /**
+     * The icon URL of the provider.
+     * @type {string}
+     */
     icon: string;
 }
 //# sourceMappingURL=eip6963.advanced.d.ts.map

package/dist.commonjs/eip6963.advanced.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"eip6963.advanced.d.ts","sourceRoot":"","sources":["../src/eip6963.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEjE,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,cAAc,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"eip6963.advanced.d.ts","sourceRoot":"","sources":["../src/eip6963.advanced.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,IAAI,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,eAAe,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd"}

package/dist.commonjs/signer.d.ts

@@ -1,12 +1,38 @@
 import { ccc } from "@ckb-ccc/core";
 import { ProviderDetail as EIP6963ProviderDetail } from "./eip6963.advanced";
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export declare class Signer extends ccc.SignerEvm {
     readonly detail: EIP6963ProviderDetail;
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {EIP6963ProviderDetail} detail - The provider detail.
+     */
     constructor(client: ccc.Client, detail: EIP6963ProviderDetail);
-    replaceClient(client: ccc.Client): Promise<Signer>;
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     getEvmAccount(): Promise<`0x${string}`>;
+    /**
+     * Connects to the provider by requesting accounts.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     connect(): Promise<void>;
+    /**
+     * Checks if the provider is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     isConnected(): Promise<boolean>;
+    /**
+     * Signs a raw message with the personal 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>;
 }
 //# sourceMappingURL=signer.d.ts.map

package/dist.commonjs/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE7E,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAGrB,MAAM,EAAE,qBAAqB;gBAD7C,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,MAAM,EAAE,qBAAqB;IAKzC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,aAAa;IAIb,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAO/B,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;CAUxE"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,cAAc,IAAI,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE7E;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,MAAM,EAAE,qBAAqB;IAP/C;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,MAAM,EAAE,qBAAqB;IAK/C;;;OAGG;IACG,aAAa;IAInB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;CAUxE"}

package/dist.commonjs/signer.js

@@ -2,24 +2,48 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Signer = void 0;
 const core_1 = require("@ckb-ccc/core");
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 class Signer extends core_1.ccc.SignerEvm {
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {EIP6963ProviderDetail} detail - The provider detail.
+     */
     constructor(client, detail) {
         super(client);
         this.detail = detail;
     }
-    async replaceClient(client) {
-        return new Signer(client, this.detail);
-    }
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     async getEvmAccount() {
         return (await this.detail.provider.request({ method: "eth_accounts" }))[0];
     }
+    /**
+     * Connects to the provider by requesting accounts.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     async connect() {
         await this.detail.provider.request({ method: "eth_requestAccounts" });
     }
+    /**
+     * Checks if the provider is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     async isConnected() {
         return ((await this.detail.provider.request({ method: "eth_accounts" }))
             .length !== 0);
     }
+    /**
+     * Signs a raw message with the personal 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 challenge = typeof message === "string" ? core_1.ccc.bytesFrom(message, "utf8") : message;
         const address = await this.getEvmAccount();

package/dist.commonjs/signersFactory.d.ts

@@ -1,9 +1,22 @@
 import { ccc } from "@ckb-ccc/core";
 import { Signer as EIP6963Signer } from "./signer";
+/**
+ * Class representing a factory for creating and managing Signer instances.
+ * @class
+ */
 export declare class SignerFactory {
     private readonly client;
     private readonly existedUuids;
+    /**
+     * Creates an instance of SignerFactory.
+     * @param {ccc.Client} client - The client instance.
+     */
     constructor(client: ccc.Client);
+    /**
+     * Subscribes to new signers and triggers a callback when a new signer is available.
+     * @param {(newSigner: EIP6963Signer) => unknown} callback - The callback to trigger with the new signer.
+     * @returns {() => void} A function to unsubscribe from the signer events.
+     */
     subscribeSigners(callback: (newSigner: EIP6963Signer) => unknown): () => void;
 }
 //# sourceMappingURL=signersFactory.d.ts.map

package/dist.commonjs/signersFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,UAAU,CAAC;AAEnD,qBAAa,aAAa;IAGZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;gBAEhB,MAAM,EAAE,GAAG,CAAC,MAAM;IAE/C,gBAAgB,CAAC,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO;CAmBjE"}
+{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEpC,OAAO,EAAE,MAAM,IAAI,aAAa,EAAE,MAAM,UAAU,CAAC;AAEnD;;;GAGG;AACH,qBAAa,aAAa;IAOZ,OAAO,CAAC,QAAQ,CAAC,MAAM;IANnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C;;;OAGG;gBAC0B,MAAM,EAAE,GAAG,CAAC,MAAM;IAE/C;;;;OAIG;IACH,gBAAgB,CACd,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO,GAC9C,MAAM,IAAI;CAoBd"}

package/dist.commonjs/signersFactory.js

@@ -2,16 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SignerFactory = void 0;
 const signer_1 = require("./signer");
+/**
+ * Class representing a factory for creating and managing Signer instances.
+ * @class
+ */
 class SignerFactory {
+    /**
+     * Creates an instance of SignerFactory.
+     * @param {ccc.Client} client - The client instance.
+     */
     constructor(client) {
         this.client = client;
         this.existedUuids = [];
     }
+    /**
+     * Subscribes to new signers and triggers a callback when a new signer is available.
+     * @param {(newSigner: EIP6963Signer) => unknown} callback - The callback to trigger with the new signer.
+     * @returns {() => void} A function to unsubscribe from the signer events.
+     */
     subscribeSigners(callback) {
         const onNewProvider = (event) => {
             const { detail } = event;
             const { uuid } = detail.info;
-            if (this.existedUuids.indexOf(uuid) !== -1) {
+            if (this.existedUuids.includes(uuid)) {
                 return;
             }
             this.existedUuids.push(uuid);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/eip6963",
-  "version": "0.0.5-alpha.8",
+  "version": "0.0.6-alpha.0",
   "description": "Common Chains Connector's support for EIP6963",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -42,7 +42,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.5-alpha.8"
+    "@ckb-ccc/core": "0.0.6-alpha.0"
   },
-  "gitHead": "f12b8758d8581bfae0c9a00abbb5f7d2c6d03147"
+  "gitHead": "2cbb4f450ed88e773a353a13ad006dbe6208f67f"
 }

package/src/eip1193.advanced.ts

@@ -1,27 +1,92 @@
 import { Hex } from "@ckb-ccc/core";
 
+/**
+ * Interface representing a provider for interacting with Ethereum-compatible wallets.
+ * @interface
+ */
 export interface Provider {
+  /**
+   * Sends a request to the provider.
+   * @type {RequestMethod}
+   */
   request: RequestMethod;
+
+  /**
+   * Adds an event listener to the provider.
+   * @type {OnMethod}
+   */
   on: OnMethod;
+
+  /**
+   * Removes an event listener from the provider.
+   * @param {string} eventName - The name of the event to remove the listener from.
+   * @param {(...args: unknown[]) => unknown} listener - The listener function to remove.
+   * @returns {Provider} The provider instance.
+   */
   removeListener(
     eventName: string,
     listener: (...args: unknown[]) => unknown,
   ): Provider;
 }
 
+/**
+ * Interface representing a method to send requests to the provider.
+ * @interface
+ */
 export interface RequestMethod {
+  /**
+   * Signs a message with the personal account.
+   * @param {object} request - The request object.
+   * @param {"personal_sign"} request.method - The method name.
+   * @param {[string, Hex]} request.params - The method parameters.
+   * @returns {Promise<Hex>} A promise that resolves to the signed message.
+   */
   (request: { method: "personal_sign"; params: [string, Hex] }): Promise<Hex>;
+
+  /**
+   * Requests the accounts from the provider.
+   * @param {object} request - The request object.
+   * @param {"eth_requestAccounts"} request.method - The method name.
+   * @param {undefined} [request.params] - The optional method parameters.
+   * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+   */
   (request: {
     method: "eth_requestAccounts";
     params?: undefined;
   }): Promise<Hex[]>;
+
+  /**
+   * Gets the accounts from the provider.
+   * @param {object} request - The request object.
+   * @param {"eth_accounts"} request.method - The method name.
+   * @param {undefined} [request.params] - The optional method parameters.
+   * @returns {Promise<Hex[]>} A promise that resolves to an array of account addresses.
+   */
   (request: { method: "eth_accounts"; params?: undefined }): Promise<Hex[]>;
+
+  /**
+   * Sends a generic request to the provider.
+   * @param {object} request - The request object.
+   * @param {string} request.method - The method name.
+   * @param {Array<unknown> | Record<string, unknown>} [request.params] - The optional method parameters.
+   * @returns {Promise<unknown>} A promise that resolves to the response from the provider.
+   */
   (request: {
     method: string;
     params?: Array<unknown> | Record<string, unknown>;
   }): Promise<unknown>;
 }
 
+/**
+ * Interface representing a method to add event listeners to the provider.
+ * @interface
+ */
 export interface OnMethod {
+  /**
+   * Adds an event listener to the provider.
+   * @param {string} eventName - The name of the event.
+   * @param {(...args: unknown[]) => unknown} listener - The listener function.
+   * @returns {Provider} The provider instance.
+   */
   (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }

package/src/eip6963.advanced.ts

@@ -1,17 +1,61 @@
 import { Provider as EIP1193Provider } from "./eip1193.advanced";
 
+/**
+ * Interface representing an event announcing a provider.
+ * @interface
+ */
 export interface AnnounceProviderEvent {
+  /**
+   * The detail of the provider.
+   * @type {ProviderDetail}
+   */
   detail: ProviderDetail;
 }
 
+/**
+ * Interface representing the details of a provider.
+ * @interface
+ */
 export interface ProviderDetail {
+  /**
+   * The information about the provider.
+   * @type {ProviderInfo}
+   */
   info: ProviderInfo;
+
+  /**
+   * The provider instance compliant with EIP-1193.
+   * @type {EIP1193Provider}
+   */
   provider: EIP1193Provider;
 }
 
+/**
+ * Interface representing information about a provider.
+ * @interface
+ */
 export interface ProviderInfo {
+  /**
+   * The reverse DNS name of the provider.
+   * @type {string}
+   */
   rdns: string;
+
+  /**
+   * The UUID of the provider.
+   * @type {string}
+   */
   uuid: string;
+
+  /**
+   * The name of the provider.
+   * @type {string}
+   */
   name: string;
+
+  /**
+   * The icon URL of the provider.
+   * @type {string}
+   */
   icon: string;
 }

package/src/signer.ts

@@ -1,7 +1,17 @@
 import { ccc } from "@ckb-ccc/core";
 import { ProviderDetail as EIP6963ProviderDetail } from "./eip6963.advanced";
 
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export class Signer extends ccc.SignerEvm {
+  /**
+   * Creates an instance of Signer.
+   * @param {ccc.Client} client - The client instance.
+   * @param {EIP6963ProviderDetail} detail - The provider detail.
+   */
   constructor(
     client: ccc.Client,
     public readonly detail: EIP6963ProviderDetail,
@@ -9,18 +19,26 @@ export class Signer extends ccc.SignerEvm {
     super(client);
   }
 
-  async replaceClient(client: ccc.Client): Promise<Signer> {
-    return new Signer(client, this.detail);
-  }
-
+  /**
+   * Gets the EVM account address.
+   * @returns {Promise<string>} A promise that resolves to the EVM account address.
+   */
   async getEvmAccount() {
     return (await this.detail.provider.request({ method: "eth_accounts" }))[0];
   }
 
+  /**
+   * Connects to the provider by requesting accounts.
+   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   */
   async connect(): Promise<void> {
     await this.detail.provider.request({ method: "eth_requestAccounts" });
   }
 
+  /**
+   * Checks if the provider is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
   async isConnected(): Promise<boolean> {
     return (
       (await this.detail.provider.request({ method: "eth_accounts" }))
@@ -28,6 +46,11 @@ export class Signer extends ccc.SignerEvm {
     );
   }
 
+  /**
+   * Signs a raw message with the personal 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: string | ccc.BytesLike): Promise<ccc.Hex> {
     const challenge =
       typeof message === "string" ? ccc.bytesFrom(message, "utf8") : message;

package/src/signersFactory.ts

@@ -2,17 +2,32 @@ import { ccc } from "@ckb-ccc/core";
 import { AnnounceProviderEvent as EIP6963AnnounceProviderEvent } from "./eip6963.advanced";
 import { Signer as EIP6963Signer } from "./signer";
 
+/**
+ * Class representing a factory for creating and managing Signer instances.
+ * @class
+ */
 export class SignerFactory {
   private readonly existedUuids: string[] = [];
 
+  /**
+   * Creates an instance of SignerFactory.
+   * @param {ccc.Client} client - The client instance.
+   */
   constructor(private readonly client: ccc.Client) {}
 
-  subscribeSigners(callback: (newSigner: EIP6963Signer) => unknown) {
+  /**
+   * Subscribes to new signers and triggers a callback when a new signer is available.
+   * @param {(newSigner: EIP6963Signer) => unknown} callback - The callback to trigger with the new signer.
+   * @returns {() => void} A function to unsubscribe from the signer events.
+   */
+  subscribeSigners(
+    callback: (newSigner: EIP6963Signer) => unknown,
+  ): () => void {
     const onNewProvider = (event: Event) => {
       const { detail } = event as unknown as EIP6963AnnounceProviderEvent;
       const { uuid } = detail.info;
 
-      if (this.existedUuids.indexOf(uuid) !== -1) {
+      if (this.existedUuids.includes(uuid)) {
         return;
       }
 
@@ -23,6 +38,7 @@ export class SignerFactory {
 
     window.addEventListener("eip6963:announceProvider", onNewProvider);
     window.dispatchEvent(new Event("eip6963:requestProvider"));
+
     return () =>
       window.removeEventListener("eip6963:announceProvider", onNewProvider);
   }