Merge pull request #72 from blocknative/feature/preferred-wallet-default

Add preferred wallet to wallet default and fix interface.

Closes #71

Author: lnbc1QWFyb24

src/interfaces.ts

@@ -138,13 +138,14 @@ export interface WalletConnectOptions {
 }
 
 export interface SelectDefaultsOptions {
-  heading: string
-  description: string
+  heading?: string
+  description?: string
   networkId: number
-  fortmaticInit: { apiKey: string }
-  portisInit: { apiKey: string }
-  squarelinkInit: { apiKey: string }
-  walletConnectInit: WalletConnectOptions
+  fortmaticInit?: { apiKey: string }
+  portisInit?: { apiKey: string }
+  squarelinkInit?: { apiKey: string }
+  walletConnectInit?: WalletConnectOptions
+  preferredWallets?: string[]
 }
 
 export interface WalletSelectFunction {

src/modules/select/index.ts

@@ -23,47 +23,67 @@ function defaults(options: SelectDefaultsOptions): WalletSelectModule {
     fortmaticInit,
     portisInit,
     squarelinkInit,
-    walletConnectInit
+    walletConnectInit,
+    preferredWallets
   } = options
 
-  const desktopModules = [metamask(), dapper(), opera()]
-  const mobileModules = [coinbase(), trust(), operaTouch()]
+  let desktopWallets = [metamask(), dapper(), opera()]
+  let mobileWallets = [coinbase(), trust(), operaTouch()]
 
   if (portisInit) {
-    desktopModules.push(portis({ ...portisInit, networkId }))
-    mobileModules.push(portis({ ...portisInit, networkId }))
+    desktopWallets.push(portis({ ...portisInit, networkId }))
+    mobileWallets.push(portis({ ...portisInit, networkId }))
   }
 
   if (fortmaticInit) {
-    desktopModules.push(fortmatic({ ...fortmaticInit, networkId }))
-    mobileModules.push(fortmatic({ ...fortmaticInit, networkId }))
+    desktopWallets.push(fortmatic({ ...fortmaticInit, networkId }))
+    mobileWallets.push(fortmatic({ ...fortmaticInit, networkId }))
   }
 
   if (walletConnectInit) {
-    desktopModules.push(
+    desktopWallets.push(
       walletConnect({ infuraKey: walletConnectInit.infuraKey })
     )
-    mobileModules.push(
+    mobileWallets.push(
       walletConnect({ infuraKey: walletConnectInit.infuraKey })
     )
   }
 
   if (squarelinkInit) {
-    desktopModules.push(squarelink({ ...squarelinkInit, networkId }))
-    mobileModules.push(squarelink({ ...squarelinkInit, networkId }))
+    desktopWallets.push(squarelink({ ...squarelinkInit, networkId }))
+    mobileWallets.push(squarelink({ ...squarelinkInit, networkId }))
   }
 
-  desktopModules.push(authereum({ networkId }))
-  mobileModules.push(authereum({ networkId }))
+  desktopWallets.push(authereum({ networkId }))
+  mobileWallets.push(authereum({ networkId }))
+
+  //set preferred wallets if provided
+  if (preferredWallets) {
+    desktopWallets = desktopWallets.map(wallet => {
+      if (preferredWallets.includes(wallet.name)) {
+        wallet.preferred = true
+      }
+  
+      return wallet
+    })
+  
+    mobileWallets = mobileWallets.map(wallet => {
+      if (preferredWallets.includes(wallet.name)) {
+        wallet.preferred = true
+      }
+  
+      return wallet
+    })
+  }
 
   return {
     heading: heading || "Select a Wallet",
     description:
       description ||
       "Please select the wallet that you would like to use with this dapp:",
     wallets: {
-      mobile: mobileModules,
-      desktop: desktopModules
+      mobile: mobileWallets,
+      desktop: desktopWallets
     }
   }
 }

src/validation.ts

@@ -347,7 +347,8 @@ export function validateSelectDefaultsOptions(
     fortmaticInit,
     portisInit,
     squarelinkInit,
-    walletConnectInit
+    walletConnectInit,
+    preferredWallets
   } = options
 
   validateType({
@@ -400,4 +401,11 @@ export function validateSelectDefaultsOptions(
     type: "object",
     optional: true
   })
+
+  validateType({
+    name: "preferredWallets",
+    value: preferredWallets,
+    type: "array",
+    optional: true
+  })
 }