@aptos-labs/wallet-adapter-core 2.0.1 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @aptos-labs/wallet-adapter-core
 
+## 2.2.0
+
+### Minor Changes
+
+- 814939c: Add deeplink support
+
+## 2.1.0
+
+### Minor Changes
+
+- 50968c4: Support to submit bcs serialized transactions
+
+### Patch Changes
+
+- 8dea640: Fix wallet adapter auto reconnect on page refresh
+
 ## 1.0.0
 
 ### Major Changes

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Types } from 'aptos';
+import { Types, TxnBuilderTypes } from 'aptos';
 import EventEmitter from 'eventemitter3';
 
 declare enum WalletReadyState {
@@ -69,6 +69,9 @@ interface AdapterPluginProps<Name extends string = string> {
     icon: `data:image/${"svg+xml" | "webp" | "png" | "gif"};base64,${string}`;
     providerName?: string;
     provider: any;
+    deeplinkProvider?: (data: {
+        url: string;
+    }) => string;
     connect(): Promise<any>;
     disconnect: () => Promise<any>;
     network: () => Promise<any>;
@@ -166,13 +169,20 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     */
     disconnect(): Promise<void>;
     /**
-    Sign and submit transaction to chain.
-    @param transaction
+    Sign and submit an entry (not bcs serialized) transaction type to chain.
+    @param transaction a non-bcs serialized transaction
     @return response from the wallet's signAndSubmitTransaction function
     @throws WalletSignAndSubmitMessageError
     */
     signAndSubmitTransaction(transaction: Types.TransactionPayload): Promise<any>;
     /**
+    Sign and submit a bsc serialized transaction type to chain.
+    @param transaction a bcs serialized transaction
+    @return response from the wallet's signAndSubmitBCSTransaction function
+    @throws WalletSignAndSubmitMessageError
+    */
+    signAndSubmitBCSTransaction(transaction: TxnBuilderTypes.TransactionPayload): Promise<any>;
+    /**
     Sign transaction (doesnt submit to chain).
     @param transaction
     @return response from the wallet's signTransaction function
@@ -201,4 +211,14 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     signMessageAndVerify(message: SignMessagePayload): Promise<boolean>;
 }
 
-export { AccountInfo, AdapterPlugin, AdapterPluginEvents, AdapterPluginProps, AptosWalletErrorResult, NetworkInfo, NetworkName, PluginProvider, SignMessagePayload, SignMessageResponse, Wallet, WalletCore, WalletCoreEvents, WalletInfo, WalletName, WalletReadyState };
+declare function scopePollingDetectionStrategy(detect: () => boolean): void;
+
+declare function setLocalStorage(walletName: WalletName): void;
+declare function removeLocalStorage(): void;
+declare function getLocalStorage(): void;
+
+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 };

package/dist/index.js

@@ -28,7 +28,14 @@ var src_exports = {};
 __export(src_exports, {
   NetworkName: () => NetworkName,
   WalletCore: () => WalletCore,
-  WalletReadyState: () => WalletReadyState
+  WalletReadyState: () => WalletReadyState,
+  getLocalStorage: () => getLocalStorage,
+  isInAppBrowser: () => isInAppBrowser,
+  isMobile: () => isMobile,
+  isRedirectable: () => isRedirectable,
+  removeLocalStorage: () => removeLocalStorage,
+  scopePollingDetectionStrategy: () => scopePollingDetectionStrategy,
+  setLocalStorage: () => setLocalStorage
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -183,6 +190,30 @@ function setLocalStorage(walletName) {
 function removeLocalStorage() {
   localStorage.removeItem(LOCAL_STORAGE_ITEM_KEY);
 }
+function getLocalStorage() {
+  localStorage.getItem(LOCAL_STORAGE_ITEM_KEY);
+}
+
+// src/utils/helpers.ts
+function isMobile() {
+  return /Mobile|iP(hone|od|ad)|Android|BlackBerry|IEMobile|Kindle|NetFront|Silk-Accelerated|(hpw|web)OS|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dolfin|Dolphin|Skyfire|Zune/i.test(
+    navigator.userAgent
+  );
+}
+function isInAppBrowser() {
+  const isIphone = /(iPhone|iPod|iPad).*AppleWebKit(?!.*Safari)/i.test(
+    navigator.userAgent
+  );
+  const isAndroid = /(Android).*Version\/[\d.]+.*Chrome\/[^\s]+ Mobile/i.test(
+    navigator.userAgent
+  );
+  return isIphone || isAndroid;
+}
+function isRedirectable() {
+  if (!navigator)
+    return false;
+  return isMobile() && !isInAppBrowser();
+}
 
 // src/ans.ts
 var ChainIdToAnsContractAddressMap = {
@@ -304,7 +335,7 @@ var WalletCore = class extends import_eventemitter3.default {
     }
   }
   async connect(walletName) {
-    var _a;
+    var _a, _b;
     try {
       const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
         (wallet) => wallet.name === walletName
@@ -313,8 +344,19 @@ var WalletCore = class extends import_eventemitter3.default {
         return;
       }
       if (this._connected) {
+        if (((_b = this.wallet) == null ? void 0 : _b.name) === walletName)
+          return;
         await this.disconnect();
       }
+      if (isRedirectable()) {
+        if (selectedWallet.deeplinkProvider) {
+          const url = encodeURIComponent(window.location.href);
+          const location = selectedWallet.deeplinkProvider({ url });
+          window.location.href = location;
+        } else {
+          return;
+        }
+      }
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -356,6 +398,24 @@ var WalletCore = class extends import_eventemitter3.default {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
+  async signAndSubmitBCSTransaction(transaction) {
+    var _a;
+    if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${(_a = this.wallet) == null ? void 0 : _a.name}`
+      ).message;
+    }
+    try {
+      this.doesWalletExist();
+      const response = await this._wallet.signAndSubmitBCSTransaction(
+        transaction
+      );
+      return response;
+    } catch (error) {
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignAndSubmitMessageError(errMsg).message;
+    }
+  }
   async signTransaction(transaction) {
     var _a;
     if (this._wallet && !("signTransaction" in this._wallet)) {
@@ -476,5 +536,12 @@ var WalletCore = class extends import_eventemitter3.default {
 0 && (module.exports = {
   NetworkName,
   WalletCore,
-  WalletReadyState
+  WalletReadyState,
+  getLocalStorage,
+  isInAppBrowser,
+  isMobile,
+  isRedirectable,
+  removeLocalStorage,
+  scopePollingDetectionStrategy,
+  setLocalStorage
 });

package/dist/index.mjs

@@ -149,6 +149,30 @@ function setLocalStorage(walletName) {
 function removeLocalStorage() {
   localStorage.removeItem(LOCAL_STORAGE_ITEM_KEY);
 }
+function getLocalStorage() {
+  localStorage.getItem(LOCAL_STORAGE_ITEM_KEY);
+}
+
+// src/utils/helpers.ts
+function isMobile() {
+  return /Mobile|iP(hone|od|ad)|Android|BlackBerry|IEMobile|Kindle|NetFront|Silk-Accelerated|(hpw|web)OS|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dolfin|Dolphin|Skyfire|Zune/i.test(
+    navigator.userAgent
+  );
+}
+function isInAppBrowser() {
+  const isIphone = /(iPhone|iPod|iPad).*AppleWebKit(?!.*Safari)/i.test(
+    navigator.userAgent
+  );
+  const isAndroid = /(Android).*Version\/[\d.]+.*Chrome\/[^\s]+ Mobile/i.test(
+    navigator.userAgent
+  );
+  return isIphone || isAndroid;
+}
+function isRedirectable() {
+  if (!navigator)
+    return false;
+  return isMobile() && !isInAppBrowser();
+}
 
 // src/ans.ts
 var ChainIdToAnsContractAddressMap = {
@@ -270,7 +294,7 @@ var WalletCore = class extends EventEmitter {
     }
   }
   async connect(walletName) {
-    var _a;
+    var _a, _b;
     try {
       const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
         (wallet) => wallet.name === walletName
@@ -279,8 +303,19 @@ var WalletCore = class extends EventEmitter {
         return;
       }
       if (this._connected) {
+        if (((_b = this.wallet) == null ? void 0 : _b.name) === walletName)
+          return;
         await this.disconnect();
       }
+      if (isRedirectable()) {
+        if (selectedWallet.deeplinkProvider) {
+          const url = encodeURIComponent(window.location.href);
+          const location = selectedWallet.deeplinkProvider({ url });
+          window.location.href = location;
+        } else {
+          return;
+        }
+      }
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -322,6 +357,24 @@ var WalletCore = class extends EventEmitter {
       throw new WalletSignAndSubmitMessageError(errMsg).message;
     }
   }
+  async signAndSubmitBCSTransaction(transaction) {
+    var _a;
+    if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${(_a = this.wallet) == null ? void 0 : _a.name}`
+      ).message;
+    }
+    try {
+      this.doesWalletExist();
+      const response = await this._wallet.signAndSubmitBCSTransaction(
+        transaction
+      );
+      return response;
+    } catch (error) {
+      const errMsg = typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignAndSubmitMessageError(errMsg).message;
+    }
+  }
   async signTransaction(transaction) {
     var _a;
     if (this._wallet && !("signTransaction" in this._wallet)) {
@@ -441,5 +494,12 @@ var WalletCore = class extends EventEmitter {
 export {
   NetworkName,
   WalletCore,
-  WalletReadyState
+  WalletReadyState,
+  getLocalStorage,
+  isInAppBrowser,
+  isMobile,
+  isRedirectable,
+  removeLocalStorage,
+  scopePollingDetectionStrategy,
+  setLocalStorage
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-core",
-  "version": "2.0.1",
+  "version": "2.2.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -27,27 +27,27 @@
     "Wallet Adapter",
     "Aptos Wallet"
   ],
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
-    "test": "jest",
-    "lint": "TIMING=1 eslint \"src/**/*.ts*\"",
-    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
-  },
   "devDependencies": {
-    "@aptos-labs/eslint-config-adapter": "workspace:*",
-    "@aptos-labs/wallet-adapter-tsconfig": "workspace:*",
     "@types/jest": "^29.2.4",
     "eslint": "^8.15.0",
     "jest": "^29.3.1",
     "ts-jest": "^29.0.3",
     "tsup": "^5.10.1",
-    "typescript": "^4.5.3"
+    "typescript": "^4.5.3",
+    "@aptos-labs/eslint-config-adapter": "0.0.0",
+    "@aptos-labs/wallet-adapter-tsconfig": "0.0.0"
   },
   "dependencies": {
     "aptos": "^1.3.17",
     "buffer": "^6.0.3",
     "eventemitter3": "^4.0.7",
     "tweetnacl": "^1.0.3"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "test": "jest",
+    "lint": "TIMING=1 eslint \"src/**/*.ts*\"",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   }
-}
+}

package/src/WalletCore.ts

@@ -1,4 +1,4 @@
-import { HexString, Types } from "aptos";
+import { HexString, TxnBuilderTypes, Types } from "aptos";
 import EventEmitter from "eventemitter3";
 import nacl from "tweetnacl";
 import { Buffer } from "buffer";
@@ -34,6 +34,7 @@ import {
   removeLocalStorage,
   setLocalStorage,
   scopePollingDetectionStrategy,
+  isRedirectable,
 } from "./utils";
 import { getNameByAddress } from "./ans";
 
@@ -195,8 +196,21 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       }
 
       if (this._connected) {
+        // if the selected wallet is already connected, we don't need to connect again
+        if (this.wallet?.name === walletName) return;
+
         await this.disconnect();
       }
+      if (isRedirectable()) {
+        // use wallet deep link
+        if (selectedWallet.deeplinkProvider) {
+          const url = encodeURIComponent(window.location.href);
+          const location = selectedWallet.deeplinkProvider({ url });
+          window.location.href = location;
+        } else {
+          return;
+        }
+      }
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -233,8 +247,8 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   }
 
   /** 
-  Sign and submit transaction to chain.
-  @param transaction
+  Sign and submit an entry (not bcs serialized) transaction type to chain.
+  @param transaction a non-bcs serialized transaction
   @return response from the wallet's signAndSubmitTransaction function
   @throws WalletSignAndSubmitMessageError
   */
@@ -254,6 +268,34 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
   }
 
+  /** 
+  Sign and submit a bsc serialized transaction type to chain.
+  @param transaction a bcs serialized transaction
+  @return response from the wallet's signAndSubmitBCSTransaction function
+  @throws WalletSignAndSubmitMessageError
+  */
+  async signAndSubmitBCSTransaction(
+    transaction: TxnBuilderTypes.TransactionPayload
+  ): Promise<any> {
+    if (this._wallet && !("signAndSubmitBCSTransaction" in this._wallet)) {
+      throw new WalletNotSupportedMethod(
+        `Submit a BCS Transaction is not supported by ${this.wallet?.name}`
+      ).message;
+    }
+
+    try {
+      this.doesWalletExist();
+      const response = await (this._wallet as any).signAndSubmitBCSTransaction(
+        transaction
+      );
+      return response;
+    } catch (error: any) {
+      const errMsg =
+        typeof error == "object" && "message" in error ? error.message : error;
+      throw new WalletSignAndSubmitMessageError(errMsg).message;
+    }
+  }
+
   /** 
   Sign transaction (doesnt submit to chain).
   @param transaction

package/src/index.ts

@@ -1,3 +1,4 @@
 export { WalletCore } from "./WalletCore";
 export * from "./types";
 export * from "./constants";
+export * from "./utils";

package/src/types.ts

@@ -53,6 +53,7 @@ export interface AdapterPluginProps<Name extends string = string> {
   icon: `data:image/${"svg+xml" | "webp" | "png" | "gif"};base64,${string}`;
   providerName?: string;
   provider: any;
+  deeplinkProvider?: (data: { url: string }) => string;
   connect(): Promise<any>;
   disconnect: () => Promise<any>;
   network: () => Promise<any>;

package/src/utils/helpers.ts

@@ -0,0 +1,26 @@
+export function isMobile(): boolean {
+  return /Mobile|iP(hone|od|ad)|Android|BlackBerry|IEMobile|Kindle|NetFront|Silk-Accelerated|(hpw|web)OS|Fennec|Minimo|Opera M(obi|ini)|Blazer|Dolfin|Dolphin|Skyfire|Zune/i.test(
+    navigator.userAgent
+  );
+}
+
+export function isInAppBrowser(): boolean {
+  const isIphone = /(iPhone|iPod|iPad).*AppleWebKit(?!.*Safari)/i.test(
+    navigator.userAgent
+  );
+
+  const isAndroid = /(Android).*Version\/[\d.]+.*Chrome\/[^\s]+ Mobile/i.test(
+    navigator.userAgent
+  );
+
+  return isIphone || isAndroid;
+}
+
+export function isRedirectable(): boolean {
+  // SSR: return false
+  if (!navigator) return false;
+
+  // if we are on mobile and NOT in a in-app browser we will redirect to a wallet app
+
+  return isMobile() && !isInAppBrowser();
+}

package/src/utils/index.ts

@@ -1,2 +1,3 @@
 export { scopePollingDetectionStrategy } from "./scopePollingDetectionStrategy";
 export * from "./localStorage";
+export * from "./helpers";