edge-currency-plugins 1.1.0 → 1.1.1

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# edge-currency-plugins
+
+## v1.1.1 (2022-07-12)
+
+- Fix: Add feathercoin blockbook server
+- Fix: Engine crashs on fetching server list network failure
+- Fix: Spend issues caused by not saving UTXOs locally without needing a network event
+
+## v1.1.0 (2022-06-29)
+
+- Change: Computes the sat/vByte used for a given transaction, and adds feeRateUsed object to the EdgeTransaction output.
+
+## v1.0.0 (2022-06-22)
+
+- Fix: Fix a logic error in UtxoEngineState.processUtxos
+- Change: Disable BCH to BSV splitting for now
+- Change: Add detailed logs for Socket errors caused by cleaner
+
+## v1.0.0-rc.6 (2022-06-21)
+
+- Fix: Fee rounding errors for some spending cases (particularly sweek keys for segwit wallets)
+- Change: Use WhatsOnChain.com as the block explorer URLs for BSV
+
+## v1.0.0-rc.5 (2022-06-21)
+
+- Fix: Insufficient funds error for edge case (max spend on a zero-balance wallet)
+
+## v1.0.0-rc.4 (2022-06-20)
+
+- Fix: Avoid redundant ADDRESSES_CHECKED events after initial sync
+
+## v1.0.0-rc.3 (2022-06-20)
+
+- Fix: Balance bug after sending transactions
+
+## v1.0.0-rc.2 (2022-06-17)
+
+- Fix: Improve connection states and fix reconnection bugs caused when connections are unreliable
+- Fix: Improve BSV address format support for addresses coming from networks

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

@@ -378,6 +378,7 @@ var _utils = require('./utils');
         targets,
         feeRate,
         coin: coinInfo.name,
+        currencyCode: currencyInfo.currencyCode,
         setRBF,
         freshChangeAddress,
         subtractFee
@@ -468,8 +469,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

@@ -236,4 +236,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

@@ -229,6 +229,7 @@ var VerifyAddressEnum; (function (VerifyAddressEnum) {
 
 
 
+
 
 
  function bip43PurposeNumberToTypeEnum(
@@ -933,7 +934,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/keymanager/keymanager.d.ts

@@ -128,6 +128,7 @@ export interface MakeTxArgs {
     feeRate: number;
     setRBF: boolean;
     coin: string;
+    currencyCode: string;
     freshChangeAddress: string;
     subtractFee?: boolean;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",
   "license": "MIT",