Support askForEmail (#308)

Author: tolgahan-arikan

packages/0xsequence/tests/browser/mock-wallet/mock-wallet.test.ts

@@ -83,7 +83,7 @@ const main = async () => {
   )
 
   // the json-rpc signer via the wallet
-  const walletRequestHandler = new WalletRequestHandler(undefined, null, networks)
+  const walletRequestHandler = new WalletRequestHandler(undefined, null, null, networks)
 
   // fake/force an async wallet initialization for the wallet-request handler. This is the behaviour
   // of the wallet-webapp, so lets ensure the mock wallet does the same thing too.

packages/0xsequence/tests/browser/mux-transport/mux.test.ts

@@ -90,7 +90,7 @@ export const tests = async () => {
   )
 
   // the rpc signer via the wallet
-  const walletRequestHandler = new WalletRequestHandler(saccount, null, networks)
+  const walletRequestHandler = new WalletRequestHandler(saccount, null, null, networks)
 
   // register wallet message handler, in this case using the ProxyMessage transport.
   const proxyHandler = new ProxyMessageHandler(walletRequestHandler, ch.wallet)

packages/0xsequence/tests/browser/proxy-transport/channel.test.ts

@@ -1,4 +1,12 @@
-import { Web3Provider, ProxyMessageProvider, WalletSession, WalletRequestHandler, ProxyMessageChannel, ProxyMessageHandler, prefixEIP191Message } from '@0xsequence/provider'
+import {
+  Web3Provider,
+  ProxyMessageProvider,
+  WalletSession,
+  WalletRequestHandler,
+  ProxyMessageChannel,
+  ProxyMessageHandler,
+  prefixEIP191Message
+} from '@0xsequence/provider'
 import { ethers, Wallet as EOAWallet } from 'ethers'
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { test, assert } from '../../utils/assert'
@@ -12,7 +20,6 @@ import { testAccounts, getEOAWallet } from '../testutils'
 configureLogger({ logLevel: 'DEBUG', silence: false })
 
 export const tests = async () => {
-
   // ProxyMessageChannel object is to be instantiated by the app coordinating
   // the channel, ie. such as the mobile application itself.
   //
@@ -22,7 +29,7 @@ export const tests = async () => {
   // Sending messages to the wallet port will go through channel and get received by the app.
   const ch = new ProxyMessageChannel()
 
-  ch.app.on('open', (openInfo) => {
+  ch.app.on('open', openInfo => {
     console.log('app, wallet opened.', openInfo)
   })
   ch.app.on('close', () => {
@@ -68,13 +75,13 @@ export const tests = async () => {
       rpcUrl: rpcProvider.connection.url,
       provider: rpcProvider,
       relayer: relayer,
-      isDefaultChain: true,
+      isDefaultChain: true
       // isAuthChain: true
     }
   ]
 
   // the rpc signer via the wallet
-  const walletRequestHandler = new WalletRequestHandler(undefined, null, networks)
+  const walletRequestHandler = new WalletRequestHandler(undefined, null, null, networks)
 
   // fake/force an async wallet initialization for the wallet-request handler. This is the behaviour
   // of the wallet-webapp, so lets ensure the mock wallet does the same thing too.
@@ -86,7 +93,6 @@ export const tests = async () => {
   const proxyHandler = new ProxyMessageHandler(walletRequestHandler, ch.wallet)
   proxyHandler.register()
 
-
   //
   // App Provider
   //
@@ -137,7 +143,6 @@ export const tests = async () => {
       'signature match'
     )
 
-
     const chainId = await signer.getChainId()
 
     //
@@ -152,7 +157,6 @@ export const tests = async () => {
     // in order to recover the config properly, the subDigest + sig is required.
     const subDigest = packMessageData(address, chainId, messageDigest)
 
-
     //
     // Recover config / address
     //
@@ -166,5 +170,4 @@ export const tests = async () => {
   })
 
   walletProvider.closeWallet()
-
 }

packages/provider/src/provider.ts

@@ -94,7 +94,7 @@ export function isSequenceProvider(provider: any): provider is Web3Provider {
 
 export class LocalWeb3Provider extends Web3Provider {
   constructor(signer: Signer, networks?: NetworkConfig[]) {
-    const walletRequestHandler = new WalletRequestHandler(signer, null, networks || [])
+    const walletRequestHandler = new WalletRequestHandler(signer, null, null, networks || [])
     super(walletRequestHandler)
   }
 }

packages/provider/src/transports/wallet-request-handler.ts

@@ -44,6 +44,7 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
   private signerReadyCallbacks: Array<() => void> = []
 
   private prompter: WalletUserPrompter | null
+  private auxDataProvider: AuxDataProvider | null
   private mainnetNetworks: NetworkConfig[]
   private testnetNetworks: NetworkConfig[]
 
@@ -57,11 +58,13 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
   constructor(
     signer: Signer | null | undefined,
     prompter: WalletUserPrompter | null,
+    auxDataProvider: AuxDataProvider | null,
     mainnetNetworks: NetworkConfig[],
     testnetNetworks: NetworkConfig[] = []
   ) {
     this.signer = signer
     this.prompter = prompter
+    this.auxDataProvider = auxDataProvider
     this.mainnetNetworks = mainnetNetworks
     this.testnetNetworks = testnetNetworks
   }
@@ -152,6 +155,13 @@ export class WalletRequestHandler implements ExternalProvider, JsonRpcHandler, P
       chainId: ethers.utils.hexlify(await this.getChainId())
     }
 
+    if (options && options.askForEmail) {
+      const email = await this.auxDataProvider?.get('email')
+      if (email) {
+        connectDetails.email = email
+      }
+    }
+
     if (options && options.authorize) {
       // Perform ethauth eip712 request and construct the ConnectDetails response
       // including the auth proof
@@ -802,6 +812,10 @@ export interface WalletUserPrompter {
   promptConfirmWalletDeploy(chainId: number, options?: ConnectOptions): Promise<boolean>
 }
 
+export interface AuxDataProvider {
+  get(key: string): Promise<any>
+}
+
 const permittedJsonRpcMethods = [
   'net_version',
   'eth_chainId',

packages/provider/src/types.ts

@@ -156,8 +156,7 @@ export interface ConnectOptions {
   /** authorize will perform an ETHAuth eip712 signing and return the proof to the dapp. */
   authorize?: boolean
 
-  /** *Currently not used* askForEmail will prompt to give permission to the dapp to access email address */
-  // TODO: this feature is currently not used as the wallet does not report emails yet
+  /** askForEmail will prompt to give permission to the dapp to access email address */
   askForEmail?: boolean
 
   /** refresh flag will force a full re-connect (ie. disconnect then connect again) */