[Cashtab] [xecjs-message upgrade p1/3] Deprecate segwit support from xecjs-message

Summary:
T2784

Remove segwit support from the xecjs-message library. Test the async signing function in Cashtab to verify that segwit removal did not break any modified functions.

Publish this version to npm as a tagged dev release so that unit tests in Cashtab are not broken by local dependency.

Test Plan:
npm start
Sign a message
Confirm dev log displays 'Both methods not broken'
Verify a message
Confirm verification

Reviewers: #bitcoin_abc, emack

Reviewed By: #bitcoin_abc, emack

Differential Revision: https://reviews.bitcoinabc.org/D12645

Author: BytesOfMan

web/cashtab/package-lock.json

@@ -92,7 +92,7 @@
         "webpack-manifest-plugin": "^4.0.2",
         "wif": "^2.0.6",
         "workbox-webpack-plugin": "^6.4.1",
-        "xecjs-message": "^1.0.5"
+        "xecjs-message": "^1.0.5-b"
     },
     "scripts": {
         "start": "node scripts/start.js",

web/cashtab/package.json

@@ -98,7 +98,7 @@ const SignVerifyMsg = () => {
         useState(false);
     const [messageVerificationSigError, setMessageVerificationSigError] =
         useState(false);
-    const signMessageByPk = () => {
+    const signMessageByPk = async () => {
         try {
             // First, get required params
             const keyPair = getECPairFromWIF(wallet.Path1899.fundingWif);
@@ -109,6 +109,22 @@ const SignVerifyMsg = () => {
                 .sign(msgToSign, privKey, keyPair.compressed)
                 .toString('base64');
 
+            // Also test the async function
+            let asyncSignature = await (
+                await xecMessage.signAsync(
+                    msgToSign,
+                    privKey,
+                    keyPair.compressed,
+                )
+            ).toString('base64');
+
+            console.log(`sync sig`, messageSignature);
+            console.log(`asyncSignature`, asyncSignature);
+
+            if (messageSignature === asyncSignature) {
+                console.log(`Both methods not broken`);
+            }
+
             setMessageSignature(messageSignature);
             messageSignedNotification(messageSignature);
         } catch (err) {

web/cashtab/src/components/SignVerifyMsg/SignVerifyMsg.js

@@ -33,3 +33,9 @@
 **removed**
 
 -   No changes. This is the first version published from the BitcoinABC monorepo.
+
+# 1.0.6
+
+**removed**
+
+-   All segwit support

web/xecjs-message/CHANGELOG.md

@@ -4,11 +4,6 @@ const secp256k1 = require('secp256k1');
 const varuint = require('varuint-bitcoin');
 const ecashaddr = require('ecashaddrjs');
 
-const SEGWIT_TYPES = {
-    P2WPKH: 'p2wpkh',
-    P2SH_P2WPKH: 'p2sh(p2wpkh)',
-};
-
 function sha256(b) {
     return createHash('sha256').update(b).digest();
 }
@@ -19,13 +14,9 @@ function hash160(buffer) {
     return createHash('ripemd160').update(sha256(buffer)).digest();
 }
 
-function encodeSignature(signature, recovery, compressed, segwitType) {
-    if (segwitType !== undefined) {
-        recovery += 8;
-        if (segwitType === SEGWIT_TYPES.P2WPKH) recovery += 4;
-    } else {
-        if (compressed) recovery += 4;
-    }
+function encodeSignature(signature, recovery, compressed) {
+    if (compressed) recovery += 4;
+
     return Buffer.concat([Buffer.alloc(1, recovery + 27), signature]);
 }
 
@@ -39,11 +30,6 @@ function decodeSignature(buffer) {
 
     return {
         compressed: !!(flagByte & 12),
-        segwitType: !(flagByte & 8)
-            ? null
-            : !(flagByte & 4)
-            ? SEGWIT_TYPES.P2SH_P2WPKH
-            : SEGWIT_TYPES.P2WPKH,
         recovery: flagByte & 3,
         signature: buffer.slice(1),
     };
@@ -72,30 +58,10 @@ function prepareSign(messagePrefixArg, sigOptions) {
         sigOptions = messagePrefixArg;
         messagePrefixArg = undefined;
     }
-    let { segwitType, extraEntropy } = sigOptions || {};
-    if (
-        segwitType &&
-        (typeof segwitType === 'string' || segwitType instanceof String)
-    ) {
-        segwitType = segwitType.toLowerCase();
-    }
-    if (
-        segwitType &&
-        segwitType !== SEGWIT_TYPES.P2SH_P2WPKH &&
-        segwitType !== SEGWIT_TYPES.P2WPKH
-    ) {
-        throw new Error(
-            'Unrecognized segwitType: use "' +
-                SEGWIT_TYPES.P2SH_P2WPKH +
-                '" or "' +
-                SEGWIT_TYPES.P2WPKH +
-                '"',
-        );
-    }
+    let { extraEntropy } = sigOptions || {};
 
     return {
         messagePrefixArg,
-        segwitType,
         extraEntropy,
     };
 }
@@ -105,27 +71,22 @@ function isSigner(obj) {
 }
 
 function sign(message, privateKey, compressed, messagePrefix, sigOptions) {
-    const { messagePrefixArg, segwitType, extraEntropy } = prepareSign(
+    const { messagePrefixArg, extraEntropy } = prepareSign(
         messagePrefix,
         sigOptions,
     );
     const hash = magicHash(message, messagePrefixArg);
     const sigObj = isSigner(privateKey)
         ? privateKey.sign(hash, extraEntropy)
         : secp256k1.sign(hash, privateKey, { data: extraEntropy });
-    return encodeSignature(
-        sigObj.signature,
-        sigObj.recovery,
-        compressed,
-        segwitType,
-    );
+    return encodeSignature(sigObj.signature, sigObj.recovery, compressed);
 }
 
 function signAsync(message, privateKey, compressed, messagePrefix, sigOptions) {
-    let messagePrefixArg, segwitType, extraEntropy;
+    let messagePrefixArg, extraEntropy;
     return Promise.resolve()
         .then(() => {
-            ({ messagePrefixArg, segwitType, extraEntropy } = prepareSign(
+            ({ messagePrefixArg, extraEntropy } = prepareSign(
                 messagePrefix,
                 sigOptions,
             ));
@@ -139,7 +100,6 @@ function signAsync(message, privateKey, compressed, messagePrefix, sigOptions) {
                 sigObj.signature,
                 sigObj.recovery,
                 compressed,
-                segwitType,
             );
         });
 }

web/xecjs-message/index.js

@@ -1,6 +1,6 @@
 {
     "name": "xecjs-message",
-    "version": "1.0.5",
+    "version": "1.0.5b",
     "description": "xecjs-message",
     "keywords": [
         "xecjs-message",