Merge pull request #627 from blocknative/release/1.31.0

Release: 1.31.0 - Master

Author: taylorjdawson

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bnc-onboard",
-  "version": "1.30.0",
+  "version": "1.31.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",
@@ -54,6 +54,9 @@
   },
   "dependencies": {
     "@cvbb/eth-keyring": "^1.1.0",
+    "@ensdomains/ensjs": "^2.0.1",
+    "@ethereumjs/common": "^2.0.0",
+    "@ethereumjs/tx": "^3.0.0",
     "@gnosis.pm/safe-apps-provider": "^0.5.0",
     "@gnosis.pm/safe-apps-sdk": "^3.0.0",
     "@ledgerhq/hw-app-eth": "^5.49.0",
@@ -78,7 +81,7 @@
     "hdkey": "^2.0.1",
     "regenerator-runtime": "^0.13.7",
     "trezor-connect": "^8.1.9",
-    "walletlink": "^2.1.0",
+    "walletlink": "^2.1.6",
     "web3-provider-engine": "^15.0.4"
   },
   "resolutions": {

pull_request_template.md

@@ -0,0 +1,8 @@
+### Description
+<!-- Add a description of the fix or feature here -->
+
+### Checklist
+- [ ] The version field in `package.json` is incremented following [semantic versioning](https://semver.org/)
+- [ ] The box that allows repo maintainers to update this PR is checked
+- [ ] I tested locally to make sure this feature/fix works
+- [ ] This PR passes the Circle CI checks

rollup.config.js

@@ -67,6 +67,8 @@ export default {
     'regenerator-runtime/runtime',
     'trezor-connect',
     'ethereumjs-tx',
+    '@ethereumjs/tx',
+    '@ethereumjs/common',
     'ethereumjs-util',
     'eth-lattice-keyring',
     'eth-sig-util',
@@ -89,6 +91,7 @@ export default {
     '@shapeshiftoss/hdwallet-keepkey-webusb',
     '@shapeshiftoss/hdwallet-core',
     '@gnosis.pm/safe-apps-sdk',
-    '@gnosis.pm/safe-apps-provider'
+    '@gnosis.pm/safe-apps-provider',
+    '@ensdomains/ensjs'
   ]
 }

src/@types/index.d.ts

@@ -8,14 +8,16 @@ declare module 'web3-provider-engine/subproviders/subscriptions'
 declare module 'web3-provider-engine/subproviders/filters'
 declare module 'trezor-connect'
 declare module 'eth-lattice-keyring'
-declare module 'eth-sig-util'
 declare module 'ethereumjs-tx'
+declare module '@ethereumjs/tx'
+declare module '@ethereumjs/common'
 declare module 'ethereumjs-util'
 declare module 'hdkey'
 declare module '@ledgerhq/hw-app-eth'
 declare module '@ledgerhq/hw-transport-u2f'
 declare module '@ledgerhq/hw-transport-webusb'
 declare module 'eth-provider'
+declare module '@ensdomains/ensjs'
 
 declare module '@shapeshiftoss/hdwallet-core'
 declare module '@shapeshiftoss/hdwallet-keepkey-webusb'

src/interfaces.ts

@@ -13,6 +13,7 @@ export interface Initialization {
 
 export interface Subscriptions {
   address?: (address: string) => void
+  ens?: (ens: Ens) => void
   network?: (networkId: number) => void
   balance?: (balance: string) => void
   wallet?: (wallet: Wallet) => void
@@ -196,20 +197,66 @@ export interface WalletConnectOptions extends CommonWalletOptions {
   bridge: string
 }
 
+/*
+ * Types taken from https://github.com/ethereumjs/ethereumjs-vm/blob/eb05651554ec23d2ba7c46af6e5f5a7bc199f217/packages/common/src/types.ts#L15
+ * since they are not exported
+ */
+
+export interface GenesisBlock {
+  hash: string
+  timestamp: string | null
+  gasLimit: number
+  difficulty: number
+  nonce: string
+  extraData: string
+  stateRoot: string
+}
+export interface Hardfork {
+  name: string
+  block: number | null
+}
+
+export interface BootstrapNode {
+  ip: string
+  port: number | string
+  network?: string
+  chainId?: number
+  id: string
+  location: string
+  comment: string
+}
+
+export interface HardwareWalletCustomNetwork {
+  networkId: number
+  genesis: GenesisBlock
+  hardforks: Hardfork[]
+  bootstrapNodes: BootstrapNode[]
+}
+
 export interface TrezorOptions extends CommonWalletOptions {
   appUrl: string
   email: string
   rpcUrl: string
+  customNetwork?: HardwareWalletCustomNetwork
 }
 
 export interface LatticeOptions extends CommonWalletOptions {
   appName: string
   rpcUrl: string
+  customNetwork?: HardwareWalletCustomNetwork
 }
 
 export interface LedgerOptions extends CommonWalletOptions {
   rpcUrl: string
   LedgerTransport?: any
+  customNetwork?: HardwareWalletCustomNetwork
+}
+
+export interface GnosisOptions extends CommonWalletOptions {
+  // For default apps (cf. https://github.com/gnosis/safe-apps-list/issues/new/choose)
+  appName?: string
+  // For other apps, give the URL needed to add a custom app
+  appUrl?: string
 }
 
 //#region torus
@@ -513,3 +560,10 @@ export interface TermsAgreementState {
   terms?: boolean
   privacy?: boolean
 }
+
+export interface Ens {
+  name?: string
+  avatar?: string
+  contentHash?: string
+  getText?: (key: string) => Promise<string | undefined>
+}

src/modules/select/index.ts

@@ -50,16 +50,23 @@ function select(
     : desktopDefaultWalletNames
 
   if (wallets) {
+    // For backwards compatibility if a user is still using 'detectedwallet' in the onboard wallet select array
+    // it will be filtered out so there are no duplicates
+    wallets = wallets.filter(
+      wallet =>
+        'walletName' in wallet ? wallet.walletName !== 'detectedwallet' : true // It is not a WalletInitOption but rather a WalletModule so let it through
+    )
+
+    // If we detect an injected wallet then place the detected wallet
+    // at the beginning of the list e.g. the of the wallet select modal
+    if (injectedWalletDetected()) {
+      wallets.unshift({ walletName: 'detectedwallet' })
+    }
     return Promise.all(
-      wallets
-        // only include a detected wallet if it's not already one of the provided options
-        .filter(
-          wallet =>
-            isWalletInit(wallet) &&
-            (wallet.walletName !== 'detectedwallet' || injectedWalletDetected())
-        )
-        .map(wallet => {
-          const { walletName, ...initParams } = wallet as WalletInitOptions
+      wallets.map(wallet => {
+        // If this is a wallet init object then load the built-in wallet module
+        if (isWalletInit(wallet)) {
+          const { walletName, ...initParams } = wallet
           try {
             return getModule(walletName).then((m: any) =>
               m.default({ ...initParams, networkId, isMobile })
@@ -71,15 +78,17 @@ function select(
               throw error
             }
           }
+        }
 
-          return Promise.resolve(wallet)
-        })
+        // This is a custom wallet module so just return it
+        return Promise.resolve(wallet)
+      })
     )
   }
 
   return Promise.all(
     defaultWalletNames
-      // only include a detected wallet if it's not already one of the provided options
+      // Include the detected wallet only if an injected wallet is detected
       .filter(
         walletName =>
           walletName !== 'detectedwallet' || injectedWalletDetected()

src/modules/select/wallets/cobovault.ts

@@ -65,7 +65,7 @@ async function cobovaultProvider(options: {
     walletName: string
   }) => void
 }) {
-  const EthereumTx = await import('ethereumjs-tx')
+  const { Transaction } = await import('@ethereumjs/tx')
   const { default: createProvider } = await import('./providerEngine')
 
   const BASE_PATH = "m/44'/60'/0'/0"
@@ -227,7 +227,7 @@ async function cobovaultProvider(options: {
       await enable()
     }
 
-    const transaction = new EthereumTx.Transaction(transactionData, {
+    const transaction = Transaction.fromTxData(transactionData, {
       chain: networkName(networkId)
     })
 

src/modules/select/wallets/gnosis.ts

@@ -1,6 +1,6 @@
 import type SafeAppsSDK from '@gnosis.pm/safe-apps-sdk'
 import type { SafeInfo } from '@gnosis.pm/safe-apps-sdk'
-import { CommonWalletOptions, Helpers, WalletModule } from '../../../interfaces'
+import { GnosisOptions, Helpers, WalletModule } from '../../../interfaces'
 import gnosisWalletIcon from '../wallet-icons/icon-gnosis'
 
 const getSafe = (sdk: SafeAppsSDK): Promise<SafeInfo | undefined> =>
@@ -20,11 +20,16 @@ export const checkGnosisSafeContext = async (selectWallet: () => void) =>
   !!(await getSafe(new (await import('@gnosis.pm/safe-apps-sdk')).default())) &&
   selectWallet()
 
-function gnosis(options: CommonWalletOptions): WalletModule {
+function gnosis(options: GnosisOptions): WalletModule {
   const { preferred, label, iconSrc, svg, networkId } = options
 
   const network = networkId === 4 ? 'rinkeby.' : ''
   const link = `https://${network}gnosis-safe.io/app`
+  const safeAppMessage = options.appName
+    ? `Then go to APPS and select <b>${options.appName}</b>.`
+    : options.appUrl
+    ? `Then go to APPS and add a custom app with the URL:<br /><b>${options.appUrl}</b>`
+    : ''
 
   return {
     name: label || 'Gnosis Safe',
@@ -51,7 +56,8 @@ function gnosis(options: CommonWalletOptions): WalletModule {
     link,
     installMessage: () => `
         <p style="font-size: 0.889rem; font-family: inherit; margin: 0.889rem 0;">
-            Click the button below to open the Gnosis Safe interface.
+            Click the button below to open the Gnosis Safe interface.<br />
+            ${safeAppMessage}
         </p>
         `,
     desktop: true,

src/modules/select/wallets/hd-wallet.ts

@@ -37,7 +37,6 @@ export function generateAddresses(
 
 export function isValidPath(path: string) {
   const parts = path.split('/')
-
   if (parts[0] !== 'm') {
     return false
   }
@@ -46,11 +45,11 @@ export function isValidPath(path: string) {
     return false
   }
 
-  if (parts[2] !== "60'" && parts[2] !== "1'") {
+  if (!["60'", "1'", "73799'", "246'"].includes(parts[2])) {
     return false
   }
 
-  if (parts[3] === undefined) {
+  if (parts[3] === undefined || parts[3] === "0'") {
     return true
   }
 

src/modules/select/wallets/keepkey/index.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/camelcase */
+import * as ethUtil from 'ethereumjs-util'
 import {
   CommonWalletOptions,
   Helpers,
@@ -385,7 +386,7 @@ async function createKeepKeyProvider({
       gasPrice,
       gasLimit: gas,
       to,
-      value: value || '',
+      value: value || '0x0',
       data: data || '',
       chainId: networkId
     })
@@ -406,7 +407,7 @@ async function createKeepKeyProvider({
 
     const { signature } = await keepKeyWallet.ethSignMessage({
       addressNList,
-      message
+      message: ethUtil.toBuffer(message).toString('utf8')
     })
 
     return signature