edge-currency-plugins 3.11.0 → 3.12.0

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

@@ -45,6 +45,9 @@ var _cleaners3 = require('../keymanager/cleaners');
 
 
 var _keymanager = require('../keymanager/keymanager');
+
+
+
 var _types5 = require('../keymanager/types');
 var _utils = require('../keymanager/utxopicker/utils');
 var _paymentRequest = require('./paymentRequest');
@@ -797,11 +800,20 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       opts
     ) {
       const otherParams = _types7.asUtxoSignMessageOtherParams.call(void 0, opts.otherParams)
-      const { publicAddress } = otherParams
-      const scriptPubkey = walletTools.addressToScriptPubkey(publicAddress)
+      const { publicAddress, signatureFormat } = otherParams
+      // An address the wallet cannot sign for reaches us two ways: it parses
+      // but is not ours, or it is not an address of this chain at all and
+      // `addressToScriptPubkey` throws. Both are the same thing to a caller,
+      // so give them one named error rather than assorted parser prose.
+      let scriptPubkey
+      try {
+        scriptPubkey = walletTools.addressToScriptPubkey(publicAddress)
+      } catch (e2) {
+        throw new (0, _types5.AddressNotOwnedError)()
+      }
       const addressData = await dataLayer.fetchAddress(scriptPubkey)
       if (_optionalChain([addressData, 'optionalAccess', _13 => _13.path]) == null) {
-        throw new Error('Missing data-layer address to sign with')
+        throw new (0, _types5.AddressNotOwnedError)()
       }
       const privateKey = asMaybeCurrencyPrivateKey(privateKeys)
 
@@ -818,7 +830,8 @@ var _UtxoWalletTools = require('./UtxoWalletTools');
       const signature = await walletTools.signMessageBase64({
         path: _optionalChain([addressData, 'optionalAccess', _14 => _14.path]),
         message,
-        xprivKeys
+        xprivKeys,
+        signatureFormat
       })
       return signature
     },

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

@@ -25,6 +25,7 @@ var _keymanager = require('../keymanager/keymanager');
 
 
 
+
 var _utils = require('./utils');
 
 
@@ -92,6 +93,7 @@ var _utils = require('./utils');
 
 
 
+
 
 
  function makeUtxoWalletTools(
@@ -236,12 +238,23 @@ var _utils = require('./utils');
       return { address, scriptPubkey, redeemScript }
     },
 
-    signMessageBase64({ path, message, xprivKeys }) {
+    signMessageBase64({
+      path,
+      message,
+      xprivKeys,
+      signatureFormat
+    }) {
       const privKey = fns.getPrivateKey({
         path,
         xprivKeys
       })
-      return _keymanager.signMessageBase64.call(void 0, message, privKey)
+      return _keymanager.signMessageBase64.call(void 0, 
+        message,
+        privKey,
+        path.format,
+        coin,
+        signatureFormat
+      )
     }
   }
 

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

@@ -11,6 +11,7 @@ var _cleaners = require('cleaners');
 
 
 var _types3 = require('../../plugin/types');
+var _types5 = require('../keymanager/types');
 
 
 
@@ -42,7 +43,12 @@ var _types3 = require('../../plugin/types');
 
 
  const asUtxoSignMessageOtherParams = _cleaners.asObject.call(void 0, {
-  publicAddress: _cleaners.asString
+  publicAddress: _cleaners.asString,
+  // Defaults to the legacy Electrum encoding so existing callers keep the
+  // format they already produce. BIP-137 is opt-in, since emitting a BIP-137
+  // header to a verifier expecting the legacy one is just as broken as the
+  // reverse.
+  signatureFormat: _cleaners.asMaybe.call(void 0, _types5.asUtxoSignatureFormat, 'electrum')
 }); exports.asUtxoSignMessageOtherParams = asUtxoSignMessageOtherParams
 
 const asOutputSort = _cleaners.asValue.call(void 0, 'bip69', 'targets')

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

@@ -73,7 +73,7 @@ const engineInfo = {
   coinType: 156,
 
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Gold Signed Message:\n'],
+    messagePrefix: ['\x1dBitcoin Gold Signed Message:\n'],
     wif: [0x80],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -65,7 +65,7 @@ const engineInfo = {
   coinType: 1,
 
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Gold Signed Message:\n'],
+    messagePrefix: ['\x1dBitcoin Gold Signed Message:\n'],
     wif: [0xef],
     legacyXPriv: [0x04358394],
     legacyXPub: [0x043587cf],

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

@@ -99,7 +99,8 @@ const engineInfo = {
   segwit: false,
   coinType: 5,
   prefixes: {
-    messagePrefix: ['unused'],
+    // Dash kept its pre-rebrand DarkCoin magic; not a typo.
+    messagePrefix: ['\x19DarkCoin Signed Message:\n'],
     wif: [0xcc],
     legacyXPriv: [0x02fe52f8],
     legacyXPub: [0x02fe52cc],

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

@@ -79,7 +79,7 @@ const engineInfo = {
   segwit: true,
   coinType: 20,
   prefixes: {
-    messagePrefix: ['\x18Digibyte Signed Message:\n'],
+    messagePrefix: ['\x19DigiByte Signed Message:\n'],
     wif: [0x80, 0x9e],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -81,7 +81,7 @@ const engineInfo = {
   coinType: 3,
   utxoPicker: _dogeUtxoPicker.makeDogeUtxoPicker.call(void 0, ),
   prefixes: {
-    messagePrefix: ['\x18Dogecoin Signed Message:\n'],
+    messagePrefix: ['\x19Dogecoin Signed Message:\n'],
     wif: [0x9e],
     legacyXPriv: [0x02fac398],
     legacyXPub: [0x02facafd],

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

@@ -80,7 +80,7 @@ const engineInfo = {
   includeCashaddrPrefix: true,
 
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Signed Message::\n'],
+    messagePrefix: ['\x16eCash Signed Message:\n'],
     wif: [0x80],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -63,7 +63,7 @@ var _commonInfo = require('./commonInfo');
   segwit: true,
   coinType: 8,
   prefixes: {
-    messagePrefix: ['\x18Feathercoin Signed Message:\n'],
+    messagePrefix: ['\x1cFeathercoin Signed Message:\n'],
     wif: [0x8e],
     legacyXPriv: [0x0488daee],
     legacyXPub: [0x0488bc26],

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

@@ -83,7 +83,7 @@ var _commonInfo = require('./commonInfo');
   segwit: true,
   coinType: 2,
   prefixes: {
-    messagePrefix: ['\x18Litecoin Signed Message:\n'],
+    messagePrefix: ['\x19Litecoin Signed Message:\n'],
     wif: [0xb0],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -79,7 +79,8 @@ const engineInfo = {
     /*
     [Prefix reference](https://github.com/PIVX-Project/PIVX/blob/b89a9fc04e9e31bb3fd009df0506c957a00ad536/src/chainparams.cpp#L329)
     */
-    messagePrefix: ['PIVX Signed Message:\n'],
+    // PIVX inherited DarkNet from its Dash fork ancestry; not a typo.
+    messagePrefix: ['\x18DarkNet Signed Message:\n'],
     wif: [0xd4],
     legacyXPriv: [0x0221312b],
     legacyXPub: [0x022d2533],

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

@@ -70,7 +70,7 @@ const engineInfo = {
   segwit: false,
   coinType: 2301,
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Signed Message:\n'],
+    messagePrefix: ['\x15Qtum Signed Message:\n'],
     wif: [0x80],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -60,7 +60,7 @@ const engineInfo = {
   segwit: false,
   coinType: 175,
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Signed Message:\n'],
+    messagePrefix: ['\x16Raven Signed Message:\n'],
     wif: [0x80],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -71,7 +71,7 @@ const engineInfo = {
   bs58EncodeFunc: base58smart.encode,
   wifEncodeFunc: wifsmart.encode,
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Signed Message:\n'],
+    messagePrefix: ['\x1aSmartCash Signed Message:\n'],
     wif: [0xbf],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -63,7 +63,7 @@ const engineInfo = {
   segwit: true,
   coinType: 202,
   prefixes: {
-    messagePrefix: ['\x18Bitcoin Signed Message:\n'],
+    messagePrefix: ['\x14UFO Signed Message:\n'],
     wif: [0x9b],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -77,6 +77,7 @@ const engineInfo = {
   segwit: true,
   coinType: 28,
   prefixes: {
+    // Vertcoin Core genuinely uses Bitcoin's magic; not an oversight.
     messagePrefix: ['\x18Bitcoin Signed Message:\n'],
     wif: [0x80],
     legacyXPriv: [0x0488ade4],

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

@@ -78,7 +78,7 @@ var _commonInfo = require('./commonInfo');
   segwit: false,
   coinType: 136,
   prefixes: {
-    messagePrefix: ['\x18Zcoin Signed Message:\n'],
+    messagePrefix: ['\x16Zcoin Signed Message:\n'],
     wif: [0xd2],
     legacyXPriv: [0x0488ade4],
     legacyXPub: [0x0488b21e],

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

@@ -21,6 +21,12 @@ var _undefinedIfEmptyString = require('../../../util/undefinedIfEmptyString');
 
 
 
+
+
+
+
+
+
 var _bip69 = require('./bip69');
 
 
@@ -938,14 +944,62 @@ const wifToPrivateKeyEncodingInternal = (
   }).publicKey.toString('hex')
 } exports.privateKeyEncodingToPubkey = privateKeyEncodingToPubkey;
 
- function signMessageBase64(message, privateKey) {
+/**
+ * The `segwitType` to hand `bitcoinjs-message`, or `undefined` to leave the
+ * header byte in the legacy Electrum range. Only the BIP137 encoding cares
+ * about the derivation purpose, so only it resolves one.
+ */
+function getBip137SegwitType(
+  signatureFormat,
+  format
+) {
+  if (signatureFormat !== 'bip137') return undefined
+  const purposeType = bip43PurposeNumberToTypeEnum(
+    parseInt(format.replace('bip', ''))
+  )
+  switch (purposeType) {
+    case BIP43PurposeTypeEnum.Segwit:
+      return 'p2wpkh'
+    case BIP43PurposeTypeEnum.WrappedSegwit:
+      return 'p2sh(p2wpkh)'
+    default:
+      return undefined
+  }
+}
+
+ function signMessageBase64(
+  message,
+  privateKey,
+  format,
+  coin,
+  signatureFormat = 'electrum'
+) {
   const ECPair = getECPair()
   const keyPair = ECPair.fromPrivateKey(Buffer.from(privateKey, 'hex'))
   if (keyPair.privateKey == null) {
     throw new Error('Address could not sign message')
   }
+  // BIP137 encodes the address type in the signature's header byte. Native
+  // SegWit (bip84 / P2WPKH) and nested SegWit (bip49 / P2SH-P2WPKH) each have
+  // their own header range; verifiers such as Bringin reject a SegWit address
+  // whose message was signed with a legacy (bip44) header byte. The derivation
+  // path is what tells us the script type, so no caller has to infer it from
+  // the address string. Callers opt in, since emitting a BIP137 header to a
+  // verifier that expects the legacy Electrum encoding is just as broken.
+  // The purpose lookup stays inside the BIP137 branch on purpose:
+  // `bip43PurposeNumberToTypeEnum` throws on a purpose it does not map, so
+  // computing it unconditionally would let a future `CurrencyFormat` (bip86
+  // Taproot being the obvious candidate) break the default Electrum path,
+  // which never needs it.
+  const segwitType = getBip137SegwitType(signatureFormat, format)
+  // Magic-hash the message with the coin's own prefix (e.g. "Litecoin Signed
+  // Message:\n") so the signature verifies against that coin's addresses.
+  // Every UTXO coin routes through here, not just Bitcoin.
+  const messagePrefix = _coinmapper.getCoinFromString.call(void 0, coin).prefixes.messagePrefix[0]
   return _bitcoinjsmessage2.default
-    .sign(message, keyPair.privateKey, keyPair.compressed)
+    .sign(message, keyPair.privateKey, keyPair.compressed, messagePrefix, {
+      segwitType
+    })
     .toString('base64')
 } exports.signMessageBase64 = signMessageBase64;
 

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

@@ -1,6 +1,17 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _cleaners = require('cleaners');
 var _types = require('edge-core-js/types');
 
+/**
+ * How to encode the header byte of a signed message.
+ *  - `electrum`: the legacy format, whose header carries only the recovery id
+ *    and key compression. Every verifier understands it, but it says nothing
+ *    about the script type.
+ *  - `bip137`: additionally encodes the signing address' script type, which
+ *    verifiers such as Bringin require for SegWit addresses.
+ */
+ const asUtxoSignatureFormat = _cleaners.asValue.call(void 0, 'electrum', 'bip137'); exports.asUtxoSignatureFormat = asUtxoSignatureFormat
+
+
 
 
 
@@ -27,6 +38,22 @@ function asMaybeError(name) {
   }
 }
 
+/**
+ * The wallet cannot sign for the requested address: either it does not derive
+ * it, or the string is not an address of this chain at all. Callers get a
+ * stable `name` to branch on instead of matching against the message prose.
+ */
+ class AddressNotOwnedError extends Error {
+  constructor() {
+    super('Wallet does not own the address to sign with')
+    this.name = 'AddressNotOwnedError'
+  }
+} exports.AddressNotOwnedError = AddressNotOwnedError;
+
+ const asMaybeAddressNotOwnedError = asMaybeError(
+  'AddressNotOwnedError'
+); exports.asMaybeAddressNotOwnedError = asMaybeAddressNotOwnedError
+
  const asMaybeInsufficientFundsErrorPlus = asMaybeError(
   // Share the same name because this error type is a subtype of
   // InsufficientFundsError and therefore backwards compatible

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

@@ -2,6 +2,7 @@ import { AddressPath, ChangePath, CurrencyFormat, PluginInfo } from '../../plugi
 import { ScriptTemplate } from '../info/scriptTemplates/types';
 import { PublicKey } from '../keymanager/cleaners';
 import { PrivateKeyEncoding } from '../keymanager/keymanager';
+import { UtxoSignatureFormat } from '../keymanager/types';
 import { CurrencyFormatKeys } from './utils';
 export interface WalletToolsConfig {
     pluginInfo: PluginInfo;
@@ -48,6 +49,7 @@ interface SignMessageArgs {
     path: AddressPath;
     message: string;
     xprivKeys: CurrencyFormatKeys;
+    signatureFormat: UtxoSignatureFormat;
 }
 export declare function makeUtxoWalletTools(config: WalletToolsConfig): UtxoWalletTools;
 export {};

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

@@ -23,6 +23,7 @@ export interface UtxoTxOtherParams {
 export declare type UtxoSignMessageOtherParams = ReturnType<typeof asUtxoSignMessageOtherParams>;
 export declare const asUtxoSignMessageOtherParams: import("cleaners").ObjectCleaner<{
     publicAddress: string;
+    signatureFormat: "electrum" | "bip137";
 }>;
 export declare type UtxoSpendInfoOtherParams = ReturnType<typeof asUtxoSpendInfoOtherParams>;
 export declare const asUtxoSpendInfoOtherParams: import("cleaners").ObjectCleaner<{

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

@@ -1,7 +1,8 @@
 import { EdgeLog, EdgeMemo } from 'edge-core-js/types';
-import { ChangePath, FeeInfo } from '../../plugin/types';
+import { ChangePath, CurrencyFormat, FeeInfo } from '../../plugin/types';
 import { UtxoData } from '../db/types';
 import { ScriptTemplate, ScriptTemplates } from '../info/scriptTemplates/types';
+import { UtxoSignatureFormat } from './types';
 import * as utxopicker from './utxopicker';
 export declare enum BIP43PurposeTypeEnum {
     Airbitz = "airbitz",
@@ -202,7 +203,7 @@ export declare const xprivToPrivateKey: (args: XPrivToPrivateKeyArgs) => string;
 export declare function privateKeyToWIF(args: PrivateKeyToWIFArgs): 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 signMessageBase64(message: string, privateKey: string, format: CurrencyFormat, coin: string, signatureFormat?: UtxoSignatureFormat): string;
 export declare function makeTx(args: MakeTxArgs): MakeTxReturn;
 export declare function signTx(args: SignTxArgs): Promise<SignTxReturn>;
 export {};

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

@@ -1,5 +1,15 @@
 import { Cleaner } from 'cleaners';
 import { EdgeTokenId, InsufficientFundsError } from 'edge-core-js/types';
+/**
+ * How to encode the header byte of a signed message.
+ *  - `electrum`: the legacy format, whose header carries only the recovery id
+ *    and key compression. Every verifier understands it, but it says nothing
+ *    about the script type.
+ *  - `bip137`: additionally encodes the signing address' script type, which
+ *    verifiers such as Bringin require for SegWit addresses.
+ */
+export declare const asUtxoSignatureFormat: Cleaner<"electrum" | "bip137">;
+export declare type UtxoSignatureFormat = ReturnType<typeof asUtxoSignatureFormat>;
 interface InsufficientFundsErrorOptsPlus {
     tokenId: EdgeTokenId;
     networkFee?: string;
@@ -9,5 +19,14 @@ export declare class InsufficientFundsErrorPlus extends InsufficientFundsError {
     networkFeeShortage?: string;
     constructor(opts: InsufficientFundsErrorOptsPlus);
 }
+/**
+ * The wallet cannot sign for the requested address: either it does not derive
+ * it, or the string is not an address of this chain at all. Callers get a
+ * stable `name` to branch on instead of matching against the message prose.
+ */
+export declare class AddressNotOwnedError extends Error {
+    constructor();
+}
+export declare const asMaybeAddressNotOwnedError: Cleaner<AddressNotOwnedError | undefined>;
 export declare const asMaybeInsufficientFundsErrorPlus: Cleaner<InsufficientFundsErrorPlus | undefined>;
 export {};

package/lib/test/common/utxobased/keymanager/coins/altcointestfixtures.d.ts

@@ -1,4 +1,6 @@
+import { CurrencyFormat } from '../../../../../src/common/plugin/types';
 import { AddressTypeEnum, BIP43PurposeTypeEnum, ScriptTypeEnum } from '../../../../../src/common/utxobased/keymanager/keymanager';
+import { UtxoSignatureFormat } from '../../../../../src/common/utxobased/keymanager/types';
 interface SeedToXPrivTests {
     xpriv: string;
     type: BIP43PurposeTypeEnum;
@@ -34,6 +36,9 @@ interface XPubToPubkeyTests {
 interface SignMessageTests {
     wif: string;
     message: string;
+    format: CurrencyFormat;
+    /** Omitted to exercise the default, which must stay `electrum`. */
+    signatureFormat?: UtxoSignatureFormat;
     signature: string;
 }
 interface Coin {

package/lib/test/common/utxobased/keymanager/messagePrefix.spec.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "edge-currency-plugins",
-  "version": "3.11.0",
+  "version": "3.12.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",