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

package/dist.commonjs/evm/index.js

@@ -5,13 +5,32 @@ const core_1 = require("@ckb-ccc/core");
 const common_1 = require("@joyid/common");
 const common_2 = require("../common");
 const connectionsStorage_1 = require("../connectionsStorage");
+/**
+ * Class representing an EVM signer that extends SignerEvm from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerEvm}
+ */
 class EvmSigner extends core_1.ccc.SignerEvm {
+    /**
+     * Ensures that the signer is connected and returns the connection.
+     * @private
+     * @throws Will throw an error if not connected.
+     * @returns {Connection} The current connection.
+     */
     assertConnection() {
         if (!this.isConnected() || !this.connection) {
             throw new Error("Not connected");
         }
         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, name, icon, appUri = "https://app.joy.id", connectionsRepo = new connectionsStorage_1.ConnectionsRepoLocalStorage()) {
         super(client);
         this.name = name;
@@ -19,9 +38,11 @@ class EvmSigner extends core_1.ccc.SignerEvm {
         this.appUri = appUri;
         this.connectionsRepo = connectionsRepo;
     }
-    async replaceClient(client) {
-        return new EvmSigner(client, this.name, this.icon, this.appUri, this.connectionsRepo);
-    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
     getConfig() {
         return {
             redirectURL: location.href,
@@ -31,11 +52,19 @@ class EvmSigner extends core_1.ccc.SignerEvm {
             logo: this.icon,
         };
     }
+    /**
+     * Gets the EVM account address.
+     * @returns {Promise<string>} A promise that resolves to the EVM account address.
+     */
     async getEvmAccount() {
         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() {
-        const config = await this.getConfig();
+        const config = this.getConfig();
         const res = await (0, common_2.createPopup)((0, common_1.buildJoyIDURL)(config, "popup", "/auth"), {
             ...config,
             type: common_1.DappRequestType.Auth,
@@ -47,6 +76,10 @@ class EvmSigner extends core_1.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() {
         if (this.connection) {
             return true;
@@ -54,6 +87,11 @@ class EvmSigner extends core_1.ccc.SignerEvm {
         await this.restoreConnection();
         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) {
         const { address } = this.assertConnection();
         const challenge = typeof message === "string" ? message : core_1.ccc.hexFrom(message).slice(2);
@@ -66,12 +104,22 @@ class EvmSigner extends core_1.ccc.SignerEvm {
         }, "popup", "/sign-message"), { ...config, type: common_1.DappRequestType.SignMessage });
         return core_1.ccc.hexFrom(signature);
     }
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async saveConnection() {
         return this.connectionsRepo.set({
             uri: this.getConfig().joyidAppURL,
             addressType: "ethereum",
         }, this.connection);
     }
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
     async restoreConnection() {
         this.connection = await this.connectionsRepo.get({
             uri: this.getConfig().joyidAppURL,

package/dist.commonjs/nostr/index.d.ts

@@ -0,0 +1,51 @@
+import { ccc } from "@ckb-ccc/core";
+import { ConnectionsRepo } from "../connectionsStorage";
+/**
+ * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerNostr}
+ */
+export declare class NostrSigner extends ccc.SignerNostr {
+    private readonly name;
+    private readonly icon;
+    private readonly appUri;
+    private readonly connectionsRepo;
+    private 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;
+    /**
+     * 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, name: string, icon: string, appUri?: string, connectionsRepo?: ConnectionsRepo);
+    static isValidClient(client: ccc.Client): boolean;
+    replaceClient(client: ccc.Client): Promise<boolean>;
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
+    private getConfig;
+    /**
+     * Connects to the provider by requesting authentication.
+     * @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>;
+    getNostrPublicKey(): Promise<ccc.Hex>;
+    signNostrEvent(event: ccc.NostrEvent): Promise<Required<ccc.NostrEvent>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist.commonjs/nostr/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/nostr/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAGpC,OAAO,EAEL,eAAe,EAEhB,MAAM,uBAAuB,CAAC;AAE/B;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,GAAG,CAAC,WAAW;IA2B5C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,eAAe;IA7BlC,OAAO,CAAC,UAAU,CAAC,CAAa;IAEhC;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAQxB;;;;;;;OAOG;gBAED,MAAM,EAAE,GAAG,CAAC,MAAM,EACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,SAAuB,EAC7B,eAAe,GAAE,eAAmD;IAKvF,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO;IAI3C,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAOzD;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAUjB;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB9B;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAY/B,iBAAiB,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;IAQrC,cAAc,CAClB,KAAK,EAAE,GAAG,CAAC,UAAU,GACpB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;CAWrC"}

package/dist.commonjs/nostr/index.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NostrSigner = void 0;
+const core_1 = require("@ckb-ccc/core");
+const common_1 = require("@joyid/common");
+const common_2 = require("../common");
+const connectionsStorage_1 = require("../connectionsStorage");
+/**
+ * Class representing a Nostr signer that extends SignerNostr from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerNostr}
+ */
+class NostrSigner extends core_1.ccc.SignerNostr {
+    /**
+     * Ensures that the signer is connected and returns the connection.
+     * @private
+     * @throws Will throw an error if not connected.
+     * @returns {Connection} The current connection.
+     */
+    assertConnection() {
+        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, name, icon, appUri = "https://app.joy.id", connectionsRepo = new connectionsStorage_1.ConnectionsRepoLocalStorage()) {
+        super(client);
+        this.name = name;
+        this.icon = icon;
+        this.appUri = appUri;
+        this.connectionsRepo = connectionsRepo;
+    }
+    static isValidClient(client) {
+        return client.addressPrefix === "ckt";
+    }
+    async replaceClient(client) {
+        if (!NostrSigner.isValidClient(client)) {
+            return false;
+        }
+        return super.replaceClient(client);
+    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
+    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() {
+        const config = this.getConfig();
+        const res = await (0, common_2.createPopup)((0, common_1.buildJoyIDURL)(config, "popup", "/auth"), {
+            ...config,
+            type: common_1.DappRequestType.Auth,
+        });
+        this.connection = {
+            address: "",
+            publicKey: core_1.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() {
+        if (this.connection) {
+            return true;
+        }
+        this.connection = await this.connectionsRepo.get({
+            uri: this.appUri,
+            addressType: "nostr",
+        });
+        return this.connection !== undefined;
+    }
+    async getNostrPublicKey() {
+        if (!this.connection) {
+            throw new Error("Not connected");
+        }
+        return this.connection.publicKey;
+    }
+    async signNostrEvent(event) {
+        const config = this.getConfig();
+        const res = await (0, common_2.createPopup)((0, common_1.buildJoyIDURL)({ ...config, event }, "popup", "/sign-nostr-event"), {
+            ...config,
+            type: common_1.DappRequestType.SignNostrEvent,
+        });
+        return res.event;
+    }
+}
+exports.NostrSigner = NostrSigner;

package/dist.commonjs/signerFactory/index.d.ts

@@ -1,3 +1,12 @@
 import { ccc } from "@ckb-ccc/core";
+/**
+ * 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 declare function getJoyIdSigners(client: ccc.Client, name: string, icon: string): ccc.SignerInfo[];
 //# sourceMappingURL=index.d.ts.map

package/dist.commonjs/signerFactory/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAMpC,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,GAAG,CAAC,UAAU,EAAE,CA2BlB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/signerFactory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAOpC;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,GACX,GAAG,CAAC,UAAU,EAAE,CAwClB"}

package/dist.commonjs/signerFactory/index.js

@@ -1,13 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getJoyIdSigners = void 0;
+const core_1 = require("@ckb-ccc/core");
 const common_1 = require("@joyid/common");
 const btc_1 = require("../btc");
 const ckb_1 = require("../ckb");
 const evm_1 = require("../evm");
+const nostr_1 = require("../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.
+ */
 function getJoyIdSigners(client, name, icon) {
-    if ((0, common_1.isStandaloneBrowser)()) {
-        return [];
+    if ((0, common_1.isStandaloneBrowser)() || core_1.ccc.isWebview(window.navigator.userAgent)) {
+        return [core_1.ccc.SignerType.CKB, core_1.ccc.SignerType.EVM, core_1.ccc.SignerType.BTC].map((type) => ({
+            name: type,
+            signer: new core_1.ccc.SignerAlwaysError(client, type, "JoyID can only be used with standard browsers"),
+        }));
     }
     return [
         {
@@ -18,6 +32,10 @@ function getJoyIdSigners(client, name, icon) {
             name: "BTC",
             signer: new btc_1.BitcoinSigner(client, name, icon),
         },
+        {
+            name: "Nostr",
+            signer: new nostr_1.NostrSigner(client, name, icon),
+        },
         {
             name: "EVM",
             signer: new evm_1.EvmSigner(client, name, icon),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/joy-id",
-  "version": "0.0.5-alpha.7",
+  "version": "0.0.6-alpha.0",
   "description": "Connector's support for JoyID",
   "author": "Hanssen0 <hanssen0@hanssen0.com>",
   "license": "MIT",
@@ -38,9 +38,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@ckb-ccc/core": "0.0.5-alpha.2",
+    "@ckb-ccc/core": "0.0.6-alpha.0",
     "@joyid/ckb": "^0.0.11",
     "@joyid/common": "^0.0.3"
   },
-  "gitHead": "efbdcebedb8375237b3dd98be358ca7df9765cfd"
+  "gitHead": "2cbb4f450ed88e773a353a13ad006dbe6208f67f"
 }

package/src/btc/index.ts

@@ -7,10 +7,21 @@ import {
   ConnectionsRepoLocalStorage,
 } from "../connectionsStorage";
 
+/**
+ * Class representing a Bitcoin signer that extends SignerBtc from @ckb-ccc/core.
+ * @class
+ * @extends {ccc.SignerBtc}
+ */
 export class BitcoinSigner extends ccc.SignerBtc {
   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,15 @@ export class BitcoinSigner extends ccc.SignerBtc {
     return this.connection;
   }
 
+  /**
+   * Creates an instance of BitcoinSigner.
+   * @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 {"auto" | "p2wpkh" | "p2tr"} [addressType="auto"] - The address type.
+   * @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,
@@ -29,17 +49,11 @@ export class BitcoinSigner extends ccc.SignerBtc {
     super(client);
   }
 
-  async replaceClient(client: ccc.Client): Promise<BitcoinSigner> {
-    return new BitcoinSigner(
-      client,
-      this.name,
-      this.icon,
-      this.addressType,
-      this.appUri,
-      this.connectionsRepo,
-    );
-  }
-
+  /**
+   * Gets the configuration for JoyID.
+   * @private
+   * @returns {object} The configuration object.
+   */
   private getConfig() {
     return {
       redirectURL: location.href,
@@ -50,16 +64,28 @@ export class BitcoinSigner extends ccc.SignerBtc {
     };
   }
 
+  /**
+   * Gets the Bitcoin account address.
+   * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
+   */
   async getBtcAccount(): Promise<string> {
     const { address } = this.assertConnection();
     return address;
   }
 
+  /**
+   * Gets the Bitcoin public key.
+   * @returns {Promise<ccc.Hex>} A promise that resolves to the Bitcoin public key.
+   */
   async getBtcPublicKey(): Promise<ccc.Hex> {
     const { publicKey } = this.assertConnection();
     return publicKey;
   }
 
+  /**
+   * 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"), {
@@ -91,6 +117,10 @@ 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.
+   */
   async isConnected(): Promise<boolean> {
     if (this.connection) {
       return true;
@@ -103,6 +133,11 @@ export class BitcoinSigner extends ccc.SignerBtc {
     return this.connection !== undefined;
   }
 
+  /**
+   * 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 { address } = this.assertConnection();