edge-currency-plugins 1.3.7 → 2.0.1

package/lib/common/plugin/makeCurrencyTools.js

@@ -38,7 +38,7 @@ var _utils3 = require('./utils');
 
   const asCurrencyPrivateKey = _cleaners3.asPrivateKey.call(void 0, coinInfo.name, coinInfo.coinType)
   const wasCurrencyPrivateKey = _cleaners.uncleaner.call(void 0, asCurrencyPrivateKey)
-  const asCurrencyNumbWalletInfo = _cleaners3.asNumbWalletInfo.call(void 0, pluginInfo)
+  const asCurrencySafeWalletInfo = _cleaners3.asSafeWalletInfo.call(void 0, pluginInfo)
 
   const fns = {
     async checkPublicKey(publicKeyData) {
@@ -102,9 +102,13 @@ var _utils3 = require('./utils');
       return _utils.validateMemo.call(void 0, memo)
     },
 
-    async derivePublicKey(walletInfo) {
-      const numbWalletInfo = asCurrencyNumbWalletInfo(walletInfo)
-      return numbWalletInfo.keys.publicKey
+    async derivePublicKey(
+      unsafeWalletInfo
+    ) {
+      // Use the safety cleaner to derive the public keys from the
+      // unsafeWalletInfo which contains the private key.
+      const safeWalletInfo = asCurrencySafeWalletInfo(unsafeWalletInfo)
+      return safeWalletInfo.keys.publicKey
     },
 
     async parseUri(uri) {

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

@@ -14,7 +14,8 @@ var _disklet = require('disklet');
 
 
 
-var _types = require('edge-core-js/types');
+
+var _edgecorejs = require('edge-core-js');
 
 var _filterUndefined = require('../../../util/filterUndefined');
 var _unixTime = require('../../../util/unixTime');
@@ -42,7 +43,11 @@ var _keymanager = require('../keymanager/keymanager');
 var _makeUtxoEngineState = require('./makeUtxoEngineState');
 var _makeUtxoWalletTools = require('./makeUtxoWalletTools');
 var _paymentRequest = require('./paymentRequest');
-var _types7 = require('./types');
+
+
+
+
+var _types5 = require('./types');
 var _getOwnUtxosFromTx = require('./util/getOwnUtxosFromTx');
 var _utils = require('./utils');
 
@@ -53,7 +58,6 @@ var _utils = require('./utils');
     pluginInfo,
     pluginDisklet,
     // Rename to make it explicit that this is sensitive memory
-    walletInfo: sensitiveWalletInfo,
     options,
     io,
     pluginState
@@ -65,7 +69,7 @@ var _utils = require('./utils');
     log
   } = options
   const { currencyInfo, engineInfo, coinInfo } = pluginInfo
-  const userSettings = _types7.asUtxoUserSettings.call(void 0, options.userSettings)
+  const userSettings = _types5.asUtxoUserSettings.call(void 0, options.userSettings)
 
   // We should move the active server list to the engine state,
   // since multiple accounts can be logged in at once,
@@ -77,10 +81,12 @@ var _utils = require('./utils');
   })
 
   const asCurrencyPrivateKey = _cleaners3.asPrivateKey.call(void 0, coinInfo.name, coinInfo.coinType)
-  // Private key may be missing for watch-only wallets
+  // Private key may be missing for read-only wallets
   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)
+
+  // This walletInfo will not contain private keys and should only contain the
+  // public keys and so can be passed around the plugin safely.
+  const walletInfo = _cleaners3.asSafeWalletInfo.call(void 0, pluginInfo)(config.walletInfo)
   const { privateKeyFormat, publicKey, walletFormats } = walletInfo.keys
 
   if (
@@ -120,7 +126,7 @@ var _utils = require('./utils');
     pluginState
   })
 
-  const fns = {
+  const engine = {
     async startEngine() {
       emitter.emit(
         _makeEngineEmitter.EngineEvent.WALLET_BALANCE_CHANGED,
@@ -180,7 +186,7 @@ var _utils = require('./utils');
     },
 
     async changeUserSettings(userSettings) {
-      await pluginState.updateServers(_types7.asUtxoUserSettings.call(void 0, userSettings))
+      await pluginState.updateServers(_types5.asUtxoUserSettings.call(void 0, userSettings))
     },
 
     async disableTokens(_tokens) {
@@ -208,8 +214,8 @@ var _utils = require('./utils');
       return await Promise.resolve(undefined)
     },
 
-    getDisplayPrivateSeed() {
-      const privateKey = asMaybeCurrencyPrivateKey(sensitiveWalletInfo.keys)
+    getDisplayPrivateSeed(privateKeys) {
+      const privateKey = asMaybeCurrencyPrivateKey(privateKeys)
       if (privateKey == null) return null
       return privateKey.format === 'bip32'
         ? Buffer.from(privateKey.seed, 'base64').toString('hex')
@@ -279,11 +285,10 @@ var _utils = require('./utils');
       return addressData.used
     },
 
-    async makeSpend(
-      edgeSpendInfo,
-      options
-    ) {
+    async makeSpend(edgeSpendInfo) {
       const { spendTargets } = edgeSpendInfo
+      const txOptions =
+        _optionalChain([edgeSpendInfo, 'access', _5 => _5.otherParams, 'optionalAccess', _6 => _6.txOptions])
       const { outputSort = 'bip69', utxoSourceAddress, forceChangeAddress } =
         _nullishCoalesce(edgeSpendInfo.otherParams, () => ( {}))
 
@@ -292,7 +297,7 @@ var _utils = require('./utils');
         utxoScriptPubkey = walletTools.addressToScriptPubkey(utxoSourceAddress)
       }
 
-      if (_optionalChain([options, 'optionalAccess', _5 => _5.CPFP]) == null && spendTargets.length < 1) {
+      if (_optionalChain([txOptions, 'optionalAccess', _7 => _7.CPFP]) == null && spendTargets.length < 1) {
         throw new Error('Need to provide Spend Targets')
       }
       // Calculate the total amount to send
@@ -301,7 +306,7 @@ var _utils = require('./utils');
         '0'
       )
       const utxos =
-        await _asyncNullishCoalesce(await _asyncOptionalChain([options, 'optionalAccess', async _6 => _6.utxos]), async () => (
+        await _asyncNullishCoalesce(await _asyncOptionalChain([txOptions, 'optionalAccess', async _8 => _8.utxos]), async () => (
         _filterUndefined.filterUndefined.call(void 0, 
           (await processor.fetchUtxos({
             scriptPubkey: utxoScriptPubkey,
@@ -313,7 +318,7 @@ var _utils = require('./utils');
         bs.gt(totalAmountToSend, `${_utils.sumUtxos.call(void 0, utxos)}`) ||
         utxos.length === 0
       ) {
-        throw new (0, _types.InsufficientFundsError)(currencyInfo.currencyCode)
+        throw new (0, _edgecorejs.InsufficientFundsError)(currencyInfo.currencyCode)
       }
 
       let targets = []
@@ -327,7 +332,7 @@ var _utils = require('./utils');
         }
 
         // if script exists construct address from script
-        if (_optionalChain([target, 'access', _7 => _7.otherParams, 'optionalAccess', _8 => _8.script]) != null) {
+        if (_optionalChain([target, 'access', _9 => _9.otherParams, 'optionalAccess', _10 => _10.script]) != null) {
           const { script } = target.otherParams
           if (script.type === 'replayProtection') {
             // construct a replay protection p2sh address
@@ -373,7 +378,7 @@ var _utils = require('./utils');
         freshAddress.segwitAddress)), () => (
         freshAddress.publicAddress))
 
-      const setRBF = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _9 => _9.setRBF]), () => ( false))
+      const setRBF = _nullishCoalesce(_optionalChain([txOptions, 'optionalAccess', _11 => _11.setRBF]), () => ( false))
       const rbfTxid = edgeSpendInfo.rbfTxid
       let maxUtxo
       let feeRate = parseInt(await fees.getRate(edgeSpendInfo))
@@ -395,9 +400,9 @@ var _utils = require('./utils');
           )
         }
       }
-      if (_optionalChain([options, 'optionalAccess', _10 => _10.CPFP]) != null) {
+      if (_optionalChain([txOptions, 'optionalAccess', _12 => _12.CPFP]) != null) {
         const [childTx] = await processor.fetchTransactions({
-          txId: _optionalChain([options, 'optionalAccess', _11 => _11.CPFP])
+          txId: _optionalChain([txOptions, 'optionalAccess', _13 => _13.CPFP])
         })
         if (childTx == null) throw new Error('transaction not found')
         const utxos = []
@@ -411,7 +416,7 @@ var _utils = require('./utils');
       }
       log.warn(`spend: Using fee rate ${feeRate} sat/B`)
       const subtractFee =
-        _optionalChain([options, 'optionalAccess', _12 => _12.subtractFee]) != null ? options.subtractFee : false
+        _optionalChain([txOptions, 'optionalAccess', _14 => _14.subtractFee]) != null ? txOptions.subtractFee : false
       const tx = _keymanager.makeTx.call(void 0, {
         utxos,
         forceUseUtxo: maxUtxo != null ? [maxUtxo] : [],
@@ -480,7 +485,7 @@ var _utils = require('./utils');
 
     async resyncBlockchain() {
       // Stops the engine
-      await fns.killEngine()
+      await engine.killEngine()
 
       // Clear cache and state
       await processor.clearAll()
@@ -492,7 +497,7 @@ var _utils = require('./utils');
       await pluginState.refreshServers()
 
       // Restart the engine
-      await fns.startEngine()
+      await engine.startEngine()
     },
 
     async saveTx(edgeTx) {
@@ -507,7 +512,7 @@ var _utils = require('./utils');
       })
       await processor.saveTransaction({
         tx,
-        scriptPubkeys: _optionalChain([edgeTx, 'access', _13 => _13.otherParams, 'optionalAccess', _14 => _14.ourScriptPubkeys])
+        scriptPubkeys: _optionalChain([edgeTx, 'access', _15 => _15.otherParams, 'optionalAccess', _16 => _16.ourScriptPubkeys])
       })
 
       /*
@@ -517,7 +522,42 @@ var _utils = require('./utils');
       await engineState.processUtxos(ownUtxos)
     },
 
-    async signTx(transaction) {
+    async signMessage(
+      message,
+      privateKeys,
+      opts
+    ) {
+      const otherParams = _types5.asUtxoSignMessageOtherParams.call(void 0, opts.otherParams)
+      const { publicAddress } = otherParams
+      const scriptPubkey = walletTools.addressToScriptPubkey(publicAddress)
+      const processorAddress = await processor.fetchAddress(scriptPubkey)
+      if (_optionalChain([processorAddress, 'optionalAccess', _17 => _17.path]) == null) {
+        throw new Error('Missing address to sign with')
+      }
+      const privateKey = asMaybeCurrencyPrivateKey(privateKeys)
+
+      if (privateKey == null)
+        throw new Error('Cannot sign a message for a read-only wallet')
+
+      // Derive the xprivs on the fly, since we do not persist them
+      const xprivKeys = await _utils.fetchOrDeriveXprivFromKeys.call(void 0, {
+        privateKey,
+        walletLocalEncryptedDisklet,
+        coin: coinInfo.name
+      })
+
+      const signature = await walletTools.signMessageBase64({
+        path: _optionalChain([processorAddress, 'optionalAccess', _18 => _18.path]),
+        message,
+        xprivKeys
+      })
+      return signature
+    },
+
+    async signTx(
+      transaction,
+      privateKeys
+    ) {
       const otherParams = transaction.otherParams 
       if (otherParams == null) throw new Error('Invalid transaction data')
 
@@ -525,7 +565,7 @@ var _utils = require('./utils');
       if (psbt == null || edgeSpendInfo == null)
         throw new Error('Invalid transaction data')
 
-      const privateKey = asMaybeCurrencyPrivateKey(sensitiveWalletInfo.keys)
+      const privateKey = asMaybeCurrencyPrivateKey(privateKeys)
 
       if (privateKey == null)
         throw new Error('Cannot sign a transaction for a read-only wallet')
@@ -587,7 +627,7 @@ var _utils = require('./utils');
       transaction.signedTx = signedTx.hex
 
       const { paymentProtocolInfo } =
-        _nullishCoalesce(_optionalChain([transaction, 'access', _15 => _15.otherParams, 'optionalAccess', _16 => _16.edgeSpendInfo, 'optionalAccess', _17 => _17.otherParams]), () => ( {}))
+        _nullishCoalesce(_optionalChain([transaction, 'access', _19 => _19.otherParams, 'optionalAccess', _20 => _20.edgeSpendInfo, 'optionalAccess', _21 => _21.otherParams]), () => ( {}))
       if (paymentProtocolInfo != null) {
         const payment = _paymentRequest.createPayment.call(void 0, 
           transaction.signedTx,
@@ -672,12 +712,15 @@ var _utils = require('./utils');
             }
             const destAddress = await this.getFreshAddress({})
             const nativeAmount = tmpMetadata.state.balance
-            const options = { utxos: tmpUtxos, subtractFee: true }
+            const txOptions = { utxos: tmpUtxos, subtractFee: true }
             spendInfo.spendTargets = [
               { publicAddress: destAddress.publicAddress, nativeAmount }
             ]
-            // @ts-expect-error TODO: TheCharlatan - add option to makeSpend declaration in edge-core-js
-            const tx = await this.makeSpend(spendInfo, options)
+            spendInfo.otherParams = {
+              ...spendInfo.otherParams,
+              txOptions
+            }
+            const tx = await this.makeSpend(spendInfo)
             success(tx)
           } catch (e) {
             failure(e)
@@ -711,37 +754,8 @@ var _utils = require('./utils');
       return await end
     },
 
-    otherMethods: {
-      signMessageBase64: async (
-        message,
-        address
-      ) => {
-        const scriptPubkey = walletTools.addressToScriptPubkey(address)
-        const processorAddress = await processor.fetchAddress(scriptPubkey)
-        if (_optionalChain([processorAddress, 'optionalAccess', _18 => _18.path]) == null) {
-          throw new Error('Missing address to sign with')
-        }
-        const privateKey = asMaybeCurrencyPrivateKey(sensitiveWalletInfo.keys)
-
-        if (privateKey == null)
-          throw new Error('Cannot sign a message for a read-only wallet')
-
-        // Derive the xprivs on the fly, since we do not persist them
-        const xprivKeys = await _utils.fetchOrDeriveXprivFromKeys.call(void 0, {
-          privateKey,
-          walletLocalEncryptedDisklet,
-          coin: coinInfo.name
-        })
-
-        const signature = await walletTools.signMessageBase64({
-          path: _optionalChain([processorAddress, 'optionalAccess', _19 => _19.path]),
-          message,
-          xprivKeys
-        })
-        return signature
-      }
-    }
+    otherMethods: {}
   }
 
-  return fns
+  return engine
 } exports.makeUtxoEngine = makeUtxoEngine;

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

@@ -19,3 +19,10 @@
 
 
 
+
+
+
+
+ const asUtxoSignMessageOtherParams = _cleaners.asObject.call(void 0, {
+  publicAddress: _cleaners.asString
+}); exports.asUtxoSignMessageOtherParams = asUtxoSignMessageOtherParams

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

@@ -52,14 +52,6 @@ var _keymanager = require('../keymanager/keymanager');
   return result
 }; exports.validateMemo = validateMemo
 
- const getAddressTypeFromKeys = (
-  privateKey
-) => {
-  return exports.getAddressTypeFromPurposeType.call(void 0, 
-    exports.currencyFormatToPurposeType.call(void 0, privateKey.format)
-  )
-}; exports.getAddressTypeFromKeys = getAddressTypeFromKeys
-
  const getAddressTypeFromPurposeType = (
   purpose
 ) => {
@@ -239,32 +231,22 @@ var _keymanager = require('../keymanager/keymanager');
 ) => {
   const { engineInfo, privateKey, coin } = args
   const xpubs = {}
-  for (const format of _cleaners.getSupportedFormats.call(void 0, 
-    engineInfo,
-    args.privateKey.format
-  )) {
-    xpubs[format] = exports.deriveXpub.call(void 0, {
-      privateKey,
+  for (const format of _cleaners.getSupportedFormats.call(void 0, engineInfo, privateKey.format)) {
+    const xpriv = exports.deriveXprivFromKeys.call(void 0, {
       coin,
-      type: exports.currencyFormatToPurposeType.call(void 0, format)
+      privateKey
+    })[format]
+    if (xpriv == null)
+      throw new Error('Cannot derive xpub: no private key exists')
+    xpubs[format] = _keymanager.xprivToXPub.call(void 0, {
+      coin,
+      type: exports.currencyFormatToPurposeType.call(void 0, format),
+      xpriv
     })
   }
   return xpubs
 }; exports.deriveXpubsFromKeys = deriveXpubsFromKeys
 
- const deriveXpub = (args
-
-
-
-) => {
-  const xpriv = exports.deriveXprivFromKeys.call(void 0, args)[
-    exports.getCurrencyFormatFromPurposeType.call(void 0, args.type)
-  ]
-  if (xpriv == null)
-    throw new Error('Cannot derive xpub: no private key exists')
-  return _keymanager.xprivToXPub.call(void 0, { ...args, xpriv })
-}; exports.deriveXpub = deriveXpub
-
  const parsePathname = (args
 
 

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

@@ -27,6 +27,10 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
 
 /**
  * A cleaner for the private key format following the key-formats specification.
+ * It _includes_ the private key.
+ *
+ * **It is not considered safe memory, and it should be deallocated
+ * (thrown away) after use**.
  *
  * (spec: https://github.com/EdgeApp/edge-core-js/blob/master/docs/key-formats.md)
  */
@@ -123,9 +127,12 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
 }; exports.inferPrivateKeyFormat = inferPrivateKeyFormat
 
 /**
- * A cleaner that desensitizes the walletInfo object, excluding sensitive
+ * A cleaner that desensitizes an unsafeWalletInfo object, excluding sensitive
  * keys (seed/mnemonic, sync key, data key, etc). By using this object type
- * internally within the plugin, we can minimize risk of leaking sensitive data.
+ * internally within the plugin, we can minimize risk of leaking sensitive data
+ * when deriving public keys from walletInfo which only contains private keys.
+ * It may also be used on a safeWalletInfo object which only contains the
+ * wallet's public keys.
  *
  * 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).
@@ -147,7 +154,7 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
 
 
 
- const asNumbWalletInfo = (
+ const asSafeWalletInfo = (
   pluginInfo
 ) => {
   return (walletInfo) => {
@@ -209,4 +216,4 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
     // If we get here, nothing matched:
     throw new Error('Either a public or private key are required')
   }
-}; exports.asNumbWalletInfo = asNumbWalletInfo
+}; exports.asSafeWalletInfo = asSafeWalletInfo

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

@@ -2,7 +2,7 @@ import { EdgeLog, EdgeTransaction } from 'edge-core-js/types';
 import { EngineEmitter } from '../../plugin/makeEngineEmitter';
 import { PluginState } from '../../plugin/pluginState';
 import { PluginInfo } from '../../plugin/types';
-import { NumbWalletInfo } from '../keymanager/cleaners';
+import { SafeWalletInfo } from '../keymanager/cleaners';
 import { BlockBook } from '../network/BlockBook';
 import Deferred from '../network/Deferred';
 import { WsTask } from '../network/Socket';
@@ -18,7 +18,7 @@ interface ServerStateConfig {
     log: EdgeLog;
     pluginInfo: PluginInfo;
     pluginState: PluginState;
-    walletInfo: NumbWalletInfo;
+    walletInfo: SafeWalletInfo;
 }
 export interface ServerStates {
     setPickNextTaskCB: (callback: (uri: string) => Promise<boolean | WsTask<any> | undefined>) => void;

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

@@ -1,3 +1,3 @@
-import { EdgeCurrencyEngine } from 'edge-core-js/types';
+import { EdgeCurrencyEngine } from 'edge-core-js';
 import { EngineConfig } from '../../plugin/types';
 export declare function makeUtxoEngine(config: EngineConfig): Promise<EdgeCurrencyEngine>;

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

@@ -4,7 +4,7 @@ import { PluginState } from '../../plugin/pluginState';
 import { ChangePath, CurrencyFormat, EngineConfig, PluginInfo } from '../../plugin/types';
 import { Processor } from '../db/makeProcessor';
 import { IAddress, IProcessorTransaction, IUTXO } from '../db/types';
-import { NumbWalletInfo } from '../keymanager/cleaners';
+import { SafeWalletInfo } from '../keymanager/cleaners';
 import { BlockbookAccountUtxo } from '../network/BlockBookAPI';
 import { WsTask } from '../network/Socket';
 import AwaitLock from './await-lock';
@@ -29,13 +29,13 @@ export interface UtxoEngineState {
 }
 export interface UtxoEngineStateConfig extends EngineConfig {
     walletTools: UTXOPluginWalletTools;
-    walletInfo: NumbWalletInfo;
+    walletInfo: SafeWalletInfo;
     processor: Processor;
 }
 export declare function makeUtxoEngineState(config: UtxoEngineStateConfig): UtxoEngineState;
 interface CommonArgs {
     pluginInfo: PluginInfo;
-    walletInfo: NumbWalletInfo;
+    walletInfo: SafeWalletInfo;
     walletTools: UTXOPluginWalletTools;
     processor: Processor;
     emitter: EngineEmitter;

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

@@ -15,3 +15,7 @@ export interface UtxoTxOtherParams {
     edgeSpendInfo?: EdgeSpendInfo;
     ourScriptPubkeys: string[];
 }
+export declare type UtxoSignMessageOtherParams = ReturnType<typeof asUtxoSignMessageOtherParams>;
+export declare const asUtxoSignMessageOtherParams: import("cleaners").ObjectCleaner<{
+    publicAddress: string;
+}>;

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

@@ -7,7 +7,6 @@ import { PrivateKey } from '../keymanager/cleaners';
 import { AddressTypeEnum, BIP43PurposeTypeEnum, ScriptTypeEnum } from '../keymanager/keymanager';
 export declare const getCurrencyFormatFromPurposeType: (purpose: BIP43PurposeTypeEnum) => CurrencyFormat;
 export declare const validateMemo: (memo: string) => EdgeMemoRules;
-export declare const getAddressTypeFromKeys: (privateKey: PrivateKey) => AddressTypeEnum;
 export declare const getAddressTypeFromPurposeType: (purpose: BIP43PurposeTypeEnum) => AddressTypeEnum;
 export declare const getScriptTypeFromPurposeType: (purpose: BIP43PurposeTypeEnum) => ScriptTypeEnum;
 export declare const validScriptPubkeyFromAddress: (args: {
@@ -53,11 +52,6 @@ export declare const deriveXpubsFromKeys: (args: {
     privateKey: PrivateKey;
     coin: string;
 }) => CurrencyFormatKeys;
-export declare const deriveXpub: (args: {
-    privateKey: PrivateKey;
-    coin: string;
-    type: BIP43PurposeTypeEnum;
-}) => string;
 export declare const parsePathname: (args: {
     pathname: string;
     coin: string;

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

@@ -4,6 +4,10 @@ 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.
+ * It _includes_ the private key.
+ *
+ * **It is not considered safe memory, and it should be deallocated
+ * (thrown away) after use**.
  *
  * (spec: https://github.com/EdgeApp/edge-core-js/blob/master/docs/key-formats.md)
  */
@@ -35,9 +39,12 @@ export declare const getSupportedFormats: (engineInfo: EngineInfo, privateKeyFor
  */
 export declare const inferPrivateKeyFormat: (publicKey: PublicKey) => PrivateKeyFormat;
 /**
- * A cleaner that desensitizes the walletInfo object, excluding sensitive
+ * A cleaner that desensitizes an unsafeWalletInfo object, excluding sensitive
  * keys (seed/mnemonic, sync key, data key, etc). By using this object type
- * internally within the plugin, we can minimize risk of leaking sensitive data.
+ * internally within the plugin, we can minimize risk of leaking sensitive data
+ * when deriving public keys from walletInfo which only contains private keys.
+ * It may also be used on a safeWalletInfo object which only contains the
+ * wallet's public keys.
  *
  * 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).
@@ -49,7 +56,7 @@ export declare const inferPrivateKeyFormat: (publicKey: PublicKey) => PrivateKey
  * useful for determining the "kind of wallet", or more precisely how the public
  * key (xpubs) formats were derived.
  */
-export interface NumbWalletInfo {
+export interface SafeWalletInfo {
     id: string;
     type: string;
     keys: {
@@ -59,5 +66,5 @@ export interface NumbWalletInfo {
         walletFormats: CurrencyFormat[];
     };
 }
-export declare const asNumbWalletInfo: (pluginInfo: PluginInfo) => Cleaner<NumbWalletInfo>;
+export declare const asSafeWalletInfo: (pluginInfo: PluginInfo) => Cleaner<SafeWalletInfo>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "1.3.7",
+  "version": "2.0.1",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",
@@ -48,7 +48,7 @@
     "bs58smartcheck": "^2.0.4",
     "cleaners": "^0.3.12",
     "disklet": "^0.4.5",
-    "edge-core-js": "^0.19.37",
+    "edge-core-js": "^0.19.48",
     "edge-sync-client": "^0.2.7",
     "memlet": "^0.1.7",
     "uri-js": "^4.4.0",