edge-currency-plugins 3.12.0 → 3.14.0

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',
@@ -44,7 +44,7 @@ const currencyInfo = {
 const engineInfo = {
   serverConfigs: [
     {
-      type: 'blockbook-nownode',
+      type: 'blockbook',
       uris: ['https://pivx-wusa1.edge.app']
     },
     {

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

@@ -42,7 +42,7 @@ const currencyInfo = {
 const engineInfo = {
   serverConfigs: [
     {
-      type: 'blockbook-nownode',
+      type: 'blockbook',
       uris: ['https://qtum-wusa1.edge.app']
     }
   ],

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

@@ -48,7 +48,7 @@ const currencyInfo = {
 const engineInfo = {
   serverConfigs: [
     {
-      type: 'blockbook-nownode',
+      type: 'blockbook',
       uris: ['https://vtc-wusa1.edge.app']
     }
   ],

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

@@ -45,7 +45,7 @@ var _commonInfo = require('./commonInfo');
  const engineInfo = {
   serverConfigs: [
     {
-      type: 'blockbook-nownode',
+      type: 'blockbook',
       uris: ['https://firo-eusa1.edge.app']
     },
     {

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/common/utxobased/network/Blockbook.js

@@ -177,8 +177,16 @@ var _Socket = require('./Socket');
 
 
  {
-        const value = yield { ...message }
-        deferred.resolve(value)
+        try {
+          const value = yield { ...message }
+          deferred.resolve(value)
+        } catch (error) {
+          // The socket reports a failed request (an error response, the
+          // request timeout, the socket closing) by throwing into this
+          // generator. Without this catch the deferred stays pending forever
+          // and the caller hangs instead of seeing the failure.
+          deferred.reject(error)
+        }
         return false
       }
       const generator = taskGeneratorFn()

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/plugin/types.d.ts

@@ -116,7 +116,13 @@ export interface EngineInfo {
     txSpecificHandling?: (tx: TransactionData, specialTx: unknown) => TransactionData;
 }
 export interface ServerConfig {
-    type: 'blockbook-nownode';
+    /**
+     * - `blockbook`: a public Blockbook HTTP server. No credentials are sent.
+     * - `blockbook-nownode`: a NOWNodes Blockbook HTTP server. Requests carry
+     *   the `nowNodesApiKey` init option as the `api-key` header, and the
+     *   server is skipped when no key is configured.
+     */
+    type: 'blockbook' | 'blockbook-nownode';
     uris: string[];
 }
 /**

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

@@ -23,6 +23,11 @@ interface ServerStateConfig {
     pluginInfo: PluginInfo;
     pluginState: PluginState;
     walletInfo: SafeWalletInfo;
+    /**
+     * Upper bound on any single broadcast attempt. Defaults to the same 30
+     * seconds the socket layer uses for a request. Exposed for tests.
+     */
+    broadcastTimeoutMs?: number;
 }
 export interface ServerStates {
     setPickNextTaskCB: (callback: (uri: string) => AsyncGenerator<WsTask<unknown> | boolean>) => void;
@@ -46,5 +51,21 @@ export interface ServerStates {
     transactionSpecialQueryTask: (serverUri: string, txId: string) => WsTaskGenerator<unknown>;
     utxoListQueryTask: (serverUri: string, address: string) => WsTaskGenerator<AddressUtxosResponse>;
 }
+/**
+ * How long broadcastTx gives the first wave (our sockets and Edge's own HTTP
+ * servers) before it also sends the transaction to the NOWNodes HTTP servers.
+ * NOWNodes is a third party, so it should only see a transaction when our own
+ * infrastructure has not already carried it. A first wave that fails outright
+ * does not wait this long; the second wave fires as soon as it has all failed.
+ */
+export declare const NOWNODES_BROADCAST_DELAY_MS = 2000;
+/**
+ * Every broadcast attempt is counted toward "all attempts failed", so every
+ * attempt must settle. Sockets already expire a request after 30 seconds
+ * (Socket.ts); HTTP has no such bound of its own, and a server that accepts
+ * the connection and never answers would otherwise hold the whole broadcast
+ * open. This mirrors the socket figure.
+ */
+export declare const BROADCAST_ATTEMPT_TIMEOUT_MS = 30000;
 export declare function makeServerStates(config: ServerStateConfig): ServerStates;
 export {};

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/engine/ServerStates.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.12.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",