Release: v1.18.0 (#477)

* Modify default wallets
  * Separates default wallets into mobile and desktop
  * Moves Authereum to 2nd place
  * Adds isMobile parameter to determine which wallets to display
  * Adds deprecation warning for deprecated wallets
  * Remove deprecated wallet modules/icons
  * Fixes issue where there was an undefined wallet in the list of wallets returned
  * getModule return type more specific and no longer returns undefined which simplifies things for the method's caller
  * 1.17.1-0.1.0: Updates GridPlus connector in anticipation of upcoming Lattice firmware release (#475)

Author: taylorjdawson

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnc-onboard",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "description": "Onboard users to web3 by allowing them to select a wallet, get that wallet ready to transact and have access to synced wallet state.",
   "keywords": [
     "ethereum",
@@ -49,19 +49,17 @@
     "@ledgerhq/hw-transport-u2f": "^5.21.0",
     "@portis/web3": "^2.0.0-beta.57",
     "@toruslabs/torus-embed": "^1.9.2",
-    "@unilogin/provider": "^0.6.1",
     "@walletconnect/web3-provider": "^1.3.1",
     "authereum": "^0.1.12",
     "bignumber.js": "^9.0.0",
     "bnc-sdk": "^2.1.4",
     "bowser": "^2.10.0",
-    "eth-lattice-keyring": "^0.2.4",
+    "eth-lattice-keyring": "^0.2.7",
     "ethereumjs-tx": "^2.1.2",
     "ethereumjs-util": "^7.0.3",
     "fortmatic": "^2.2.1",
     "hdkey": "^2.0.1",
     "regenerator-runtime": "^0.13.7",
-    "squarelink": "^1.1.4",
     "trezor-connect": "^8.1.9",
     "walletlink": "^2.0.2",
     "web3-provider-engine": "^15.0.4"

rollup.config.js

@@ -61,11 +61,9 @@ export default {
     '@portis/web3',
     '@walletconnect/web3-provider',
     'fortmatic',
-    'squarelink',
     'authereum',
     '@toruslabs/torus-embed',
     'walletlink',
-    '@unilogin/provider',
     'regenerator-runtime/runtime',
     'trezor-connect',
     'ethereumjs-tx',

src/modules/index.ts

@@ -13,9 +13,14 @@ const defaultWalletExplanation = `Wallets are used to send, receive, and store d
 export default function initializeModules(
   networkId: number,
   walletSelect: WalletSelectModuleOptions | undefined,
-  walletCheck: Array<WalletCheckModule | WalletCheckInit> | undefined
+  walletCheck: Array<WalletCheckModule | WalletCheckInit> | undefined,
+  isMobile: boolean
 ) {
-  const wallets = select(walletSelect && walletSelect.wallets, networkId)
+  const wallets = select(
+    walletSelect && walletSelect.wallets,
+    networkId,
+    isMobile
+  )
 
   return {
     walletSelect: {

src/modules/select/index.ts

@@ -3,42 +3,49 @@ import { isWalletInit } from '../../validation'
 
 // wallets that qualify for default wallets need to have no
 // init parameters that are required for full functionality
-const defaultWalletNames = [
+const desktopDefaultWalletNames = ['metamask', 'authereum', 'torus', 'opera']
+
+const mobileDefaultWalletNames = [
   'metamask',
-  'dapper',
+  'authereum',
   'coinbase',
   'trust',
-  'authereum',
   'torus',
   'opera',
   'operaTouch',
   'status',
   'hyperpay',
-  'unilogin',
   'tokenpocket',
   'dcent',
   'atoken'
 ]
 
 function select(
   wallets: Array<WalletInitOptions | WalletModule> | undefined,
-  networkId: number
+  networkId: number,
+  isMobile: boolean
 ) {
+  const defaultWalletNames = isMobile
+    ? mobileDefaultWalletNames
+    : desktopDefaultWalletNames
+
   if (wallets) {
     return Promise.all(
       wallets.map(wallet => {
         if (isWalletInit(wallet)) {
           const { walletName, ...initParams } = wallet
-          const module = getModule(walletName)
 
-          if (!module) {
-            throw new Error(`${walletName} is not a valid walletName.`)
+          try {
+            return getModule(walletName).then((m: any) =>
+              m.default({ ...initParams, networkId })
+            )
+          } catch (error) {
+            if (error.name === 'DeprecatedWalletError') {
+              console.warn(error.message)
+            } else {
+              throw error
+            }
           }
-
-          return (
-            module &&
-            module.then((m: any) => m.default({ ...initParams, networkId }))
-          )
         }
 
         return Promise.resolve(wallet)
@@ -47,29 +54,34 @@ function select(
   }
 
   return Promise.all(
-    defaultWalletNames.map(walletName => {
-      const module = getModule(walletName)
-      if (module) {
-        return module.then((m: any) => m.default({ networkId }))
-      }
-    })
+    defaultWalletNames.map(walletName =>
+      getModule(walletName).then((m: any) => m.default({ networkId }))
+    )
   )
 }
 
-function getModule(name: string): Promise<any> | undefined {
+function getModule(
+  name: string
+): Promise<{
+  default: (options: any) => WalletModule
+}> {
   switch (name) {
+    // Deprecated wallets
+    case 'dapper':
+    case 'squarelink':
+    case 'unilogin':
+      throw {
+        name: 'DeprecatedWalletError',
+        message: `${name} wallet has been deprecated`
+      }
     case 'meetone':
       return import('./wallets/meetone')
     case 'metamask':
       return import('./wallets/metamask')
-    case 'dapper':
-      return import('./wallets/dapper')
     case 'portis':
       return import('./wallets/portis')
     case 'fortmatic':
       return import('./wallets/fortmatic')
-    case 'squarelink':
-      return import('./wallets/squarelink')
     case 'authereum':
       return import('./wallets/authereum')
     case 'trust':
@@ -96,8 +108,6 @@ function getModule(name: string): Promise<any> | undefined {
       return import('./wallets/wallet-link')
     case 'imToken':
       return import('./wallets/imtoken')
-    case 'unilogin':
-      return import('./wallets/unilogin')
     case 'mykey':
       return import('./wallets/mykey')
     case 'huobiwallet':
@@ -113,7 +123,7 @@ function getModule(name: string): Promise<any> | undefined {
     case 'atoken':
       return import('./wallets/atoken')
     default:
-      return
+      throw new Error(`${name} is not a valid walletName.`)
   }
 }