edge-currency-plugins 3.0.2 → 3.1.0

package/lib/common/plugin/CurrencyTools.js

@@ -63,8 +63,8 @@ var _utils3 = require('./utils');
       const privateKey = {
         imported: false,
         seed: mnemonic,
-        format: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _ => _.format]), () => ( _optionalChain([engineInfo, 'access', _2 => _2.formats, 'optionalAccess', _3 => _3[0]]))), () => ( 'bip44')),
-        coinType: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _4 => _4.coinType]), () => ( coinInfo.coinType)), () => ( 0))
+        format: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _ => _.format]), () => ( engineInfo.formats[0])), () => ( 'bip44')),
+        coinType: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _2 => _2.coinType]), () => ( coinInfo.coinType)), () => ( 0))
       }
 
       return wasCurrencyPrivateKey(privateKey)
@@ -90,8 +90,8 @@ var _utils3 = require('./utils');
       const privateKey = {
         imported: true,
         seed: entropy,
-        format: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _5 => _5.format]), () => ( _optionalChain([engineInfo, 'access', _6 => _6.formats, 'optionalAccess', _7 => _7[0]]))), () => ( 'bip44')),
-        coinType: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _8 => _8.coinType]), () => ( coinInfo.coinType)), () => ( 0))
+        format: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _3 => _3.format]), () => ( _optionalChain([engineInfo, 'access', _4 => _4.formats, 'optionalAccess', _5 => _5[0]]))), () => ( 'bip44')),
+        coinType: _nullishCoalesce(_nullishCoalesce(_optionalChain([opts, 'optionalAccess', _6 => _6.coinType]), () => ( coinInfo.coinType)), () => ( 0))
       }
 
       return wasCurrencyPrivateKey(privateKey)

package/lib/common/plugin/types.js

@@ -137,6 +137,160 @@ var _types3 = require('../utxobased/db/types');
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 

package/lib/common/plugin/utils.js

@@ -1,9 +1,8 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }var _all = require('../utxobased/info/all');
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _all = require('../utxobased/info/all');
 
  const getFormatsForNetwork = (coinName) => {
   for (const plugin of _all.all) {
-    if (plugin.coinInfo.name === coinName)
-      return _nullishCoalesce(plugin.engineInfo.formats, () => ( []))
+    if (plugin.coinInfo.name === coinName) return plugin.engineInfo.formats
   }
   return []
 }; exports.getFormatsForNetwork = getFormatsForNetwork

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

@@ -102,10 +102,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
   const walletInfo = _cleaners3.asSafeWalletInfo.call(void 0, pluginInfo)(config.walletInfo)
   const { privateKeyFormat, publicKey, walletFormats } = walletInfo.keys
 
-  if (
-    engineInfo.formats == null ||
-    !engineInfo.formats.includes(privateKeyFormat)
-  ) {
+  if (!engineInfo.formats.includes(privateKeyFormat)) {
     const message = `Wallet format is not supported: ${privateKeyFormat}`
     log.error(message)
     throw new Error(message)
@@ -620,6 +617,13 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         targets = []
       }
 
+      // Determine whether the transaction should enable RBF given that the
+      // currency supports RBF.
+      const enableRbf =
+        currencyInfo.canReplaceByFee === true
+          ? _nullishCoalesce(_nullishCoalesce(edgeSpendInfo.enableRbf, () => ( spendInfoOtherParams.enableRbf)), () => ( true))
+          : false
+
       log.warn(`spend: Using fee rate ${feeRate} sat/B`)
       const subtractFee =
         txOptions.subtractFee != null ? txOptions.subtractFee : false
@@ -631,10 +635,7 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
         feeRate,
         coin: coinInfo.name,
         currencyCode: currencyInfo.currencyCode,
-        enableRbf:
-          _nullishCoalesce(_nullishCoalesce(spendInfoOtherParams.enableRbf, () => (
-          currencyInfo.canReplaceByFee)), () => (
-          false)),
+        enableRbf,
         freshChangeAddress,
         subtractFee,
         log,
@@ -904,11 +905,6 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
 
       // The temporary wallet info should include all formats for the currency
       const allFormats = engineInfo.formats
-      if (allFormats == null) {
-        throw new Error(
-          `Missing  formats for wallet type ${currencyInfo.walletType}`
-        )
-      }
 
       const tmpWalletInfo = {
         id: walletInfo.id,

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

@@ -48,6 +48,7 @@ const asOutputSort = _cleaners.asValue.call(void 0, 'bip69', 'targets')
 
 
  const asUtxoSpendInfoOtherParams = _cleaners.asObject.call(void 0, {
+  /** @deprecated use `EdgeSpendInfo['enableRbf']` */
   enableRbf: _cleaners.asOptional.call(void 0, _cleaners.asBoolean),
   forceChangeAddress: _cleaners.asOptional.call(void 0, _cleaners.asString),
   outputSort: _cleaners.asOptional.call(void 0, asOutputSort, 'bip69'),

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

@@ -38,7 +38,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip49', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 500000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -55,7 +55,6 @@ const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   forks: ['bitcoincash', 'bitcoingold'],
   gapLimit: 25,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/recommended',
   defaultFeeInfo: {

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

@@ -57,7 +57,6 @@ const engineInfo = {
   formats: ['bip44', 'bip32'],
   forks: [], // 'bitcoinsv' is currently disabled, so not included in the forks
   gapLimit: 10,
-  defaultFee: 10000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -43,7 +43,6 @@ const engineInfo = {
   formats: ['bip44', 'bip32'],
   forks: ['bitcoinsv'],
   gapLimit: 10,
-  defaultFee: 10000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -47,7 +47,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -40,7 +40,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -48,7 +48,6 @@ const engineInfo = {
   formats: ['bip44', 'bip32'],
   uriPrefix: 'bitcoin',
   gapLimit: 10,
-  defaultFee: 10000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -42,7 +42,6 @@ var _commonInfo = require('./commonInfo');
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   forks: ['bitcoincash', 'bitcoingold'],
   gapLimit: 25,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   mempoolSpaceFeeInfoServer: 'https://mempool.space/api/v1/fees/recommended',
   defaultFeeInfo: {

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

@@ -54,7 +54,6 @@ const engineInfo = {
   ],
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 10000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -46,7 +46,6 @@ const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   forks: [],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -50,7 +50,6 @@ const engineInfo = {
   ],
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 10000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -39,7 +39,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 500000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -39,7 +39,6 @@ var _commonInfo = require('./commonInfo');
  const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -51,7 +51,6 @@ const engineInfo = {
   ],
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 100000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -52,7 +52,6 @@ var _commonInfo = require('./commonInfo');
   ],
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 50000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -36,7 +36,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -36,7 +36,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -42,7 +42,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 100000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -39,7 +39,6 @@ const currencyInfo = {
 const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   gapLimit: 10,
-  defaultFee: 50000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -46,7 +46,6 @@ const engineInfo = {
   formats: ['bip49', 'bip84', 'bip44', 'bip32'],
   forks: [],
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -46,7 +46,6 @@ var _commonInfo = require('./commonInfo');
   formats: ['bip44', 'bip32'],
   uriPrefix: 'firo',
   gapLimit: 10,
-  defaultFee: 1000,
   feeUpdateInterval: 60000,
   defaultFeeInfo: {
     lowFeeFudgeFactor: undefined,

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

@@ -1,4 +1,4 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
 
@@ -105,7 +105,7 @@ const asOptionalPrivateKeyFormat = _cleaners.asOptional.call(void 0, asPrivateKe
         return ['bip49', 'bip84']
     }
   })()
-  const engineInfoFormats = _nullishCoalesce(engineInfo.formats, () => ( ['bip44', 'bip32']))
+  const engineInfoFormats = engineInfo.formats
   return formats.filter(format => engineInfoFormats.includes(format))
 }; exports.getSupportedFormats = getSupportedFormats
 

package/lib/src/common/plugin/types.d.ts

@@ -34,17 +34,85 @@ export interface PluginInfo {
     coinInfo: CoinInfo;
 }
 export interface EngineInfo {
-    formats?: CurrencyFormat[];
+    /**
+     * Supported wallet formats for address derivation.
+     *
+     * See https://github.com/EdgeApp/edge-core-js/blob/master/docs/key-formats.md#detailed-key-formats
+     **/
+    formats: CurrencyFormat[];
+    /**
+     * Optional list of currency pluginId strings of which this currency is a fork.
+     * These fork currencies are able to be split into this currency.
+     **/
     forks?: string[];
     uriPrefix?: string;
+    /**
+     * The gap limit defines the number of indexes to derive from the last used
+     * address. This is typically set to 10 for most currencies with the exception
+     * of Bitcoin which is set to 25 for historical reasons.
+     */
     gapLimit: number;
-    defaultFee: number;
+    /**
+     * The number of milliseconds defining the frequency that the engine will
+     * fetch new fee rates.
+     */
     feeUpdateInterval: number;
+    /**
+     * Optional mempool.space URI for fetching fee info.
+     *
+     * See https://mempool.space/docs/api/rest#get-recommended-fees
+     */
     mempoolSpaceFeeInfoServer?: string;
+    /**
+     * Default fee info used before fetching up-to-date fee info from Edge
+     * Info Servers.
+     */
     defaultFeeInfo: FeeInfo;
+    /**
+     * Optional script template functions for non-standard output script types.
+     * These are used to generate the output scriptPubkey for a transaction given
+     * pubkey as an argument.
+     *
+     * The derivation path includes a changeIndex using the 2 bytes of the hash
+     * of the script template function output given an empty pubkey value.
+     * The engine will search for funds on this derivation path using address
+     * indexes up to the gapLimit.
+     *
+     * This feature is mainly used for replay-protection script templates for
+     * Bitcoin Cash and Bitcoin SV replay protection. It it currently limited
+     * to supporting only `replayProtection` keyed entries.
+     */
     scriptTemplates?: ScriptTemplates;
+    /**
+     * Optional server configurations for the currency engine. Currently only supports
+     * NOWNode Blockbook servers configuration types for HTTP fallback.
+     *
+     * Use `blockbookServers` config in `EdgeCurrencyInfo['defaultSettings']` for
+     * the time being. This config controls the WebSocket URI for Blockbook
+     * connections over the WebSocket protocol.
+     */
     serverConfigs?: ServerConfig[];
+    /**
+     * An optional codec cleaner (asCodec) for serializing and deserializing an
+     * address over network interfaces. This can be used to resolve issues with
+     * network interfaces that expect addresses to be formatted differently than
+     * what is expected by the engine.
+     *
+     * For example, if a Blockbook server expects
+     * an address URI prefix (mycurrency:), then this cleaner codec can add the
+     * necessary translations.
+     *
+     * See https://cleaners.js.org/#/reference?id=ascodec cleaner codec
+     * documentation.
+     */
     asBlockbookAddress?: Cleaner<string>;
+    /**
+     * Some currencies require an additional blockbook payload
+     * 'getTransactionSpecific' in order to provide all relevant transaction
+     * data. If this function is defined, it should merge the unknown `specialTx`
+     * data from the Blockbook endpoint with the `IProcessorTransaction` object
+     * which is stored to disk.
+     **/
     txSpecificHandling?: (tx: IProcessorTransaction, specialTx: unknown) => IProcessorTransaction;
 }
 export interface ServerConfig {
@@ -54,21 +122,92 @@ export interface ServerConfig {
 /**
  * Coin Info
  */
+/**
+ * This info is to be used to interface with the AltcoinJs library. It contains
+ * network and encoding parameters for the currency.
+ */
 export interface CoinInfo {
+    /**
+     * The official network name in lower case. This is a unique network name
+     * to identify the `CoinInfo`. It should not conflict with other currency
+     * plugins using the same UTXO plugin implementation.
+     */
     name: string;
+    /**
+     * Whether the currency uses segwit addresses (wrapped-segwit P2SH, P2WSH, etc).
+     */
     segwit: boolean;
+    /**
+     * The SLIP-0044 coin type number. This is used to derive the BIP32 path for
+     * addresses.
+     */
     coinType: number;
+    /**
+     * Optional sighash value to be passed to AltcoinJS as the sighashType field
+     * on inputs. This is primarily used by currencies that leverage it as
+     * build-in replay-protection mechanisms.
+     */
     sighash?: number;
+    /**
+     * A function to be passed to AltcoinJS `signInput` method. This is used to
+     * get the input hash for the signature algorithm before signing the input.
+     *
+     * This is used if the currency has a custom signature hash function that
+     * deviates from the default `bcrypto.hash256` function used for Bitcoin.
+     */
     sighashFunction?: (Hash: Buffer) => Buffer;
+    /**
+     * A function to be passed to AltcoinJS `getId` method. This is used to get
+     * the transaction hash (txid) for a transaction.
+     *
+     * This is used if the currency has a custom signature hash function that
+     * deviates from the default `bcrypto.hash256` function used for Bitcoin.
+     */
     txHashFunction?: (Hash: Buffer) => Buffer;
+    /**
+     * A optional custom decode function passed to AltcoinJS `PaymentCreator`
+     * function. This is used to decode the base58 address encoding.
+     */
     bs58DecodeFunc?: BaseConverter['decode'];
+    /**
+     * A optional custom encode function passed to AltcoinJS `PaymentCreator`
+     * function. This is used to encode the address to a base58 encoding.
+     */
     bs58EncodeFunc?: BaseConverter['encode'];
+    /**
+     * A optional custom WIF encoding function passed to AltcoinJS `toWIF` method.
+     * This is used to encode the private key into a WIF.
+     */
     wifEncodeFunc?: typeof wif.encode;
+    /**
+     * A optional custom extended public/private key encoding function.
+     * This is used when converting a public or private key to an xpub/xpriv.
+     */
     bip32FromBase58Func?: (xKey: string, network: BitcoinJSNetwork) => bip32.BIP32Interface;
+    /**
+     * A optional custom seed encoding function.
+     * This is used when converting a seed to root private key.
+     */
     bip32FromSeedFunc?: (seed: Buffer) => bip32.BIP32Interface;
+    /**
+     * A optional custom UTXO picker function for currencies that may require
+     * different UTXO selection algorithms.
+     */
     utxoPicker?: UtxoPicker;
+    /**
+     * This is all the currency specific prefixes for encoding and decoding
+     * of various data types.
+     */
     prefixes: CoinPrefixes;
 }
+/**
+ * This is all the currency specific prefixes for encoding and decoding
+ * of various data types.
+ *
+ * The first entry in the array is used for standard serialization.
+ * The second entry in the array is used for legacy serialization.
+ * All entries in the array are checked whether they can de-serialize the content
+ */
 export interface CoinPrefixes {
     messagePrefix: string[];
     wif: number[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "3.0.2",
+  "version": "3.1.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",
@@ -87,7 +87,7 @@
     "base-x": "^4.0.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
-    "edge-core-js": "^2.5.0",
+    "edge-core-js": "^2.7.0",
     "esbuild-loader": "^4.1.0",
     "eslint": "^7.14.0",
     "eslint-config-standard-kit": "0.15.1",