edge-currency-plugins 3.13.0 → 3.14.0

package/lib/common/constants.js

@@ -3,7 +3,10 @@
 // Fees
  const FEES_PATH = 'fees.json'; exports.FEES_PATH = FEES_PATH
  const MAX_FEE = 999999999.0; exports.MAX_FEE = MAX_FEE
- const LOW_FEE = 2; exports.LOW_FEE = LOW_FEE
+// Fee rates are sat/vB and may be fractional. Three decimal places matches the
+// precision of the mempool.space `/fees/precise` endpoint, which is the most
+// precise rate source we consume.
+ const FEE_RATE_DECIMALS = 3; exports.FEE_RATE_DECIMALS = FEE_RATE_DECIMALS
  const MAX_HIGH_DELAY = 200; exports.MAX_HIGH_DELAY = MAX_HIGH_DELAY
  const MAX_STANDARD_DELAY = 6; exports.MAX_STANDARD_DELAY = MAX_STANDARD_DELAY
  const MIN_STANDARD_DELAY = 2; exports.MIN_STANDARD_DELAY = MIN_STANDARD_DELAY

package/lib/common/fees/calcMinerFeePerByte.js

@@ -1,6 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});var _biggystring = require('biggystring');
 
 
+var _constants = require('../constants');
 
 
 
@@ -29,10 +30,20 @@
   } = feeInfo
   let { highFee, lowFee, standardFeeHigh, standardFeeLow } = feeInfo
 
-  highFee = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, highFee, highFeeFudgeFactor), 0)
-  lowFee = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, lowFee, lowFeeFudgeFactor), 0)
-  standardFeeHigh = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, standardFeeHigh, standardFeeHighFudgeFactor), 0)
-  standardFeeLow = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, standardFeeLow, standardFeeLowFudgeFactor), 0)
+  // Fee rates may be fractional, so these round to FEE_RATE_DECIMALS places
+  // rather than to a whole sat/vB. biggystring's `round` takes the power of ten
+  // to round at, so the precision is negated: -3 means three decimal places.
+  const feeRatePlaces = -_constants.FEE_RATE_DECIMALS
+  highFee = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, highFee, highFeeFudgeFactor), feeRatePlaces)
+  lowFee = _biggystring.round.call(void 0, _biggystring.mul.call(void 0, lowFee, lowFeeFudgeFactor), feeRatePlaces)
+  standardFeeHigh = _biggystring.round.call(void 0, 
+    _biggystring.mul.call(void 0, standardFeeHigh, standardFeeHighFudgeFactor),
+    feeRatePlaces
+  )
+  standardFeeLow = _biggystring.round.call(void 0, 
+    _biggystring.mul.call(void 0, standardFeeLow, standardFeeLowFudgeFactor),
+    feeRatePlaces
+  )
 
   switch (networkFeeOption) {
     case 'low':
@@ -55,7 +66,10 @@
 
       // Add this much to the low fee = (amountDiffFromLow * lowHighFeeDiff) / lowHighAmountDiff)
       const temp1 = _biggystring.mul.call(void 0, amountDiffFromLow, lowHighFeeDiff)
-      const addFeeToLow = _biggystring.div.call(void 0, temp1, lowHighAmountDiff)
+      // `div` defaults to zero decimal places, which would truncate the
+      // interpolated rate back to a whole sat/vB. Unlike `round` above, its
+      // precision argument is the number of decimal places, not a power of ten.
+      const addFeeToLow = _biggystring.div.call(void 0, temp1, lowHighAmountDiff, _constants.FEE_RATE_DECIMALS)
       return _biggystring.add.call(void 0, standardFeeLow, addFeeToLow)
     }
 

package/lib/common/fees/calcReplacementFeeRate.js

@@ -0,0 +1,25 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _constants = require('../constants');
+
+/**
+ * Calculate the sat/vB fee rate for a transaction that replaces another by fee:
+ * double the rate the replaced transaction paid.
+ *
+ * The rate rounds up to FEE_RATE_DECIMALS places. Rounding up means the
+ * replacement never pays less than double, and a positive rate never rounds
+ * down to zero, which the UTXO picker would accept as a valid rate. Rounding
+ * to a fixed number of places keeps the rate readable where it is reported as
+ * `feeRateUsed`.
+ *
+ * @param replacedFee The fee the replaced transaction paid, in satoshis
+ * @param replacedVBytes The replaced transaction's virtual size
+ * @returns {number}
+ */
+ const calcReplacementFeeRate = (
+  replacedFee,
+  replacedVBytes
+) => {
+  const scale = 10 ** _constants.FEE_RATE_DECIMALS
+  // The fee and size are whole numbers, so this division is exact whenever the
+  // scaled rate is, and Math.ceil sees no floating point noise.
+  return Math.ceil((replacedFee * 2 * scale) / replacedVBytes) / scale
+}; exports.calcReplacementFeeRate = calcReplacementFeeRate

package/lib/common/fees/processMempoolSpaceFees.js

@@ -1,7 +1,6 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } }var _biggystring = require('biggystring'); var bs = _interopRequireWildcard(_biggystring);
 var _cleaners = require('cleaners');
 
-var _constants = require('../constants');
 
 
  const asMempoolSpaceFees = _cleaners.asObject.call(void 0, {
@@ -12,13 +11,16 @@ var _constants = require('../constants');
 
 /**
  * Calculates the FeeRates object from MempoolSpace
- * Sets the minimum of LOW_FEE on all fee levels
  * @param fees
  * @returns Partial<FeeRates>
  */
 
-const STANDARD_FEE_HIGH_MULTIPLIER = 1.3
-const HIGH_FEE_MULTIPLIER = 2
+// The `/fees/precise` endpoint reports rates with up to three decimal places,
+// so the multipliers run through biggystring rather than JS numbers. A float
+// multiply would reintroduce noise (0.575 * 1.3 is 0.7474999999999999) that
+// biggystring carries exactly.
+const STANDARD_FEE_HIGH_MULTIPLIER = '1.3'
+const HIGH_FEE_MULTIPLIER = '2'
 
  const processMempoolSpaceFees = (fees) => {
   let mempoolFees
@@ -28,19 +30,13 @@ const HIGH_FEE_MULTIPLIER = 2
     return null
   }
 
-  const { fastestFee, halfHourFee } = mempoolFees
-
-  const lowFee = halfHourFee.toString()
-  const standardFeeLow = fastestFee.toString()
-  const standardFeeHigh = Math.round(
-    fastestFee * STANDARD_FEE_HIGH_MULTIPLIER
-  ).toString()
-  const highFee = Math.round(fastestFee * HIGH_FEE_MULTIPLIER).toString()
+  const fastestFee = mempoolFees.fastestFee.toString()
+  const halfHourFee = mempoolFees.halfHourFee.toString()
 
   return {
-    lowFee: bs.max(lowFee, _constants.LOW_FEE.toString()),
-    standardFeeLow: bs.max(standardFeeLow, _constants.LOW_FEE.toString()),
-    standardFeeHigh: bs.max(standardFeeHigh, _constants.LOW_FEE.toString()),
-    highFee: bs.max(highFee, _constants.LOW_FEE.toString())
+    lowFee: halfHourFee,
+    standardFeeLow: fastestFee,
+    standardFeeHigh: bs.mul(fastestFee, STANDARD_FEE_HIGH_MULTIPLIER),
+    highFee: bs.mul(fastestFee, HIGH_FEE_MULTIPLIER)
   }
 }; exports.processMempoolSpaceFees = processMempoolSpaceFees

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

@@ -20,6 +20,7 @@ var _edgecorejs = require('edge-core-js');
 
 var _filterUndefined = require('../../../util/filterUndefined');
 var _unixTime = require('../../../util/unixTime');
+var _calcReplacementFeeRate = require('../../fees/calcReplacementFeeRate');
 var _makeFees = require('../../fees/makeFees');
 var _EngineEmitter = require('../../plugin/EngineEmitter');
 var _Metadata = require('../../plugin/Metadata');
@@ -187,9 +188,12 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       // Must not be confirmed or dropped.
       if (replacedTx.blockHeight !== 0) return null
 
-      // Double the fee used for the RBF transaction:
+      // Double the fee rate used by the replaced transaction:
       const vBytes = _utils.transactionSizeFromHex.call(void 0, replacedTx.hex)
-      const newFeeRate = Math.round((parseInt(replacedTx.fees) / vBytes) * 2)
+      const newFeeRate = _calcReplacementFeeRate.calcReplacementFeeRate.call(void 0, 
+        parseInt(replacedTx.fees),
+        vBytes
+      )
 
       const replacedTxInputs = replacedTx.inputs
       // Recreate UTXOs from DataLayer transaction and mark them as unspent:
@@ -631,7 +635,16 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         freshAddress.segwitAddress)), () => (
         freshAddress.publicAddress))
 
-      const feeRate = parseInt(await fees.getRate(edgeSpendInfo))
+      // Fee rates may be fractional (e.g. a 1.8 sat/vB custom fee), so this
+      // must not be truncated to an integer. The picker rounds the satoshi
+      // amounts it derives from this rate up to whole satoshis. Number rejects
+      // any string that is not entirely a number, where parseFloat would read a
+      // comma-decimal '1,8' as 1 and charge the wrong rate without an error.
+      const feeRateString = await fees.getRate(edgeSpendInfo)
+      const feeRate = Number(feeRateString)
+      if (!isFinite(feeRate) || feeRate <= 0) {
+        throw new Error(`Invalid fee rate: ${feeRateString}`)
+      }
 
       let maxUtxo
       if (txOptions.CPFP != null) {

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

@@ -65,7 +65,7 @@ const engineInfo = {
   forks: ['bitcoincash', 'bitcoingold'],
   gapLimit: 25,
   feeUpdateInterval: 60000,
-  mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/recommended',
+  mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/precise',
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,
     standardFeeLowFudgeFactor: undefined,

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

@@ -45,7 +45,7 @@ var _commonInfo = require('./commonInfo');
   forks: ['bitcoincash', 'bitcoingold'],
   gapLimit: 25,
   feeUpdateInterval: 60000,
-  mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/recommended',
+  mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/precise',
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,
     standardFeeLowFudgeFactor: undefined,

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

@@ -49,7 +49,7 @@ var _commonInfo = require('./commonInfo');
   gapLimit: 25,
   feeUpdateInterval: 60000,
   mempoolSpaceFeeInfoServer:
-    'https://mempool.space/testnet4/api/v1/fees/recommended',
+    'https://mempool.space/testnet4/api/v1/fees/precise',
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,
     standardFeeLowFudgeFactor: undefined,

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

@@ -32,7 +32,10 @@ const currencyInfo = {
   ..._commonInfo.legacyMemoInfo,
   defaultSettings: {
     customFeeSettings: ['satPerByte'],
-    blockbookServers: ['wss://blockbook.fabien.cash/websocket'],
+    blockbookServers: [
+      'wss://blockbook.fabien.cash/websocket',
+      'wss://xec-blockbook.nownodes.io/wss/%{nowNodesApiKey}'
+    ],
     enableCustomServers: false
   },
   displayName: 'eCash',

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

@@ -18,9 +18,9 @@ const currencyInfo = {
   walletType: 'wallet:pivx',
 
   // Explorers:
-  addressExplorer: 'https://zkbitcoin.com/address/%s',
-  blockExplorer: 'https://zkbitcoin.com/block/%s',
-  transactionExplorer: 'https://zkbitcoin.com/tx/%s',
+  addressExplorer: 'https://explorer.duddino.com/address/%s',
+  blockExplorer: 'https://explorer.duddino.com/block/%s',
+  transactionExplorer: 'https://explorer.duddino.com/tx/%s',
 
   denominations: [
     {
@@ -34,7 +34,7 @@ const currencyInfo = {
   ..._commonInfo.legacyMemoInfo,
   defaultSettings: {
     customFeeSettings: ['satPerByte'],
-    blockbookServers: ['wss://pivx-eusa1.edge.app', 'wss://zkbitcoin.com'],
+    blockbookServers: ['wss://pivx-eusa1.edge.app'],
     enableCustomServers: false
   },
   displayName: 'PIVX',

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

@@ -6,7 +6,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
  function accumulative(args) {
   const { utxos, targets, feeRate, changeScript } = args
 
-  if (!isFinite(utils.uintOrNaN(feeRate))) {
+  if (!isFinite(utils.feeRateOrNaN(feeRate))) {
     throw new Error('No rate provided')
   }
 
@@ -24,7 +24,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
     const utxo = utxos[i]
 
     // skip detrimental input
-    const utxoFee = feeRate * utils.inputBytes(utxo)
+    const utxoFee = utils.feeForBytes(feeRate, utils.inputBytes(utxo))
     if (utxoFee > utxo.value) {
       if (i === utxos.length - 1) {
         break
@@ -37,7 +37,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
     inValue += utxo.value
 
     const bytes = utils.transactionBytes(inputs, outputs)
-    const fee = bytes * feeRate
+    const fee = utils.feeForBytes(feeRate, bytes)
 
     // go again?
     if (inValue < targetValue + fee) continue
@@ -47,7 +47,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
 
   return {
     changeUsed: false,
-    fee: Math.ceil(feeRate * utils.transactionBytes(inputs, outputs)),
+    fee: utils.feeForBytes(feeRate, utils.transactionBytes(inputs, outputs)),
     inputs
   }
 } exports.accumulative = accumulative;

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

@@ -7,7 +7,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
  function forceUseUtxo(args) {
   const { utxos, useUtxos, targets, feeRate, changeScript } = args
 
-  if (!isFinite(utils.uintOrNaN(feeRate))) {
+  if (!isFinite(utils.feeRateOrNaN(feeRate))) {
     throw new Error('No rate provided')
   }
 
@@ -21,7 +21,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
   let inValue = inputs.reduce((n, { value }) => n + value, 0)
   const targetValue = utils.sumOrNaN(targets)
   const bytes = utils.transactionBytes(inputs, outputs)
-  const fee = bytes * feeRate
+  const fee = utils.feeForBytes(feeRate, bytes)
   // if the new feeRate is already covered by lowering the change amount, return
   if (inValue >= targetValue + fee) {
     return utils.finalize(inputs, outputs, feeRate, changeScript)
@@ -31,7 +31,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
     const utxo = utxos[i]
 
     // skip detrimental input
-    const utxoFee = feeRate * utils.inputBytes(utxo)
+    const utxoFee = utils.feeForBytes(feeRate, utils.inputBytes(utxo))
     if (utxoFee > utxo.value) {
       if (i === utxos.length - 1) {
         break
@@ -44,7 +44,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
     inValue += utxo.value
 
     const bytes = utils.transactionBytes(inputs, outputs)
-    const fee = bytes * feeRate
+    const fee = utils.feeForBytes(feeRate, bytes)
 
     // go again?
     if (inValue < targetValue + fee) continue
@@ -54,7 +54,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
 
   return {
     changeUsed: false,
-    fee: Math.ceil(feeRate * utils.transactionBytes(inputs, outputs)),
+    fee: utils.feeForBytes(feeRate, utils.transactionBytes(inputs, outputs)),
     inputs
   }
 } exports.forceUseUtxo = forceUseUtxo;

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

@@ -10,7 +10,7 @@ var _utils = require('./utils'); var utils = _interopRequireWildcard(_utils);
     scriptPubkey: Buffer.from(target.script, 'hex')
   }))
 
-  const fee = Math.ceil(feeRate * utils.transactionBytes(utxos, outputs))
+  const fee = utils.feeForBytes(feeRate, utils.transactionBytes(utxos, outputs))
   targets[0].value -= fee
   outputs[0].value -= fee
 

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

@@ -73,7 +73,7 @@ const scriptSizeMap = (() => {
 } exports.outputBytes = outputBytes;
 
  function dustThreshold(output, feeRate) {
-  return outputBytes(output) * feeRate
+  return feeForBytes(feeRate, outputBytes(output))
 } exports.dustThreshold = dustThreshold;
 
 function witnessCount(inputs) {
@@ -122,6 +122,30 @@ function witnessCount(inputs) {
   return v
 } exports.uintOrNaN = uintOrNaN;
 
+/**
+ * Validates a fee rate in satoshis per byte. Fee rates may be fractional,
+ * unlike the satoshi values they produce: a rate is always multiplied by a
+ * byte count and rounded up before it becomes a satoshi amount.
+ */
+ function feeRateOrNaN(v) {
+  if (!isFinite(v)) return NaN
+  if (v < 0) return NaN
+  return v
+} exports.feeRateOrNaN = feeRateOrNaN;
+
+/**
+ * Returns the whole number of satoshis required to pay for `bytes` at
+ * `feeRate` satoshis per byte. Always rounds up, so a fractional rate can
+ * never produce a fractional satoshi amount and can never underpay.
+ */
+ function feeForBytes(feeRate, bytes) {
+  // Multiplying a fractional rate carries floating point noise: `1.1 * 10` is
+  // 11.000000000000002, which would round an exact satoshi amount up to the
+  // next satoshi. Snap the product back to 12 significant digits first, which
+  // is far more precision than any real fee needs, but well short of the noise.
+  return Math.ceil(parseFloat((feeRate * bytes).toPrecision(12)))
+} exports.feeForBytes = feeForBytes;
+
  function sumForgiving(range) {
   return range.reduce((a, x) => a + (isFinite(x.value) ? x.value : 0), 0)
 } exports.sumForgiving = sumForgiving;
@@ -139,7 +163,7 @@ function witnessCount(inputs) {
   const inValue = sumOrNaN(inputs)
   const outValue = sumOrNaN(outputs)
   let txSize = transactionBytes(inputs, outputs)
-  let fee = Math.ceil(feeRate * txSize)
+  let fee = feeForBytes(feeRate, txSize)
 
   const changeValue = inValue - (outValue + fee)
   const changeOutput = {
@@ -149,7 +173,7 @@ function witnessCount(inputs) {
   }
   const changeOutputSize = outputBytes(changeOutput)
   txSize += changeOutputSize
-  const changeFee = feeRate * changeOutputSize
+  const changeFee = feeForBytes(feeRate, changeOutputSize)
   changeOutput.value -= changeFee
   let changeUsed = false
   if (changeOutput.value > dustThreshold(changeOutput, feeRate)) {

package/lib/src/common/constants.d.ts

@@ -1,7 +1,7 @@
 export declare const INFO_SERVER_URI = "https://info1.edge.app";
 export declare const FEES_PATH = "fees.json";
 export declare const MAX_FEE = 999999999;
-export declare const LOW_FEE = 2;
+export declare const FEE_RATE_DECIMALS = 3;
 export declare const MAX_HIGH_DELAY = 200;
 export declare const MAX_STANDARD_DELAY = 6;
 export declare const MIN_STANDARD_DELAY = 2;

package/lib/src/common/fees/calcReplacementFeeRate.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Calculate the sat/vB fee rate for a transaction that replaces another by fee:
+ * double the rate the replaced transaction paid.
+ *
+ * The rate rounds up to FEE_RATE_DECIMALS places. Rounding up means the
+ * replacement never pays less than double, and a positive rate never rounds
+ * down to zero, which the UTXO picker would accept as a valid rate. Rounding
+ * to a fixed number of places keeps the rate readable where it is reported as
+ * `feeRateUsed`.
+ *
+ * @param replacedFee The fee the replaced transaction paid, in satoshis
+ * @param replacedVBytes The replaced transaction's virtual size
+ * @returns {number}
+ */
+export declare const calcReplacementFeeRate: (replacedFee: number, replacedVBytes: number) => number;

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

@@ -7,6 +7,18 @@ export declare function dustThreshold(output: Output, feeRate: number): number;
 export declare function transactionBytes(inputs: UTXO[], outputs: Output[]): number;
 export declare const transactionSizeFromHex: (hex: string) => number;
 export declare function uintOrNaN(v: number): number;
+/**
+ * Validates a fee rate in satoshis per byte. Fee rates may be fractional,
+ * unlike the satoshi values they produce: a rate is always multiplied by a
+ * byte count and rounded up before it becomes a satoshi amount.
+ */
+export declare function feeRateOrNaN(v: number): number;
+/**
+ * Returns the whole number of satoshis required to pay for `bytes` at
+ * `feeRate` satoshis per byte. Always rounds up, so a fractional rate can
+ * never produce a fractional satoshi amount and can never underpay.
+ */
+export declare function feeForBytes(feeRate: number, bytes: number): number;
 export declare function sumForgiving(range: Array<{
     value: number;
 }>): number;

package/lib/test/common/fees/calcReplacementFeeRate.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/fees/processMempoolSpaceFees.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/keymanager/utxopicker/decimalFeeRate.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/common/utxobased/keymanager/utxopicker/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "description": "Edge currency plugins to fetch and process wallet accounts, balances and transactions.",
   "homepage": "https://edge.app/",
   "repository": "https://github.com/EdgeApp/edge-currency-plugins",