@ckb-ccc/joy-id 0.0.8-alpha.3 → 0.0.9-alpha.0

package/dist.commonjs/nostr/index.js

@@ -11,116 +11,121 @@ const connectionsStorage_1 = require("../connectionsStorage");
  * @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");
+    /**
+     * 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;
     }
-    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;
+    /**
+     * Creates an instance of NostrSigner.
+     * @param client - The client instance.
+     * @param name - The name of the signer.
+     * @param icon - The icon URL of the signer.
+     * @param appUri - The application URI.
+     * @param connectionsRepo - The connections repository.
+     */
+    constructor(client, name, icon, _appUri, connectionsRepo = new connectionsStorage_1.ConnectionsRepoLocalStorage()) {
+        super(client);
+        this.name = name;
+        this.icon = icon;
+        this._appUri = _appUri;
+        this.connectionsRepo = connectionsRepo;
     }
-    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;
+    async replaceClient(client) {
+        if (!(await super.replaceClient(client))) {
+            return false;
+        }
+        this.connection = undefined;
+        return true;
+    }
+    /**
+     * Gets the configuration for JoyID.
+     * @private
+     * @returns {object} The configuration object.
+     */
+    getConfig() {
+        return {
+            redirectURL: location.href,
+            joyidAppURL: this._appUri ?? this.client.addressPrefix === "ckb"
+                ? "https://app.joy.id"
+                : "https://testnet.joyid.dev",
+            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.saveConnection();
+    }
+    async disconnect() {
+        await super.disconnect();
+        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() {
+        if (this.connection) {
+            return true;
+        }
+        await this.restoreConnection();
+        return this.connection !== undefined;
+    }
+    async getNostrPublicKey() {
+        return this.assertConnection().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;
+    }
+    /**
+     * Saves the current connection.
+     * @private
+     * @returns {Promise<void>}
+     */
+    async saveConnection() {
+        return this.connectionsRepo.set({
+            uri: this.getConfig().joyidAppURL,
+            addressType: "nostr",
+        }, this.connection);
+    }
+    /**
+     * Restores the previous connection.
+     * @private
+     * @returns {Promise<void>}
+     */
+    async restoreConnection() {
+        this.connection = await this.connectionsRepo.get({
+            uri: this.getConfig().joyidAppURL,
+            addressType: "nostr",
+        });
     }
-    this.connection = await this.connectionsRepo.get({
-      uri: this.appUri,
-      addressType: "nostr",
-    });
-    return this.connection !== undefined;
-  }
-  async getNostrPublicKey() {
-    return this.assertConnection().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

@@ -8,9 +8,5 @@ import { ccc } from "@ckb-ccc/core";
  * @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
+export declare function getJoyIdSigners(client: ccc.Client, name: string, icon: string, preferredNetworks: ccc.NetworkPreference[]): 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;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"}
+{"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,EACZ,iBAAiB,EAAE,GAAG,CAAC,iBAAiB,EAAE,GACzC,GAAG,CAAC,UAAU,EAAE,CA8ClB"}

package/dist.commonjs/signerFactory/index.js

@@ -16,49 +16,38 @@ const nostr_1 = require("../nostr");
  * @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)() ||
-    core_1.ccc.isWebview(window.navigator.userAgent)
-  ) {
+function getJoyIdSigners(client, name, icon, preferredNetworks) {
+    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 [
-      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 [
-    {
-      name: "CKB",
-      signer: new ckb_1.CkbSigner(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),
-    },
-    {
-      name: "BTC (P2WPKH)",
-      signer: new btc_1.BitcoinSigner(client, name, icon, "p2wpkh"),
-    },
-    {
-      name: "BTC (P2TR)",
-      signer: new btc_1.BitcoinSigner(client, name, icon, "p2tr"),
-    },
-  ];
+        {
+            name: "CKB",
+            signer: new ckb_1.CkbSigner(client, name, icon),
+        },
+        {
+            name: "BTC",
+            signer: new btc_1.BitcoinSigner(client, name, icon, preferredNetworks),
+        },
+        {
+            name: "Nostr",
+            signer: new nostr_1.NostrSigner(client, name, icon),
+        },
+        {
+            name: "EVM",
+            signer: new evm_1.EvmSigner(client, name, icon),
+        },
+        {
+            name: "BTC (P2WPKH)",
+            signer: new btc_1.BitcoinSigner(client, name, icon, preferredNetworks, "p2wpkh"),
+        },
+        {
+            name: "BTC (P2TR)",
+            signer: new btc_1.BitcoinSigner(client, name, icon, preferredNetworks, "p2tr"),
+        },
+    ];
 }
 exports.getJoyIdSigners = getJoyIdSigners;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckb-ccc/joy-id",
-  "version": "0.0.8-alpha.3",
+  "version": "0.0.9-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.8-alpha.3",
+    "@ckb-ccc/core": "0.0.9-alpha.0",
     "@joyid/ckb": "^1.0.0",
     "@joyid/common": "^0.2.0"
   },
-  "gitHead": "bddfa3e5631252194dfde32b79ee589703f18afb"
+  "gitHead": "ac4435006da9c9e48b3b66fc329e6f539156b252"
 }

package/src/btc/index.ts

@@ -14,6 +14,7 @@ import {
  */
 export class BitcoinSigner extends ccc.SignerBtc {
   private connection?: Connection;
+  private network = "btcTestnet";
 
   /**
    * Ensures that the signer is connected and returns the connection.
@@ -31,39 +32,76 @@ export class BitcoinSigner extends ccc.SignerBtc {
 
   /**
    * 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.
+   * @param client - The client instance.
+   * @param name - The name of the signer.
+   * @param icon - The icon URL of the signer.
+   * @param addressType - The address type.
+   * @param _appUri - The application URI.
+   * @param connectionsRepo - The connections repository.
    */
   constructor(
     client: ccc.Client,
-    private readonly name: string,
-    private readonly icon: string,
-    private readonly addressType: "auto" | "p2wpkh" | "p2tr" = "auto",
-    private readonly appUri = "https://app.joy.id",
+    public readonly name: string,
+    public readonly icon: string,
+    private readonly preferredNetworks: ccc.NetworkPreference[],
+    public readonly addressType: "auto" | "p2wpkh" | "p2tr" = "auto",
+    private readonly _appUri?: string,
     private readonly connectionsRepo: ConnectionsRepo = new ConnectionsRepoLocalStorage(),
   ) {
     super(client);
   }
 
+  async replaceClient(client: ccc.Client): Promise<boolean> {
+    if (!(await super.replaceClient(client))) {
+      return false;
+    }
+    this.connection = undefined;
+    return true;
+  }
+
   /**
    * Gets the configuration for JoyID.
    * @private
-   * @returns {object} The configuration object.
+   * @returns The configuration object.
    */
   private getConfig() {
+    const { network } = this.matchNetworkPreference(
+      this.preferredNetworks,
+      this.network,
+    ) ?? { network: this.network };
+    if (this.network !== network) {
+      this.connection = undefined;
+    }
+    this.network = network;
+
+    const url = {
+      btc: "https://app.joy.id",
+      btcTestnet: "https://testnet.joyid.dev",
+    }[network];
+    if (!url) {
+      throw new Error(
+        `JoyID wallet doesn't support the requested chain ${this.network}`,
+      );
+    }
+
     return {
       redirectURL: location.href,
-      joyidAppURL: this.appUri,
+      joyidAppURL: this._appUri ?? url,
       requestNetwork: `btc-${this.addressType}`,
       name: this.name,
       logo: this.icon,
     };
   }
 
+  async disconnect(): Promise<void> {
+    await super.disconnect();
+
+    await this.connectionsRepo.set(
+      { uri: this.getConfig().joyidAppURL, addressType: "btc" },
+      undefined,
+    );
+  }
+
   /**
    * Gets the Bitcoin account address.
    * @returns {Promise<string>} A promise that resolves to the Bitcoin account address.
@@ -107,11 +145,11 @@ export class BitcoinSigner extends ccc.SignerBtc {
     };
     await Promise.all([
       this.connectionsRepo.set(
-        { uri: this.appUri, addressType: `btc-${res.btcAddressType}` },
+        { uri: config.joyidAppURL, addressType: `btc-${res.btcAddressType}` },
         this.connection,
       ),
       this.connectionsRepo.set(
-        { uri: this.appUri, addressType: "btc-auto" },
+        { uri: config.joyidAppURL, addressType: "btc-auto" },
         this.connection,
       ),
     ]);
@@ -127,7 +165,7 @@ export class BitcoinSigner extends ccc.SignerBtc {
     }
 
     this.connection = await this.connectionsRepo.get({
-      uri: this.appUri,
+      uri: this.getConfig().joyidAppURL,
       addressType: `btc-${this.addressType}`,
     });
     return this.connection !== undefined;

package/src/ckb/index.ts

@@ -66,10 +66,18 @@ export class CkbSigner extends ccc.Signer {
     super(client);
   }
 
+  async replaceClient(client: ccc.Client): Promise<boolean> {
+    if (!(await super.replaceClient(client))) {
+      return false;
+    }
+    this.connection = undefined;
+    return true;
+  }
+
   /**
    * Gets the configuration for JoyID.
    * @private
-   * @returns {object} The configuration object.
+   * @returns The configuration object.
    */
   private getConfig() {
     return {
@@ -118,6 +126,13 @@ export class CkbSigner extends ccc.Signer {
     await this.saveConnection();
   }
 
+  async disconnect(): Promise<void> {
+    await super.disconnect();
+
+    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.
@@ -210,7 +225,7 @@ export class CkbSigner extends ccc.Signer {
       return [];
     }
 
-    const pubkeyHash = ccc.ckbHash(this.connection.publicKey).substring(0, 42);
+    const pubkeyHash = ccc.hashCkb(this.connection.publicKey).substring(0, 42);
     const lock = (await this.getAddressObj()).script;
     const aggregator = new Aggregator(this.getAggregatorUri());
     const { unlock_entry: unlockEntry } =

package/src/connectionsStorage/index.ts

@@ -17,8 +17,11 @@ export type AccountSelector = {
  * @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;
+export function isSelectorMatch(
+  a: AccountSelector,
+  filter: AccountSelector,
+): boolean {
+  return a.uri === filter.uri && a.addressType.startsWith(filter.addressType);
 }
 
 /**
@@ -85,7 +88,7 @@ export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
    */
   async get(selector: AccountSelector): Promise<Connection | undefined> {
     return (await this.readConnections()).find(([s]) =>
-      isSelectorEq(selector, s),
+      isSelectorMatch(selector, s),
     )?.[1];
   }
 
@@ -102,7 +105,7 @@ export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
     const connections = await this.readConnections();
 
     if (connection) {
-      const existed = connections.find(([s]) => isSelectorEq(s, selector));
+      const existed = connections.find(([s]) => isSelectorMatch(s, selector));
       if (existed) {
         existed[1] = connection;
       } else {
@@ -112,7 +115,9 @@ export class ConnectionsRepoLocalStorage implements ConnectionsRepo {
     } else {
       window.localStorage.setItem(
         this.storageKey,
-        JSON.stringify(connections.filter(([s]) => !isSelectorEq(s, selector))),
+        JSON.stringify(
+          connections.filter(([s]) => !isSelectorMatch(s, selector)),
+        ),
       );
     }
   }

package/src/evm/index.ts

@@ -31,22 +31,30 @@ export class EvmSigner extends ccc.SignerEvm {
 
   /**
    * 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.
+   * @param client - The client instance.
+   * @param name - The name of the signer.
+   * @param icon - The icon URL of the signer.
+   * @param appUri - The application URI.
+   * @param connectionsRepo - The connections repository.
    */
   constructor(
     client: ccc.Client,
     private readonly name: string,
     private readonly icon: string,
-    private readonly appUri = "https://app.joy.id",
+    private readonly _appUri?: string,
     private readonly connectionsRepo: ConnectionsRepo = new ConnectionsRepoLocalStorage(),
   ) {
     super(client);
   }
 
+  async replaceClient(client: ccc.Client): Promise<boolean> {
+    if (!(await super.replaceClient(client))) {
+      return false;
+    }
+    this.connection = undefined;
+    return true;
+  }
+
   /**
    * Gets the configuration for JoyID.
    * @private
@@ -55,7 +63,10 @@ export class EvmSigner extends ccc.SignerEvm {
   private getConfig() {
     return {
       redirectURL: location.href,
-      joyidAppURL: this.appUri,
+      joyidAppURL:
+        this._appUri ?? this.client.addressPrefix === "ckb"
+          ? "https://app.joy.id"
+          : "https://testnet.joyid.dev",
       requestNetwork: `ethereum`,
       name: this.name,
       logo: this.icon,
@@ -90,6 +101,13 @@ export class EvmSigner extends ccc.SignerEvm {
     await this.saveConnection();
   }
 
+  async disconnect(): Promise<void> {
+    await super.disconnect();
+
+    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.