@0xsequence/provider 0.38.2 → 0.39.2

package/src/transports/window-transport/window-message-handler.ts

@@ -22,7 +22,7 @@ export class WindowMessageHandler extends BaseWalletTransport {
     this._init = InitState.NIL
   }
 
-  register(windowHref?: any) {
+  async register(windowHref?: any) {
     const isPopup = parent.window.opener !== null
     this._isPopup = isPopup
     if (isPopup !== true) {
@@ -39,7 +39,7 @@ export class WindowMessageHandler extends BaseWalletTransport {
 
     // attempt to restore previous session in the case of a redirect or window reload
     if (!isNewWindowSession) {
-      session = this.getCachedTransportSession()
+      session = await this.getCachedTransportSession()
     }
 
     if (!session) {
@@ -143,7 +143,8 @@ export class WindowMessageHandler extends BaseWalletTransport {
       this.parentWindow.postMessage(message, '*')
     } else {
       // open message transmission
-      if (this.appOrigin && this.appOrigin.length > 4) { // just above '.com'
+      if (this.appOrigin && this.appOrigin.length > 4) {
+        // just above '.com'
         this.parentWindow.postMessage(message, this.appOrigin)
       } else {
         logger.error('unable to postMessage as parentOrigin is invalid')

package/src/types.ts

@@ -37,6 +37,7 @@ export interface ProviderMessage<T> {
   type: string // message type
   data: T // the ethereum json-rpc payload
   chainId?: number // chain id which the message is intended
+  origin?: string // origin of the message
 }
 
 export type ProviderMessageRequest = ProviderMessage<JsonRpcRequest>
@@ -111,7 +112,7 @@ export interface WalletEventTypes {
   connect: (connectDetails: ConnectDetails) => void
   disconnect: (error?: ProviderRpcError) => void
 
-  accountsChanged: (accounts: string[]) => void
+  accountsChanged: (accounts: string[], origin?: string) => void
   chainChanged: (chainIdHex: string) => void
 
   networks: (networks: NetworkConfig[]) => void

package/src/utils.ts

@@ -3,9 +3,9 @@ import { WalletContext } from '@0xsequence/network'
 import { WalletConfig, addressOf, DecodedSignature, isConfigEqual } from '@0xsequence/config'
 import { packMessageData, encodeMessageDigest, TypedData, encodeTypedDataDigest } from '@0xsequence/utils'
 import { Web3Provider } from './provider'
-import { isValidSignature as _isValidSignature, recoverConfig, Signer, isValidEIP712Signature, isValidEthSignSignature } from '@0xsequence/wallet'
+import { isValidSignature as _isValidSignature, recoverConfig, Signer } from '@0xsequence/wallet'
 
-const eip191prefix = ethers.utils.toUtf8Bytes("\x19Ethereum Signed Message:\n")
+const eip191prefix = ethers.utils.toUtf8Bytes('\x19Ethereum Signed Message:\n')
 
 export const messageToBytes = (message: BytesLike): Uint8Array => {
   if (ethers.utils.isBytes(message) || ethers.utils.isHexString(message)) {
@@ -17,11 +17,7 @@ export const messageToBytes = (message: BytesLike): Uint8Array => {
 
 export const prefixEIP191Message = (message: BytesLike): Uint8Array => {
   const messageBytes = messageToBytes(message)
-  return ethers.utils.concat([
-    eip191prefix,
-    ethers.utils.toUtf8Bytes(String(messageBytes.length)),
-    messageBytes
-  ])
+  return ethers.utils.concat([eip191prefix, ethers.utils.toUtf8Bytes(String(messageBytes.length)), messageBytes])
 }
 
 export const isValidSignature = async (
@@ -130,6 +126,33 @@ export const isWalletUpToDate = async (signer: Signer, chainId: number): Promise
   return isDeployed && isUpToDate
 }
 
+export interface ItemStore {
+  getItem(key: string): Promise<string | null>
+  setItem(key: string, value: string): Promise<void>
+  removeItem(key: string): Promise<void>
+}
+
+export class LocalStorage {
+  private static _instance: ItemStore
+
+  private constructor() {}
+
+  static getInstance(): ItemStore {
+    if (!LocalStorage._instance) {
+      LocalStorage._instance = {
+        getItem: (key: string) => Promise.resolve(window.localStorage.getItem(key)),
+        setItem: (key: string, value: string) => Promise.resolve(window.localStorage.setItem(key, value)),
+        removeItem: (key: string) => Promise.resolve(window.localStorage.removeItem(key))
+      }
+    }
+    return this._instance
+  }
+
+  static use(instance: ItemStore) {
+    LocalStorage._instance = instance
+  }
+}
+
 // window.localstorage helper
 export class LocalStore<T extends Object = string> {
   readonly key: string
@@ -138,8 +161,8 @@ export class LocalStore<T extends Object = string> {
     this.key = key
   }
 
-  get(): T | undefined {
-    const val = window.localStorage.getItem(this.key)
+  async get(): Promise<T | undefined> {
+    const val = await LocalStorage.getInstance().getItem(this.key)
 
     if (val === null) {
       return this.def
@@ -155,10 +178,10 @@ export class LocalStore<T extends Object = string> {
   }
 
   set(val: T | undefined) {
-    val ? window.localStorage.setItem(this.key, JSON.stringify(val)) : window.localStorage.removeItem(this.key)
+    val ? LocalStorage.getInstance().setItem(this.key, JSON.stringify(val)) : LocalStorage.getInstance().removeItem(this.key)
   }
 
   del() {
-    window.localStorage.removeItem(this.key)
+    LocalStorage.getInstance().removeItem(this.key)
   }
 }

package/src/wallet.ts

@@ -1,25 +1,18 @@
 import {
   NetworkConfig,
   WalletContext,
-  sequenceContext,
   ChainIdLike,
-  getChainId,
   JsonRpcSender,
   JsonRpcRouter,
   JsonRpcMiddleware,
   allowProviderMiddleware,
   CachedProvider,
-  PublicProvider,
   loggingProviderMiddleware,
   SigningProvider,
   EagerProvider,
   exceptionProviderMiddleware,
   networkProviderMiddleware,
-  JsonRpcExternalProvider,
-  JsonRpcHandlerFunc,
   JsonRpcRequest,
-  JsonRpcResponse,
-  JsonRpcResponseCallback,
   findNetworkConfig,
   updateNetworkConfig,
   ensureValidNetworks
@@ -32,7 +25,7 @@ import { MuxMessageProvider, WindowMessageProvider, ProxyMessageProvider, ProxyM
 import { WalletSession, ProviderEventTypes, ConnectOptions, OpenWalletIntent, ConnectDetails } from './types'
 import { ethers } from 'ethers'
 import { ExtensionMessageProvider } from './transports/extension-transport/extension-message-provider'
-import { LocalStore } from './utils'
+import { LocalStore, ItemStore, LocalStorage } from './utils'
 import { WalletUtils } from './utils/index'
 
 import { Runtime } from 'webextension-polyfill-ts'
@@ -111,6 +104,10 @@ export class Wallet implements WalletProvider {
       this.config.defaultNetworkId = 'mainnet'
     }
 
+    if (config?.localStorage) {
+      LocalStorage.use(config.localStorage)
+    }
+
     this.transport = {}
     this.networks = []
     this.providers = {}
@@ -213,8 +210,17 @@ export class Wallet implements WalletProvider {
       }
     })
 
-    // below will update the account upon wallet connect/disconnect (aka, login/logout)
-    this.transport.messageProvider.on('accountsChanged', (accounts: string[]) => {
+    // below will update the account upon wallet connect/disconnect - aka, login/logout.
+    // if an origin is provided, this operation should be performed only on that origin
+    // and shouldn't affect the session of the wallet.
+    this.transport.messageProvider.on('accountsChanged', (accounts: string[], origin?: string) => {
+      if (origin) {
+        if (accounts.length > 0) {
+          this.useSession({ accountAddress: accounts[0] }, true)
+        }
+        return
+      }
+
       if (!accounts || accounts.length === 0 || accounts[0] === '') {
         this.clearSession()
       } else {
@@ -233,10 +239,11 @@ export class Wallet implements WalletProvider {
     })
 
     // Load existing session from localStorage
-    const session = this.loadSession()
-    if (session) {
-      this.useSession(session, false)
-    }
+    this.loadSession().then(session => {
+      if (session) {
+        this.useSession(session, false)
+      }
+    })
   }
 
   connect = async (options?: ConnectOptions): Promise<ConnectDetails> => {
@@ -246,7 +253,7 @@ export class Wallet implements WalletProvider {
 
     if (
       this.isConnected() &&
-      this.isSiteConnected(options?.origin) &&
+      (await this.isSiteConnected(options?.origin)) &&
       !!this.session &&
       !options?.authorize &&
       !options?.askForEmail
@@ -282,10 +289,10 @@ export class Wallet implements WalletProvider {
     return connectDetails
   }
 
-  addConnectedSite(origin: string | undefined) {
+  async addConnectedSite(origin: string | undefined) {
     origin = origin || window.location.origin
 
-    const connectedSites = this.connectedSites.get()
+    const connectedSites = await this.connectedSites.get()
 
     if (connectedSites) {
       if (connectedSites.includes(origin)) {
@@ -297,8 +304,8 @@ export class Wallet implements WalletProvider {
     }
   }
 
-  removeConnectedSite(origin: string) {
-    const authorized = this.connectedSites.get()
+  async removeConnectedSite(origin: string) {
+    const authorized = await this.connectedSites.get()
 
     if (authorized) {
       this.connectedSites.set(authorized.filter(domain => domain !== origin))
@@ -309,8 +316,8 @@ export class Wallet implements WalletProvider {
     return this.connectedSites.get()
   }
 
-  private isSiteConnected(origin: string | undefined): boolean {
-    const authorized = this.connectedSites.get()
+  async isSiteConnected(origin: string | undefined): Promise<boolean> {
+    const authorized = await this.connectedSites.get()
 
     return !!authorized && authorized.includes(origin || window.location.origin)
   }
@@ -538,8 +545,8 @@ export class Wallet implements WalletProvider {
     this.transport.messageProvider!.once(event, fn)
   }
 
-  private loadSession = (): WalletSession | undefined => {
-    const data = window.localStorage.getItem('@sequence.session')
+  private loadSession = async (): Promise<WalletSession | undefined> => {
+    const data = await LocalStorage.getInstance().getItem('@sequence.session')
     if (!data || data === '') {
       return undefined
     }
@@ -555,7 +562,7 @@ export class Wallet implements WalletProvider {
   private saveSession = (session: WalletSession) => {
     logger.debug('wallet provider: saving session')
     const data = JSON.stringify(session)
-    window.localStorage.setItem('@sequence.session', data)
+    LocalStorage.getInstance().setItem('@sequence.session', data)
   }
 
   private useSession = async (session: WalletSession, autoSave: boolean = true) => {
@@ -631,7 +638,7 @@ export class Wallet implements WalletProvider {
 
   private clearSession(): void {
     logger.debug('wallet provider: clearing session')
-    window.localStorage.removeItem('@sequence.session')
+    LocalStorage.getInstance().removeItem('@sequence.session')
     this.session = undefined
     this.networks = []
     this.providers = {}
@@ -640,6 +647,10 @@ export class Wallet implements WalletProvider {
 }
 
 export interface ProviderConfig {
+  // The local storage dependency for the wallet provider, defaults to window.localStorage.
+  // For example, this option should be used when using React Native since window.localStorage is not available.
+  localStorage?: ItemStore
+
   // Sequence Wallet App URL, default: https://sequence.app
   walletAppURL: string