Add "Import recovery keys" button to Payments->Advanced->Recover

(opens a file chooser dialog)

fixes #4806

Includes tests for Ledger backup and recovery:
- add advanced ledger panel tests file `test/components/ledgerPanelAdvancedPanelTest.js`
- add tests for backup and recovery of wallet
- add commands to Brave test client (`ipcOnce`, `ipcSendRendererSync`, and `translations`)
  client.translations: returns a map of all existing translations (current locale) to test client

Import recovery keys success closes modals
- successful import closes modals
- and closing file chooser dialog does not trigger error screen

fixes #6263

Import recovery keys shows error popover if keys are invalid or missing
- error popover is displayed if paymentId / passphrase are missing or not UUIDs
  (ledger-client#recoverWallet should probably do validation too)
- added tests for cases:
  one or both recovery keys missing from file
  a recovery key is not a UUID
  an empty recovery file

app/extensions/brave/locales/en-US/preferences.properties

@@ -160,6 +160,7 @@ backupLedger=Backup your wallet
 balanceRecovered={{balance}} BTC was recovered and transferred to your Brave wallet.
 recoverLedger=Recover your wallet
 recover=Recover
+recoverFromFile=Import recovery keys
 printKeys=Print keys
 saveRecoveryFile=Save recovery file...
 advancedPrivacySettings=Advanced Privacy Settings:

app/filtering.js

@@ -490,12 +490,14 @@ function registerForDownloadListener (session) {
     }
 
     const defaultPath = path.join(getSetting(settings.DEFAULT_DOWNLOAD_SAVE_PATH) || app.getPath('downloads'), itemFilename)
-    const savePath = dialog.showSaveDialog(win, { defaultPath })
+    const savePath = (process.env.SPECTRON ? defaultPath : dialog.showSaveDialog(win, { defaultPath }))
+
     // User cancelled out of save dialog prompt
     if (!savePath) {
       event.preventDefault()
       return
     }
+
     item.setSavePath(savePath)
     appActions.changeSetting(settings.DEFAULT_DOWNLOAD_SAVE_PATH, path.dirname(savePath))
 

app/ledger.js

@@ -254,6 +254,7 @@ var backupKeys = (appState, action) => {
   const date = moment().format('L')
   const paymentId = appState.getIn(['ledgerInfo', 'paymentId'])
   const passphrase = appState.getIn(['ledgerInfo', 'passphrase'])
+
   const messageLines = [
     locale.translation('ledgerBackupText1'),
     [locale.translation('ledgerBackupText2'), date].join(' '),
@@ -263,6 +264,7 @@ var backupKeys = (appState, action) => {
     '',
     locale.translation('ledgerBackupText5')
   ]
+
   const message = messageLines.join(os.EOL)
   const filePath = path.join(app.getPath('userData'), '/brave_wallet_recovery.txt')
 
@@ -283,14 +285,83 @@ var backupKeys = (appState, action) => {
   return appState
 }
 
+var loadKeysFromBackupFile = (filePath) => {
+  let keys = null
+  let data = fs.readFileSync(filePath)
+
+  if (!data || !data.length || !(data.toString())) {
+    logError('No data in backup file', 'recoveryWallet')
+  } else {
+    try {
+      const recoveryFileContents = data.toString()
+
+      let messageLines = recoveryFileContents.split(os.EOL)
+
+      let paymentIdLine = '' || messageLines[3]
+      let passphraseLine = '' || messageLines[4]
+
+      const paymentIdPattern = new RegExp([locale.translation('ledgerBackupText3'), '([^ ]+)'].join(' '))
+      const paymentId = (paymentIdLine.match(paymentIdPattern) || [])[1]
+
+      const passphrasePattern = new RegExp([locale.translation('ledgerBackupText4'), '(.+)$'].join(' '))
+      const passphrase = (passphraseLine.match(passphrasePattern) || [])[1]
+
+      keys = {
+        paymentId,
+        passphrase
+      }
+    } catch (exc) {
+      logError(exc, 'recoveryWallet')
+    }
+  }
+
+  return keys
+}
+
 /*
  * Recover Ledger Keys
  */
 
 var recoverKeys = (appState, action) => {
-  client.recoverWallet(action.firstRecoveryKey, action.secondRecoveryKey, (err, body) => {
-    if (logError(err, 'recoveryWallet')) appActions.updateLedgerInfo(underscore.omit(ledgerInfo, [ '_internal' ]))
-    if (err) {
+  let firstRecoveryKey, secondRecoveryKey
+
+  if (action.useRecoveryKeyFile) {
+    let recoveryKeyFile = promptForRecoveryKeyFile()
+    if (!recoveryKeyFile) {
+      // user canceled from dialog, we abort without error
+      return appState
+    }
+
+    if (recoveryKeyFile) {
+      let keys = loadKeysFromBackupFile(recoveryKeyFile) || {}
+
+      if (keys) {
+        firstRecoveryKey = keys.paymentId
+        secondRecoveryKey = keys.passphrase
+      }
+    }
+  }
+
+  if (!firstRecoveryKey || !secondRecoveryKey) {
+    firstRecoveryKey = action.firstRecoveryKey
+    secondRecoveryKey = action.secondRecoveryKey
+  }
+
+  const UUID_REGEX = /^[0-9a-z]{8}\-[0-9a-z]{4}\-[0-9a-z]{4}\-[0-9a-z]{4}\-[0-9a-z]{12}$/
+  if (typeof firstRecoveryKey !== 'string' || !firstRecoveryKey.match(UUID_REGEX) || typeof secondRecoveryKey !== 'string' || !secondRecoveryKey.match(UUID_REGEX)) {
+    setImmediate(() => appActions.ledgerRecoveryFailed())
+    return appState
+  }
+
+  client.recoverWallet(firstRecoveryKey, secondRecoveryKey, (err, body) => {
+    let existingLedgerError = ledgerInfo.error
+
+    if (logError(err, 'recoveryWallet')) {
+      // we reset ledgerInfo.error to what it was before (likely null)
+      // if ledgerInfo.error is not null, the wallet info will not display in UI
+      // logError sets ledgerInfo.error, so we must we clear it or UI will show an error
+      ledgerInfo.error = existingLedgerError
+      appActions.updateLedgerInfo(underscore.omit(ledgerInfo, [ '_internal' ]))
       setImmediate(() => appActions.ledgerRecoveryFailed())
     } else {
       setImmediate(() => appActions.ledgerRecoverySucceeded())
@@ -300,6 +371,31 @@ var recoverKeys = (appState, action) => {
   return appState
 }
 
+const dialog = electron.dialog
+
+var promptForRecoveryKeyFile = () => {
+  const defaultRecoveryKeyFilePath = path.join(app.getPath('userData'), '/brave_wallet_recovery.txt')
+
+  let files
+
+  if (process.env.SPECTRON) {
+    // skip the dialog for tests
+    console.log(`for test, trying to recover keys from path: ${defaultRecoveryKeyFilePath}`)
+    files = [defaultRecoveryKeyFilePath]
+  } else {
+    files = dialog.showOpenDialog({
+      properties: ['openFile'],
+      defaultPath: defaultRecoveryKeyFilePath,
+      filters: [{
+        name: 'TXT files',
+        extensions: ['txt']
+      }]
+    })
+  }
+
+  return (files && files.length ? files[0] : null)
+}
+
 /*
  * IPC entry point
  */

docs/appActions.md

@@ -146,13 +146,13 @@ Dispatches a message to clear all completed downloads
 
 ### ledgerRecoverySucceeded() 
 
-Dispatches a message to clear all completed downloads
+Dispatches a message indicating ledger recovery succeeded
 
 
 
 ### ledgerRecoveryFailed() 
 
-Dispatches a message to clear all completed downloads
+Dispatches a message indicating ledger recovery failed
 
 
 

js/about/aboutActions.js

@@ -108,6 +108,13 @@ const aboutActions = {
     })
   },
 
+  ledgerRecoverWalletFromFile: function () {
+    aboutActions.dispatchAction({
+      actionType: appConstants.APP_RECOVER_WALLET,
+      useRecoveryKeyFile: true
+    })
+  },
+
   /**
    * Clear wallet recovery status
    */

js/about/preferences.js

@@ -900,6 +900,10 @@ class PaymentsTab extends ImmutableComponent {
     aboutActions.ledgerRecoverWallet(this.state.FirstRecoveryKey, this.state.SecondRecoveryKey)
   }
 
+  recoverWalletFromFile () {
+    aboutActions.ledgerRecoverWalletFromFile()
+  }
+
   copyToClipboard (text) {
     aboutActions.setClipboard(text)
   }
@@ -910,6 +914,7 @@ class PaymentsTab extends ImmutableComponent {
 
   clearRecoveryStatus () {
     aboutActions.clearRecoveryStatus()
+    this.props.hideAdvancedOverlays()
   }
 
   printKeys () {
@@ -1142,23 +1147,26 @@ class PaymentsTab extends ImmutableComponent {
   }
 
   get ledgerRecoveryContent () {
+    let balance = this.props.ledgerData.get('balance')
+
     const l10nDataArgs = {
-      balance: this.props.ledgerData.get('balance')
+      balance: (!balance ? '0.00' : balance)
     }
+
     return <div className='board'>
       {
         this.props.ledgerData.get('recoverySucceeded') === true
         ? <div className='recoveryOverlay'>
           <h1>Success!</h1>
           <p className='spaceAround' data-l10n-id='balanceRecovered' data-l10n-args={JSON.stringify(l10nDataArgs)} />
-          <Button l10nId='ok' className='whiteButton inlineButton' onClick={this.clearRecoveryStatus} />
+          <Button l10nId='ok' className='whiteButton inlineButton' onClick={this.clearRecoveryStatus.bind(this)} />
         </div>
         : null
       }
       {
         this.props.ledgerData.get('recoverySucceeded') === false
         ? <div className='recoveryOverlay'>
-          <h1>Recovery failed</h1>
+          <h1 className='recoveryError'>Recovery failed</h1>
           <p className='spaceAround'>Please re-enter keys or try different keys.</p>
           <Button l10nId='ok' className='whiteButton inlineButton' onClick={this.clearRecoveryStatus} />
         </div>
@@ -1183,6 +1191,7 @@ class PaymentsTab extends ImmutableComponent {
     return <div className='panel advancedSettingsFooter'>
       <div className='recoveryFooterButtons'>
         <Button l10nId='recover' className='primaryButton' onClick={this.recoverWallet} />
+        <Button l10nId='recoverFromFile' className='primaryButton' onClick={this.recoverWalletFromFile} />
         <Button l10nId='cancel' className='whiteButton' onClick={this.props.hideOverlay.bind(this, 'ledgerRecovery')} />
       </div>
     </div>
@@ -1849,6 +1858,15 @@ class AboutPreferences extends React.Component {
     this.updateTabFromAnchor = this.updateTabFromAnchor.bind(this)
   }
 
+  hideAdvancedOverlays () {
+    this.setState({
+      advancedSettingsOverlayVisible: false,
+      ledgerBackupOverlayVisible: false,
+      ledgerRecoveryOverlayVisible: false
+    })
+    this.forceUpdate()
+  }
+
   componentDidMount () {
     window.addEventListener('popstate', this.updateTabFromAnchor)
   }
@@ -1974,7 +1992,8 @@ class AboutPreferences extends React.Component {
           ledgerRecoveryOverlayVisible={this.state.ledgerRecoveryOverlayVisible}
           addFundsOverlayVisible={this.state.addFundsOverlayVisible}
           showOverlay={this.setOverlayVisible.bind(this, true)}
-          hideOverlay={this.setOverlayVisible.bind(this, false)} />
+          hideOverlay={this.setOverlayVisible.bind(this, false)}
+          hideAdvancedOverlays={this.hideAdvancedOverlays.bind(this)} />
         break
       case preferenceTabs.SECURITY:
         tab = <SecurityTab settings={settings} siteSettings={siteSettings} braveryDefaults={braveryDefaults} onChangeSetting={this.onChangeSetting} />

js/actions/appActions.js

@@ -192,7 +192,7 @@ const appActions = {
   },
 
   /**
-   * Dispatches a message to clear all completed downloads
+   * Dispatches a message indicating ledger recovery succeeded
    */
   ledgerRecoverySucceeded: function () {
     AppDispatcher.dispatch({
@@ -201,7 +201,7 @@ const appActions = {
   },
 
   /**
-   * Dispatches a message to clear all completed downloads
+   * Dispatches a message indicating ledger recovery failed
    */
   ledgerRecoveryFailed: function () {
     AppDispatcher.dispatch({