@aptos-labs/wallet-adapter-core 2.3.3 → 2.5.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @aptos-labs/wallet-adapter-core
 
+## 2.5.0
+
+### Minor Changes
+
+- c95933a: Update the `onNetworkChange` type interface to conform with `WalletCore`'s usage of the callback
+
+## 2.4.0
+
+### Minor Changes
+
+- d2a0bbd: Support error message on connect and disconnect functions
+
+### Patch Changes
+
+- b0586e8: Separate connect and connectWallet for SRP
+
 ## 2.3.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -45,6 +45,7 @@ interface AptosWalletErrorResult {
     name: string;
     message: string;
 }
+declare type OnNetworkChange = (callBack: (networkInfo: NetworkInfo) => Promise<void>) => Promise<void>;
 interface PluginProvider {
     connect: () => Promise<AccountInfo>;
     account: () => Promise<AccountInfo>;
@@ -55,12 +56,10 @@ interface PluginProvider {
     signMessage: (message: SignMessagePayload) => Promise<SignMessageResponse>;
     network: () => Promise<NetworkName>;
     onAccountChange: (listener: (newAddress: AccountInfo) => Promise<void>) => Promise<void>;
-    onNetworkChange: (listener: (network: {
-        networkName: NetworkInfo;
-    }) => Promise<void>) => Promise<void>;
+    onNetworkChange: OnNetworkChange;
 }
 interface AdapterPluginEvents {
-    onNetworkChange(callback: any): Promise<any>;
+    onNetworkChange: OnNetworkChange;
     onAccountChange(callback: any): Promise<any>;
 }
 interface AdapterPluginProps<Name extends string = string> {
@@ -155,16 +154,21 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
      */
     get network(): NetworkInfo | null;
     /**
-    Connects a wallet to the app. If a wallet is already connected,
-    we first disconnect the current connected wallet and then connect the selected wallet.
-    On connect success, we set the current account and the network, and keeping the selected wallet
-    name in LocalStorage to support autoConnect function.
-  
-    @param walletName. The wallet name we want to connect as a WalletName type.
-    @emit emits "connect" event
-    @throws WalletConnectionError
-    */
+     * We first make sure we can connect a dapp to a wallet.
+     * If all good, we connect the wallet by calling `this.connectWallet`
+     * @param walletName. The wallet name we want to connect.
+     */
     connect(walletName: WalletName): Promise<void | string>;
+    /**
+     * Connects a wallet to the dapp.
+     * On connect success, we set the current account and the network, and keeping the selected wallet
+     * name in LocalStorage to support autoConnect function.
+     *
+     * @param selectedWallet. The wallet we want to connect.
+     * @emit emits "connect" event
+     * @throws WalletConnectionError
+     */
+    connectWallet(selectedWallet: Wallet): Promise<void>;
     /**
     Disconnect the exisitng wallet. On success, we clear the
     current account, current network and LocalStorage data.
@@ -228,4 +232,4 @@ declare function isMobile(): boolean;
 declare function isInAppBrowser(): boolean;
 declare function isRedirectable(): boolean;
 
-export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, PluginProvider, SignMessagePayload, SignMessageResponse, TransactionOptions, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };
+export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, OnNetworkChange, PluginProvider, SignMessagePayload, SignMessageResponse, TransactionOptions, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };

package/dist/index.js

@@ -335,30 +335,32 @@ var WalletCore = class extends import_eventemitter3.default {
     }
   }
   async connect(walletName) {
-    var _a, _b;
-    try {
-      const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
-        (wallet) => wallet.name === walletName
-      );
-      if (!selectedWallet)
-        return;
-      if (this._connected) {
-        if (((_b = this.wallet) == null ? void 0 : _b.name) === walletName)
-          throw new WalletConnectionError(
-            `${walletName} wallet is already connected`
-          ).message;
-        await this.disconnect();
-      }
-      if (isRedirectable()) {
-        if (selectedWallet.deeplinkProvider) {
-          const url = encodeURIComponent(window.location.href);
-          const location = selectedWallet.deeplinkProvider({ url });
-          window.location.href = location;
-        }
-      }
-      if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
-        return;
+    var _a;
+    const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
+      (wallet) => wallet.name === walletName
+    );
+    if (!selectedWallet)
+      return;
+    if (this._connected) {
+      if (selectedWallet.name === walletName)
+        throw new WalletConnectionError(
+          `${walletName} wallet is already connected`
+        ).message;
+    }
+    if (isRedirectable()) {
+      if (selectedWallet.deeplinkProvider) {
+        const url = encodeURIComponent(window.location.href);
+        const location = selectedWallet.deeplinkProvider({ url });
+        window.location.href = location;
       }
+    }
+    if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+      return;
+    }
+    await this.connectWallet(selectedWallet);
+  }
+  async connectWallet(selectedWallet) {
+    try {
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -371,7 +373,8 @@ var WalletCore = class extends import_eventemitter3.default {
       this.emit("connect", account);
     } catch (error) {
       this.clearData();
-      throw new WalletConnectionError(error).message;
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletConnectionError(errMsg).message;
     } finally {
       this._connecting = false;
     }
@@ -384,7 +387,8 @@ var WalletCore = class extends import_eventemitter3.default {
       this.clearData();
       this.emit("disconnect");
     } catch (error) {
-      throw new WalletDisconnectionError(error).message;
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletDisconnectionError(errMsg).message;
     }
   }
   async signAndSubmitTransaction(transaction, options) {
@@ -429,7 +433,10 @@ var WalletCore = class extends import_eventemitter3.default {
     }
     try {
       this.doesWalletExist();
-      const response = await this._wallet.signTransaction(transaction, options);
+      const response = await this._wallet.signTransaction(
+        transaction,
+        options
+      );
       return response;
     } catch (error) {
       const errMsg = typeof error == "object" && "message" in error ? error.message : error;

package/dist/index.mjs

@@ -294,30 +294,32 @@ var WalletCore = class extends EventEmitter {
     }
   }
   async connect(walletName) {
-    var _a, _b;
-    try {
-      const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
-        (wallet) => wallet.name === walletName
-      );
-      if (!selectedWallet)
-        return;
-      if (this._connected) {
-        if (((_b = this.wallet) == null ? void 0 : _b.name) === walletName)
-          throw new WalletConnectionError(
-            `${walletName} wallet is already connected`
-          ).message;
-        await this.disconnect();
-      }
-      if (isRedirectable()) {
-        if (selectedWallet.deeplinkProvider) {
-          const url = encodeURIComponent(window.location.href);
-          const location = selectedWallet.deeplinkProvider({ url });
-          window.location.href = location;
-        }
-      }
-      if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
-        return;
+    var _a;
+    const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
+      (wallet) => wallet.name === walletName
+    );
+    if (!selectedWallet)
+      return;
+    if (this._connected) {
+      if (selectedWallet.name === walletName)
+        throw new WalletConnectionError(
+          `${walletName} wallet is already connected`
+        ).message;
+    }
+    if (isRedirectable()) {
+      if (selectedWallet.deeplinkProvider) {
+        const url = encodeURIComponent(window.location.href);
+        const location = selectedWallet.deeplinkProvider({ url });
+        window.location.href = location;
       }
+    }
+    if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+      return;
+    }
+    await this.connectWallet(selectedWallet);
+  }
+  async connectWallet(selectedWallet) {
+    try {
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -330,7 +332,8 @@ var WalletCore = class extends EventEmitter {
       this.emit("connect", account);
     } catch (error) {
       this.clearData();
-      throw new WalletConnectionError(error).message;
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletConnectionError(errMsg).message;
     } finally {
       this._connecting = false;
     }
@@ -343,7 +346,8 @@ var WalletCore = class extends EventEmitter {
       this.clearData();
       this.emit("disconnect");
     } catch (error) {
-      throw new WalletDisconnectionError(error).message;
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletDisconnectionError(errMsg).message;
     }
   }
   async signAndSubmitTransaction(transaction, options) {
@@ -388,7 +392,10 @@ var WalletCore = class extends EventEmitter {
     }
     try {
       this.doesWalletExist();
-      const response = await this._wallet.signTransaction(transaction, options);
+      const response = await this._wallet.signTransaction(
+        transaction,
+        options
+      );
       return response;
     } catch (error) {
       const errMsg = typeof error == "object" && "message" in error ? error.message : error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-core",
-  "version": "2.3.3",
+  "version": "2.5.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/WalletCore.ts

@@ -172,51 +172,58 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
-  /** 
-  Connects a wallet to the app. If a wallet is already connected,
-  we first disconnect the current connected wallet and then connect the selected wallet.
-  On connect success, we set the current account and the network, and keeping the selected wallet
-  name in LocalStorage to support autoConnect function.
-
-  @param walletName. The wallet name we want to connect as a WalletName type.
-  @emit emits "connect" event
-  @throws WalletConnectionError
-  */
+  /**
+   * We first make sure we can connect a dapp to a wallet.
+   * If all good, we connect the wallet by calling `this.connectWallet`
+   * @param walletName. The wallet name we want to connect.
+   */
   async connect(walletName: WalletName): Promise<void | string> {
-    try {
-      const selectedWallet = this._wallets?.find(
-        (wallet: Wallet) => wallet.name === walletName
-      );
-
-      if (!selectedWallet) return;
-
-      if (this._connected) {
-        // if the selected wallet is already connected, we don't need to connect again
-        if (this.wallet?.name === walletName)
-          throw new WalletConnectionError(
-            `${walletName} wallet is already connected`
-          ).message;
+    const selectedWallet = this._wallets?.find(
+      (wallet: Wallet) => wallet.name === walletName
+    );
+
+    if (!selectedWallet) return;
+
+    if (this._connected) {
+      // if the selected wallet is already connected, we don't need to connect again
+      if (selectedWallet.name === walletName)
+        throw new WalletConnectionError(
+          `${walletName} wallet is already connected`
+        ).message;
+    }
 
-        await this.disconnect();
+    // check if we are in a redirectable view (i.e on mobile AND not in an in-app browser) and
+    // since wallet readyState can be NotDetected, we check it before the next check
+    if (isRedirectable()) {
+      // use wallet deep link
+      if (selectedWallet.deeplinkProvider) {
+        const url = encodeURIComponent(window.location.href);
+        const location = selectedWallet.deeplinkProvider({ url });
+        window.location.href = location;
       }
+    }
+    if (
+      selectedWallet.readyState !== WalletReadyState.Installed &&
+      selectedWallet.readyState !== WalletReadyState.Loadable
+    ) {
+      return;
+    }
 
-      // check if we are in a redirectable view (i.e on mobile AND not in an in-app browser) and
-      // since wallet readyState can be NotDetected, we check it before the next check
-      if (isRedirectable()) {
-        // use wallet deep link
-        if (selectedWallet.deeplinkProvider) {
-          const url = encodeURIComponent(window.location.href);
-          const location = selectedWallet.deeplinkProvider({ url });
-          window.location.href = location;
-        }
-      }
-      if (
-        selectedWallet.readyState !== WalletReadyState.Installed &&
-        selectedWallet.readyState !== WalletReadyState.Loadable
-      ) {
-        return;
-      }
+    // Now we can connect to the wallet
+    await this.connectWallet(selectedWallet);
+  }
 
+  /**
+   * Connects a wallet to the dapp.
+   * On connect success, we set the current account and the network, and keeping the selected wallet
+   * name in LocalStorage to support autoConnect function.
+   *
+   * @param selectedWallet. The wallet we want to connect.
+   * @emit emits "connect" event
+   * @throws WalletConnectionError
+   */
+  async connectWallet(selectedWallet: Wallet) {
+    try {
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -229,7 +236,9 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       this.emit("connect", account);
     } catch (error: any) {
       this.clearData();
-      throw new WalletConnectionError(error).message;
+      const errMsg =
+        typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletConnectionError(errMsg).message;
     } finally {
       this._connecting = false;
     }
@@ -248,7 +257,9 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       this.clearData();
       this.emit("disconnect");
     } catch (error: any) {
-      throw new WalletDisconnectionError(error).message;
+      const errMsg =
+        typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletDisconnectionError(errMsg).message;
     }
   }
 
@@ -327,7 +338,10 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
 
     try {
       this.doesWalletExist();
-      const response = await (this._wallet as any).signTransaction(transaction, options);
+      const response = await (this._wallet as any).signTransaction(
+        transaction,
+        options
+      );
       return response;
     } catch (error: any) {
       const errMsg =

package/src/types.ts

@@ -24,6 +24,10 @@ export interface AptosWalletErrorResult {
   message: string;
 }
 
+export type OnNetworkChange = (
+  callBack: (networkInfo: NetworkInfo) => Promise<void>
+) => Promise<void>;
+
 export interface PluginProvider {
   connect: () => Promise<AccountInfo>;
   account: () => Promise<AccountInfo>;
@@ -37,13 +41,11 @@ export interface PluginProvider {
   onAccountChange: (
     listener: (newAddress: AccountInfo) => Promise<void>
   ) => Promise<void>;
-  onNetworkChange: (
-    listener: (network: { networkName: NetworkInfo }) => Promise<void>
-  ) => Promise<void>;
+  onNetworkChange: OnNetworkChange;
 }
 
 export interface AdapterPluginEvents {
-  onNetworkChange(callback: any): Promise<any>;
+  onNetworkChange: OnNetworkChange;
   onAccountChange(callback: any): Promise<any>;
 }
 
@@ -110,4 +112,4 @@ export interface SignMessageResponse {
 export interface TransactionOptions {
   max_gas_amount?: bigint;
   gas_unit_price?: bigint;
-}
+}