@aptos-labs/wallet-adapter-core 2.3.2 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @aptos-labs/wallet-adapter-core
 
+## 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
+
+- dc98bf4: fix sendAndSubmitTransaction params
+
 ## 2.3.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -114,6 +114,10 @@ interface SignMessageResponse {
     signature: string | string[];
     bitmap?: Uint8Array;
 }
+interface TransactionOptions {
+    max_gas_amount?: bigint;
+    gas_unit_price?: bigint;
+}
 
 declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private _wallets;
@@ -151,16 +155,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.
@@ -171,24 +180,27 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     /**
     Sign and submit an entry (not bcs serialized) transaction type to chain.
     @param transaction a non-bcs serialized transaction
+    @param options max_gas_amount and gas_unit_limit
     @return response from the wallet's signAndSubmitTransaction function
     @throws WalletSignAndSubmitMessageError
     */
-    signAndSubmitTransaction(transaction: Types.TransactionPayload): Promise<any>;
+    signAndSubmitTransaction(transaction: Types.TransactionPayload, options?: TransactionOptions): Promise<any>;
     /**
     Sign and submit a bsc serialized transaction type to chain.
     @param transaction a bcs serialized transaction
+    @param options max_gas_amount and gas_unit_limit
     @return response from the wallet's signAndSubmitBCSTransaction function
     @throws WalletSignAndSubmitMessageError
     */
-    signAndSubmitBCSTransaction(transaction: TxnBuilderTypes.TransactionPayload): Promise<any>;
+    signAndSubmitBCSTransaction(transaction: TxnBuilderTypes.TransactionPayload, options?: TransactionOptions): Promise<any>;
     /**
     Sign transaction (doesnt submit to chain).
     @param transaction
+    @param options max_gas_amount and gas_unit_limit
     @return response from the wallet's signTransaction function
     @throws WalletSignTransactionError
     */
-    signTransaction(transaction: Types.TransactionPayload): Promise<Uint8Array | null>;
+    signTransaction(transaction: Types.TransactionPayload, options?: TransactionOptions): Promise<Uint8Array | null>;
     /**
     Sign message (doesnt submit to chain).
     @param message
@@ -221,4 +233,4 @@ declare function isMobile(): boolean;
 declare function isInAppBrowser(): boolean;
 declare function isRedirectable(): boolean;
 
-export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, PluginProvider, SignMessagePayload, SignMessageResponse, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState, getLocalStorage, isInAppBrowser, isMobile, isRedirectable, removeLocalStorage, scopePollingDetectionStrategy, setLocalStorage };
+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 };

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,15 +387,17 @@ 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) {
+  async signAndSubmitTransaction(transaction, options) {
     var _a;
     try {
       this.doesWalletExist();
       const response = await ((_a = this._wallet) == null ? void 0 : _a.signAndSubmitTransaction(
-        transaction
+        transaction,
+        options
       ));
       return response;
     } catch (error) {
@@ -400,7 +405,7 @@ var WalletCore = class extends import_eventemitter3.default {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
-  async signAndSubmitBCSTransaction(transaction) {
+  async signAndSubmitBCSTransaction(transaction, options) {
     var _a;
     if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -410,7 +415,8 @@ var WalletCore = class extends import_eventemitter3.default {
     try {
       this.doesWalletExist();
       const response = await this._wallet.signAndSubmitBCSTransaction(
-        transaction
+        transaction,
+        options
       );
       return response;
     } catch (error) {
@@ -418,7 +424,7 @@ var WalletCore = class extends import_eventemitter3.default {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
-  async signTransaction(transaction) {
+  async signTransaction(transaction, options) {
     var _a;
     if (this._wallet && !("signTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -427,7 +433,10 @@ var WalletCore = class extends import_eventemitter3.default {
     }
     try {
       this.doesWalletExist();
-      const response = await this._wallet.signTransaction(transaction);
+      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,15 +346,17 @@ 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) {
+  async signAndSubmitTransaction(transaction, options) {
     var _a;
     try {
       this.doesWalletExist();
       const response = await ((_a = this._wallet) == null ? void 0 : _a.signAndSubmitTransaction(
-        transaction
+        transaction,
+        options
       ));
       return response;
     } catch (error) {
@@ -359,7 +364,7 @@ var WalletCore = class extends EventEmitter {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
-  async signAndSubmitBCSTransaction(transaction) {
+  async signAndSubmitBCSTransaction(transaction, options) {
     var _a;
     if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -369,7 +374,8 @@ var WalletCore = class extends EventEmitter {
     try {
       this.doesWalletExist();
       const response = await this._wallet.signAndSubmitBCSTransaction(
-        transaction
+        transaction,
+        options
       );
       return response;
     } catch (error) {
@@ -377,7 +383,7 @@ var WalletCore = class extends EventEmitter {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
-  async signTransaction(transaction) {
+  async signTransaction(transaction, options) {
     var _a;
     if (this._wallet && !("signTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -386,7 +392,10 @@ var WalletCore = class extends EventEmitter {
     }
     try {
       this.doesWalletExist();
-      const response = await this._wallet.signTransaction(transaction);
+      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.2",
+  "version": "2.4.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/WalletCore.ts

@@ -29,6 +29,7 @@ import {
   Wallet,
   WalletInfo,
   WalletCoreEvents,
+  TransactionOptions,
 } from "./types";
 import {
   removeLocalStorage,
@@ -171,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();
@@ -228,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;
     }
@@ -247,23 +257,28 @@ 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;
     }
   }
 
   /** 
   Sign and submit an entry (not bcs serialized) transaction type to chain.
   @param transaction a non-bcs serialized transaction
+  @param options max_gas_amount and gas_unit_limit
   @return response from the wallet's signAndSubmitTransaction function
   @throws WalletSignAndSubmitMessageError
   */
   async signAndSubmitTransaction(
-    transaction: Types.TransactionPayload
+    transaction: Types.TransactionPayload,
+    options?: TransactionOptions
   ): Promise<any> {
     try {
       this.doesWalletExist();
       const response = await this._wallet?.signAndSubmitTransaction(
-        transaction
+        transaction,
+        options
       );
       return response;
     } catch (error: any) {
@@ -276,11 +291,13 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   /** 
   Sign and submit a bsc serialized transaction type to chain.
   @param transaction a bcs serialized transaction
+  @param options max_gas_amount and gas_unit_limit
   @return response from the wallet's signAndSubmitBCSTransaction function
   @throws WalletSignAndSubmitMessageError
   */
   async signAndSubmitBCSTransaction(
-    transaction: TxnBuilderTypes.TransactionPayload
+    transaction: TxnBuilderTypes.TransactionPayload,
+    options?: TransactionOptions
   ): Promise<any> {
     if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -291,7 +308,8 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     try {
       this.doesWalletExist();
       const response = await (this._wallet as any).signAndSubmitBCSTransaction(
-        transaction
+        transaction,
+        options
       );
       return response;
     } catch (error: any) {
@@ -304,11 +322,13 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   /** 
   Sign transaction (doesnt submit to chain).
   @param transaction
+  @param options max_gas_amount and gas_unit_limit
   @return response from the wallet's signTransaction function
   @throws WalletSignTransactionError
   */
   async signTransaction(
-    transaction: Types.TransactionPayload
+    transaction: Types.TransactionPayload,
+    options?: TransactionOptions
   ): Promise<Uint8Array | null> {
     if (this._wallet && !("signTransaction" in this._wallet)) {
       throw new WalletNotSupportedMethod(
@@ -318,7 +338,10 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
 
     try {
       this.doesWalletExist();
-      const response = await (this._wallet as any).signTransaction(transaction);
+      const response = await (this._wallet as any).signTransaction(
+        transaction,
+        options
+      );
       return response;
     } catch (error: any) {
       const errMsg =

package/src/types.ts

@@ -106,3 +106,8 @@ export interface SignMessageResponse {
   signature: string | string[]; // The signed full message
   bitmap?: Uint8Array; // a 4-byte (32 bits) bit-vector of length N
 }
+
+export interface TransactionOptions {
+  max_gas_amount?: bigint;
+  gas_unit_price?: bigint;
+}