@ckb-ccc/uni-sat 0.0.5-alpha.8 → 0.0.7-alpha.0

package/dist/advancedBarrel.d.ts

@@ -1,12 +1,54 @@
+/**
+ * Interface representing a provider for interacting with accounts and signing messages.
+ * @interface
+ */
 export interface Provider {
+    /**
+     * Requests user accounts.
+     * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+     */
     requestAccounts(): Promise<string[]>;
+    /**
+     * Gets the current accounts.
+     * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+     */
     getAccounts(): Promise<string[]>;
+    /**
+     * Gets the public key of the account.
+     * @returns {Promise<string>} A promise that resolves to the public key.
+     */
     getPublicKey(): Promise<string>;
+    /**
+     * Signs a message with the specified type.
+     * @param {string} msg - The message to sign.
+     * @param {"ecdsa" | "bip322-simple"} type - The type of signature.
+     * @returns {Promise<string>} A promise that resolves to the signed message.
+     */
     signMessage(msg: string, type: "ecdsa" | "bip322-simple"): Promise<string>;
+    /**
+     * 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 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=advancedBarrel.d.ts.map

package/dist/advancedBarrel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E,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,QAAQ;IACvB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}
+{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjC;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E;;;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,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/signer.d.ts

@@ -1,13 +1,43 @@
 import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel";
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export declare class Signer extends ccc.SignerBtc {
     readonly provider: Provider;
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {Provider} provider - The provider instance.
+     */
     constructor(client: ccc.Client, provider: Provider);
-    replaceClient(client: ccc.Client): Promise<Signer>;
+    /**
+     * 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 accounts.
+     * @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=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,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAGrB,QAAQ,EAAE,QAAQ;gBADlC,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ;IAK9B,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,aAAa;IAIb,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAInC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/B,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAPpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ;IAKpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAIrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}

package/dist/signer.js

@@ -1,24 +1,52 @@
 import { ccc } from "@ckb-ccc/core";
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export class Signer extends ccc.SignerBtc {
+    /**
+     * Creates an instance of Signer.
+     * @param {ccc.Client} client - The client instance.
+     * @param {Provider} provider - The provider instance.
+     */
     constructor(client, provider) {
         super(client);
         this.provider = provider;
     }
-    async replaceClient(client) {
-        return new Signer(client, this.provider);
-    }
+    /**
+     * Gets the Bitcoin account address.
+     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     */
     async getBtcAccount() {
         return (await this.provider.getAccounts())[0];
     }
+    /**
+     * Gets the Bitcoin public key.
+     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     */
     async getBtcPublicKey() {
         return ccc.hexFrom(await this.provider.getPublicKey());
     }
+    /**
+     * Connects to the provider by requesting accounts.
+     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     */
     async connect() {
         await this.provider.requestAccounts();
     }
+    /**
+     * Checks if the signer is connected.
+     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     */
     async isConnected() {
         return (await this.provider.getAccounts()).length !== 0;
     }
+    /**
+     * 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 challenge = typeof message === "string" ? message : ccc.hexFrom(message).slice(2);
         return this.provider.signMessage(challenge, "ecdsa");

package/dist/signersFactory.d.ts

@@ -1,4 +1,9 @@
 import { ccc } from "@ckb-ccc/core";
 import { Signer } from "./signer";
+/**
+ * Retrieves the UniSat signer if available.
+ * @param {ccc.Client} client - The client instance.
+ * @returns {Signer | undefined} The Signer instance if the UniSat provider is available, otherwise undefined.
+ */
 export declare function getUniSatSigner(client: ccc.Client): Signer | undefined;
 //# 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,EAAE,MAAM,UAAU,CAAC;AAElC,wBAAgB,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAQtE"}
+{"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,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAQtE"}

package/dist/signersFactory.js

@@ -1,8 +1,13 @@
 import { Signer } from "./signer";
+/**
+ * Retrieves the UniSat signer if available.
+ * @param {ccc.Client} client - The client instance.
+ * @returns {Signer | undefined} The Signer instance if the UniSat provider is available, otherwise undefined.
+ */
 export function getUniSatSigner(client) {
     const windowRef = window;
     if (typeof windowRef.unisat === "undefined") {
-        return;
+        return undefined;
     }
     return new Signer(client, windowRef.unisat);
 }

package/dist.commonjs/advanced.d.ts

@@ -1,2 +1,2 @@
 export * as UniSatA from "./advancedBarrel";
-//# sourceMappingURL=advanced.d.ts.map
+//# sourceMappingURL=advanced.d.ts.map

package/dist.commonjs/advanced.js

@@ -1,27 +1,48 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
-};
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UniSatA = void 0;
 exports.UniSatA = __importStar(require("./advancedBarrel"));

package/dist.commonjs/advancedBarrel.d.ts

@@ -1,12 +1,57 @@
+/**
+ * Interface representing a provider for interacting with accounts and signing messages.
+ * @interface
+ */
 export interface Provider {
-    requestAccounts(): Promise<string[]>;
-    getAccounts(): Promise<string[]>;
-    getPublicKey(): Promise<string>;
-    signMessage(msg: string, type: "ecdsa" | "bip322-simple"): Promise<string>;
-    on: OnMethod;
-    removeListener(eventName: string, listener: (...args: unknown[]) => unknown): Provider;
+  /**
+   * Requests user accounts.
+   * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+   */
+  requestAccounts(): Promise<string[]>;
+  /**
+   * Gets the current accounts.
+   * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+   */
+  getAccounts(): Promise<string[]>;
+  /**
+   * Gets the public key of the account.
+   * @returns {Promise<string>} A promise that resolves to the public key.
+   */
+  getPublicKey(): Promise<string>;
+  /**
+   * Signs a message with the specified type.
+   * @param {string} msg - The message to sign.
+   * @param {"ecdsa" | "bip322-simple"} type - The type of signature.
+   * @returns {Promise<string>} A promise that resolves to the signed message.
+   */
+  signMessage(msg: string, type: "ecdsa" | "bip322-simple"): Promise<string>;
+  /**
+   * 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 add event listeners to the provider.
+ * @interface
+ */
 export interface OnMethod {
-    (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
+  /**
+   * 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=advancedBarrel.d.ts.map
+//# sourceMappingURL=advancedBarrel.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,QAAQ;IACvB,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACrC,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACjC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E,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,QAAQ;IACvB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,GAAG,QAAQ,CAAC;CAC1E"}
+{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjC;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhC;;;;;OAKG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3E;;;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,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/barrel.d.ts

@@ -1,3 +1,3 @@
 export * from "./signer";
 export * from "./signersFactory";
-//# sourceMappingURL=barrel.d.ts.map
+//# sourceMappingURL=barrel.d.ts.map

package/dist.commonjs/barrel.js

@@ -1,18 +1,34 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __exportStar =
+  (this && this.__exportStar) ||
+  function (m, exports) {
+    for (var p in m)
+      if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p))
+        __createBinding(exports, m, p);
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./signer"), exports);
 __exportStar(require("./signersFactory"), exports);

package/dist.commonjs/index.d.ts

@@ -1,2 +1,2 @@
 export * as UniSat from "./barrel";
-//# sourceMappingURL=index.d.ts.map
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/index.js

@@ -1,27 +1,48 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
     if (mod && mod.__esModule) return mod;
     var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
     __setModuleDefault(result, mod);
     return result;
-};
+  };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UniSat = void 0;
 exports.UniSat = __importStar(require("./barrel"));

package/dist.commonjs/signer.d.ts

@@ -1,13 +1,43 @@
 import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel";
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export declare class Signer extends ccc.SignerBtc {
-    readonly provider: Provider;
-    constructor(client: ccc.Client, provider: Provider);
-    replaceClient(client: ccc.Client): Promise<Signer>;
-    getBtcAccount(): Promise<string>;
-    getBtcPublicKey(): Promise<ccc.Hex>;
-    connect(): Promise<void>;
-    isConnected(): Promise<boolean>;
-    signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
+  readonly provider: Provider;
+  /**
+   * Creates an instance of Signer.
+   * @param {ccc.Client} client - The client instance.
+   * @param {Provider} provider - The provider instance.
+   */
+  constructor(client: ccc.Client, provider: Provider);
+  /**
+   * 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 accounts.
+   * @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=signer.d.ts.map
+//# 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,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAGrB,QAAQ,EAAE,QAAQ;gBADlC,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ;IAK9B,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD,aAAa;IAIb,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAInC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxB,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAI/B,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAE5C;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAPpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ;IAKpC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;;OAGG;IACG,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAIzC;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAIrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}

package/dist.commonjs/signer.js

@@ -2,29 +2,60 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Signer = void 0;
 const core_1 = require("@ckb-ccc/core");
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 class Signer extends core_1.ccc.SignerBtc {
-    constructor(client, provider) {
-        super(client);
-        this.provider = provider;
-    }
-    async replaceClient(client) {
-        return new Signer(client, this.provider);
-    }
-    async getBtcAccount() {
-        return (await this.provider.getAccounts())[0];
-    }
-    async getBtcPublicKey() {
-        return core_1.ccc.hexFrom(await this.provider.getPublicKey());
-    }
-    async connect() {
-        await this.provider.requestAccounts();
-    }
-    async isConnected() {
-        return (await this.provider.getAccounts()).length !== 0;
-    }
-    async signMessageRaw(message) {
-        const challenge = typeof message === "string" ? message : core_1.ccc.hexFrom(message).slice(2);
-        return this.provider.signMessage(challenge, "ecdsa");
-    }
+  /**
+   * Creates an instance of Signer.
+   * @param {ccc.Client} client - The client instance.
+   * @param {Provider} provider - The provider instance.
+   */
+  constructor(client, provider) {
+    super(client);
+    this.provider = provider;
+  }
+  /**
+   * Gets the Bitcoin account address.
+   * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+   */
+  async getBtcAccount() {
+    return (await this.provider.getAccounts())[0];
+  }
+  /**
+   * Gets the Bitcoin public key.
+   * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+   */
+  async getBtcPublicKey() {
+    return core_1.ccc.hexFrom(await this.provider.getPublicKey());
+  }
+  /**
+   * Connects to the provider by requesting accounts.
+   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   */
+  async connect() {
+    await this.provider.requestAccounts();
+  }
+  /**
+   * Checks if the signer is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
+  async isConnected() {
+    return (await this.provider.getAccounts()).length !== 0;
+  }
+  /**
+   * 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 challenge =
+      typeof message === "string"
+        ? message
+        : core_1.ccc.hexFrom(message).slice(2);
+    return this.provider.signMessage(challenge, "ecdsa");
+  }
 }
 exports.Signer = Signer;

package/dist.commonjs/signersFactory.d.ts

@@ -1,4 +1,9 @@
 import { ccc } from "@ckb-ccc/core";
 import { Signer } from "./signer";
+/**
+ * Retrieves the UniSat signer if available.
+ * @param {ccc.Client} client - The client instance.
+ * @returns {Signer | undefined} The Signer instance if the UniSat provider is available, otherwise undefined.
+ */
 export declare function getUniSatSigner(client: ccc.Client): Signer | undefined;
-//# sourceMappingURL=signersFactory.d.ts.map
+//# 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,EAAE,MAAM,UAAU,CAAC;AAElC,wBAAgB,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAQtE"}
+{"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,EAAE,MAAM,UAAU,CAAC;AAElC;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAQtE"}

package/dist.commonjs/signersFactory.js

@@ -2,11 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUniSatSigner = void 0;
 const signer_1 = require("./signer");
+/**
+ * Retrieves the UniSat signer if available.
+ * @param {ccc.Client} client - The client instance.
+ * @returns {Signer | undefined} The Signer instance if the UniSat provider is available, otherwise undefined.
+ */
 function getUniSatSigner(client) {
-    const windowRef = window;
-    if (typeof windowRef.unisat === "undefined") {
-        return;
-    }
-    return new signer_1.Signer(client, windowRef.unisat);
+  const windowRef = window;
+  if (typeof windowRef.unisat === "undefined") {
+    return undefined;
+  }
+  return new signer_1.Signer(client, windowRef.unisat);
 }
 exports.getUniSatSigner = getUniSatSigner;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/uni-sat",
-  "version": "0.0.5-alpha.8",
+  "version": "0.0.7-alpha.0",
   "description": "Common Chains Connector's support for UniSat",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -50,7 +50,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.5-alpha.8"
+    "@ckb-ccc/core": "0.0.7-alpha.0"
   },
-  "gitHead": "f12b8758d8581bfae0c9a00abbb5f7d2c6d03147"
+  "gitHead": "99d88c6179e7af6f592b1b39f8df6f6968cc0df3"
 }

package/src/advancedBarrel.ts

@@ -1,16 +1,62 @@
+/**
+ * Interface representing a provider for interacting with accounts and signing messages.
+ * @interface
+ */
 export interface Provider {
+  /**
+   * Requests user accounts.
+   * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+   */
   requestAccounts(): Promise<string[]>;
+
+  /**
+   * Gets the current accounts.
+   * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+   */
   getAccounts(): Promise<string[]>;
+
+  /**
+   * Gets the public key of the account.
+   * @returns {Promise<string>} A promise that resolves to the public key.
+   */
   getPublicKey(): Promise<string>;
+
+  /**
+   * Signs a message with the specified type.
+   * @param {string} msg - The message to sign.
+   * @param {"ecdsa" | "bip322-simple"} type - The type of signature.
+   * @returns {Promise<string>} A promise that resolves to the signed message.
+   */
   signMessage(msg: string, type: "ecdsa" | "bip322-simple"): Promise<string>;
 
+  /**
+   * 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 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/signer.ts

@@ -1,7 +1,17 @@
 import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel";
 
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export class Signer extends ccc.SignerBtc {
+  /**
+   * Creates an instance of Signer.
+   * @param {ccc.Client} client - The client instance.
+   * @param {Provider} provider - The provider instance.
+   */
   constructor(
     client: ccc.Client,
     public readonly provider: Provider,
@@ -9,26 +19,43 @@ export class Signer extends ccc.SignerBtc {
     super(client);
   }
 
-  async replaceClient(client: ccc.Client): Promise<Signer> {
-    return new Signer(client, this.provider);
-  }
-
-  async getBtcAccount() {
+  /**
+   * Gets the Bitcoin account address.
+   * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+   */
+  async getBtcAccount(): Promise<string> {
     return (await this.provider.getAccounts())[0];
   }
 
+  /**
+   * Gets the Bitcoin public key.
+   * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+   */
   async getBtcPublicKey(): Promise<ccc.Hex> {
     return ccc.hexFrom(await this.provider.getPublicKey());
   }
 
+  /**
+   * 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.provider.requestAccounts();
   }
 
+  /**
+   * Checks if the signer is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
   async isConnected(): Promise<boolean> {
     return (await this.provider.getAccounts()).length !== 0;
   }
 
+  /**
+   * 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: string | ccc.BytesLike): Promise<string> {
     const challenge =
       typeof message === "string" ? message : ccc.hexFrom(message).slice(2);

package/src/signersFactory.ts

@@ -2,11 +2,16 @@ import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel";
 import { Signer } from "./signer";
 
+/**
+ * Retrieves the UniSat signer if available.
+ * @param {ccc.Client} client - The client instance.
+ * @returns {Signer | undefined} The Signer instance if the UniSat provider is available, otherwise undefined.
+ */
 export function getUniSatSigner(client: ccc.Client): Signer | undefined {
   const windowRef = window as { unisat?: Provider };
 
   if (typeof windowRef.unisat === "undefined") {
-    return;
+    return undefined;
   }
 
   return new Signer(client, windowRef.unisat);