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

package/src/ckb/index.ts

@@ -8,17 +8,36 @@ import {
   ConnectionsRepoLocalStorage,
 } from "../connectionsStorage";
 
+/**
+ * Class representing a CKB signer that extends Signer from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.Signer}
+ */
 export class CkbSigner extends ccc.Signer {
+  /**
+   * Gets the signer type.
+   * @returns {ccc.SignerType} The type of the signer.
+   */
   get type(): ccc.SignerType {
     return ccc.SignerType.CKB;
   }
 
+  /**
+   * Gets the sign type.
+   * @returns {ccc.SignerSignType} The sign type.
+   */
   get signType(): ccc.SignerSignType {
     return ccc.SignerSignType.JoyId;
   }
 
   private connection?: Connection;
 
+  /**
+   * Ensures that the signer is connected and returns the connection.
+   * @private
+   * @throws Will throw an error if not connected.
+   * @returns {Promise<Connection>} A promise that resolves to the current connection.
+   */
   private async assertConnection(): Promise<Connection> {
     if (!(await this.isConnected()) || !this.connection) {
       throw new Error("Not connected");
@@ -27,6 +46,15 @@ export class CkbSigner extends ccc.Signer {
     return this.connection;
   }
 
+  /**
+   * Creates an instance of CkbSigner.
+   * @param {ccc.Client} client - The client instance.
+   * @param {string} name - The name of the signer.
+   * @param {string} icon - The icon URL of the signer.
+   * @param {string} [_appUri] - The application URI.
+   * @param {string} [_aggregatorUri] - The aggregator URI.
+   * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+   */
   constructor(
     client: ccc.Client,
     private readonly name: string,
@@ -38,17 +66,11 @@ export class CkbSigner extends ccc.Signer {
     super(client);
   }
 
-  async replaceClient(client: ccc.Client): Promise<CkbSigner> {
-    return new CkbSigner(
-      client,
-      this.name,
-      this.icon,
-      this._appUri,
-      this._aggregatorUri,
-      this.connectionsRepo,
-    );
-  }
-
+  /**
+   * Gets the configuration for JoyID.
+   * @private
+   * @returns {object} The configuration object.
+   */
   private getConfig() {
     return {
       redirectURL: location.href,
@@ -61,6 +83,11 @@ export class CkbSigner extends ccc.Signer {
     };
   }
 
+  /**
+   * Gets the aggregator URI.
+   * @private
+   * @returns {string} The aggregator URI.
+   */
   private getAggregatorUri(): string {
     if (this._aggregatorUri) {
       return this._aggregatorUri;
@@ -71,6 +98,10 @@ export class CkbSigner extends ccc.Signer {
       : "https://cota.nervina.dev/aggregator";
   }
 
+  /**
+   * Connects to the provider by requesting authentication.
+   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   */
   async connect(): Promise<void> {
     const config = this.getConfig();
 
@@ -87,11 +118,10 @@ export class CkbSigner extends ccc.Signer {
     await this.saveConnection();
   }
 
-  async disconnect(): Promise<void> {
-    this.connection = undefined;
-    await this.saveConnection();
-  }
-
+  /**
+   * Checks if the signer is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
   async isConnected(): Promise<boolean> {
     if (this.connection) {
       return true;
@@ -100,10 +130,18 @@ export class CkbSigner extends ccc.Signer {
     return this.connection !== undefined;
   }
 
+  /**
+   * Gets the internal address.
+   * @returns {Promise<string>} A promise that resolves to the internal address.
+   */
   async getInternalAddress(): Promise<string> {
     return (await this.assertConnection()).address;
   }
 
+  /**
+   * Gets the identity of the signer.
+   * @returns {Promise<string>} A promise that resolves to the identity.
+   */
   async getIdentity(): Promise<string> {
     const connection = await this.assertConnection();
     return JSON.stringify({
@@ -112,6 +150,10 @@ export class CkbSigner extends ccc.Signer {
     });
   }
 
+  /**
+   * Gets the address object.
+   * @returns {Promise<ccc.Address>} A promise that resolves to the address object.
+   */
   async getAddressObj(): Promise<ccc.Address> {
     return await ccc.Address.fromString(
       await this.getInternalAddress(),
@@ -119,10 +161,19 @@ export class CkbSigner extends ccc.Signer {
     );
   }
 
+  /**
+   * Gets the address objects.
+   * @returns {Promise<ccc.Address[]>} A promise that resolves to an array of address objects.
+   */
   async getAddressObjs(): Promise<ccc.Address[]> {
     return [await this.getAddressObj()];
   }
 
+  /**
+   * Prepares a transaction.
+   * @param {ccc.TransactionLike} txLike - The transaction-like object.
+   * @returns {Promise<ccc.Transaction>} A promise that resolves to the prepared transaction.
+   */
   async prepareTransaction(
     txLike: ccc.TransactionLike,
   ): Promise<ccc.Transaction> {
@@ -138,9 +189,19 @@ export class CkbSigner extends ccc.Signer {
     const witness = tx.getWitnessArgsAt(position) ?? ccc.WitnessArgs.from({});
     witness.lock = "0x";
     await this.prepareTransactionForSubKey(tx, witness);
-    return tx.setWitnessArgsAt(position, witness);
+    tx.setWitnessArgsAt(position, witness);
+
+    return tx;
   }
 
+  /**
+   * Prepares a transaction for a sub key.
+   * @private
+   * @param {ccc.Transaction} tx - The transaction object.
+   * @param {ccc.WitnessArgs} witness - The witness arguments.
+   * @returns {Promise<void>}
+   * @throws Will throw an error if no COTA cells are found for the sub key wallet.
+   */
   private async prepareTransactionForSubKey(
     tx: ccc.Transaction,
     witness: ccc.WitnessArgs,
@@ -180,6 +241,11 @@ export class CkbSigner extends ccc.Signer {
     tx.cellDeps.unshift(...cotaDeps);
   }
 
+  /**
+   * Signs a transaction.
+   * @param {ccc.TransactionLike} txLike - The transaction-like object.
+   * @returns {Promise<ccc.Transaction>} A promise that resolves to the signed transaction.
+   */
   async signOnlyTransaction(
     txLike: ccc.TransactionLike,
   ): Promise<ccc.Transaction> {
@@ -194,6 +260,10 @@ export class CkbSigner extends ccc.Signer {
           tx: JSON.parse(tx.stringify()),
           signerAddress: (await this.assertConnection()).address,
           witnessIndex: await tx.findInputIndexByLock(script, this.client),
+          witnessLastIndex: await tx.findLastInputIndexByLock(
+            script,
+            this.client,
+          ),
         },
         "popup",
         "/sign-ckb-raw-tx",
@@ -207,6 +277,11 @@ export class CkbSigner extends ccc.Signer {
     return ccc.Transaction.from(res.tx);
   }
 
+  /**
+   * Signs a raw message with the 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 { address } = await this.assertConnection();
 
@@ -234,7 +309,12 @@ export class CkbSigner extends ccc.Signer {
     });
   }
 
-  private async saveConnection() {
+  /**
+   * Saves the current connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async saveConnection(): Promise<void> {
     return this.connectionsRepo.set(
       {
         uri: this.getConfig().joyidAppURL,
@@ -244,7 +324,12 @@ export class CkbSigner extends ccc.Signer {
     );
   }
 
-  private async restoreConnection() {
+  /**
+   * Restores the previous connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async restoreConnection(): Promise<void> {
     this.connection = await this.connectionsRepo.get({
       uri: this.getConfig().joyidAppURL,
       addressType: "ckb",

package/src/common/index.ts

@@ -16,6 +16,10 @@ import {
   openPopup,
 } from "@joyid/common";
 
+/**
+ * Interface representing the return type for various Dapp request types.
+ * @interface
+ */
 export interface PopupReturnType {
   [DappRequestType.Auth]: AuthResponseData;
   [DappRequestType.SignMessage]: SignMessageResponseData;
@@ -36,6 +40,15 @@ export interface PopupReturnType {
   [DappRequestType.EvmWeb2Login]: EvmWeb2LoginResponse;
 }
 
+/**
+ * Creates a popup window for JoyID Dapp requests.
+ * @param {string} url - The URL to open in the popup.
+ * @param {PopupConfigOptions<T> & { joyidAppURL: string }} config - The popup configuration options.
+ * @returns {Promise<PopupReturnType[T]>} A promise that resolves to the response data of the requested type.
+ * @throws {PopupNotSupportedError} If popups are not supported in the current browser.
+ * @throws {PopupCancelledError} If the popup is closed by the user.
+ * @throws {PopupTimeoutError} If the popup operation times out.
+ */
 export async function createPopup<T extends DappRequestType>(
   url: string,
   config: PopupConfigOptions<T> & { joyidAppURL: string },

package/src/connectionsStorage/index.ts

@@ -1,42 +1,104 @@
 import { ccc } from "@ckb-ccc/core";
 
+/**
+ * Type representing an account selector with a URI and address type.
+ * @typedef {Object} AccountSelector
+ * @property {string} uri - The URI of the account.
+ * @property {string} addressType - The address type of the account.
+ */
 export type AccountSelector = {
   uri: string;
   addressType: string;
 };
 
-export function isSelectorEq(a: AccountSelector, b: AccountSelector) {
+/**
+ * Checks if two AccountSelectors are equal.
+ * @param {AccountSelector} a - The first account selector.
+ * @param {AccountSelector} b - The second account selector.
+ * @returns {boolean} True if the selectors are equal, false otherwise.
+ */
+export function isSelectorEq(a: AccountSelector, b: AccountSelector): boolean {
   return a.uri === b.uri && a.addressType === b.addressType;
 }
 
+/**
+ * Type representing a connection with an address, public key, and key type.
+ * @typedef {Object} Connection
+ * @property {string} address - The address of the connection.
+ * @property {ccc.Hex} publicKey - The public key of the connection.
+ * @property {string} keyType - The key type of the connection.
+ */
 export type Connection = {
   readonly address: string;
   readonly publicKey: ccc.Hex;
   readonly keyType: string;
 };
 
+/**
+ * Interface representing a repository for managing connections.
+ * @interface
+ */
 export interface ConnectionsRepo {
+  /**
+   * Gets a connection for the given selector.
+   * @param {AccountSelector} selector - The account selector.
+   * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+   */
   get(selector: AccountSelector): Promise<Connection | undefined>;
+
+  /**
+   * Sets a connection for the given selector.
+   * @param {AccountSelector} selector - The account selector.
+   * @param {Connection | undefined} connection - The connection to set.
+   * @returns {Promise<void>} A promise that resolves when the connection is set.
+   */
   set(
     selector: AccountSelector,
     connection: Connection | undefined,
   ): Promise<void>;
 }
 
+/**
+ * Class representing a local storage-based repository for managing connections.
+ * @class
+ * @implements {ConnectionsRepo}
+ */
 export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
+  /**
+   * Creates an instance of ConnectionsRepoLocalStorage.
+   * @param {string} [storageKey="ccc-joy-id-signer"] - The local storage key.
+   */
   constructor(private readonly storageKey = "ccc-joy-id-signer") {}
 
+  /**
+   * Reads all connections from local storage.
+   * @returns {Promise<[AccountSelector, Connection][]>} A promise that resolves to an array of selectors and connections.
+   */
   async readConnections(): Promise<[AccountSelector, Connection][]> {
     return JSON.parse(window.localStorage.getItem(this.storageKey) ?? "[]");
   }
 
+  /**
+   * Gets a connection for the given selector.
+   * @param {AccountSelector} selector - The account selector.
+   * @returns {Promise<Connection | undefined>} A promise that resolves to the connection, if found.
+   */
   async get(selector: AccountSelector): Promise<Connection | undefined> {
     return (await this.readConnections()).find(([s]) =>
       isSelectorEq(selector, s),
     )?.[1];
   }
 
-  async set(selector: AccountSelector, connection: Connection | undefined) {
+  /**
+   * Sets a connection for the given selector.
+   * @param {AccountSelector} selector - The account selector.
+   * @param {Connection | undefined} connection - The connection to set.
+   * @returns {Promise<void>}
+   */
+  async set(
+    selector: AccountSelector,
+    connection: Connection | undefined,
+  ): Promise<void> {
     const connections = await this.readConnections();
 
     if (connection) {

package/src/evm/index.ts

@@ -7,10 +7,21 @@ import {
   ConnectionsRepoLocalStorage,
 } from "../connectionsStorage";
 
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 export class EvmSigner extends ccc.SignerEvm {
   private connection?: Connection;
 
-  private assertConnection() {
+  /**
+   * Ensures that the signer is connected and returns the connection.
+   * @private
+   * @throws Will throw an error if not connected.
+   * @returns {Connection} The current connection.
+   */
+  private assertConnection(): Connection {
     if (!this.isConnected() || !this.connection) {
       throw new Error("Not connected");
     }
@@ -18,6 +29,14 @@ export class EvmSigner extends ccc.SignerEvm {
     return this.connection;
   }
 
+  /**
+   * Creates an instance of EvmSigner.
+   * @param {ccc.Client} client - The client instance.
+   * @param {string} name - The name of the signer.
+   * @param {string} icon - The icon URL of the signer.
+   * @param {string} [appUri="https://app.joy.id"] - The application URI.
+   * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+   */
   constructor(
     client: ccc.Client,
     private readonly name: string,
@@ -28,16 +47,11 @@ export class EvmSigner extends ccc.SignerEvm {
     super(client);
   }
 
-  async replaceClient(client: ccc.Client): Promise<EvmSigner> {
-    return new EvmSigner(
-      client,
-      this.name,
-      this.icon,
-      this.appUri,
-      this.connectionsRepo,
-    );
-  }
-
+  /**
+   * Gets the configuration for JoyID.
+   * @private
+   * @returns {object} The configuration object.
+   */
   private getConfig() {
     return {
       redirectURL: location.href,
@@ -48,12 +62,20 @@ export class EvmSigner extends ccc.SignerEvm {
     };
   }
 
-  async getEvmAccount() {
+  /**
+   * Gets the EVM account address.
+   * @returns {Promise<string>} A promise that resolves to the EVM account address.
+   */
+  async getEvmAccount(): Promise<string> {
     return this.assertConnection().address;
   }
 
+  /**
+   * Connects to the provider by requesting authentication.
+   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   */
   async connect(): Promise<void> {
-    const config = await this.getConfig();
+    const config = this.getConfig();
 
     const res = await createPopup(buildJoyIDURL(config, "popup", "/auth"), {
       ...config,
@@ -68,6 +90,10 @@ export class EvmSigner extends ccc.SignerEvm {
     await this.saveConnection();
   }
 
+  /**
+   * Checks if the signer is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
   async isConnected(): Promise<boolean> {
     if (this.connection) {
       return true;
@@ -76,6 +102,11 @@ export class EvmSigner extends ccc.SignerEvm {
     return this.connection !== undefined;
   }
 
+  /**
+   * Signs a raw message with the EVM account.
+   * @param {string | ccc.BytesLike} message - The message to sign.
+   * @returns {Promise<ccc.Hex>} A promise that resolves to the signed message.
+   */
   async signMessageRaw(message: string | ccc.BytesLike): Promise<ccc.Hex> {
     const { address } = this.assertConnection();
 
@@ -99,7 +130,12 @@ export class EvmSigner extends ccc.SignerEvm {
     return ccc.hexFrom(signature);
   }
 
-  private async saveConnection() {
+  /**
+   * Saves the current connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async saveConnection(): Promise<void> {
     return this.connectionsRepo.set(
       {
         uri: this.getConfig().joyidAppURL,
@@ -109,7 +145,12 @@ export class EvmSigner extends ccc.SignerEvm {
     );
   }
 
-  private async restoreConnection() {
+  /**
+   * Restores the previous connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async restoreConnection(): Promise<void> {
     this.connection = await this.connectionsRepo.get({
       uri: this.getConfig().joyidAppURL,
       addressType: "ethereum",

package/src/nostr/index.ts

@@ -0,0 +1,135 @@
+import { ccc } from "@ckb-ccc/core";
+import { DappRequestType, buildJoyIDURL } from "@joyid/common";
+import { createPopup } from "../common";
+import {
+  Connection,
+  ConnectionsRepo,
+  ConnectionsRepoLocalStorage,
+} from "../connectionsStorage";
+
+/**
+ * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerNostr}
+ */
+export class NostrSigner extends ccc.SignerNostr {
+  private connection?: Connection;
+
+  /**
+   * Ensures that the signer is connected and returns the connection.
+   * @private
+   * @throws Will throw an error if not connected.
+   * @returns {Connection} The current connection.
+   */
+  private assertConnection(): Connection {
+    if (!this.isConnected() || !this.connection) {
+      throw new Error("Not connected");
+    }
+
+    return this.connection;
+  }
+
+  /**
+   * Creates an instance of NostrSigner.
+   * @param {ccc.Client} client - The client instance.
+   * @param {string} name - The name of the signer.
+   * @param {string} icon - The icon URL of the signer.
+   * @param {string} [appUri="https://app.joy.id"] - The application URI.
+   * @param {ConnectionsRepo} [connectionsRepo=new ConnectionsRepoLocalStorage()] - The connections repository.
+   */
+  constructor(
+    client: ccc.Client,
+    private readonly name: string,
+    private readonly icon: string,
+    private readonly appUri = "https://app.joy.id",
+    private readonly connectionsRepo: ConnectionsRepo = new ConnectionsRepoLocalStorage(),
+  ) {
+    super(client);
+  }
+
+  static isValidClient(client: ccc.Client): boolean {
+    return client.addressPrefix === "ckt";
+  }
+
+  async replaceClient(client: ccc.Client): Promise<boolean> {
+    if (!NostrSigner.isValidClient(client)) {
+      return false;
+    }
+    return super.replaceClient(client);
+  }
+
+  /**
+   * Gets the configuration for JoyID.
+   * @private
+   * @returns {object} The configuration object.
+   */
+  private getConfig() {
+    return {
+      redirectURL: location.href,
+      joyidAppURL: this.appUri,
+      requestNetwork: "nostr",
+      name: this.name,
+      logo: this.icon,
+    };
+  }
+
+  /**
+   * Connects to the provider by requesting authentication.
+   * @returns {Promise<void>} A promise that resolves when the connection is established.
+   */
+  async connect(): Promise<void> {
+    const config = this.getConfig();
+    const res = await createPopup(buildJoyIDURL(config, "popup", "/auth"), {
+      ...config,
+      type: DappRequestType.Auth,
+    });
+
+    this.connection = {
+      address: "",
+      publicKey: ccc.hexFrom(res.nostrPubkey),
+      keyType: res.keyType,
+    };
+    await this.connectionsRepo.set(
+      { uri: this.appUri, addressType: "nostr" },
+      this.connection,
+    );
+  }
+
+  /**
+   * Checks if the signer is connected.
+   * @returns {Promise<boolean>} A promise that resolves to true if connected, false otherwise.
+   */
+  async isConnected(): Promise<boolean> {
+    if (this.connection) {
+      return true;
+    }
+
+    this.connection = await this.connectionsRepo.get({
+      uri: this.appUri,
+      addressType: "nostr",
+    });
+    return this.connection !== undefined;
+  }
+
+  async getNostrPublicKey(): Promise<ccc.Hex> {
+    if (!this.connection) {
+      throw new Error("Not connected");
+    }
+
+    return this.connection.publicKey;
+  }
+
+  async signNostrEvent(
+    event: ccc.NostrEvent,
+  ): Promise<Required<ccc.NostrEvent>> {
+    const config = this.getConfig();
+    const res = await createPopup(
+      buildJoyIDURL({ ...config, event }, "popup", "/sign-nostr-event"),
+      {
+        ...config,
+        type: DappRequestType.SignNostrEvent,
+      },
+    );
+    return res.event;
+  }
+}

package/src/signerFactory/index.ts

@@ -3,14 +3,33 @@ import { isStandaloneBrowser } from "@joyid/common";
 import { BitcoinSigner } from "../btc";
 import { CkbSigner } from "../ckb";
 import { EvmSigner } from "../evm";
+import { NostrSigner } from "../nostr";
 
+/**
+ * Gets the JoyID signers based on the client, name, and icon.
+ * If the browser is standalone or a webview, returns SignerAlwaysError instances.
+ * Otherwise, returns instances of CkbSigner, BitcoinSigner, and EvmSigner.
+ * @param {ccc.Client} client - The client instance.
+ * @param {string} name - The name of the signer.
+ * @param {string} icon - The icon URL of the signer.
+ * @returns {ccc.SignerInfo[]} An array of signer information objects.
+ */
 export function getJoyIdSigners(
   client: ccc.Client,
   name: string,
   icon: string,
 ): ccc.SignerInfo[] {
-  if (isStandaloneBrowser()) {
-    return [];
+  if (isStandaloneBrowser() || ccc.isWebview(window.navigator.userAgent)) {
+    return [ccc.SignerType.CKB, ccc.SignerType.EVM, ccc.SignerType.BTC].map(
+      (type) => ({
+        name: type,
+        signer: new ccc.SignerAlwaysError(
+          client,
+          type,
+          "JoyID can only be used with standard browsers",
+        ),
+      }),
+    );
   }
 
   return [
@@ -22,6 +41,10 @@ export function getJoyIdSigners(
       name: "BTC",
       signer: new BitcoinSigner(client, name, icon),
     },
+    {
+      name: "Nostr",
+      signer: new NostrSigner(client, name, icon),
+    },
     {
       name: "EVM",
       signer: new EvmSigner(client, name, icon),