edge-currency-plugins 1.3.2 → 1.3.4

package/lib/common/plugin/makeCurrencyTools.js

@@ -18,6 +18,9 @@ var _utils = require('../utxobased/engine/utils');
 
 
 
+
+
+
 var _cleaners3 = require('../utxobased/keymanager/cleaners');
 
 var _utils3 = require('./utils');
@@ -38,6 +41,20 @@ var _utils3 = require('./utils');
   const asCurrencyNumbWalletInfo = _cleaners3.asNumbWalletInfo.call(void 0, pluginInfo)
 
   const fns = {
+    async checkPublicKey(publicKeyData) {
+      const publicKey = _cleaners.asMaybe.call(void 0, (0, _cleaners3.asPublicKey))(publicKeyData)
+
+      if (publicKey == null) return false
+
+      const privateKeyFormat = _cleaners3.inferPrivateKeyFormat.call(void 0, publicKey)
+      const supportedFormats = _cleaners3.getSupportedFormats.call(void 0, engineInfo, privateKeyFormat)
+
+      // Public must have an defined xpub for every supported format
+      return supportedFormats.every(
+        format => publicKey.publicKeys[format] != null
+      )
+    },
+
     async createPrivateKey(
       _walletType,
       opts

package/lib/common/utxobased/engine/makeUtxoEngine.js

@@ -81,13 +81,13 @@ var _utils = require('./utils');
   const asMaybeCurrencyPrivateKey = _cleaners.asMaybe.call(void 0, asCurrencyPrivateKey)
   // This walletInfo is desensitized (numb) and should be passed around over the original walletInfo
   const walletInfo = _cleaners3.asNumbWalletInfo.call(void 0, pluginInfo)(sensitiveWalletInfo)
-  const { primaryFormat, publicKey, walletFormats } = walletInfo.keys
+  const { privateKeyFormat, publicKey, walletFormats } = walletInfo.keys
 
   if (
     engineInfo.formats == null ||
-    !engineInfo.formats.includes(primaryFormat)
+    !engineInfo.formats.includes(privateKeyFormat)
   ) {
-    const message = `Wallet format is not supported: ${primaryFormat}`
+    const message = `Wallet format is not supported: ${privateKeyFormat}`
     log.error(message)
     throw new Error(message)
   }
@@ -194,7 +194,7 @@ var _utils = require('./utils');
         data: {
           walletInfo: {
             pluginType: currencyInfo.pluginId,
-            primaryFormat,
+            privateKeyFormat,
             walletFormats
           },
           metadataState: metadata.state,
@@ -625,7 +625,7 @@ var _utils = require('./utils');
         id: walletInfo.id,
         type: walletInfo.type,
         keys: {
-          primaryFormat: walletInfo.keys.primaryFormat,
+          privateKeyFormat: walletInfo.keys.privateKeyFormat,
           walletFormats: allFormats,
           publicKey: {
             publicKeys: {}

package/lib/common/utxobased/engine/makeUtxoEngineState.js

@@ -26,7 +26,7 @@ var _ProcessorTransaction = require('../db/Models/ProcessorTransaction');
 
 
 var _types5 = require('../db/types');
-
+var _cleaners3 = require('../keymanager/cleaners');
 
 
 
@@ -54,8 +54,6 @@ var _makeServerStates = require('./makeServerStates');
 
 
 
-
-
 var _utils3 = require('./utils');
 
 
@@ -345,73 +343,58 @@ var _utils3 = require('./utils');
       branch = 0,
       forceIndex
     }) {
-      const walletPurpose = _utils3.currencyFormatToPurposeType.call(void 0, 
-        walletInfo.keys.primaryFormat
-      )
-      if (walletPurpose === _keymanager.BIP43PurposeTypeEnum.Segwit) {
-        const {
-          address: publicAddress,
-          nativeBalance = '0',
-          legacyAddress
-        } = await internalGetFreshAddress({
-          ...commonArgs,
-          format: _utils3.getCurrencyFormatFromPurposeType.call(void 0, 
-            _keymanager.BIP43PurposeTypeEnum.WrappedSegwit
-          ),
-          forceIndex,
-          changeIndex: branch
-        })
+      const { privateKeyFormat } = walletInfo.keys
+
+      // Airbitz wallets only use branch 0
+      if (privateKeyFormat === 'bip32') branch = 0
+
+      const {
+        address: publicAddress,
+        nativeBalance = '0',
+        legacyAddress
+      } = await internalGetFreshAddress({
+        ...commonArgs,
+        format: privateKeyFormat,
+        forceIndex,
+        changeIndex: branch
+      })
 
-        const {
-          address: segwitAddress,
-          nativeBalance: segwitNativeBalance = '0'
-        } = await internalGetFreshAddress({
-          ...commonArgs,
-          format: _utils3.getCurrencyFormatFromPurposeType.call(void 0, _keymanager.BIP43PurposeTypeEnum.Segwit),
-          forceIndex,
-          changeIndex: branch
-        })
+      const freshAddress = {
+        publicAddress,
+        nativeBalance,
+        legacyAddress:
+          legacyAddress !== publicAddress ? legacyAddress : undefined,
+        // Legacy address is just a different encoding of the standard public address
+        // and therefore would have the same balance
+        legacyNativeBalance:
+          legacyAddress !== publicAddress ? nativeBalance : undefined
+      }
 
-        return {
-          nativeBalance,
-          publicAddress,
-          legacyNativeBalance:
-            legacyAddress !== publicAddress ? nativeBalance : undefined,
-          // Legacy address is just a different encoding of the standard public address
-          // and therefore would have the same balance
-          legacyAddress:
-            legacyAddress !== publicAddress ? legacyAddress : undefined,
-          segwitAddress,
-          segwitNativeBalance
-        }
-      } else {
-        // Airbitz wallets only use branch 0
-        if (walletPurpose === _keymanager.BIP43PurposeTypeEnum.Airbitz) {
-          branch = 0
-        }
+      // Exclude the privateKeyFormat because it's covered by 'publicAddress'
+      const supportedFormats = _cleaners3.getSupportedFormats.call(void 0, 
+        pluginInfo.engineInfo,
+        walletInfo.keys.privateKeyFormat
+      ).filter(format => format !== privateKeyFormat)
 
-        const {
-          address: publicAddress,
-          nativeBalance = '0',
-          legacyAddress
-        } = await internalGetFreshAddress({
-          ...commonArgs,
-          format: _utils3.getCurrencyFormatFromPurposeType.call(void 0, walletPurpose),
-          forceIndex,
-          changeIndex: branch
-        })
+      // Loop over all other supported formats for their equivalent address:
+      for (const format of supportedFormats) {
+        if (format === 'bip84') {
+          const {
+            address,
+            nativeBalance = '0'
+          } = await internalGetFreshAddress({
+            ...commonArgs,
+            format,
+            forceIndex,
+            changeIndex: branch
+          })
 
-        return {
-          nativeBalance,
-          publicAddress,
-          legacyNativeBalance:
-            legacyAddress !== publicAddress ? nativeBalance : undefined,
-          // Legacy address is just a different encoding of the standard public address
-          // and therefore would have the same balance
-          legacyAddress:
-            legacyAddress !== publicAddress ? legacyAddress : undefined
+          freshAddress.segwitAddress = address
+          freshAddress.segwitNativeBalance = nativeBalance
         }
       }
+
+      return freshAddress
     },
 
     async deriveScriptAddress(script) {
@@ -420,7 +403,7 @@ var _utils3 = require('./utils');
         engineInfo: commonArgs.pluginInfo.engineInfo,
         processor: commonArgs.processor,
         taskCache: commonArgs.taskCache,
-        format: walletInfo.keys.primaryFormat,
+        format: walletInfo.keys.privateKeyFormat,
         script
       })
       return {

package/lib/common/utxobased/engine/utils.js

@@ -235,11 +235,17 @@ var _keymanager = require('../keymanager/keymanager');
  const deriveXpubsFromKeys = (args
 
 
+
 ) => {
+  const { engineInfo, privateKey, coin } = args
   const xpubs = {}
-  for (const format of _cleaners.getSupportedFormats.call(void 0, args.privateKey.format)) {
+  for (const format of _cleaners.getSupportedFormats.call(void 0, 
+    engineInfo,
+    args.privateKey.format
+  )) {
     xpubs[format] = exports.deriveXpub.call(void 0, {
-      ...args,
+      privateKey,
+      coin,
       type: exports.currencyFormatToPurposeType.call(void 0, format)
     })
   }

package/lib/common/utxobased/info/bitcoin.js

@@ -27,6 +27,7 @@ const currencyInfo = {
     ],
     enableCustomServers: false
   },
+  canReplaceByFee: true,
   customFeeTemplate: [
     {
       type: 'nativeAmount',

package/lib/common/utxobased/info/bitcointestnet.js

@@ -21,6 +21,7 @@ var _constants = require('../../constants');
     blockbookServers: ['wss://tbtc1.trezor.io', 'wss://tbtc2.trezor.io'],
     enableCustomServers: false
   },
+  canReplaceByFee: true,
   customFeeTemplate: [
     {
       type: 'nativeAmount',

package/lib/common/utxobased/info/litecoin.js

@@ -25,6 +25,7 @@ var _constants = require('../../constants');
     ],
     enableCustomServers: false
   },
+  canReplaceByFee: true,
   customFeeTemplate: [
     {
       type: 'nativeAmount',

package/lib/common/utxobased/keymanager/cleaners.js

@@ -15,10 +15,12 @@ var _cleaners = require('cleaners');
 
 
 
+
 var _types3 = require('../../plugin/types');
 var _utils = require('../engine/utils');
 
 // Private key format are a strict subset of all currency formats
+
 const asPrivateKeyFormat = _cleaners.asValue.call(void 0, 'bip32', 'bip44', 'bip49')
 // Default to bip32 always for legacy reasons
 const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKeyFormat, 'bip32')
@@ -82,26 +84,44 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
 }); exports.asPublicKey = asPublicKey
 
 /**
- * This utility returns a wallet's supported formats as specified in the
- * key-formats specification.
+ * This utility returns a wallet's supported formats according to its
+ * private-key's format as specified in the key-formats specification.
  */
  const getSupportedFormats = (
-  format
+  engineInfo,
+  privateKeyFormat
 ) => {
-  switch (format) {
-    case 'bip32':
-      return ['bip32']
-    case 'bip44':
-      return ['bip44']
-    case 'bip49':
-      return ['bip49']
-    case 'bip84':
-      return ['bip84']
-    default:
-      throw new Error(`Unsupported format ${format}`)
-  }
+  const formats = (() => {
+    switch (privateKeyFormat) {
+      case 'bip32':
+        return ['bip32']
+      case 'bip44':
+        return ['bip44']
+      case 'bip49':
+        return ['bip49', 'bip84']
+    }
+  })()
+  const engineInfoFormats = _nullishCoalesce(engineInfo.formats, () => ( ['bip44', 'bip32']))
+  return formats.filter(format => engineInfoFormats.includes(format))
 }; exports.getSupportedFormats = getSupportedFormats
 
+/**
+ * Infers the private key format given a public key
+ */
+
+ const inferPrivateKeyFormat = (
+  publicKey
+) => {
+  const supportedFormats = []
+  for (const [format, xpub] of Object.entries(publicKey.publicKeys)) {
+    if (xpub != null) supportedFormats.push(format )
+  }
+  if (supportedFormats.includes('bip49')) return 'bip49'
+  if (supportedFormats.includes('bip44')) return 'bip44'
+  if (supportedFormats.includes('bip32')) return 'bip32'
+  return 'bip32'
+}; exports.inferPrivateKeyFormat = inferPrivateKeyFormat
+
 /**
  * A cleaner that desensitizes the walletInfo object, excluding sensitive
  * keys (seed/mnemonic, sync key, data key, etc). By using this object type
@@ -113,8 +133,9 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
  * 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.
+ * The `privateKeyFormat` field is the format defined by the private key and is
+ * useful for determining the "kind of wallet", or more precisely how the public
+ * key (xpubs) formats were derived.
  */
 
 
@@ -130,7 +151,7 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
   pluginInfo
 ) => {
   return (walletInfo) => {
-    const { engineInfo, coinInfo } = pluginInfo
+    const { coinInfo, engineInfo } = pluginInfo
     const { id, type } = walletInfo
 
     const asCurrencyPrivateKey = asPrivateKey(coinInfo.name, coinInfo.coinType)
@@ -152,21 +173,13 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
         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 are no defined formats in the engineInfo, then fallback to the
-      // first format in the publicKey after sorting alphabetically.
-      const primaryFormat =
-        _nullishCoalesce((engineInfo.formats != null && engineInfo.formats.length > 0
-          ? engineInfo.formats.find(format => walletFormats.includes(format))
-          : undefined), () => (
-        walletFormats.sort((a, b) => (a === b ? 0 : a > b ? 1 : -1))[0]))
+      const privateKeyFormat = exports.inferPrivateKeyFormat.call(void 0, publicKey)
 
       return {
         id,
         type,
         keys: {
-          primaryFormat,
+          privateKeyFormat,
           walletFormats,
           publicKey
         }
@@ -176,16 +189,17 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
     const privateKey = _cleaners.asMaybe.call(void 0, asCurrencyPrivateKey)(walletInfo.keys)
     if (privateKey != null) {
       const publicKey = _utils.deriveXpubsFromKeys.call(void 0, {
+        engineInfo,
         privateKey,
         coin: coinInfo.name
       })
-      const walletFormats = exports.getSupportedFormats.call(void 0, privateKey.format)
+      const walletFormats = exports.getSupportedFormats.call(void 0, engineInfo, privateKey.format)
 
       return {
         id,
         type,
         keys: {
-          primaryFormat: privateKey.format,
+          privateKeyFormat: privateKey.format,
           walletFormats,
           publicKey: { publicKeys: publicKey }
         }

package/lib/src/common/utxobased/engine/utils.d.ts

@@ -49,6 +49,7 @@ export declare const deriveXprivFromKeys: (args: {
     coin: string;
 }) => CurrencyFormatKeys;
 export declare const deriveXpubsFromKeys: (args: {
+    engineInfo: EngineInfo;
     privateKey: PrivateKey;
     coin: string;
 }) => CurrencyFormatKeys;

package/lib/src/common/utxobased/keymanager/cleaners.d.ts

@@ -1,5 +1,7 @@
 import { Cleaner } from 'cleaners';
-import { CurrencyFormat, PluginInfo } from '../../plugin/types';
+import { CurrencyFormat, EngineInfo, PluginInfo } from '../../plugin/types';
+declare type PrivateKeyFormat = ReturnType<typeof asPrivateKeyFormat>;
+declare const asPrivateKeyFormat: Cleaner<"bip32" | "bip44" | "bip49">;
 /**
  * A cleaner for the private key format following the key-formats specification.
  *
@@ -7,7 +9,7 @@ import { CurrencyFormat, PluginInfo } from '../../plugin/types';
  */
 export interface PrivateKey {
     coinType: number;
-    format: CurrencyFormat;
+    format: PrivateKeyFormat;
     imported?: boolean;
     seed: string;
 }
@@ -24,10 +26,14 @@ export interface PublicKey {
 }
 export declare const asPublicKey: Cleaner<PublicKey>;
 /**
- * This utility returns a wallet's supported formats as specified in the
- * key-formats specification.
+ * This utility returns a wallet's supported formats according to its
+ * private-key's format as specified in the key-formats specification.
  */
-export declare const getSupportedFormats: (format: CurrencyFormat) => CurrencyFormat[];
+export declare const getSupportedFormats: (engineInfo: EngineInfo, privateKeyFormat: PrivateKeyFormat) => CurrencyFormat[];
+/**
+ * Infers the private key format given a public key
+ */
+export declare const inferPrivateKeyFormat: (publicKey: PublicKey) => PrivateKeyFormat;
 /**
  * A cleaner that desensitizes the walletInfo object, excluding sensitive
  * keys (seed/mnemonic, sync key, data key, etc). By using this object type
@@ -39,17 +45,19 @@ export declare const getSupportedFormats: (format: CurrencyFormat) => CurrencyFo
  * 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.
+ * The `privateKeyFormat` field is the format defined by the private key and is
+ * useful for determining the "kind of wallet", or more precisely how the public
+ * key (xpubs) formats were derived.
  */
 export interface NumbWalletInfo {
     id: string;
     type: string;
     keys: {
         imported?: boolean;
-        primaryFormat: CurrencyFormat;
+        privateKeyFormat: PrivateKeyFormat;
         publicKey: PublicKey;
         walletFormats: CurrencyFormat[];
     };
 }
 export declare const asNumbWalletInfo: (pluginInfo: PluginInfo) => Cleaner<NumbWalletInfo>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",
@@ -35,7 +35,7 @@
   "dependencies": {
     "altcoin-js": "https://github.com/EdgeApp/altcoin-js.git#master",
     "async-mutex": "^0.2.6",
-    "baselet": "^0.2.2",
+    "baselet": "^0.2.3",
     "biggystring": "^4.0.0",
     "bip32": "^2.0.5",
     "bip32grs": "^2.0.5",
@@ -48,9 +48,9 @@
     "bs58smartcheck": "^2.0.4",
     "cleaners": "^0.3.12",
     "disklet": "^0.4.5",
-    "edge-core-js": "^0.19.33",
+    "edge-core-js": "^0.19.37",
     "edge-sync-client": "^0.2.7",
-    "memlet": "^0.1.6",
+    "memlet": "^0.1.7",
     "uri-js": "^4.4.0",
     "url-parse": "^1.5.2",
     "wif-smart": "^2.0.0",