@aptos-labs/wallet-adapter-core 2.1.0 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @aptos-labs/wallet-adapter-core
 
+## 2.3.0
+
+### Minor Changes
+
+- bb1595e: Fix deeplink redirect
+- 1605d28: Support ReadonlyArray of Wallets in AptosWalletAdapterProvider and WalletCore
+
+## 2.2.0
+
+### Minor Changes
+
+- 814939c: Add deeplink support
+
 ## 2.1.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -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>;
@@ -119,7 +122,7 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private _network;
     private _connecting;
     private _connected;
-    constructor(plugins: Wallet[]);
+    constructor(plugins: ReadonlyArray<Wallet>);
     private scopePollingDetectionStrategy;
     private doesWalletExist;
     private clearData;
@@ -128,7 +131,7 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     setAccount(account: AccountInfo | null): void;
     setNetwork(network: NetworkInfo | null): void;
     isConnected(): boolean;
-    get wallets(): Wallet[];
+    get wallets(): ReadonlyArray<Wallet>;
     /**
      * Getter for the current connected wallet
      * @return wallet info
@@ -208,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 = {
@@ -309,14 +340,23 @@ var WalletCore = class extends import_eventemitter3.default {
       const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
         (wallet) => wallet.name === walletName
       );
-      if (!selectedWallet || selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+      if (!selectedWallet)
         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;
+        }
+      }
+      if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+        return;
+      }
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -496,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 = {
@@ -275,14 +299,23 @@ var WalletCore = class extends EventEmitter {
       const selectedWallet = (_a = this._wallets) == null ? void 0 : _a.find(
         (wallet) => wallet.name === walletName
       );
-      if (!selectedWallet || selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+      if (!selectedWallet)
         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;
+        }
+      }
+      if (selectedWallet.readyState !== "Installed" /* Installed */ && selectedWallet.readyState !== "Loadable" /* Loadable */) {
+        return;
+      }
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();
@@ -461,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.1.0",
+  "version": "2.3.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/WalletCore.ts

@@ -34,11 +34,12 @@ import {
   removeLocalStorage,
   setLocalStorage,
   scopePollingDetectionStrategy,
+  isRedirectable,
 } from "./utils";
 import { getNameByAddress } from "./ans";
 
 export class WalletCore extends EventEmitter<WalletCoreEvents> {
-  private _wallets: Wallet[] = [];
+  private _wallets: ReadonlyArray<Wallet> = [];
   private _wallet: Wallet | null = null;
   private _account: AccountInfo | null = null;
   private _network: NetworkInfo | null = null;
@@ -46,7 +47,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   private _connecting: boolean = false;
   private _connected: boolean = false;
 
-  constructor(plugins: Wallet[]) {
+  constructor(plugins: ReadonlyArray<Wallet>) {
     super();
     this._wallets = plugins;
     this.scopePollingDetectionStrategy();
@@ -122,7 +123,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     return this._connected;
   }
 
-  get wallets(): Wallet[] {
+  get wallets(): ReadonlyArray<Wallet> {
     return this._wallets;
   }
 
@@ -186,13 +187,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
         (wallet: Wallet) => wallet.name === walletName
       );
 
-      if (
-        !selectedWallet ||
-        (selectedWallet.readyState !== WalletReadyState.Installed &&
-          selectedWallet.readyState !== WalletReadyState.Loadable)
-      ) {
-        return;
-      }
+      if (!selectedWallet) return;
 
       if (this._connected) {
         // if the selected wallet is already connected, we don't need to connect again
@@ -200,6 +195,24 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
 
         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;
+      }
+
       this._connecting = true;
       this.setWallet(selectedWallet);
       const account = await selectedWallet.connect();

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";