ledger backup and recovery

Author: jkup

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

@@ -126,7 +126,7 @@ flashInstalled=Flash is already installed and can be enabled in Preferences > Se
 goToPrefs=Open Preferences
 goToAdobe=Reinstall Flash
 allowFlashPlayer=Allow {{origin}} to run Flash Player?
-
+ledgerBackupText=Your ledger keys are {{paymentId}} and {{passphrase}}
 error=Error
 caseSensitivity=Match case
 nameField=Title:

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

@@ -59,10 +59,12 @@ bitcoinVisitAccount=Transfer BTC
 bitcoinBalance=Please transfer: 
 bitcoinWalletNotAvailable=Wallet information not available. :(
 usd=$
+cancel=Cancel
 done=Done
 off=off
 on=on
-notifications=notifications
+ok=Ok
+notifications=Show payment notifications
 moneyAdd=Use your debit/credit card
 moneyAddSubTitle=No Bitcoin needed!
 outsideUSAPayment=Need to buy Bitcoin outside of the USA?
@@ -71,6 +73,11 @@ add=Fund with debit/credit
 transferTime=Transfer may take up to 40 minutes
 addFundsTitle=Add funds…
 addFunds=Three ways to add funds to your Brave Wallet
+copy=Copy
+firstKey=Key 1
+secondKey=Key 2
+firstRecoveryKey=Recovery Key 1
+secondRecoveryKey=Recovery Key 2
 copyToClipboard=Copy to clipboard
 smartphoneTitle=Use your smartphone app to transfer Bitcoin
 displayQRCode=Display QR code
@@ -110,6 +117,21 @@ offerSearchSuggestions=Autocomplete search term as you type
 doNotTrackTitle=Do Not Track
 doNotTrack=Send a 'Do Not Track' header with browsing requests (requires browser restart)
 blockCanvasFingerprinting=Fingerprinting Protection (may break some websites)
+advancedSettings=Advanced Settings...
+advancedSettingsTitle=Advanced Settings for Brave Payments
+ledgerRecoveryTitle=Recover your Brave wallet
+ledgerRecoverySubtitle=Enter your recovery keys below
+ledgerRecoveryContent=The balance of the recovered wallet will be transferred to your new Brave wallet. The old wallet will still exist as an empty wallet.
+ledgerBackupTitle=Backup your Brave wallet
+ledgerBackupContent=Below, you will find the anonymized recovery keys that are required if you ever lose access to this computer.
+minimumPageTimeSetting=Minimum page time before logging a visit
+minimumVisitsSetting=Minimum visits for publisher relevancy
+backupLedger=Backup your wallet
+balanceRecovered={{balance}} BTC was recovered and transferred to your Brave wallet.
+recoverLedger=Recover your wallet
+recover=Recover
+printKeys=Print keys
+saveRecoveryFile=Save recovery file...
 advancedPrivacySettings=Advanced Privacy Settings:
 braveryDefaults=Bravery Defaults
 blockAttackSites=Block reported attack sites (not available yet)

app/ledger.js

@@ -53,6 +53,8 @@ const appStore = require('../js/stores/appStore')
 const eventStore = require('../js/stores/eventStore')
 const rulesolver = require('./extensions/brave/content/scripts/pageInformation')
 const ledgerUtil = require('./common/lib/ledgerUtil')
+const Tabs = require('./browser/tabs')
+const {fileUrl} = require('../js/lib/appUrlUtil')
 
 // TBD: remove these post beta [MTR]
 const logPath = 'ledger-log.json'
@@ -133,9 +135,25 @@ const doAction = (action) => {
         case settings.PAYMENTS_ENABLED:
           initialize(action.value)
           break
+
         case settings.PAYMENTS_CONTRIBUTION_AMOUNT:
           setPaymentInfo(action.value)
           break
+
+        case settings.MINIMUM_VISIT_TIME:
+          if (action.value <= 0) break
+
+          synopsis.options.minDuration = action.value
+          updatePublisherInfo()
+          break
+
+        case settings.MINIMUM_VISTS:
+          if (action.value <= 0) break
+
+          synopsis.options.minPublisherVisits = action.value
+          updatePublisherInfo()
+          break
+
         default:
           break
       }
@@ -215,6 +233,51 @@ var boot = () => {
   })
 }
 
+/*
+ * Print or Save Recovery Keys
+ */
+
+var backupKeys = (appState, action) => {
+  const paymentId = appState.getIn(['ledgerInfo', 'paymentId'])
+  const passphrase = appState.getIn(['ledgerInfo', 'passphrase'])
+  const message = locale.translation('ledgerBackupText', {paymentId, passphrase})
+  const filePath = path.join(app.getPath('userData'), '/brave_wallet_recovery.txt')
+
+  fs.writeFile(filePath, message, (err) => {
+    if (err) {
+      console.log(err)
+    } else {
+      Tabs.create({url: fileUrl(filePath)}).then((webContents) => {
+        if (action.backupAction === 'print') {
+          webContents.print({silent: false, printBackground: false})
+        } else {
+          webContents.downloadURL(fileUrl(filePath))
+        }
+      }).catch((err) => {
+        console.error(err)
+      })
+    }
+  })
+
+  return appState
+}
+
+/*
+ * Recover Ledger Keys
+ */
+
+var recoverKeys = (appState, action) => {
+  client.recoverWallet(action.firstRecoveryKey, action.secondRecoveryKey, (err, body) => {
+    if (err) {
+      setImmediate(() => appActions.ledgerRecoveryFailed())
+    } else {
+      setImmediate(() => appActions.ledgerRecoverySucceeded())
+    }
+  })
+
+  return appState
+}
+
 /*
  * IPC entry point
  */
@@ -571,6 +634,8 @@ var enable = (paymentsEnabled) => {
  */
 
 var publisherInfo = {
+  options: undefined,
+
   synopsis: undefined,
 
   _internal: {
@@ -601,13 +666,15 @@ var updatePublisherInfo = () => {
   syncWriter(pathName(synopsisPath), synopsis, () => {})
   publisherInfo.synopsis = synopsisNormalizer()
 
+  publisherInfo.synopsisOptions = synopsis.options
+
   if (publisherInfo._internal.debugP) {
     data = []
     publisherInfo.synopsis.forEach((entry) => {
       data.push(underscore.extend(underscore.omit(entry, [ 'faviconURL' ]), { faviconURL: entry.faviconURL && '...' }))
     })
 
-    console.log('\nupdatePublisherInfo: ' + JSON.stringify(data, null, 2))
+    console.log('\nupdatePublisherInfo: ' + JSON.stringify({ options: publisherInfo.synopsisOptions, synopsis: data }, null, 2))
   }
 
   appActions.updatePublisherInfo(underscore.omit(publisherInfo, [ '_internal' ]))
@@ -871,6 +938,14 @@ var ledgerInfo = {
   buyURL: undefined,
   bravery: undefined,
 
+  // wallet credentials
+  paymentId: undefined,
+  passphrase: undefined,
+
+  // advanced ledger settings
+  minDuration: undefined,
+  minPublisherVisits: undefined,
+
   hasBitcoinHandler: false,
 
   // geoIP/exchange information
@@ -1109,6 +1184,12 @@ var getStateInfo = (state) => {
   var info = state.paymentInfo
   var then = underscore.now() - msecs.year
 
+  ledgerInfo.paymentId = state.properties.wallet.paymentId
+  ledgerInfo.passphrase = state.properties.wallet.keychains.passphrase
+
+  ledgerInfo.minDuration = synopsis.options.minDuration
+  ledgerInfo.minPublisherVisits = synopsis.options.minPublisherVisits
+
   ledgerInfo.created = !!state.properties.wallet
   ledgerInfo.creating = !ledgerInfo.created
 
@@ -1230,7 +1311,6 @@ var getPaymentInfo = () => {
 
       info = underscore.extend(info, underscore.pick(body, [ 'buyURL', 'buyURLExpires', 'balance', 'unconfirmed', 'satoshis' ]))
       info.address = client.getWalletAddress()
-      info.passphrase = client.getWalletPassphrase()
       if ((amount) && (currency)) {
         info = underscore.extend(info, { amount: amount, currency: currency })
         if ((body.rates) && (body.rates[currency])) {
@@ -1452,6 +1532,8 @@ const showNotificationPaymentDone = (transactionContributionFiat) => {
 
 module.exports = {
   init: init,
+  recoverKeys: recoverKeys,
+  backupKeys: backupKeys,
   quit: quit,
   boot: boot
 }

app/locale.js

@@ -52,6 +52,7 @@ var rendererIdentifiers = function () {
     'deleteBookmark',
     'deleteHistoryEntry',
     'deleteLedgerEntry',
+    'ledgerBackupText',
     'editFolder',
     'editBookmark',
     'unmuteTabs',
@@ -229,13 +230,19 @@ var ctx = null
 var translations = {}
 var lang = 'en-US'
 
+// todo: FSI/PDI stripping can probably be replaced once
+// https://github.com/l20n/l20n.js/commit/2fea50bf43c43a8e930a519a37f0f64f3626e885
+// is released
+const FSI = '\u2068'
+const PDI = '\u2069'
+
 // Return a translate token from cache or a placeholder
 // indicating that no translation is available
 exports.translation = function (token, replacements = {}) {
   if (translations[token]) {
     let returnVal = translations[token]
     for (var key in replacements) {
-      returnVal = returnVal.replace(new RegExp('{{\\s*' + key + '\\s*}}'), replacements[key])
+      returnVal = returnVal.replace(new RegExp(FSI + '{{\\s*' + key + '\\s*}}' + PDI), replacements[key])
     }
     return returnVal
   } else {

app/sessionStore.js

@@ -233,6 +233,10 @@ module.exports.cleanAppData = (data, isShutdown) => {
   data.temporarySiteSettings = {}
   // Delete Flash state since this is checked on startup
   delete data.flashInitialized
+  // Delete Recovery status on shut down
+  try {
+    delete data.ui.about.preferences.recoverySucceeded
+  } catch (e) {}
   // We used to store a huge list of IDs but we didn't use them.
   // Get rid of them here.
   delete data.windows

docs/appActions.md

@@ -104,6 +104,18 @@ Dispatches a message to clear all completed downloads
 
 
 
+### ledgerRecoverySucceeded() 
+
+Dispatches a message to clear all completed downloads
+
+
+
+### ledgerRecoveryFailed() 
+
+Dispatches a message to clear all completed downloads
+
+
+
 ### setDefaultWindowSize(size) 
 
 Sets the default window size

docs/state.md

@@ -461,14 +461,15 @@ WindowStore
       exchangeName: string,      // the name of the BTC exchange
       exchangeURL: string        // the URL of the BTC exchange
     },
+    recoverySucceeded: boolean   // the status of an attempted recovery
     paymentIMG: string,          // the QR code equivalent of `paymentURL` expressed as "data:image/...;base64,..."
     error: {                     // non-null if the last updateLedgerInfo happened concurrently with an error
       caller: string             // function in which error was handled
       error: object              // error object returned
     }
   },
-  publisherInfo: [               // one entry for each publisher having a non-zero `score`
-    {
+  publisherInfo: {
+    synopsis: [ { // one entry for each publisher having a non-zero `score`
       rank: number,              // i.e., 1, 2, 3, ...
       verified: boolean,         // there is a verified wallet for this publisher
       site: string,              // publisher name, e.g., "wikipedia.org"
@@ -482,8 +483,12 @@ WindowStore
       percentage: number,        // i.e., 0, 1, ... 100
       publisherURL: string,      // publisher site, e.g., "https://wikipedia.org/"
       faviconURL: string         // i.e., "data:image/...;base64,..."
+    } ],
+    synopsisOptions: {
+      minDuration: number,       // e.g., 8000 for 8 seconds
+      minPublisherVisits: number // e.g., 0
     }
-  ],
+  }
   autofillAddressDetail: {
     name: string,
     organization: string,

js/about/aboutActions.js

@@ -87,6 +87,36 @@ const aboutActions = {
     })
   },
 
+  /**
+   * Generates a file with the users backup keys
+   */
+  ledgerGenerateKeyFile: function (backupAction) {
+    aboutActions.dispatchAction({
+      actionType: appConstants.APP_BACKUP_KEYS,
+      backupAction
+    })
+  },
+
+  /**
+   * Recover wallet by merging old wallet into new one
+   */
+  ledgerRecoverWallet: function (firstRecoveryKey, secondRecoveryKey) {
+    aboutActions.dispatchAction({
+      actionType: appConstants.APP_RECOVER_WALLET,
+      firstRecoveryKey,
+      secondRecoveryKey
+    })
+  },
+
+  /**
+   * Clear wallet recovery status
+   */
+  clearRecoveryStatus: function () {
+    aboutActions.dispatchAction({
+      actionType: appConstants.APP_CLEAR_RECOVERY
+    })
+  },
+
   /**
    * Click through a certificate error.
    *