Merge pull request #279 from EdgeApp/sam/rug-bip84

Disable bech32/bip84 wallet types

Author: thehobbit85

src/common/utxobased/engine/makeUtxoEngine.ts

@@ -58,17 +58,13 @@ export async function makeUtxoEngine(
   const asMaybeCurrencyPrivateKey = asMaybe(asCurrencyPrivateKey)
   // This walletInfo is desensitized (numb) and should be passed around over the original walletInfo
   const walletInfo = asNumbWalletInfo(pluginInfo)(sensitiveWalletInfo)
-  const {
-    publicKey,
-    supportedFormats: walletFormatsSupported,
-    format: walletFormat
-  } = walletInfo.keys
+  const { primaryFormat, publicKey, walletFormats } = walletInfo.keys
 
   if (
     engineInfo.formats == null ||
-    !engineInfo.formats.includes(walletFormat)
+    !engineInfo.formats.includes(primaryFormat)
   ) {
-    const message = `Wallet format is not supported: ${walletFormat}`
+    const message = `Wallet format is not supported: ${primaryFormat}`
     log.error(message)
     throw new Error(message)
   }
@@ -172,9 +168,9 @@ export async function makeUtxoEngine(
         walletType: walletInfo.type,
         data: {
           walletInfo: {
-            walletFormat,
-            walletFormatsSupported,
-            pluginType: currencyInfo.pluginId
+            pluginType: currencyInfo.pluginId,
+            primaryFormat,
+            walletFormats
           },
           processorState: await processor.dumpData(),
           pluginState: pluginState.dumpData()
@@ -536,8 +532,8 @@ export async function makeUtxoEngine(
         id: walletInfo.id,
         type: walletInfo.type,
         keys: {
-          format: walletInfo.keys.format,
-          supportedFormats: allFormats,
+          primaryFormat: walletInfo.keys.primaryFormat,
+          walletFormats: allFormats,
           publicKey: {
             publicKeys: {}
           }

src/common/utxobased/engine/makeUtxoEngineState.ts

@@ -95,7 +95,7 @@ export function makeUtxoEngineState(
     pluginState
   } = config
 
-  const { supportedFormats } = walletInfo.keys
+  const { walletFormats } = walletInfo.keys
 
   const taskCache: TaskCache = {
     addressWatching: false,
@@ -169,7 +169,7 @@ export function makeUtxoEngineState(
     io: config.io,
     log,
     serverStates,
-    supportedFormats,
+    walletFormats,
     lock
   }
 
@@ -235,7 +235,7 @@ export function makeUtxoEngineState(
   // processed by the processor. This happens only once before any call to
   // setLookAhead.
   const initializeAddressSubscriptions = async (): Promise<void> => {
-    for (const format of supportedFormats) {
+    for (const format of walletFormats) {
       const branches = getFormatSupportedBranches(format)
       for (const branch of branches) {
         const addressesToSubscribe = new Set<string>()
@@ -292,7 +292,9 @@ export function makeUtxoEngineState(
     },
 
     async getFreshAddress(branch = 0): Promise<EdgeFreshAddress> {
-      const walletPurpose = currencyFormatToPurposeType(walletInfo.keys.format)
+      const walletPurpose = currencyFormatToPurposeType(
+        walletInfo.keys.primaryFormat
+      )
       if (walletPurpose === BIP43PurposeTypeEnum.Segwit) {
         const { address: publicAddress } = await internalGetFreshAddress({
           ...commonArgs,
@@ -341,7 +343,7 @@ export function makeUtxoEngineState(
         engineInfo: commonArgs.pluginInfo.engineInfo,
         processor: commonArgs.processor,
         taskCache: commonArgs.taskCache,
-        format: walletInfo.keys.format,
+        format: walletInfo.keys.primaryFormat,
         script
       })
       return {
@@ -401,7 +403,7 @@ export function makeUtxoEngineState(
 
     async loadWifs(wifs: string[]) {
       for (const wif of wifs) {
-        for (const format of supportedFormats) {
+        for (const format of walletFormats) {
           const changePath: ChangePath = {
             format,
             changeIndex: 0
@@ -446,7 +448,7 @@ interface CommonArgs {
   io: EdgeIo
   log: EdgeLog
   serverStates: ServerStates
-  supportedFormats: CurrencyFormat[]
+  walletFormats: CurrencyFormat[]
   lock: AwaitLock
 }
 
@@ -502,7 +504,7 @@ const setLookAhead = async (common: CommonArgs): Promise<void> => {
     pluginInfo: { engineInfo },
     lock,
     processor,
-    supportedFormats,
+    walletFormats,
     walletTools
   } = common
 
@@ -511,7 +513,7 @@ const setLookAhead = async (common: CommonArgs): Promise<void> => {
   await lock.acquireAsync()
 
   try {
-    for (const format of supportedFormats) {
+    for (const format of walletFormats) {
       const branches = getFormatSupportedBranches(format)
       for (const branch of branches) {
         await deriveKeys({ format, changeIndex: branch })

src/common/utxobased/keymanager/cleaners.ts

@@ -91,9 +91,9 @@ export const getSupportedFormats = (
     case 'bip44':
       return ['bip44']
     case 'bip49':
-      return ['bip49', 'bip84']
+      return ['bip49']
     case 'bip84':
-      return ['bip49', 'bip84']
+      return ['bip84']
     default:
       throw new Error(`Unsupported format ${format}`)
   }
@@ -102,17 +102,23 @@ export const getSupportedFormats = (
 /**
  * A cleaner that desensitizes the walletInfo object, excluding sensitive
  * keys (seed/mnemonic, sync key, data key, etc). By using this object type
- * internally within the plugin, we can minimize risk.
+ * internally within the plugin, we can minimize risk of leaking sensitive data.
  *
- * It also includes internal derived data (publicKey, format, supportedFormats, etc).
+ * It also includes internal derived data (publicKey, format, walletFormats, etc).
  * This derived data is to be used internally within the plugin and saved to disk (publicKey).
+ *
+ * The `walletFormats` field is a list of formats from which to derive
+ * extended-keys for the wallet.
+ *
+ * The `primaryFormat` field is the default format from which to derive
+ * addresses from.
  */
 export interface NumbWalletInfo {
   id: string
   type: string
   keys: {
-    format: CurrencyFormat
-    supportedFormats: CurrencyFormat[]
+    primaryFormat: CurrencyFormat
+    walletFormats: CurrencyFormat[]
     publicKey: PublicKey
   }
 }
@@ -127,7 +133,7 @@ export const asNumbWalletInfo = (
 
     const publicKey = asMaybe(asPublicKey)(walletInfo.keys)
     if (publicKey != null) {
-      const formats = Object.entries(publicKey.publicKeys)
+      const walletFormats = Object.entries(publicKey.publicKeys)
         // Filter out undefined values in the entries because cleaners allow
         // undefined values for optional fields.
         .filter(([, value]) => value != null)
@@ -138,26 +144,26 @@ export const asNumbWalletInfo = (
           (format?: CurrencyFormat): format is CurrencyFormat => format != null
         )
 
-      if (formats.length === 0) {
+      if (walletFormats.length === 0) {
         throw new Error('Missing wallet public keys')
       }
 
       // Search the engineInfo's formats array for the first format that exists
       // in the publicKey data.
-      // If there is not defined formats in the engineInfo, fallback to the first
-      // format in the publicKey after sorting alphabetically.
-      const format =
+      // If there are no defined formats in the engineInfo, then fallback to the
+      // first format in the publicKey after sorting alphabetically.
+      const primaryFormat =
         (engineInfo.formats != null && engineInfo.formats.length > 0
-          ? engineInfo.formats.find(format => formats.includes(format))
+          ? engineInfo.formats.find(format => walletFormats.includes(format))
           : undefined) ??
-        formats.sort((a, b) => (a === b ? 0 : a > b ? 1 : -1))[0]
+        walletFormats.sort((a, b) => (a === b ? 0 : a > b ? 1 : -1))[0]
 
       return {
         id,
         type,
         keys: {
-          format,
-          supportedFormats: formats,
+          primaryFormat,
+          walletFormats,
           publicKey
         }
       }
@@ -169,13 +175,14 @@ export const asNumbWalletInfo = (
         privateKey,
         coin: coinInfo.name
       })
+      const walletFormats = getSupportedFormats(privateKey.format)
 
       return {
         id,
         type,
         keys: {
-          format: privateKey.format,
-          supportedFormats: getSupportedFormats(privateKey.format),
+          primaryFormat: privateKey.format,
+          walletFormats,
           publicKey: { publicKeys: publicKey }
         }
       }

test/common/utxobased/engine/engine.spec.ts

@@ -462,7 +462,7 @@ for (const fixture of fixtures) {
       assert(dataDump.walletId === id, 'walletId')
       assert(dataDump.walletType === WALLET_TYPE, 'walletType')
       assert(
-        dataDump.data.walletInfo.walletFormat === WALLET_FORMAT,
+        dataDump.data.walletInfo.primaryFormat === WALLET_FORMAT,
         'walletFormat'
       )
     })