edge-currency-plugins 3.14.0 → 3.15.0

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

@@ -45,9 +45,9 @@ var _types5 = require('../keymanager/types');
  const asUtxoSignMessageOtherParams = _cleaners.asObject.call(void 0, {
   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.
+  // format they already produce. BIP-137 and BIP-322 are opt-in, since
+  // emitting either to a verifier expecting the legacy encoding is just as
+  // broken as the reverse.
   signatureFormat: _cleaners.asMaybe.call(void 0, _types5.asUtxoSignatureFormat, 'electrum')
 }); exports.asUtxoSignMessageOtherParams = asUtxoSignMessageOtherParams
 

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

@@ -8,6 +8,7 @@
 
 
 var _altcoinjs = require('altcoin-js');
+var _psbtutils = require('altcoin-js/src/psbt/psbtutils');
 var _biggystring = require('biggystring');
 var _bip32 = require('bip32'); var bip32 = _interopRequireWildcard(_bip32);
 var _bip39 = require('bip39'); var bip39 = _interopRequireWildcard(_bip39);
@@ -967,6 +968,75 @@ function getBip137SegwitType(
   }
 }
 
+/**
+ * The BIP-322 message hash: a BIP-340 style tagged hash of the raw message
+ * bytes. Unlike the legacy format there is no coin-specific prefix.
+ */
+ function bip322MessageHash(message) {
+  const tagHash = _altcoinjs.crypto.sha256(Buffer.from('BIP0322-signed-message', 'utf8'))
+  return _altcoinjs.crypto.sha256(
+    Buffer.concat([tagHash, tagHash, Buffer.from(message, 'utf8')])
+  )
+} exports.bip322MessageHash = bip322MessageHash;
+
+/**
+ * Signs `message` per BIP-322 and returns the witness stack that spends the
+ * virtual `to_spend` output locked to the key's address. Native SegWit
+ * (bip84) and nested SegWit (bip49) both spend through a P2WPKH witness; a
+ * nested address' redeem script is implied by the key, so verifiers rebuild
+ * the scriptSig from the witness. Returns `undefined` for legacy formats,
+ * which have no witness.
+ */
+function signBip322Witness(
+  message,
+  keyPair,
+  format
+) {
+  if (format !== 'bip84' && format !== 'bip49') return undefined
+
+  const p2wpkh = _altcoinjs.payments.p2wpkh({ pubkey: keyPair.publicKey })
+  const scriptPubkey =
+    format === 'bip84'
+      ? p2wpkh.output
+      : _altcoinjs.payments.p2sh({ redeem: p2wpkh }).output
+  // BIP-143 signs a P2WPKH input against the P2PKH script of its key hash.
+  const scriptCode = _altcoinjs.payments.p2pkh({ hash: p2wpkh.hash }).output
+  if (scriptPubkey == null || scriptCode == null) {
+    throw new Error('Address could not sign message')
+  }
+
+  const toSpend = new (0, _altcoinjs.Transaction)()
+  toSpend.version = 0
+  toSpend.locktime = 0
+  toSpend.addInput(
+    Buffer.alloc(32),
+    0xffffffff,
+    0,
+    _altcoinjs.script.compile([_altcoinjs.opcodes.OP_0, bip322MessageHash(message)])
+  )
+  toSpend.addOutput(scriptPubkey, 0)
+
+  const toSign = new (0, _altcoinjs.Transaction)()
+  toSign.version = 0
+  toSign.locktime = 0
+  toSign.addInput(toSpend.getHash(), 0, 0)
+  toSign.addOutput(_altcoinjs.script.compile([_altcoinjs.opcodes.OP_RETURN]), 0)
+
+  const sighash = toSign.hashForWitnessV0(
+    0,
+    scriptCode,
+    0,
+    _altcoinjs.Transaction.SIGHASH_ALL
+  )
+  // Low-R grinding matches Bitcoin Core, so the output is byte-identical to
+  // the signatures its `signmessage` and the BIP-322 test vectors produce.
+  const signature = _altcoinjs.script.signature.encode(
+    keyPair.sign(sighash, true),
+    _altcoinjs.Transaction.SIGHASH_ALL
+  )
+  return [signature, keyPair.publicKey]
+}
+
  function signMessageBase64(
   message,
   privateKey,
@@ -979,6 +1049,14 @@ function getBip137SegwitType(
   if (keyPair.privateKey == null) {
     throw new Error('Address could not sign message')
   }
+  if (signatureFormat === 'bip322') {
+    const witness = signBip322Witness(message, keyPair, format)
+    // Legacy P2PKH addresses have no witness to sign with. BIP-322 has them
+    // fall back to the legacy message format, which the Electrum encoding
+    // below produces.
+    if (witness != null)
+      return _psbtutils.witnessStackToScriptWitness.call(void 0, witness).toString('base64')
+  }
   // 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

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

@@ -8,8 +8,12 @@ var _types = require('edge-core-js/types');
  *    about the script type.
  *  - `bip137`: additionally encodes the signing address' script type, which
  *    verifiers such as Bringin require for SegWit addresses.
+ *  - `bip322`: a BIP-322 "simple" signature (the consensus-encoded witness
+ *    of a virtual transaction spending from the address) for SegWit
+ *    addresses. Legacy P2PKH addresses have no simple form, so BIP-322 has
+ *    them sign in the legacy format, which is the `electrum` encoding.
  */
- const asUtxoSignatureFormat = _cleaners.asValue.call(void 0, 'electrum', 'bip137'); exports.asUtxoSignatureFormat = asUtxoSignatureFormat
+ const asUtxoSignatureFormat = _cleaners.asValue.call(void 0, 'electrum', 'bip137', 'bip322'); exports.asUtxoSignatureFormat = asUtxoSignatureFormat
 
 
 

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

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

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

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import { EdgeLog, EdgeMemo } from 'edge-core-js/types';
 import { ChangePath, CurrencyFormat, FeeInfo } from '../../plugin/types';
 import { UtxoData } from '../db/types';
@@ -203,6 +204,11 @@ 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;
+/**
+ * The BIP-322 message hash: a BIP-340 style tagged hash of the raw message
+ * bytes. Unlike the legacy format there is no coin-specific prefix.
+ */
+export declare function bip322MessageHash(message: string): Buffer;
 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>;

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

@@ -7,8 +7,12 @@ import { EdgeTokenId, InsufficientFundsError } from 'edge-core-js/types';
  *    about the script type.
  *  - `bip137`: additionally encodes the signing address' script type, which
  *    verifiers such as Bringin require for SegWit addresses.
+ *  - `bip322`: a BIP-322 "simple" signature (the consensus-encoded witness
+ *    of a virtual transaction spending from the address) for SegWit
+ *    addresses. Legacy P2PKH addresses have no simple form, so BIP-322 has
+ *    them sign in the legacy format, which is the `electrum` encoding.
  */
-export declare const asUtxoSignatureFormat: Cleaner<"electrum" | "bip137">;
+export declare const asUtxoSignatureFormat: Cleaner<"electrum" | "bip137" | "bip322">;
 export declare type UtxoSignatureFormat = ReturnType<typeof asUtxoSignatureFormat>;
 interface InsufficientFundsErrorOptsPlus {
     tokenId: EdgeTokenId;

package/package.json

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