@0xsequence/provider 1.0.5 → 1.1.0

package/src/utils/index.ts

@@ -1,28 +1,24 @@
 import { BytesLike, TypedDataDomain, TypedDataField } from 'ethers'
 import { ChainIdLike } from '@0xsequence/network'
 import { encodeMessageDigest, TypedData, encodeTypedDataDigest } from '@0xsequence/utils'
-import { Wallet } from '../wallet'
 import { isValidSignature, prefixEIP191Message } from '../utils'
+import { SequenceSigner, SingleNetworkSequenceSigner } from '../signer'
 
+/**
+ *  This class is redundant with the SequenceSigner class, but it is here for now to
+ *  maintain compatibility with the old wallet API. Eventually we should move these
+ *  methods to the SequenceSigner class and deprecate this class.
+ */
 export class WalletUtils {
-  private wallet: Wallet
-
-  constructor(walletProvider: Wallet) {
-    this.wallet = walletProvider
+  constructor(public signer: SequenceSigner) {
+    if (SingleNetworkSequenceSigner.is(signer)) {
+      throw new Error('WalletUtils does not support SingleNetworkSequenceSigner')
+    }
   }
 
   // Sign message on a specified chain, or DefaultChain by default
-  signMessage(message: BytesLike, chainId?: ChainIdLike, allSigners?: boolean): Promise<string> {
-    const signer = this.wallet.getSigner()
-    if (!signer) throw new Error('unable to get signer')
-    return signer.signMessage(message, chainId, allSigners)
-  }
-
-  // Sign message on the AuthChain
-  async signAuthMessage(message: BytesLike, allSigners?: boolean): Promise<string> {
-    const signer = this.wallet.getSigner()
-    if (!signer) throw new Error('unable to get AuthChain signer')
-    return signer.signMessage(message, await signer.getChainId(), allSigners)
+  signMessage(message: BytesLike, chainId?: ChainIdLike, eip6492?: boolean): Promise<string> {
+    return this.signer.signMessage(message, { chainId, eip6492 })
   }
 
   // Sign EIP-712 TypedData on a specified chain, or DefaultChain by default
@@ -31,23 +27,9 @@ export class WalletUtils {
     types: Record<string, Array<TypedDataField>>,
     message: Record<string, any>,
     chainId?: ChainIdLike,
-    allSigners?: boolean
-  ): Promise<string> {
-    const signer = this.wallet.getSigner()
-    if (!signer) throw new Error('unable to get signer')
-    return signer.signTypedData(domain, types, message, chainId, allSigners)
-  }
-
-  // Sign EIP-712 TypedData on the AuthChain
-  async signAuthTypedData(
-    domain: TypedDataDomain,
-    types: Record<string, Array<TypedDataField>>,
-    message: Record<string, any>,
-    allSigners?: boolean
+    eip6492?: boolean
   ): Promise<string> {
-    const signer = this.wallet.getSigner()
-    if (!signer) throw new Error('unable to get AuthChain signer')
-    return signer.signTypedData(domain, types, message, await signer.getChainId(), allSigners)
+    return this.signer.signTypedData(domain, types, message, { chainId, eip6492 })
   }
 
   // Verify signature of a digest, one of a message, typedData or other
@@ -57,9 +39,7 @@ export class WalletUtils {
     signature: string,
     chainId: number
   ): Promise<boolean> {
-    const provider = this.wallet.getProvider(chainId)
-    if (!provider) throw new Error(`unable to get provider for chainId ${chainId}`)
-    return isValidSignature(address, digest, signature, provider)
+    return isValidSignature(address, digest, signature, this.signer.getProvider(chainId))
   }
 
   // Verify message signature
@@ -69,8 +49,7 @@ export class WalletUtils {
     signature: string,
     chainId: number
   ): Promise<boolean> {
-    const provider = this.wallet.getProvider(chainId)
-    if (!provider) throw new Error(`unable to get provider for chainId ${chainId}`)
+    const provider = this.signer.getProvider(chainId)
     const prefixed = prefixEIP191Message(message)
     const digest = encodeMessageDigest(prefixed)
     return isValidSignature(address, digest, signature, provider)
@@ -86,42 +65,6 @@ export class WalletUtils {
     return this.isValidSignature(address, encodeTypedDataDigest(typedData), signature, chainId)
   }
 
-  // // Recover the WalletConfig from a signature + digest combo
-  // recoverWalletConfig = async (
-  //   address: string,
-  //   digest: BytesLike,
-  //   signature: string | DecodedSignature,
-  //   chainId: BigNumberish,
-  //   walletContext?: WalletContext
-  // ): Promise<WalletConfig> => {
-  //   walletContext = walletContext || (await this.wallet.getWalletContext())
-  //   return recoverWalletConfig(address, digest, signature, chainId, walletContext)
-  // }
-
-  // // Recover the WalletConfig from a signature of a message
-  // recoverWalletConfigFromMessage = async (
-  //   address: string,
-  //   message: string | Uint8Array,
-  //   signature: string | DecodedSignature,
-  //   chainId: BigNumberish,
-  //   walletContext?: WalletContext
-  // ): Promise<WalletConfig> => {
-  //   walletContext = walletContext || (await this.wallet.getWalletContext())
-  //   return recoverWalletConfig(address, encodeMessageDigest(prefixEIP191Message(message)), signature, chainId, walletContext)
-  // }
-
-  // // Recover the WalletConfig from a signature of a typedData object
-  // recoverWalletConfigFromTypedData = async (
-  //   address: string,
-  //   typedData: TypedData,
-  //   signature: string | DecodedSignature,
-  //   chainId: BigNumberish,
-  //   walletContext?: WalletContext
-  // ): Promise<WalletConfig> => {
-  //   walletContext = walletContext || (await this.wallet.getWalletContext())
-  //   return recoverWalletConfig(address, encodeTypedDataDigest(typedData), signature, chainId, walletContext)
-  // }
-
   // sendTransaction()
   // sendTransactions()
 
@@ -136,9 +79,6 @@ export class WalletUtils {
   // getLogs()
   // // ..
 
-  // isWalletDeployed()
-  // deployWallet()
-
   // validateSignature()
   // recoverWalletConfig()
   // recoverAddress()

package/src/utils.ts

@@ -111,73 +111,103 @@ export const isWalletUpToDate = (status: AccountStatus): boolean => {
 }
 
 export interface ItemStore {
-  getItem(key: string): Promise<string | null>
-  setItem(key: string, value: string): Promise<void>
-  removeItem(key: string): Promise<void>
+  getItem(key: string): string | null
+  setItem(key: string, value: string): void
+
+  removeItem(key: string): void
+
+  onItemChange(key: string, cb: (value: string | null) => void): () => void
 }
 
-export class LocalStorage {
-  private static _instance: ItemStore
-
-  private constructor() {}
-
-  static getInstance(): ItemStore {
-    if (typeof window === 'object') {
-      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))
-        }
-      }
-    } else {
-      // noop local storage if window is not defined
-      // TODO: perhaps add an in-memory local storage if we need?
-      if (!LocalStorage._instance) {
-        LocalStorage._instance = {
-          getItem: (key: string) => Promise.resolve(null),
-          setItem: (key: string, value: string) => Promise.resolve(),
-          removeItem: (key: string) => Promise.resolve()
-        }
-      }
-    }
-    return this._instance
-  }
+export class MemoryItemStore implements ItemStore {
+  private callbacks: { key: string, cb: (value: string | null) => void }[] = []
+  private store: Record<string, string> = {}
 
-  static use(instance: ItemStore) {
-    LocalStorage._instance = instance
+  getItem(key: string): string | null {
+    return this.store[key] || null
   }
-}
 
-// window.localstorage helper
-export class LocalStore<T extends Object = string> {
-  readonly key: string
+  setItem(key: string, value: string): void {
+    this.store[key] = value
+    this.callbacks.filter((c) => c.key === key).forEach((c) => c.cb(value))
+  }
 
-  constructor(key: string, public def?: T) {
-    this.key = key
+  removeItem(key: string): void {
+    delete this.store[key]
   }
 
-  async get(): Promise<T | undefined> {
-    const val = await LocalStorage.getInstance().getItem(this.key)
+  onItemChange(key: string, cb: (value: string | null) => void): () => void {
+    this.callbacks.push({ key, cb })
 
-    if (val === null) {
-      return this.def
+    return () => {
+      this.callbacks = this.callbacks.filter((c) => c.cb !== cb)
     }
+  }
+}
+
+export class LocalStorage implements ItemStore {
+  private callbacks: { key: string, cb: (value: string | null) => void }[] = []
+
+  static isAvailable(): boolean {
+    return typeof window === 'object' && typeof window.localStorage === 'object'
+  }
 
-    try {
-      return JSON.parse(val)
-    } catch (err) {
-      console.error(err)
+  constructor() {
+    if (!LocalStorage.isAvailable()) {
+      throw new Error('LocalStorage is not available')
     }
 
-    return
+    window.addEventListener('storage', (e) => {
+      const { key } = e
+      const cb = this.callbacks.filter((c) => c.key === key)
+      cb.forEach((c) => c.cb(this.getItem(key!)))
+    })
   }
 
-  set(val: T | undefined) {
-    val ? LocalStorage.getInstance().setItem(this.key, JSON.stringify(val)) : LocalStorage.getInstance().removeItem(this.key)
+  getItem(key: string): string | null {
+    return window.localStorage.getItem(key)
   }
 
-  del() {
-    LocalStorage.getInstance().removeItem(this.key)
+  setItem(key: string, value: string): void {
+    window.localStorage.setItem(key, value)
+
+    // Trigger callbacks
+    // NOTICE: the event is not triggered on the same window
+    this.callbacks.filter((c) => c.key === key).forEach((c) => c.cb(value))
   }
+
+  removeItem(key: string): void {
+    window.localStorage.removeItem(key)
+
+    // Trigger callbacks
+    // NOTICE: the event is not triggered on the same window
+    this.callbacks.filter((c) => c.key === key).forEach((c) => c.cb(null))
+  }
+
+  onItemChange(key: string, cb: (value: string | null) => void): () => void {
+    this.callbacks.push({ key, cb })
+
+    return () => {
+      this.callbacks = this.callbacks.filter((c) => c.cb !== cb)
+    }
+  }
+}
+
+export function useBestStore(): ItemStore {
+  if (LocalStorage.isAvailable()) {
+    return new LocalStorage()
+  }
+
+  return new MemoryItemStore()
+}
+
+export async function resolveArrayProperties<T>(
+  object: Readonly<ethers.utils.Deferrable<T>> | Readonly<ethers.utils.Deferrable<T>>[]
+): Promise<T> {
+  if (Array.isArray(object)) {
+    // T must include array type
+    return Promise.all(object.map((o) => ethers.utils.resolveProperties(o))) as any
+  }
+
+  return ethers.utils.resolveProperties(object)
 }

package/dist/declarations/src/extended.d.ts

@@ -1,6 +0,0 @@
-import { ethers } from "ethers";
-export type ExtendedTransactionRequest = ethers.providers.TransactionRequest & {
-    auxiliary?: ethers.providers.TransactionRequest[];
-};
-export declare function toExtended(transactions: ethers.providers.TransactionRequest[]): ExtendedTransactionRequest;
-export declare function fromExtended(transaction: ExtendedTransactionRequest): ethers.providers.TransactionRequest[];

package/dist/declarations/src/wallet.d.ts

@@ -1,105 +0,0 @@
-import { NetworkConfig, ChainIdLike } from '@0xsequence/network';
-import { Web3Provider, Web3Signer } from "./provider.js";
-import { ProxyMessageChannelPort } from "./transports/index.js";
-import { WalletSession, ProviderEventTypes, ConnectOptions, OpenWalletIntent, ConnectDetails } from "./types.js";
-import { ItemStore } from "./utils.js";
-import { WalletUtils } from "./utils/index.js";
-import { Runtime } from 'webextension-polyfill';
-import { commons } from '@0xsequence/core';
-import { AccountStatus } from '@0xsequence/account';
-export declare const SESSION_LOCALSTORE_KEY = "@sequence.session";
-export interface WalletProvider {
-    connect(options?: ConnectOptions): Promise<ConnectDetails>;
-    disconnect(): void;
-    isConnected(): boolean;
-    getSession(): WalletSession | undefined;
-    getAddress(): Promise<string>;
-    getNetworks(chainId?: ChainIdLike): Promise<NetworkConfig[]>;
-    getChainId(): Promise<number>;
-    isOpened(): boolean;
-    openWallet(path?: string, intent?: OpenWalletIntent, networkId?: string | number): Promise<boolean>;
-    closeWallet(): void;
-    getProvider(chainId?: ChainIdLike): Web3Provider | undefined;
-    getSigner(chainId?: ChainIdLike): Web3Signer;
-    getWalletContext(): Promise<commons.context.VersionedContext>;
-    getWalletConfig(chainId?: ChainIdLike): Promise<commons.config.Config>;
-    getWalletState(chainId?: ChainIdLike): Promise<AccountStatus>;
-    isDeployed(chainId?: ChainIdLike): Promise<boolean>;
-    getProviderConfig(): ProviderConfig;
-    on<K extends keyof ProviderEventTypes>(event: K, fn: ProviderEventTypes[K]): void;
-    once<K extends keyof ProviderEventTypes>(event: K, fn: ProviderEventTypes[K]): void;
-    utils: WalletUtils;
-}
-export declare class Wallet implements WalletProvider {
-    utils: WalletUtils;
-    private config;
-    private session?;
-    private connectedSites;
-    private transport;
-    private networks;
-    private providers;
-    constructor(network?: string | number, config?: Partial<ProviderConfig>);
-    private init;
-    loadSession: (preferredNetwork?: string | number) => Promise<WalletSession | undefined>;
-    connect: (options?: ConnectOptions) => Promise<ConnectDetails>;
-    addConnectedSite(origin: string | undefined): Promise<void>;
-    removeConnectedSite(origin: string): Promise<void>;
-    getConnectedSites(): Promise<string[] | undefined>;
-    isSiteConnected(origin: string | undefined): Promise<boolean>;
-    authorize: (options?: ConnectOptions) => Promise<ConnectDetails>;
-    disconnect(): Promise<void>;
-    getProviderConfig(): ProviderConfig;
-    isOpened(): boolean;
-    isConnected(): boolean;
-    getSession: () => WalletSession | undefined;
-    getAddress: () => Promise<string>;
-    getNetworks: (chainId?: ChainIdLike) => Promise<NetworkConfig[]>;
-    getChainId: () => Promise<number>;
-    openWallet: (path?: string, intent?: OpenWalletIntent, networkId?: string | number) => Promise<boolean>;
-    closeWallet: () => void;
-    getProvider(chainId?: ChainIdLike): Web3Provider | undefined;
-    getAllProviders(): {
-        [chainId: number]: Web3Provider;
-    };
-    getSigner(chainId?: ChainIdLike): Web3Signer;
-    getWalletConfig(chainId?: ChainIdLike): Promise<commons.config.Config>;
-    getWalletState(chainId?: ChainIdLike): Promise<AccountStatus>;
-    getWalletContext(): Promise<commons.context.VersionedContext>;
-    isDeployed(chainId?: ChainIdLike): Promise<boolean>;
-    on<K extends keyof ProviderEventTypes>(event: K, fn: ProviderEventTypes[K]): void;
-    once<K extends keyof ProviderEventTypes>(event: K, fn: ProviderEventTypes[K]): void;
-    unregister: () => void;
-    private saveSession;
-    private useSession;
-    private useAccountAddress;
-    private useNetworks;
-    private clearSession;
-}
-export interface ProviderConfig {
-    localStorage?: ItemStore;
-    walletAppURL: string;
-    networks?: Partial<NetworkConfig>[];
-    networkRpcUrl?: string;
-    defaultNetworkId?: string | number;
-    transports?: {
-        windowTransport?: {
-            enabled: boolean;
-        };
-        proxyTransport?: {
-            enabled: boolean;
-            appPort?: ProxyMessageChannelPort;
-        };
-        extensionTransport?: {
-            enabled: boolean;
-            runtime: Runtime.Static;
-        };
-        unrealTransport?: {
-            enabled: boolean;
-        };
-    };
-    walletContext?: commons.context.VersionedContext;
-}
-export declare const DefaultProviderConfig: ProviderConfig;
-export declare const initWallet: (network?: string | number, config?: Partial<ProviderConfig>) => Promise<Wallet>;
-export declare const unregisterWallet: () => void;
-export declare const getWallet: () => Wallet;