@ckb-ccc/uni-sat 0.0.12-alpha.1 → 0.0.13-alpha.0

package/CHANGELOG.md

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

package/README.md

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

package/dist/advancedBarrel.d.ts

@@ -1,11 +1,10 @@
 /**
  * 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.
+     * @returns A promise that resolves to an array of account addresses.
      */
     requestAccounts(): Promise<string[]>;
     /**
@@ -36,44 +35,42 @@ export interface Provider {
     }>;
     /**
      * Gets the current accounts.
-     * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+     * @returns 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.
+     * @returns 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.
+     * @param msg - The message to sign.
+     * @param type - The type of signature.
+     * @returns 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.
+     * @param eventName - The name of the event to remove the listener from.
+     * @param listener - The listener function to remove.
+     * @returns 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.
+     * @param eventName - The name of the event.
+     * @param listener - The listener function.
+     * @returns The provider instance.
      */
     (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }

package/dist/advancedBarrel.d.ts.map

@@ -1 +1 @@
-{"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,UAAU,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;OAGG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEtE;;OAEG;IACH,WAAW,CAAC,CACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D;;;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"}
+{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;OAGG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEtE;;OAEG;IACH,WAAW,CAAC,CACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D;;;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;;OAEG;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;;GAEG;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,17 +1,16 @@
 import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel.js";
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export declare class Signer extends ccc.SignerBtc {
     readonly provider: Provider;
     private readonly preferredNetworks;
     /**
      * Creates an instance of Signer.
-     * @param {ccc.Client} client - The client instance.
-     * @param {Provider} provider - The provider instance.
+     * @param client - The client instance.
+     * @param provider - The provider instance.
      */
     constructor(client: ccc.Client, provider: Provider, preferredNetworks?: ccc.NetworkPreference[]);
     _getNetworkToChange(): Promise<string | undefined>;
@@ -21,29 +20,29 @@ export declare class Signer extends ccc.SignerBtc {
     ensureNetwork(): Promise<void>;
     /**
      * Gets the Bitcoin account address.
-     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     * @returns A promise that resolves to the Bitcoin account address.
      */
     getBtcAccount(): Promise<string>;
     /**
      * Gets the Bitcoin public key.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     * @returns A promise that resolves to the Bitcoin public key.
      */
     getBtcPublicKey(): Promise<ccc.Hex>;
     /**
      * Connects to the provider by requesting accounts.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     onReplaced(listener: () => void): () => void;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     /**
      * Signs a raw message with the Bitcoin account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<string>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
 }

package/dist/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,qBAAqB,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IARpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ,EACjB,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD;IAKG,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA0BxD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BpC;;;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;IAK9B,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAiB5C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,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,qBAAqB,CAAC;AAE/C;;;GAGG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IARpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ,EACjB,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD;IAKG,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA0BxD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BpC;;;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;IAK9B,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAiB5C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}

package/dist/signer.js

@@ -1,14 +1,13 @@
 import { ccc } from "@ckb-ccc/core";
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export class Signer extends ccc.SignerBtc {
     /**
      * Creates an instance of Signer.
-     * @param {ccc.Client} client - The client instance.
-     * @param {Provider} provider - The provider instance.
+     * @param client - The client instance.
+     * @param provider - The provider instance.
      */
     constructor(client, provider, preferredNetworks = [
         {
@@ -72,21 +71,21 @@ export class Signer extends ccc.SignerBtc {
     }
     /**
      * Gets the Bitcoin account address.
-     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     * @returns A promise that resolves to the Bitcoin account address.
      */
     async getBtcAccount() {
         return (await this.provider.getAccounts())[0];
     }
     /**
      * Gets the Bitcoin public key.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     * @returns A promise that resolves to the Bitcoin public key.
      */
     async getBtcPublicKey() {
         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.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         await this.provider.requestAccounts();
@@ -108,7 +107,7 @@ export class Signer extends ccc.SignerBtc {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (await this._getNetworkToChange()) {
@@ -118,8 +117,8 @@ export class Signer extends ccc.SignerBtc {
     }
     /**
      * Signs a raw message with the Bitcoin account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<string>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     async signMessageRaw(message) {
         const challenge = typeof message === "string" ? message : ccc.hexFrom(message).slice(2);

package/dist/signersFactory.d.ts

@@ -1,8 +1,10 @@
 import { ccc } from "@ckb-ccc/core";
 /**
  * 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.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The Signer instance if the UniSat provider is available, otherwise undefined.
  */
 export declare function getUniSatSigners(client: ccc.Client, preferredNetworks?: ccc.NetworkPreference[]): ccc.SignerInfo[];
 //# 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;AAIpC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CAalB"}
+{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CAalB"}

package/dist/signersFactory.js

@@ -1,8 +1,10 @@
 import { Signer } from "./signer.js";
 /**
  * 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.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The Signer instance if the UniSat provider is available, otherwise undefined.
  */
 export function getUniSatSigners(client, preferredNetworks) {
     const windowRef = window;

package/dist.commonjs/advancedBarrel.d.ts

@@ -1,11 +1,10 @@
 /**
  * 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.
+     * @returns A promise that resolves to an array of account addresses.
      */
     requestAccounts(): Promise<string[]>;
     /**
@@ -36,44 +35,42 @@ export interface Provider {
     }>;
     /**
      * Gets the current accounts.
-     * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+     * @returns 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.
+     * @returns 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.
+     * @param msg - The message to sign.
+     * @param type - The type of signature.
+     * @returns 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.
+     * @param eventName - The name of the event to remove the listener from.
+     * @param listener - The listener function to remove.
+     * @returns 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.
+     * @param eventName - The name of the event.
+     * @param listener - The listener function.
+     * @returns The provider instance.
      */
     (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }

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

@@ -1 +1 @@
-{"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,UAAU,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;OAGG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEtE;;OAEG;IACH,WAAW,CAAC,CACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D;;;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"}
+{"version":3,"file":"advancedBarrel.d.ts","sourceRoot":"","sources":["../src/advancedBarrel.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;OAGG;IACH,eAAe,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAErC;;;OAGG;IACH,UAAU,IAAI,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC,CAAC;IAE7C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3D;;;OAGG;IACH,QAAQ,CAAC,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEtE;;OAEG;IACH,WAAW,CAAC,CACV,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D;;;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;;OAEG;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;;GAEG;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/signer.d.ts

@@ -1,17 +1,16 @@
 import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel.js";
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export declare class Signer extends ccc.SignerBtc {
     readonly provider: Provider;
     private readonly preferredNetworks;
     /**
      * Creates an instance of Signer.
-     * @param {ccc.Client} client - The client instance.
-     * @param {Provider} provider - The provider instance.
+     * @param client - The client instance.
+     * @param provider - The provider instance.
      */
     constructor(client: ccc.Client, provider: Provider, preferredNetworks?: ccc.NetworkPreference[]);
     _getNetworkToChange(): Promise<string | undefined>;
@@ -21,29 +20,29 @@ export declare class Signer extends ccc.SignerBtc {
     ensureNetwork(): Promise<void>;
     /**
      * Gets the Bitcoin account address.
-     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     * @returns A promise that resolves to the Bitcoin account address.
      */
     getBtcAccount(): Promise<string>;
     /**
      * Gets the Bitcoin public key.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     * @returns A promise that resolves to the Bitcoin public key.
      */
     getBtcPublicKey(): Promise<ccc.Hex>;
     /**
      * Connects to the provider by requesting accounts.
-     * @returns {Promise<void>} A promise that resolves when the connection is established.
+     * @returns A promise that resolves when the connection is established.
      */
     connect(): Promise<void>;
     onReplaced(listener: () => void): () => void;
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     isConnected(): Promise<boolean>;
     /**
      * Signs a raw message with the Bitcoin account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<string>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     signMessageRaw(message: string | ccc.BytesLike): Promise<string>;
 }

package/dist.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,qBAAqB,CAAC;AAE/C;;;;GAIG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IARpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ,EACjB,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD;IAKG,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA0BxD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BpC;;;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;IAK9B,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAiB5C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,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,qBAAqB,CAAC;AAE/C;;;GAGG;AACH,qBAAa,MAAO,SAAQ,GAAG,CAAC,SAAS;aAQrB,QAAQ,EAAE,QAAQ;IAClC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IARpC;;;;OAIG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACF,QAAQ,EAAE,QAAQ,EACjB,iBAAiB,GAAE,GAAG,CAAC,iBAAiB,EAWxD;IAKG,mBAAmB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA0BxD;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BpC;;;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;IAK9B,UAAU,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,MAAM,IAAI;IAiB5C;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAOrC;;;;OAIG;IACG,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,GAAG,CAAC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;CAMvE"}

package/dist.commonjs/signer.js

@@ -3,15 +3,14 @@ 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 representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 class Signer extends core_1.ccc.SignerBtc {
     /**
      * Creates an instance of Signer.
-     * @param {ccc.Client} client - The client instance.
-     * @param {Provider} provider - The provider instance.
+     * @param client - The client instance.
+     * @param provider - The provider instance.
      */
     constructor(client, provider, preferredNetworks = [
         {
@@ -75,21 +74,21 @@ class Signer extends core_1.ccc.SignerBtc {
     }
     /**
      * Gets the Bitcoin account address.
-     * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+     * @returns A promise that resolves to the Bitcoin account address.
      */
     async getBtcAccount() {
         return (await this.provider.getAccounts())[0];
     }
     /**
      * Gets the Bitcoin public key.
-     * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+     * @returns A promise that resolves to the Bitcoin public key.
      */
     async getBtcPublicKey() {
         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.
+     * @returns A promise that resolves when the connection is established.
      */
     async connect() {
         await this.provider.requestAccounts();
@@ -111,7 +110,7 @@ class Signer extends core_1.ccc.SignerBtc {
     }
     /**
      * Checks if the signer is connected.
-     * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+     * @returns A promise that resolves to true if connected, false otherwise.
      */
     async isConnected() {
         if (await this._getNetworkToChange()) {
@@ -121,8 +120,8 @@ class Signer extends core_1.ccc.SignerBtc {
     }
     /**
      * Signs a raw message with the Bitcoin account.
-     * @param {string | ccc.BytesLike} message - The message to sign.
-     * @returns {Promise<string>} A promise that resolves to the signed message.
+     * @param message - The message to sign.
+     * @returns A promise that resolves to the signed message.
      */
     async signMessageRaw(message) {
         const challenge = typeof message === "string" ? message : core_1.ccc.hexFrom(message).slice(2);

package/dist.commonjs/signersFactory.d.ts

@@ -1,8 +1,10 @@
 import { ccc } from "@ckb-ccc/core";
 /**
  * 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.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The Signer instance if the UniSat provider is available, otherwise undefined.
  */
 export declare function getUniSatSigners(client: ccc.Client, preferredNetworks?: ccc.NetworkPreference[]): ccc.SignerInfo[];
 //# 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;AAIpC;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CAalB"}
+{"version":3,"file":"signersFactory.d.ts","sourceRoot":"","sources":["../src/signersFactory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAIpC;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,iBAAiB,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAAE,GAC1C,GAAG,CAAC,UAAU,EAAE,CAalB"}

package/dist.commonjs/signersFactory.js

@@ -4,8 +4,10 @@ exports.getUniSatSigners = void 0;
 const signer_js_1 = require("./signer.js");
 /**
  * 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.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The Signer instance if the UniSat provider is available, otherwise undefined.
  */
 function getUniSatSigners(client, preferredNetworks) {
     const windowRef = window;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/uni-sat",
-  "version": "0.0.12-alpha.1",
+  "version": "0.0.13-alpha.0",
   "description": "CCC - CKBer's Codebase. Common Chains Connector's support for UniSat",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -30,11 +30,6 @@
       "default": "./dist.commonjs/advancedBarrel.js"
     }
   },
-  "scripts": {
-    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
-    "lint": "eslint",
-    "format": "prettier --write . && eslint --fix"
-  },
   "devDependencies": {
     "@eslint/js": "^9.1.1",
     "copyfiles": "^2.4.1",
@@ -51,7 +46,11 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.12-alpha.1"
+    "@ckb-ccc/core": "0.0.13-alpha.0"
   },
-  "gitHead": "22b1e1e4c7e56c8a6e9f699f54193cbec7d30a8b"
-}
+  "scripts": {
+    "build": "rimraf ./dist && rimraf ./dist.commonjs && tsc && tsc --project tsconfig.commonjs.json && copyfiles -u 2 misc/basedirs/**/* .",
+    "lint": "eslint",
+    "format": "prettier --write . && eslint --fix"
+  }
+}

package/src/advancedBarrel.ts

@@ -1,11 +1,10 @@
 /**
  * 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.
+   * @returns A promise that resolves to an array of account addresses.
    */
   requestAccounts(): Promise<string[]>;
 
@@ -35,35 +34,34 @@ export interface Provider {
 
   /**
    * Gets the current accounts.
-   * @returns {Promise<string[]>} A promise that resolves to an array of account addresses.
+   * @returns 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.
+   * @returns 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.
+   * @param msg - The message to sign.
+   * @param type - The type of signature.
+   * @returns 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.
+   * @param eventName - The name of the event to remove the listener from.
+   * @param listener - The listener function to remove.
+   * @returns The provider instance.
    */
   removeListener(
     eventName: string,
@@ -73,14 +71,13 @@ export interface 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.
+   * @param eventName - The name of the event.
+   * @param listener - The listener function.
+   * @returns The provider instance.
    */
   (eventName: string, listener: (...args: unknown[]) => unknown): Provider;
 }

package/src/signer.ts

@@ -2,15 +2,14 @@ import { ccc } from "@ckb-ccc/core";
 import { Provider } from "./advancedBarrel.js";
 
 /**
- * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
- * @class
- * @extends {ccc.SignerBtc}
+ * Class representing a Bitcoin signer that extends SignerBtc
+ * @public
  */
 export class Signer extends ccc.SignerBtc {
   /**
    * Creates an instance of Signer.
-   * @param {ccc.Client} client - The client instance.
-   * @param {Provider} provider - The provider instance.
+   * @param client - The client instance.
+   * @param provider - The provider instance.
    */
   constructor(
     client: ccc.Client,
@@ -89,7 +88,7 @@ export class Signer extends ccc.SignerBtc {
 
   /**
    * Gets the Bitcoin account address.
-   * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+   * @returns A promise that resolves to the Bitcoin account address.
    */
   async getBtcAccount(): Promise<string> {
     return (await this.provider.getAccounts())[0];
@@ -97,7 +96,7 @@ export class Signer extends ccc.SignerBtc {
 
   /**
    * Gets the Bitcoin public key.
-   * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+   * @returns A promise that resolves to the Bitcoin public key.
    */
   async getBtcPublicKey(): Promise<ccc.Hex> {
     return ccc.hexFrom(await this.provider.getPublicKey());
@@ -105,7 +104,7 @@ export class Signer extends ccc.SignerBtc {
 
   /**
    * Connects to the provider by requesting accounts.
-   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   * @returns A promise that resolves when the connection is established.
    */
   async connect(): Promise<void> {
     await this.provider.requestAccounts();
@@ -131,7 +130,7 @@ export class Signer extends ccc.SignerBtc {
 
   /**
    * Checks if the signer is connected.
-   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   * @returns A promise that resolves to true if connected, false otherwise.
    */
   async isConnected(): Promise<boolean> {
     if (await this._getNetworkToChange()) {
@@ -142,8 +141,8 @@ export class Signer extends ccc.SignerBtc {
 
   /**
    * Signs a raw message with the Bitcoin account.
-   * @param {string | ccc.BytesLike} message - The message to sign.
-   * @returns {Promise<string>} A promise that resolves to the signed message.
+   * @param message - The message to sign.
+   * @returns A promise that resolves to the signed message.
    */
   async signMessageRaw(message: string | ccc.BytesLike): Promise<string> {
     const challenge =

package/src/signersFactory.ts

@@ -4,8 +4,10 @@ import { Signer } from "./signer.js";
 
 /**
  * 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.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The Signer instance if the UniSat provider is available, otherwise undefined.
  */
 export function getUniSatSigners(
   client: ccc.Client,

package/typedoc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["./src/index.ts", "./src/advanced.ts"],
+  "extends": ["../../typedoc.base.json"],
+  "name": "@ckb-ccc uni-sat"
+}