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

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.

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.

package/src/nostr/index.ts

@@ -31,24 +31,28 @@ export class NostrSigner extends ccc.SignerNostr {
 
   /**
    * 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.
+   * @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> {
-    return super.replaceClient(client);
+    if (!(await super.replaceClient(client))) {
+      return false;
+    }
+    this.connection = undefined;
+    return true;
   }
 
   /**
@@ -59,7 +63,10 @@ export class NostrSigner extends ccc.SignerNostr {
   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: "nostr",
       name: this.name,
       logo: this.icon,
@@ -82,10 +89,14 @@ export class NostrSigner extends ccc.SignerNostr {
       publicKey: ccc.hexFrom(res.nostrPubkey),
       keyType: res.keyType,
     };
-    await this.connectionsRepo.set(
-      { uri: this.appUri, addressType: "nostr" },
-      this.connection,
-    );
+    await this.saveConnection();
+  }
+
+  async disconnect(): Promise<void> {
+    await super.disconnect();
+
+    this.connection = undefined;
+    await this.saveConnection();
   }
 
   /**
@@ -97,10 +108,7 @@ export class NostrSigner extends ccc.SignerNostr {
       return true;
     }
 
-    this.connection = await this.connectionsRepo.get({
-      uri: this.appUri,
-      addressType: "nostr",
-    });
+    await this.restoreConnection();
     return this.connection !== undefined;
   }
 
@@ -121,4 +129,31 @@ export class NostrSigner extends ccc.SignerNostr {
     );
     return res.event;
   }
+
+  /**
+   * Saves the current connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async saveConnection(): Promise<void> {
+    return this.connectionsRepo.set(
+      {
+        uri: this.getConfig().joyidAppURL,
+        addressType: "nostr",
+      },
+      this.connection,
+    );
+  }
+
+  /**
+   * Restores the previous connection.
+   * @private
+   * @returns {Promise<void>}
+   */
+  private async restoreConnection(): Promise<void> {
+    this.connection = await this.connectionsRepo.get({
+      uri: this.getConfig().joyidAppURL,
+      addressType: "nostr",
+    });
+  }
 }

package/src/signerFactory/index.ts

@@ -18,6 +18,7 @@ export function getJoyIdSigners(
   client: ccc.Client,
   name: string,
   icon: string,
+  preferredNetworks: ccc.NetworkPreference[],
 ): ccc.SignerInfo[] {
   if (isStandaloneBrowser() || ccc.isWebview(window.navigator.userAgent)) {
     return [ccc.SignerType.CKB, ccc.SignerType.EVM, ccc.SignerType.BTC].map(
@@ -39,7 +40,7 @@ export function getJoyIdSigners(
     },
     {
       name: "BTC",
-      signer: new BitcoinSigner(client, name, icon),
+      signer: new BitcoinSigner(client, name, icon, preferredNetworks),
     },
     {
       name: "Nostr",
@@ -51,11 +52,17 @@ export function getJoyIdSigners(
     },
     {
       name: "BTC (P2WPKH)",
-      signer: new BitcoinSigner(client, name, icon, "p2wpkh"),
+      signer: new BitcoinSigner(
+        client,
+        name,
+        icon,
+        preferredNetworks,
+        "p2wpkh",
+      ),
     },
     {
       name: "BTC (P2TR)",
-      signer: new BitcoinSigner(client, name, icon, "p2tr"),
+      signer: new BitcoinSigner(client, name, icon, preferredNetworks, "p2tr"),
     },
   ];
 }