edge-currency-plugins 1.1.6 → 1.2.1

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

@@ -32,6 +32,11 @@ var _ProcessorTransaction = require('../db/Models/ProcessorTransaction');
 
 
 var _cleaners3 = require('../keymanager/cleaners');
+
+
+
+
+
 var _keymanager = require('../keymanager/keymanager');
 var _makeUtxoEngineState = require('./makeUtxoEngineState');
 var _makeUtxoWalletTools = require('./makeUtxoWalletTools');
@@ -275,6 +280,8 @@ var _utils = require('./utils');
       options
     ) {
       const { spendTargets } = edgeSpendInfo
+      const { outputSort = 'bip69' } = _nullishCoalesce(edgeSpendInfo.otherParams, () => ( {}))
+
       if (_optionalChain([options, 'optionalAccess', _5 => _5.CPFP]) == null && spendTargets.length < 1) {
         throw new Error('Need to provide Spend Targets')
       }
@@ -397,7 +404,8 @@ var _utils = require('./utils');
         setRBF,
         freshChangeAddress,
         subtractFee,
-        log
+        log,
+        outputSort
       })
       if (tx.changeUsed) {
         ourReceiveAddresses.push(freshChangeAddress)
@@ -511,10 +519,12 @@ var _utils = require('./utils');
 
       // Use the privateKeys (WIFs) from spendInfo, otherwise get them from the
       // PBST inputs.
-      const privateKeys = await (async () => {
+      const privateKeyEncodings = await (async (
+
+) => {
         if (edgeSpendInfo.privateKeys != null) {
           return edgeSpendInfo.privateKeys.map(wif =>
-            walletTools.getPrivateKeyFromWif(wif)
+            walletTools.getPrivateKeyEncodingFromWif(wif)
           )
         } else {
           return await Promise.all(
@@ -530,10 +540,14 @@ var _utils = require('./utils');
               if (_optionalChain([address, 'optionalAccess', _15 => _15.path]) == null)
                 throw new Error('Invalid script pubkey')
 
-              return walletTools.getPrivateKey({
+              const privateKey = walletTools.getPrivateKey({
                 path: address.path,
                 xprivKeys
               })
+              return {
+                hex: privateKey,
+                compressed: true // We shouldn't ever be storing/deriving uncompressed keys
+              }
             })
           )
         }
@@ -541,7 +555,7 @@ var _utils = require('./utils');
       const signedTx = await _keymanager.signTx.call(void 0, {
         psbtBase64: psbt.base64,
         coin: coinInfo.name,
-        privateKeys
+        privateKeyEncodings: privateKeyEncodings
       })
       transaction.txid = signedTx.id
       transaction.signedTx = signedTx.hex

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

@@ -11,6 +11,8 @@
 
 
 
+
+
 var _keymanager = require('../keymanager/keymanager');
 
 
@@ -125,12 +127,24 @@ var _utils = require('./utils');
     ) {
       const purposeType = _utils.currencyFormatToPurposeType.call(void 0, format)
       const scriptType = _utils.getScriptTypeFromPurposeType.call(void 0, purposeType)
-      const pubkey = _keymanager.privateKeyToPubkey.call(void 0, 
-        _keymanager.wifToPrivateKey.call(void 0, {
-          wifKey,
-          coin
-        })
-      )
+      const privateKeyEncoding = _keymanager.wifToPrivateKeyEncoding.call(void 0, {
+        wifKey,
+        coin
+      })
+
+      // Restrict only compressed keys for segwit pubkeys as per BIP143
+      // (see https://github.com/bitcoin/bips/blob/master/bip-0143.mediawiki#restrictions-on-public-key-type)
+      if (
+        [
+          _keymanager.BIP43PurposeTypeEnum.Segwit,
+          _keymanager.BIP43PurposeTypeEnum.WrappedSegwit
+        ].includes(purposeType) &&
+        !privateKeyEncoding.compressed
+      ) {
+        privateKeyEncoding.compressed = true
+      }
+
+      const pubkey = _keymanager.privateKeyEncodingToPubkey.call(void 0, privateKeyEncoding)
       return _keymanager.pubkeyToScriptPubkey.call(void 0, {
         pubkey: pubkey,
         scriptType
@@ -179,8 +193,8 @@ var _utils = require('./utils');
       })
     },
 
-    getPrivateKeyFromWif(wifKey) {
-      return _keymanager.wifToPrivateKey.call(void 0, {
+    getPrivateKeyEncodingFromWif(wifKey) {
+      return _keymanager.wifToPrivateKeyEncoding.call(void 0, {
         wifKey,
         coin
       })

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

@@ -221,7 +221,7 @@ var _keymanager = require('../keymanager/keymanager');
 
   // Check if the pathname type is a wif
   try {
-    _keymanager.wifToPrivateKey.call(void 0, {
+    _keymanager.wifToPrivateKeyEncoding.call(void 0, {
       wifKey: args.pathname,
       coin: args.coin
     })

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

@@ -228,6 +228,12 @@ var VerifyAddressEnum; (function (VerifyAddressEnum) {
 
 
 
+
+
+
+
+
+
 
 
 
@@ -784,7 +790,7 @@ const xprivToPrivateKeyInternal = (
   }).toWIF(coinClass.wifEncodeFunc)
 } exports.privateKeyToWIF = privateKeyToWIF;
 
-const wifToPrivateKeyInternal = (
+const wifToPrivateKeyEncodingInternal = (
   prefixIndex,
   args
 ) => {
@@ -794,29 +800,39 @@ const wifToPrivateKeyInternal = (
     forWIF: true,
     prefixIndex
   })
-  return _optionalChain([bitcoin, 'access', _10 => _10.ECPair, 'access', _11 => _11.fromWIF, 'call', _12 => _12(
+  const ecPair = bitcoin.ECPair.fromWIF(
     args.wifKey,
     network,
     coin.bs58DecodeFunc
-  ), 'access', _13 => _13.privateKey, 'optionalAccess', _14 => _14.toString, 'call', _15 => _15('hex')])
+  )
+  if (ecPair.privateKey == null) return
+  return {
+    hex: ecPair.privateKey.toString('hex'),
+    compressed: ecPair.compressed
+  }
 }
- const wifToPrivateKey = (args) => {
-  const privateKey = filterCoinPrefixes(
+ const wifToPrivateKeyEncoding = (
+  args
+) => {
+  const privateKeyEncoding = filterCoinPrefixes(
     args.coin,
-    prefixIndex => wifToPrivateKeyInternal(prefixIndex, args),
+    prefixIndex => wifToPrivateKeyEncodingInternal(prefixIndex, args),
     ['Invalid network version']
   )
-  if (privateKey == null) {
+  if (privateKeyEncoding == null) {
     throw new Error('Failed to convert WIF key to private key')
   }
-  return privateKey
-}; exports.wifToPrivateKey = wifToPrivateKey
+  return privateKeyEncoding
+}; exports.wifToPrivateKeyEncoding = wifToPrivateKeyEncoding
 
- function privateKeyToPubkey(privateKey) {
-  return bitcoin.ECPair.fromPrivateKey(
-    Buffer.from(privateKey, 'hex')
-  ).publicKey.toString('hex')
-} exports.privateKeyToPubkey = privateKeyToPubkey;
+ function privateKeyEncodingToPubkey(
+  privateKeyEncoding
+) {
+  const { hex, compressed } = privateKeyEncoding
+  return bitcoin.ECPair.fromPrivateKey(Buffer.from(hex, 'hex'), {
+    compressed
+  }).publicKey.toString('hex')
+} exports.privateKeyEncodingToPubkey = privateKeyEncodingToPubkey;
 
  function signMessageBase64(message, privateKey) {
   const keyPair = bitcoin.ECPair.fromPrivateKey(Buffer.from(privateKey, 'hex'))
@@ -829,7 +845,7 @@ const wifToPrivateKeyInternal = (
 } exports.signMessageBase64 = signMessageBase64;
 
  function makeTx(args) {
-  const { log } = args
+  const { log, outputSort } = args
   let sequence = 0xffffffff
   if (args.setRBF) {
     sequence -= 2
@@ -962,14 +978,21 @@ const wifToPrivateKeyInternal = (
   }
 
   const sortedInputs = _bip69.sortInputs.call(void 0, result.inputs)
-  const sortedOutputs = _bip69.sortOutputs.call(void 0, result.outputs)
+  const sortedOutputs = (() => {
+    switch (outputSort) {
+      case 'bip69':
+        return _bip69.sortOutputs.call(void 0, result.outputs)
+      case 'targets':
+        return result.outputs
+    }
+  })()
 
   const psbt = new bitcoin.Psbt()
   try {
     psbt.addInputs(sortedInputs)
     psbt.addOutputs(sortedOutputs)
   } catch (error) {
-    _optionalChain([log, 'optionalAccess', _16 => _16.error, 'call', _17 => _17(`Failed makeTx: ${String(error)}`)])
+    _optionalChain([log, 'optionalAccess', _10 => _10.error, 'call', _11 => _11(`Failed makeTx: ${String(error)}`)])
     throw error
   }
 
@@ -979,7 +1002,7 @@ const wifToPrivateKeyInternal = (
     changeUsed: result.changeUsed,
     fee: result.fee,
     psbtBase64: psbt.toBase64(),
-    hex: _optionalChain([psbt, 'access', _18 => _18.data, 'optionalAccess', _19 => _19.globalMap, 'optionalAccess', _20 => _20.unsignedTx, 'optionalAccess', _21 => _21.toBuffer, 'call', _22 => _22(), 'optionalAccess', _23 => _23.toString, 'call', _24 => _24('hex')])
+    hex: _optionalChain([psbt, 'access', _12 => _12.data, 'optionalAccess', _13 => _13.globalMap, 'optionalAccess', _14 => _14.unsignedTx, 'optionalAccess', _15 => _15.toBuffer, 'call', _16 => _16(), 'optionalAccess', _17 => _17.toString, 'call', _18 => _18('hex')])
   }
 } exports.makeTx = makeTx;
 
@@ -988,13 +1011,13 @@ const wifToPrivateKeyInternal = (
   const coin = _coinmapper.getCoinFromString.call(void 0, args.coin)
 
   for (let i = 0; i < psbt.inputCount; i++) {
-    const privateKey = Buffer.from(
-      _nullishCoalesce(args.privateKeys[i], () => ( args.privateKeys[args.privateKeys.length - 1])),
-      'hex'
-    )
+    const privateKeyEncoding =
+      _nullishCoalesce(args.privateKeyEncodings[i], () => (
+      args.privateKeyEncodings[args.privateKeyEncodings.length - 1]))
+    const { hex, compressed } = privateKeyEncoding
     psbt.signInput(
       i,
-      bitcoin.ECPair.fromPrivateKey(privateKey),
+      bitcoin.ECPair.fromPrivateKey(Buffer.from(hex, 'hex'), { compressed }),
       bitcoin.Psbt.DEFAULT_SIGHASHES,
       coin.sighashFunction
     )

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

@@ -1,6 +1,7 @@
 import { AddressPath, CurrencyFormat } from '../../plugin/types';
 import { ScriptTemplate } from '../info/scriptTemplates/types';
 import { PublicKey } from '../keymanager/cleaners';
+import { PrivateKeyEncoding } from '../keymanager/keymanager';
 import { CurrencyFormatKeys } from './utils';
 export interface WalletToolsConfig {
     publicKey: PublicKey;
@@ -14,7 +15,7 @@ export interface UTXOPluginWalletTools {
     addressToScriptPubkey: (address: string) => string;
     scriptPubkeyToAddress: (args: ScriptPubkeyToAddressArgs) => AddressReturn;
     getPrivateKey: (args: GetPrivateKeyArgs) => string;
-    getPrivateKeyFromWif: (wif: string) => string;
+    getPrivateKeyEncodingFromWif: (wif: string) => PrivateKeyEncoding;
     getScriptAddress: (args: GetScriptAddressArgs) => GetScriptAddressReturn;
     signMessageBase64: (args: SignMessageArgs) => string;
 }

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

@@ -101,10 +101,14 @@ export interface ScriptPubkeyToP2SHReturn {
     redeemScript: string;
     address?: string;
 }
-export interface WIFToPrivateKeyArgs {
+export interface WIFToPrivateKeyEncodingArgs {
     wifKey: string;
     coin: string;
 }
+export interface PrivateKeyEncoding {
+    hex: string;
+    compressed: boolean;
+}
 export interface PrivateKeyToWIFArgs {
     privateKey: string;
     coin: string;
@@ -133,6 +137,7 @@ export interface MakeTxArgs {
     freshChangeAddress: string;
     subtractFee?: boolean;
     log?: EdgeLog;
+    outputSort: 'bip69' | 'targets';
 }
 export interface MakeTxTarget {
     address?: string;
@@ -144,7 +149,7 @@ interface MakeTxReturn extends Required<utxopicker.UtxoPickerResult> {
     psbtBase64: string;
 }
 export interface SignTxArgs {
-    privateKeys: string[];
+    privateKeyEncodings: PrivateKeyEncoding[];
     psbtBase64: string;
     coin: string;
 }
@@ -194,8 +199,8 @@ export declare function pubkeyToScriptPubkey(args: PubkeyToScriptPubkeyArgs): Pu
 export declare const toNewFormat: (address: string, coinName: string) => string;
 export declare const xprivToPrivateKey: (args: XPrivToPrivateKeyArgs) => string;
 export declare function privateKeyToWIF(args: PrivateKeyToWIFArgs): string;
-export declare const wifToPrivateKey: (args: WIFToPrivateKeyArgs) => string;
-export declare function privateKeyToPubkey(privateKey: string): string;
+export declare const wifToPrivateKeyEncoding: (args: WIFToPrivateKeyEncodingArgs) => PrivateKeyEncoding;
+export declare function privateKeyEncodingToPubkey(privateKeyEncoding: PrivateKeyEncoding): string;
 export declare function signMessageBase64(message: string, privateKey: string): string;
 export declare function makeTx(args: MakeTxArgs): MakeTxReturn;
 export declare function signTx(args: SignTxArgs): Promise<SignTxReturn>;

package/package.json

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