@ckb-ccc/okx 0.0.12-alpha.7 → 0.0.12

package/src/btc/index.ts

@@ -2,17 +2,17 @@ import { ccc } from "@ckb-ccc/core";
 import { BitcoinProvider } 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 BitcoinSigner extends ccc.SignerBtc {
   private network = "btcTestnet";
 
   /**
    * Creates an instance of Signer.
-   * @param {ccc.Client} client - The client instance.
-   * @param {Provider} provider - The provider instance.
+   * @param client - The client instance.
+   * @param providers - The providers instance.
+   * @param preferredNetworks - All preferred networks
    */
   constructor(
     client: ccc.Client,
@@ -61,7 +61,7 @@ export class BitcoinSigner 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> {
     if (this.provider.getAccounts) {
@@ -85,7 +85,7 @@ export class BitcoinSigner 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> {
     if (this.provider.getPublicKey) {
@@ -105,7 +105,7 @@ export class BitcoinSigner 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> {
     if (this.provider.requestAccounts) {
@@ -138,7 +138,7 @@ export class BitcoinSigner 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> {
     try {
@@ -163,8 +163,8 @@ export class BitcoinSigner 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/nostr/index.ts

@@ -2,9 +2,8 @@ import { ccc } from "@ckb-ccc/core";
 import { NostrProvider } 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 NostrSigner extends ccc.SignerNostr {
   private publicKeyCache?: Promise<string> = undefined;

package/src/signersFactory.ts

@@ -5,8 +5,10 @@ import { NostrSigner } from "./nostr/index.js";
 
 /**
  * Retrieves the OKX Bitcoin signer if available.
- * @param {ccc.Client} client - The client instance.
- * @returns {BitcoinSigner | undefined} The BitcoinSigner instance if the OKX wallet is available, otherwise undefined.
+ * @public
+ *
+ * @param client - The client instance.
+ * @returns The BitcoinSigner instance if the OKX wallet is available, otherwise undefined.
  */
 export function getOKXSigners(
   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 okx"
+}