@ledgerhq/hw-app-btc 10.2.1 → 10.2.2-next.0

package/src/createTransaction.ts

@@ -173,7 +173,8 @@ export async function createTransaction(
 
     if (expiryHeight && !isDecred) {
       targetTransaction.nVersionGroupId = Buffer.from(
-        // nVersionGroupId is 0x26A7270A for zcash from https://z.cash/upgrade/nu5/
+        // nVersionGroupId is 0x26A7270A for zcash NU5 upgrade
+        // refer to https://github.com/zcash/zcash/blob/master/src/primitives/transaction.h
         isZcash
           ? [0x0a, 0x27, 0xa7, 0x26]
           : sapling

package/src/getWalletPublicKey.ts

@@ -2,7 +2,7 @@ import type Transport from "@ledgerhq/hw-transport";
 import { bip32asBuffer } from "./bip32";
 
 /**
- * address format is one of legacy | p2sh | bech32 | cashaddr
+ * address format is one of legacy | p2sh | bech32 | bech32m | cashaddr
  */
 export type AddressFormat = "legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr";
 const addressFormatMap = {

package/src/types.ts

@@ -17,14 +17,26 @@ export interface TransactionOutput {
 /**
  */
 export interface Transaction {
+  // Each transaction is prefixed by a four-byte transaction version number
+  // which tells Bitcoin peers and miners which set of rules to use to validate it.
   version: Buffer;
   inputs: TransactionInput[];
   outputs?: TransactionOutput[];
+  // locktime indicates the earliest time or earliest block when that transaction may
+  // be added to the block chain.
   locktime?: Buffer;
   witness?: Buffer;
+  // timestamp is used only for peercoin but it is no longer necessary anymore
   timestamp?: Buffer;
+  // nVersionGroupId is used only for Zcash, different version of Zcash has different nVersionGroupId
+  // refer to https://github.com/zcash/zcash/blob/master/src/primitives/transaction.h for more details
   nVersionGroupId?: Buffer;
+  // nExpiryHeight is used only for Decred and Zcash and ZenCash.
+  // It sets the block height after which transactions will be removed
+  // from the mempool if they have not been mined
+  // refer to https://zips.z.cash/zip-0203 for more details
   nExpiryHeight?: Buffer;
+  // extraData is used only for Zcash and ZenCash and komodo
   extraData?: Buffer;
 }