edge-currency-plugins 1.1.0 → 1.1.3

package/lib/common/plugin/makeCurrencyTools.js

@@ -9,6 +9,7 @@ var _cleaners = require('cleaners');
 
 
 
+
 var _urijs = require('uri-js'); var uri = _interopRequireWildcard(_urijs);
 var _urlparse = require('url-parse'); var _urlparse2 = _interopRequireDefault(_urlparse);
 
@@ -80,6 +81,10 @@ var _utils3 = require('./utils');
       return wasCurrencyPrivateKey(privateKey)
     },
 
+    async validateMemo(memo) {
+      return _utils.validateMemo.call(void 0, memo)
+    },
+
     async derivePublicKey(walletInfo) {
       const numbWalletInfo = asCurrencyNumbWalletInfo(walletInfo)
       return numbWalletInfo.keys.publicKey

package/lib/common/plugin/pluginState.js

@@ -116,24 +116,21 @@ const asServerListInfo = _cleaners.asObject.call(void 0, _cleaners.asEither.call
   const fetchServers = async () => {
     log(`${pluginId} - GET ${serverListInfoUrl}`)
 
-    const response = await io.fetch(serverListInfoUrl)
-    const responseBody = await (async () => {
-      try {
-        if (response.ok) {
-          return await response.json()
-        }
-        log(
-          `${pluginId} - Fetching ${serverListInfoUrl} failed with status ${response.status}`
-        )
-      } catch (err) {
-        log(`${pluginId} - Fetching ${serverListInfoUrl} failed: ${err}`)
+    try {
+      const response = await io.fetch(serverListInfoUrl)
+      if (!response.ok) {
+        throw new Error(`Failed with status ${response.status}`)
       }
-      return {}
-    })()
-
-    const serverListInfo = asServerListInfo(responseBody)
+      const responseBody = await response.json()
+      const serverListInfo = asServerListInfo(responseBody)
 
-    return _nullishCoalesce(serverListInfo[currencyCode], () => ( []))
+      return _nullishCoalesce(serverListInfo[currencyCode], () => ( []))
+    } catch (error) {
+      log.warn(
+        `${pluginId} - GET ${serverListInfoUrl} failed: ${error.toString()}`
+      )
+      return []
+    }
   }
 
   const refreshServers = async () => {

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

@@ -371,7 +371,7 @@ var _constants = require('./constants');
         pluginState.serverScoreDown(uri)
         _optionalChain([deferredAddressSub, 'optionalAccess', _3 => _3.reject, 'call', _4 => _4()])
       })
-    blockbook.watchAddresses(Array.from(addresses), deferred)
+    blockbook.watchAddresses(Array.from(serverState.addresses), deferred)
   }
 
   const watchBlocks = (uri) => {

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

@@ -66,7 +66,9 @@ var _utils = require('./utils');
   // each with a different list of custom servers.
   // The Edge UI only allows for one active login, though,
   // so this is OK for now:
-  await pluginState.updateServers(userSettings)
+  pluginState.updateServers(userSettings).catch(err => {
+    log.error(err)
+  })
 
   const asCurrencyPrivateKey = _cleaners3.asPrivateKey.call(void 0, coinInfo.name, coinInfo.coinType)
   // Private key may be missing for watch-only wallets
@@ -295,7 +297,10 @@ var _utils = require('./utils');
       let targets = []
       const ourReceiveAddresses = []
       for (const target of spendTargets) {
-        if (target.publicAddress == null || target.nativeAmount == null) {
+        if (
+          target.memo == null &&
+          (target.publicAddress == null || target.nativeAmount == null)
+        ) {
           throw new Error('Invalid spend target')
         }
 
@@ -309,19 +314,29 @@ var _utils = require('./utils');
             )
             targets.push({
               address: publicAddress,
-              value: parseInt(target.nativeAmount)
+              value:
+                target.nativeAmount == null
+                  ? undefined
+                  : parseInt(target.nativeAmount),
+              memo: target.memo
             })
           }
         } else {
-          const scriptPubkey = walletTools.addressToScriptPubkey(
-            target.publicAddress
-          )
-          if (processor.fetchAddress(scriptPubkey) != null) {
-            ourReceiveAddresses.push(target.publicAddress)
+          if (target.publicAddress != null) {
+            const scriptPubkey = walletTools.addressToScriptPubkey(
+              target.publicAddress
+            )
+            if (processor.fetchAddress(scriptPubkey) != null) {
+              ourReceiveAddresses.push(target.publicAddress)
+            }
           }
           targets.push({
             address: target.publicAddress,
-            value: parseInt(target.nativeAmount)
+            value:
+              target.nativeAmount == null
+                ? undefined
+                : parseInt(target.nativeAmount),
+            memo: target.memo
           })
         }
       }
@@ -372,12 +387,13 @@ 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
-      const tx = await _keymanager.makeTx.call(void 0, {
+      const tx = _keymanager.makeTx.call(void 0, {
         utxos,
         forceUseUtxo: maxUtxo != null ? [maxUtxo] : [],
         targets,
         feeRate,
         coin: coinInfo.name,
+        currencyCode: currencyInfo.currencyCode,
         setRBF,
         freshChangeAddress,
         subtractFee
@@ -406,7 +422,7 @@ var _utils = require('./utils');
       nativeAmount = bs.sub(nativeAmount, networkFee)
 
       const otherParams = {
-        txJson: { hex: tx.hex },
+        unsignedTx: tx.hex,
         psbt: {
           base64: tx.psbtBase64,
           inputs: tx.inputs,
@@ -468,8 +484,8 @@ var _utils = require('./utils');
       /*
       Get the wallet's UTXOs from the new transaction and save them to the processsor.
       */
-      const utxos = await _getOwnUtxosFromTx.getOwnUtxosFromTx.call(void 0, engineInfo, processor, tx)
-      await engineState.processUtxos(utxos)
+      const ownUtxos = await _getOwnUtxosFromTx.getOwnUtxosFromTx.call(void 0, engineInfo, processor, tx)
+      await engineState.processUtxos(ownUtxos)
     },
 
     async signTx(transaction) {

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

@@ -40,7 +40,6 @@ var _keymanager = require('../keymanager/keymanager');
 
 
 
-
 var _BlockBookAPI = require('../network/BlockBookAPI');
 var _Deferred = require('../network/Deferred'); var _Deferred2 = _interopRequireDefault(_Deferred);
 
@@ -386,22 +385,6 @@ var _utils3 = require('./utils');
     async broadcastTx(transaction) {
       const txId = await serverStates.broadcastTx(transaction)
 
-      /*
-      After successfully broadcasting the tx, we must mark each UTXO, used as
-      an input for the tx, as spent so we don't try to reuse the UTXO.
-      */
-      const txInputs = _nullishCoalesce(_optionalChain([transaction, 'access', _ => _.otherParams, 'optionalAccess', _2 => _2.psbt, 'access', _3 => _3.inputs]), () => ( []))
-      for (const input of txInputs) {
-        const scriptPubkey = Buffer.from(input.scriptPubkey).toString('hex')
-        const [utxo] = await processor.fetchUtxos({
-          scriptPubkey
-        })
-        if (utxo != null) {
-          utxo.spent = true
-          await processor.saveUtxo(utxo)
-        }
-      }
-
       return txId
     },
     refillServers() {
@@ -447,18 +430,37 @@ var _utils3 = require('./utils');
       }
     },
     async processUtxos(utxos) {
+      // Map of scriptPubkey to IUTXOs
       const utxoMap = new Map()
+      const utxoIds = new Set()
+
+      // Map updated utxos
       for (const utxo of utxos) {
-        const utxoSet = _nullishCoalesce(utxoMap.get(utxo.scriptPubkey), () => ( new Set()))
+        const utxoSet = _nullishCoalesce(utxoMap.get(utxo.scriptPubkey), () => ( []))
         if (!utxoMap.has(utxo.scriptPubkey))
           utxoMap.set(utxo.scriptPubkey, utxoSet)
-        utxoSet.add(utxo)
+        // Add utxo to set for scriptPubkey
+        utxoSet.push(utxo)
+        // Add UTXO ID set
+        utxoIds.add(utxo.id)
       }
+
+      // Process UTXO sets for each scriptPubkey in map
       for (const [scriptPubkey, utxos] of utxoMap.entries()) {
+        // Get saved utxo set
+        const savedUtxos = await processor.fetchUtxos({ scriptPubkey })
+        // Filter UTXOs to de-duplicate (and undefined utxo as a type assert)
+        const filteredUtxos = savedUtxos.filter(
+          utxo => utxo != null && !utxoIds.has(_optionalChain([utxo, 'optionalAccess', _ => _.id]))
+        ) 
+
+        // Add updated utxos to utxo set
+        const combinedUtxos = [...filteredUtxos, ...utxos]
+
         await processProcessorUtxos({
           ...commonArgs,
           scriptPubkey,
-          utxos
+          utxos: combinedUtxos
         })
       }
     }
@@ -1221,25 +1223,71 @@ const processProcessorUtxos = async (
     pluginInfo: { currencyInfo }
   } = args
 
+  const updatedUtxos = Object.fromEntries(
+    [...utxos].map(utxo => [utxo.id, utxo])
+  )
+  const utxoIdsToRemove = []
   const currentUtxos = await processor.fetchUtxos({ scriptPubkey })
-  const currentUtxoIds = []
+
+  //
+  // Modify existing UTXO set
+  //
+
   let oldBalance = '0'
   for (const utxo of currentUtxos) {
     if (utxo == null)
       throw new Error(
         'Unexpected undefined utxo when processing unspent transactions'
       )
-    oldBalance = _biggystring.add.call(void 0, utxo.value, oldBalance)
-    currentUtxoIds.push(utxo.id)
+    if (!utxo.spent) {
+      // Accumulate over the current address balance
+      oldBalance = _biggystring.add.call(void 0, utxo.value, oldBalance)
+    }
+
+    // If the UTXO isn't present in the update UTXO set, then it is spent.
+    if (updatedUtxos[utxo.id] == null) {
+      if (utxo.blockHeight > 0) {
+        // Delete the UTXO from the database if it's spent and confirmed
+        utxoIdsToRemove.push(utxo.id)
+      } else {
+        // Otherwise just mark it as spent.
+        updatedUtxos[utxo.id] = { ...utxo, spent: true }
+      }
+    } else {
+      /*
+      If the UTXO is present in the updated UTXO set, enforce that the UTXO 
+      remains spent in the new UTXO set. This means, we will never mark a UTXO 
+      as unspent again. UTXOs only become unspent again if the tx is dropped
+      which shall be affected by another routine.
+      */
+      // TODO: To fix this logic for dropped-tx, add a condition which uses the
+      // network's block-height to determine whether to set it back as unspend
+      updatedUtxos[utxo.id].spent = utxo.spent || updatedUtxos[utxo.id].spent
+    }
   }
-  await processor.removeUtxos(currentUtxoIds)
+
+  // Remove any spent UTXOs that have confirmations
+  await processor.removeUtxos(utxoIdsToRemove)
+
+  //
+  // Save updated UTXO set
+  //
 
   let newBalance = '0'
-  for (const utxo of Array.from(utxos)) {
-    newBalance = _biggystring.add.call(void 0, utxo.value, newBalance)
+  for (const utxo of Object.values(updatedUtxos)) {
+    if (!utxo.spent) {
+      // Accumulate over the new address balance
+      newBalance = _biggystring.add.call(void 0, utxo.value, newBalance)
+    }
+    // Save new UTXOs
     await processor.saveUtxo(utxo)
   }
 
+  //
+  // Balance update
+  //
+
+  // Address balance and emit address balance change event
   const diff = _biggystring.sub.call(void 0, newBalance, oldBalance)
   if (diff !== '0') {
     log('balance changed:', { scriptPubkey, diff })
@@ -1392,19 +1440,19 @@ const processRawUtxo = async (
 }
 
 const addToProcessorUtxoCache = (
-  processorUtxosCache,
+  processorUtxoCache,
   path,
   scriptPubkey,
   requiredCount,
   utxo
 ) => {
-  const processorUtxos = _nullishCoalesce(processorUtxosCache[scriptPubkey], () => ( {
-    utxos: new Set(),
+  const processorUtxos = _nullishCoalesce(processorUtxoCache[scriptPubkey], () => ( {
+    utxos: [],
     processing: false,
     path,
     full: false
   }))
-  if (utxo != null) processorUtxos.utxos.add(utxo)
-  processorUtxosCache[scriptPubkey] = processorUtxos
-  processorUtxos.full = processorUtxos.utxos.size >= requiredCount
+  if (utxo != null) processorUtxos.utxos.push(utxo)
+  processorUtxoCache[scriptPubkey] = processorUtxos
+  processorUtxos.full = processorUtxos.utxos.length >= requiredCount
 }

package/lib/common/utxobased/engine/util/getOwnUtxosFromTx.js

@@ -12,7 +12,29 @@ var _utils = require('../utils');
   processor,
   tx
 ) => {
-  const utxos = []
+  const ownUtxos = []
+
+  //
+  // Spent UTXOs (Inputs)
+  //
+
+  const inputUtxoIds = tx.inputs.map(
+    input => `${input.txId}_${input.outputIndex}`
+  )
+  const inputUtxos = await processor.fetchUtxos({
+    utxoIds: inputUtxoIds
+  })
+  for (const utxo of inputUtxos) {
+    if (utxo == null) continue
+    // Must create a new IUTXO object when mutating processor objects because
+    // memlet may keep a reference in memory.
+    ownUtxos.push({ ...utxo, spent: true })
+  }
+
+  //
+  // Unspent UTXOs (Outputs)
+  //
+
   for (const output of tx.outputs) {
     const scriptPubkey = output.scriptPubkey
     const address = await processor.fetchAddress(scriptPubkey)
@@ -46,9 +68,10 @@ var _utils = require('../utils');
           blockHeight: tx.blockHeight,
           spent: false
         }
-        utxos.push(utxo)
+        ownUtxos.push(utxo)
       }
     }
   }
-  return utxos
+
+  return ownUtxos
 }; exports.getOwnUtxosFromTx = getOwnUtxosFromTx

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

@@ -35,6 +35,19 @@ var _keymanager = require('../keymanager/keymanager');
   }
 }; exports.getCurrencyFormatFromPurposeType = getCurrencyFormatFromPurposeType
 
+// Expect memo to be a hex string
+ const validateMemo = (memo) => {
+  const result = {
+    passed: true,
+    tooLarge: false
+  }
+  if (Math.ceil(memo.length / 2) > 80) {
+    result.passed = false
+    result.tooLarge = true
+  }
+  return result
+}; exports.validateMemo = validateMemo
+
  const getAddressTypeFromKeys = (
   privateKey
 ) => {
@@ -236,4 +249,7 @@ var _keymanager = require('../keymanager/keymanager');
 }; exports.parsePathname = parsePathname
 
  const sumUtxos = (utxos) =>
-  utxos.reduce((sum, { value }) => bs.add(sum, value), '0'); exports.sumUtxos = sumUtxos
+  utxos.reduce(
+    (sum, { spent, value }) => (spent ? sum : bs.add(sum, value)),
+    '0'
+  ); exports.sumUtxos = sumUtxos

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

@@ -16,7 +16,7 @@ var _constants = require('../../constants');
   // Configuration options:
   defaultSettings: {
     customFeeSettings: ['satPerByte'],
-    blockbookServers: [],
+    blockbookServers: ['wss://blockbook.feathercoin.com'],
     enableCustomServers: false
   },
   customFeeTemplate: [

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

@@ -10,6 +10,7 @@ var _indexAtProtected = require('../../../util/indexAtProtected');
 var _undefinedIfEmptyString = require('../../../util/undefinedIfEmptyString');
 
 
+var _utils = require('../engine/utils');
 
 var _bip69 = require('./bip69');
 
@@ -228,6 +229,8 @@ var VerifyAddressEnum; (function (VerifyAddressEnum) {
 
 
 
+
+
 
 
 
@@ -824,7 +827,7 @@ const wifToPrivateKeyInternal = (
     .toString('base64')
 } exports.signMessageBase64 = signMessageBase64;
 
- async function makeTx(args) {
+ function makeTx(args) {
   let sequence = 0xffffffff
   if (args.setRBF) {
     sequence -= 2
@@ -902,16 +905,36 @@ const wifToPrivateKeyInternal = (
     if (!forceUsage) mappedUtxos.push(input)
   }
 
-  const targets = args.targets.map(target => {
-    const script = exports.addressToScriptPubkey.call(void 0, {
-      address: target.address,
-      coin: coin.name
-    })
-    return {
-      script,
-      value: target.value
+  const targets = []
+  for (const target of args.targets) {
+    if (target.address != null && target.value != null) {
+      const script = exports.addressToScriptPubkey.call(void 0, {
+        address: target.address,
+        coin: coin.name
+      })
+      targets.push({
+        script,
+        value: target.value
+      })
     }
-  })
+
+    if (target.memo != null) {
+      const memoHex = Buffer.from(target.memo, 'utf8').toString('hex')
+      // check if hex string is within 80 bytes
+      const validatedMemo = _utils.validateMemo.call(void 0, memoHex)
+      if (!validatedMemo.passed) {
+        throw new Error('Memo size exceeds 80 bytes')
+      }
+      const script = bitcoin.script
+        .compile([bitcoin.opcodes.OP_RETURN, Buffer.from(target.memo, 'utf8')])
+        .toString('hex')
+      targets.push({
+        script,
+        value: 0
+      })
+    }
+  }
+
   const changeScript = exports.addressToScriptPubkey.call(void 0, {
     address: args.freshChangeAddress,
     coin: coin.name
@@ -933,7 +956,7 @@ const wifToPrivateKeyInternal = (
     changeScript
   })
   if (result.inputs == null || result.outputs == null) {
-    throw new (0, _types.InsufficientFundsError)(args.coin)
+    throw new (0, _types.InsufficientFundsError)(args.currencyCode)
   }
 
   const sortedInputs = _bip69.sortInputs.call(void 0, result.inputs)

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

@@ -74,7 +74,7 @@ interface ProcessorUtxoCache {
     [key: string]: {
         processing: boolean;
         full: boolean;
-        utxos: Set<IUTXO>;
+        utxos: IUTXO[];
         path: ChangePath;
     };
 }

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

@@ -6,9 +6,7 @@ export declare const asUtxoUserSettings: import("cleaners").ObjectCleaner<{
 }>;
 export declare type UtxoUserSettings = ReturnType<typeof asUtxoUserSettings>;
 export interface UtxoTxOtherParams {
-    txJson?: {
-        hex?: string;
-    };
+    unsignedTx: string;
     psbt?: {
         base64: string;
         inputs: Input[];

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

@@ -1,11 +1,12 @@
 import { Disklet } from 'disklet';
-import { EdgeParsedUri } from 'edge-core-js/types';
+import { EdgeMemoRules, EdgeParsedUri } from 'edge-core-js/types';
 import { CurrencyFormat } from '../../plugin/types';
 import { IUTXO } from '../db/types';
 import { ScriptTemplates } from '../info/scriptTemplates/types';
 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, redeemScript?: string | undefined, scriptTemplates?: ScriptTemplates | undefined) => ScriptTypeEnum;

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

@@ -128,12 +128,14 @@ export interface MakeTxArgs {
     feeRate: number;
     setRBF: boolean;
     coin: string;
+    currencyCode: string;
     freshChangeAddress: string;
     subtractFee?: boolean;
 }
 export interface MakeTxTarget {
-    address: string;
-    value: number;
+    address?: string;
+    value?: number;
+    memo?: string | null;
 }
 interface MakeTxReturn extends Required<utxopicker.UtxoPickerResult> {
     hex: string;
@@ -193,6 +195,6 @@ export declare function privateKeyToWIF(args: PrivateKeyToWIFArgs): string;
 export declare const wifToPrivateKey: (args: WIFToPrivateKeyArgs) => string;
 export declare function privateKeyToPubkey(privateKey: string): string;
 export declare function signMessageBase64(message: string, privateKey: string): string;
-export declare function makeTx(args: MakeTxArgs): Promise<MakeTxReturn>;
+export declare function makeTx(args: MakeTxArgs): MakeTxReturn;
 export declare function signTx(args: SignTxArgs): Promise<SignTxReturn>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",
@@ -49,6 +49,7 @@
     "cleaners": "^0.3.12",
     "disklet": "^0.4.5",
     "edge-core-js": "^0.19.20",
+    "edge-sync-client": "^0.2.7",
     "memlet": "^0.1.6",
     "uri-js": "^4.4.0",
     "url-parse": "^1.5.2",