Bugfix/LIVE-2373 zec parser and serialization for v5 transaction (#836)

* fix zec version 5 transaction hex parse

* remove unnecessary code

* fix app dependencies

* zec fix

* fix test

* fix test

* small refactoring

* revert pnpm-lock.yaml

* add for script in APDU for zcash

* update changeset

* Fix typo on Decred Test app name

* Enforce minimum ZCash nano app version > 2.0.6

Co-authored-by: haammar-ledger <[email protected]>

.changeset/few-clouds-brush.md

@@ -0,0 +1,6 @@
+---
+"@ledgerhq/live-common": minor
+"@ledgerhq/hw-app-btc": minor
+---
+
+Support zcash v5 format transaction

libs/ledger-live-common/src/apps/__snapshots__/logic.test.ts.snap

@@ -368,38 +368,45 @@ Object {
       "name": "Dogecoin",
     },
     Object {
-      "blocks": 1,
-      "bytes": 4096,
+      "blocks": 10,
+      "bytes": 40960,
       "currencyId": "zcash",
       "name": "Zcash",
     },
   ],
   "appsSpaceBlocks": 60,
   "appsSpaceBytes": 245760,
-  "freeSpaceBlocks": 27,
-  "freeSpaceBytes": 110592,
+  "freeSpaceBlocks": 18,
+  "freeSpaceBytes": 73728,
   "osBlocks": 20,
   "osBytes": 81920,
   "shouldWarnMemory": false,
-  "totalAppsBlocks": 33,
-  "totalAppsBytes": 135168,
+  "totalAppsBlocks": 42,
+  "totalAppsBytes": 172032,
   "totalBlocks": 80,
   "totalBytes": 327680,
 }
 `;
 
 exports[`Scenario: order is preserved in uninstall action plan 1`] = `
 Object {
-  "apps": Array [],
+  "apps": Array [
+    Object {
+      "blocks": 1,
+      "bytes": 4096,
+      "currencyId": "zcash",
+      "name": "Zcash",
+    },
+  ],
   "appsSpaceBlocks": 60,
   "appsSpaceBytes": 245760,
-  "freeSpaceBlocks": 60,
-  "freeSpaceBytes": 245760,
+  "freeSpaceBlocks": 59,
+  "freeSpaceBytes": 241664,
   "osBlocks": 20,
   "osBytes": 81920,
   "shouldWarnMemory": false,
-  "totalAppsBlocks": 0,
-  "totalAppsBytes": 0,
+  "totalAppsBlocks": 1,
+  "totalAppsBytes": 4096,
   "totalBlocks": 80,
   "totalBytes": 327680,
 }

libs/ledger-live-common/src/apps/logic.test.ts

@@ -313,8 +313,7 @@ const scenarios = [
             name: "Bitcoin",
           },
         ],
-        expectPlan:
-          "-XRP, -Ethereum Classic, -Ethereum, -Dogecoin, -Zcash, -Bitcoin",
+        expectPlan: "-XRP, -Ethereum Classic, -Ethereum, -Dogecoin, -Bitcoin",
         expectInstalled: "",
       },
     ],

libs/ledger-live-common/src/apps/polyfill.ts

@@ -7,7 +7,14 @@ import {
 import { App, Application } from "@ledgerhq/types-live";
 const directDep = {};
 const reverseDep = {};
+
+// whitelist dependencies
+export const whitelistDependencies = ["Decred", "Decred Test", "Zcash"];
+
 export function declareDep(name: string, dep: string) {
+  if (whitelistDependencies.includes(name)) {
+    return;
+  }
   directDep[name] = (directDep[name] || []).concat(dep);
   reverseDep[dep] = (reverseDep[dep] || []).concat(name);
 }
@@ -25,8 +32,6 @@ listCryptoCurrencies(true, true).forEach((a) => {
     declareDep(a.managerAppName + " Test", dep.managerAppName);
   }
 });
-// whitelist dependencies
-export const whitelistDependencies = ["Decred", "Decred Testnet"];
 
 // extra dependencies
 [

libs/ledger-live-common/src/apps/support.ts

@@ -37,6 +37,7 @@ const appVersionsRequired = {
   Solana: ">= 1.2.0",
   Celo: ">= 1.1.8",
   "Cardano ADA": ">= 4.1.0",
+  Zcash: "> 2.0.6",
 };
 export function mustUpgrade(
   deviceModel: DeviceModelId,

libs/ledgerjs/packages/hw-app-btc/src/createTransaction.ts

@@ -113,6 +113,7 @@ export async function createTransaction(
   };
 
   const isDecred = additionals.includes("decred");
+  const isZcash = additionals.includes("zcash");
   const isXST = additionals.includes("stealthcoin");
   const startTime = Date.now();
   const sapling = additionals.includes("sapling");
@@ -126,11 +127,16 @@ export async function createTransaction(
     (!!expiryHeight && !isDecred);
   // Inputs are provided as arrays of [transaction, output_index, optional redeem script, optional sequence]
   // associatedKeysets are provided as arrays of [path]
+  const lockTimeBuffer = Buffer.alloc(4);
+  lockTimeBuffer.writeUInt32LE(lockTime, 0);
   const nullScript = Buffer.alloc(0);
   const nullPrevout = Buffer.alloc(0);
   const defaultVersion = Buffer.alloc(4);
   !!expiryHeight && !isDecred
-    ? defaultVersion.writeUInt32LE(sapling ? 0x80000004 : 0x80000003, 0)
+    ? defaultVersion.writeUInt32LE(
+        isZcash ? 0x80000005 : sapling ? 0x80000004 : 0x80000003,
+        0
+      ) // v5 format for zcash refer to https://zips.z.cash/zip-0225
     : isXST
     ? defaultVersion.writeUInt32LE(2, 0)
     : defaultVersion.writeUInt32LE(1, 0);
@@ -152,7 +158,6 @@ export async function createTransaction(
       : getTrustedInput;
   const outputScript = Buffer.from(outputScriptHex, "hex");
   notify(0, 0);
-
   // first pass on inputs to get trusted inputs
   for (const input of inputs) {
     if (!resuming) {
@@ -186,7 +191,12 @@ export async function createTransaction(
 
     if (expiryHeight && !isDecred) {
       targetTransaction.nVersionGroupId = Buffer.from(
-        sapling ? [0x85, 0x20, 0x2f, 0x89] : [0x70, 0x82, 0xc4, 0x03]
+        // nVersionGroupId is 0x26A7270A for zcash from https://z.cash/upgrade/nu5/
+        isZcash
+          ? [0x0a, 0x27, 0xa7, 0x26]
+          : sapling
+          ? [0x85, 0x20, 0x2f, 0x89]
+          : [0x70, 0x82, 0xc4, 0x03]
       );
       targetTransaction.nExpiryHeight = expiryHeight;
       // For sapling : valueBalance (8), nShieldedSpend (1), nShieldedOutput (1), nJoinSplit (1)
@@ -201,7 +211,7 @@ export async function createTransaction(
     }
   }
 
-  targetTransaction.inputs = inputs.map((input) => {
+  targetTransaction.inputs = inputs.map((input, idx) => {
     const sequence = Buffer.alloc(4);
     sequence.writeUInt32LE(
       input.length >= 4 && typeof input[3] === "number"
@@ -210,7 +220,7 @@ export async function createTransaction(
       0
     );
     return {
-      script: nullScript,
+      script: isZcash ? regularOutputs[idx].script : nullScript,
       prevout: nullPrevout,
       sequence,
     };
@@ -366,9 +376,7 @@ export async function createTransaction(
       offset + 0x24
     );
   }
-
-  const lockTimeBuffer = Buffer.alloc(4);
-  lockTimeBuffer.writeUInt32LE(lockTime, 0);
+  targetTransaction.locktime = lockTimeBuffer;
   let result = Buffer.concat([
     serializeTransaction(
       targetTransaction,
@@ -396,20 +404,17 @@ export async function createTransaction(
     result = Buffer.concat([result, witness]);
   }
 
-  // FIXME: In ZEC or KMD sapling lockTime is serialized before expiryHeight.
-  // expiryHeight is used only in overwinter/sapling so I moved lockTimeBuffer here
-  // and it should not break other coins because expiryHeight is false for them.
-  // Don't know about Decred though.
-  result = Buffer.concat([result, lockTimeBuffer]);
-
-  if (expiryHeight) {
-    result = Buffer.concat([
-      result,
-      targetTransaction.nExpiryHeight || Buffer.alloc(0),
-      targetTransaction.extraData || Buffer.alloc(0),
-    ]);
+  // from to https://zips.z.cash/zip-0225, zcash is different with other coins, the lock_time and nExpiryHeight fields are before the inputs and outputs
+  if (!isZcash) {
+    result = Buffer.concat([result, lockTimeBuffer]);
+    if (expiryHeight) {
+      result = Buffer.concat([
+        result,
+        targetTransaction.nExpiryHeight || Buffer.alloc(0),
+        targetTransaction.extraData || Buffer.alloc(0),
+      ]);
+    }
   }
-
   if (isDecred) {
     let decredWitness = Buffer.from([targetTransaction.inputs.length]);
     inputs.forEach((input, inputIndex) => {
@@ -424,6 +429,8 @@ export async function createTransaction(
     });
     result = Buffer.concat([result, decredWitness]);
   }
-
+  if (isZcash) {
+    result = Buffer.concat([result, Buffer.from([0x00, 0x00, 0x00])]);
+  }
   return result.toString("hex");
 }

libs/ledgerjs/packages/hw-app-btc/src/serializeTransaction.ts

@@ -30,6 +30,7 @@ export function serializeTransaction(
   additionals: string[] = []
 ) {
   const isDecred = additionals.includes("decred");
+  const isZcash = additionals.includes("zcash");
   const isBech32 = additionals.includes("bech32");
   let inputBuffer = Buffer.alloc(0);
   const useWitness =
@@ -65,7 +66,20 @@ export function serializeTransaction(
       transaction.extraData || Buffer.alloc(0),
     ]);
   }
-
+  // from to https://zips.z.cash/zip-0225, zcash is different with other coins, the lock_time and nExpiryHeight fields are before the inputs and outputs
+  if (isZcash) {
+    return Buffer.concat([
+      transaction.version,
+      transaction.nVersionGroupId || Buffer.alloc(0),
+      Buffer.from([0xb4, 0xd0, 0xd6, 0xc2]), // Zcash Consensus Branch ID: 0xC2D6D0B4 refer to https://z.cash/upgrade/nu5/
+      transaction.locktime || Buffer.from([0x00, 0x00, 0x00, 0x00]),
+      transaction.nExpiryHeight || Buffer.from([0x00, 0x00, 0x00, 0x00]),
+      useWitness ? Buffer.from("0001", "hex") : Buffer.alloc(0),
+      createVarint(transaction.inputs.length),
+      inputBuffer,
+      outputBuffer,
+    ]);
+  }
   return Buffer.concat([
     transaction.version,
     timestamp ? timestamp : Buffer.alloc(0),

libs/ledgerjs/packages/hw-app-btc/src/splitTransaction.ts

@@ -17,13 +17,18 @@ export function splitTransaction(
   let nExpiryHeight = Buffer.alloc(0);
   let nVersionGroupId = Buffer.alloc(0);
   let extraData = Buffer.alloc(0);
+  let witnessScript, locktime;
   const isDecred = additionals.includes("decred");
   const isZencash = additionals.includes("zencash");
+  const isZcash = additionals.includes("zcash");
   const transaction = Buffer.from(transactionHex, "hex");
   const version = transaction.slice(offset, offset + 4);
   const overwinter =
     version.equals(Buffer.from([0x03, 0x00, 0x00, 0x80])) ||
-    version.equals(Buffer.from([0x04, 0x00, 0x00, 0x80]));
+    version.equals(Buffer.from([0x04, 0x00, 0x00, 0x80])) ||
+    version.equals(Buffer.from([0x05, 0x00, 0x00, 0x80]));
+  const isZcashv5 =
+    isZcash && version.equals(Buffer.from([0x05, 0x00, 0x00, 0x80]));
   offset += 4;
   if (
     !hasTimestamp &&
@@ -45,7 +50,11 @@ export function splitTransaction(
     nVersionGroupId = transaction.slice(offset, 4 + offset);
     offset += 4;
   }
-
+  if (isZcashv5) {
+    locktime = transaction.slice(offset + 4, offset + 8);
+    nExpiryHeight = transaction.slice(offset + 8, offset + 12);
+    offset += 12;
+  }
   let varint = getVarint(transaction, offset);
   const numberInputs = varint[0];
   offset += varint[1];
@@ -77,11 +86,9 @@ export function splitTransaction(
       tree,
     });
   }
-
   varint = getVarint(transaction, offset);
   const numberOutputs = varint[0];
   offset += varint[1];
-
   for (let i = 0; i < numberOutputs; i++) {
     const amount = transaction.slice(offset, offset + 8);
     offset += 8;
@@ -101,18 +108,16 @@ export function splitTransaction(
     });
   }
 
-  let witnessScript, locktime;
-
   if (witness) {
     witnessScript = transaction.slice(offset, -4);
     locktime = transaction.slice(transaction.length - 4);
-  } else {
+  } else if (!isZcashv5) {
     locktime = transaction.slice(offset, offset + 4);
   }
 
   offset += 4;
 
-  if (overwinter || isDecred) {
+  if ((overwinter || isDecred) && !isZcashv5) {
     nExpiryHeight = transaction.slice(offset, offset + 4);
     offset += 4;
   }