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

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ledgerhq/hw-app-btc
 
+## 10.2.2-new-wc.0
+
+### Patch Changes
+
+- [#6105](https://github.com/LedgerHQ/ledger-live/pull/6105) [`6d40673`](https://github.com/LedgerHQ/ledger-live/commit/6d4067382b55827b00806a1b71ac0b249563d90f) Thanks [@hzheng-ledger](https://github.com/hzheng-ledger)! - update hw-app-btc doc
+
+- Updated dependencies []:
+  - @ledgerhq/hw-transport@6.30.4-new-wc.0
+
 ## 10.2.1
 
 ### Patch Changes

package/README.md

@@ -27,6 +27,7 @@ For a smooth and quick integration:
 
 #### Table of Contents
 
+*   [bippath](#bippath)
 *   [Btc](#btc)
     *   [Parameters](#parameters)
     *   [Examples](#examples)
@@ -50,80 +51,90 @@ For a smooth and quick integration:
     *   [serializeTransactionOutputs](#serializetransactionoutputs)
         *   [Parameters](#parameters-7)
         *   [Examples](#examples-6)
+    *   [getTrustedInput](#gettrustedinput)
+        *   [Parameters](#parameters-8)
+    *   [getTrustedInputBIP143](#gettrustedinputbip143)
+        *   [Parameters](#parameters-9)
 *   [BtcNew](#btcnew)
-    *   [Parameters](#parameters-8)
     *   [getWalletXpub](#getwalletxpub-1)
-        *   [Parameters](#parameters-9)
-    *   [getWalletPublicKey](#getwalletpublickey-1)
         *   [Parameters](#parameters-10)
-    *   [createPaymentTransaction](#createpaymenttransaction-1)
+    *   [getWalletPublicKey](#getwalletpublickey-1)
         *   [Parameters](#parameters-11)
-    *   [signMessage](#signmessage-1)
+    *   [createPaymentTransaction](#createpaymenttransaction-1)
         *   [Parameters](#parameters-12)
+    *   [signMessage](#signmessage-1)
+        *   [Parameters](#parameters-13)
+*   [descrTemplFrom](#descrtemplfrom)
+    *   [Parameters](#parameters-14)
 *   [BtcOld](#btcold)
-    *   [Parameters](#parameters-13)
-    *   [Examples](#examples-7)
     *   [getWalletPublicKey](#getwalletpublickey-2)
-        *   [Parameters](#parameters-14)
-        *   [Examples](#examples-8)
-    *   [createPaymentTransaction](#createpaymenttransaction-2)
         *   [Parameters](#parameters-15)
-        *   [Examples](#examples-9)
+        *   [Examples](#examples-7)
+    *   [createPaymentTransaction](#createpaymenttransaction-2)
+        *   [Parameters](#parameters-16)
+        *   [Examples](#examples-8)
 *   [CreateTransactionArg](#createtransactionarg)
     *   [Properties](#properties)
 *   [AddressFormat](#addressformat)
 *   [AccountType](#accounttype)
     *   [spendingCondition](#spendingcondition)
-        *   [Parameters](#parameters-16)
-    *   [setInput](#setinput)
         *   [Parameters](#parameters-17)
-    *   [setOwnOutput](#setownoutput)
+    *   [setInput](#setinput)
         *   [Parameters](#parameters-18)
+    *   [setOwnOutput](#setownoutput)
+        *   [Parameters](#parameters-19)
     *   [getDescriptorTemplate](#getdescriptortemplate)
 *   [SingleKeyAccount](#singlekeyaccount)
 *   [getTaprootOutputKey](#gettaprootoutputkey)
-    *   [Parameters](#parameters-19)
-*   [AppClient](#appclient)
     *   [Parameters](#parameters-20)
-*   [ClientCommandInterpreter](#clientcommandinterpreter)
+*   [AppClient](#appclient)
     *   [Parameters](#parameters-21)
-*   [MerkelizedPsbt](#merkelizedpsbt)
+*   [ClientCommandInterpreter](#clientcommandinterpreter)
     *   [Parameters](#parameters-22)
-*   [Merkle](#merkle)
+*   [MerkelizedPsbt](#merkelizedpsbt)
     *   [Parameters](#parameters-23)
-*   [MerkleMap](#merklemap)
+*   [Merkle](#merkle)
     *   [Parameters](#parameters-24)
-*   [WalletPolicy](#walletpolicy)
+*   [MerkleMap](#merklemap)
     *   [Parameters](#parameters-25)
-*   [extract](#extract)
+*   [WalletPolicy](#walletpolicy)
     *   [Parameters](#parameters-26)
-*   [finalize](#finalize)
+*   [extract](#extract)
     *   [Parameters](#parameters-27)
-*   [clearFinalizedInput](#clearfinalizedinput)
+*   [finalize](#finalize)
     *   [Parameters](#parameters-28)
-*   [writePush](#writepush)
+*   [clearFinalizedInput](#clearfinalizedinput)
     *   [Parameters](#parameters-29)
+*   [writePush](#writepush)
+    *   [Parameters](#parameters-30)
 *   [PsbtV2](#psbtv2)
 *   [serializeTransactionOutputs](#serializetransactionoutputs-1)
-    *   [Parameters](#parameters-30)
-    *   [Examples](#examples-10)
+    *   [Parameters](#parameters-31)
+    *   [Examples](#examples-9)
 *   [SignP2SHTransactionArg](#signp2shtransactionarg)
     *   [Properties](#properties-1)
 *   [TransactionInput](#transactioninput)
 *   [TransactionOutput](#transactionoutput)
 *   [Transaction](#transaction)
 
+### bippath
+
+BIP32 Path Handling for Bitcoin Wallets
+
+This file provides utility functions to handle BIP32 paths,
+which are commonly used in hierarchical deterministic (HD) wallets.
+It includes functions to convert BIP32 paths to and from different formats,
+extract components from extended public keys (xpubs), and manipulate path elements.
+
 ### Btc
 
 Bitcoin API.
 
 #### Parameters
 
-*   `$0` **{transport: Transport, scrambleKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, currency: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?}** 
-
-    *   `$0.transport`  
-    *   `$0.scrambleKey`   (optional, default `"BTC"`)
-    *   `$0.currency`   (optional, default `"bitcoin"`)
+*   `transport`  The transport layer used for communication.
+*   `scrambleKey`  This parameter is deprecated and no longer needed.
+*   `currency`  The currency to use, defaults to "bitcoin".
 
 #### Examples
 
@@ -138,8 +149,10 @@ Get an XPUB with a ledger device
 
 ##### Parameters
 
-*   `arg` **{path: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), xpubVersion: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)}** derivation parameter*   path: a BIP 32 path of the account level. e.g. `84'/0'/0'`
-    *   xpubVersion: the XPUBVersion of the coin used. (use @ledgerhq/currencies if needed)
+*   `arg` **{path: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), xpubVersion: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)}** derivation parameter*   path: a BIP 32 path of the account level. (e.g. The derivation path `84'/0'/0'`
+        follows the `purpose' / coin_type' / account'` standard, with purpose=84, coin\_type=0, account=0)
+    *   xpubVersion: the XPUBVersion of the coin used. (refer to ledgerjs/packages/cryptoassets/src/currencies.ts
+        for the XPUBVersion value if needed)
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** XPUB of the account
 
@@ -147,9 +160,9 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ##### Parameters
 
-*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a BIP 32 path
+*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a BIP 32 path (i.e. the `purpose’ / coin_type’ / account’ / change / address_index` standard)
 *   `opts` **{verify: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, format: [AddressFormat](#addressformat)?}?**&#x20;
-*   `options`  an object with optional these fields:*   verify (boolean) will ask user to confirm the address on the device
+*   `options`  an object with optional these fields:*   verify (boolean) whether ask user to confirm the address on the device
 
     *   format ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr") to use different bitcoin address formatter.NB The normal usage is to use:*   legacy format with 44' paths
 
@@ -157,6 +170,8 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
     *   bech32 format with 84' paths
 
+    *   bech32m format with 86' paths
+
     *   cashaddr in case of Bitcoin Cash
 
 ##### Examples
@@ -211,6 +226,8 @@ To sign a transaction involving standard (P2PKH) inputs, call createTransaction
     *   "bech32m" for spending segwit v1+ outputs
     *   "abc" for bch
     *   "gold" for btg
+    *   "decred" for decred
+    *   "zcash" for zcash
     *   "bipxxx" for using BIPxxx
     *   "sapling" to indicate a zec transaction is supporting sapling (to be set over block 419200)
 *   `expiryHeight`  is an optional Buffer for zec overwinter / sapling Txs
@@ -262,11 +279,11 @@ For each UTXO included in your transaction, create a transaction object from the
 
 ##### Parameters
 
-*   `transactionHex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-*   `isSegwitSupported` **([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**  (optional, default `false`)
-*   `hasTimestamp`   (optional, default `false`)
-*   `hasExtraData`   (optional, default `false`)
-*   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
+*   `transactionHex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a raw hexadecimal serialized transaction
+*   `isSegwitSupported` **([boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** is a boolean indicating if the segwit is supported (optional, default `false`)
+*   `hasTimestamp`  is a boolean (peercoin includes timestamp in their transactions, others don't) (optional, default `false`)
+*   `hasExtraData`  is a boolean (komodo, zencash and zcash include extraData in their transactions, others don't) (optional, default `false`)
+*   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** list of additionnal options (optional, default `[]`)
 
 ##### Examples
 
@@ -274,10 +291,12 @@ For each UTXO included in your transaction, create a transaction object from the
 const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
 ```
 
-Returns **[Transaction](#transaction)**&#x20;
+Returns **[Transaction](#transaction)** the transaction object deserialized from the raw hexadecimal transaction
 
 #### serializeTransactionOutputs
 
+Serialize a transaction's outputs to hexadecimal
+
 ##### Parameters
 
 *   `t` **[Transaction](#transaction)**&#x20;
@@ -291,10 +310,36 @@ const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
 
 Returns **[Buffer](https://nodejs.org/api/buffer.html)**&#x20;
 
+#### getTrustedInput
+
+Trusted input is the hash of a UTXO that needs to be signed
+For Legacy transactions, the app has some APDUs flows that do the amount check for an UTXO,
+by parsing the transaction that created this UTXO
+
+##### Parameters
+
+*   `indexLookup` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
+*   `transaction` **[Transaction](#transaction)**&#x20;
+*   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
+
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**&#x20;
+
+#### getTrustedInputBIP143
+
+Trusted input is the hash of a UTXO that needs to be signed. BIP143 is used for Segwit inputs.
+
+##### Parameters
+
+*   `indexLookup` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
+*   `transaction` **[Transaction](#transaction)**&#x20;
+*   `additionals` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**  (optional, default `[]`)
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
 ### BtcNew
 
 This class implements the same interface as BtcOld (formerly
-named Btc), but interacts with Bitcoin hardware app version 2+
+named Btc), but interacts with Bitcoin hardware app version 2.1.0+
 which uses a totally new APDU protocol. This new
 protocol is documented at
 <https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/bitcoin.md>
@@ -305,10 +350,6 @@ input data into the PSBT process. In the future, a new interface should
 be developed that exposes PSBT to the outer world, which would render
 a much cleaner implementation.
 
-#### Parameters
-
-*   `` &#x20;
-
 #### getWalletXpub
 
 This is a new method that allow users to get an xpub at a standard path.
@@ -394,20 +435,21 @@ and returns v, r, s.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{v: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), r: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), s: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>**&#x20;
 
-### BtcOld
+### descrTemplFrom
 
-Bitcoin API.
+This function returns a descriptor template based on the address format.
+See <https://github.com/LedgerHQ/app-bitcoin-new/blob/develop/doc/wallet.md> for details of
+the bitcoin descriptor template.
 
 #### Parameters
 
-*   `` &#x20;
+*   `addressFormat` **[AddressFormat](#addressformat)**&#x20;
 
-#### Examples
+Returns **DefaultDescriptorTemplate**&#x20;
 
-```javascript
-import Btc from "@ledgerhq/hw-app-btc";
-const btc = new Btc({ transport, currency: "zcash" });
-```
+### BtcOld
+
+This Bitcoin old API is compatible with versions of the Bitcoin nano app that are earlier than 2.1.0
 
 #### getWalletPublicKey
 
@@ -417,11 +459,13 @@ const btc = new Btc({ transport, currency: "zcash" });
 *   `opts` **{verify: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, format: [AddressFormat](#addressformat)?}?**&#x20;
 *   `options`  an object with optional these fields:*   verify (boolean) will ask user to confirm the address on the device
 
-    *   format ("legacy" | "p2sh" | "bech32" | "cashaddr") to use different bitcoin address formatter.NB The normal usage is to use:*   legacy format with 44' paths
+    *   format ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr") to use different bitcoin address formatter.NB The normal usage is to use:*   legacy format with 44' paths
 
     *   p2sh format with 49' paths
 
-    *   bech32 format with 173' paths
+    *   bech32 format with 84' paths
+
+    *   bech32m format with 86' paths
 
     *   cashaddr in case of Bitcoin Cash
 
@@ -455,6 +499,8 @@ To sign a transaction involving standard (P2PKH) inputs, call createTransaction
 *   `additionals`  list of additionnal options*   "bech32" for spending native segwit outputs
     *   "abc" for bch
     *   "gold" for btg
+    *   "decred" for decred
+    *   "zcash" for zcash
     *   "bipxxx" for using BIPxxx
     *   "sapling" to indicate a zec transaction is supporting sapling (to be set over block 419200)
 *   `expiryHeight`  is an optional Buffer for zec overwinter / sapling Txs
@@ -495,7 +541,7 @@ Type: {inputs: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Referen
 
 ### AddressFormat
 
-address format is one of legacy | p2sh | bech32 | cashaddr
+address format is one of legacy | p2sh | bech32 | bech32m | cashaddr
 
 Type: (`"legacy"` | `"p2sh"` | `"bech32"` | `"bech32m"` | `"cashaddr"`)
 

package/lib/Btc.d.ts

@@ -8,8 +8,11 @@ import type { SignP2SHTransactionArg } from "./signP2SHTransaction";
 import type { Transaction } from "./types";
 export type { AddressFormat };
 /**
- * Bitcoin API.
- *
+ * @class Btc
+ * @description Bitcoin API.
+ * @param transport The transport layer used for communication.
+ * @param scrambleKey This parameter is deprecated and no longer needed.
+ * @param currency The currency to use, defaults to "bitcoin".
  * @example
  * import Btc from "@ledgerhq/hw-app-btc";
  * const btc = new Btc({ transport, currency: "bitcoin" });
@@ -25,8 +28,10 @@ export default class Btc {
     /**
      * Get an XPUB with a ledger device
      * @param arg derivation parameter
-     * - path: a BIP 32 path of the account level. e.g. `84'/0'/0'`
-     * - xpubVersion: the XPUBVersion of the coin used. (use @ledgerhq/currencies if needed)
+     * - path: a BIP 32 path of the account level. (e.g. The derivation path `84'/0'/0'`
+     * follows the `purpose' / coin_type' / account'` standard, with purpose=84, coin_type=0, account=0)
+     * - xpubVersion: the XPUBVersion of the coin used. (refer to ledgerjs/packages/cryptoassets/src/currencies.ts
+     * for the XPUBVersion value if needed)
      * @returns XPUB of the account
      */
     getWalletXpub(arg: {
@@ -34,10 +39,10 @@ export default class Btc {
         xpubVersion: number;
     }): Promise<string>;
     /**
-     * @param path a BIP 32 path
+     * @param path a BIP 32 path (i.e. the `purpose’ / coin_type’ / account’ / change / address_index` standard)
      * @param options an object with optional these fields:
      *
-     * - verify (boolean) will ask user to confirm the address on the device
+     * - verify (boolean) whether ask user to confirm the address on the device
      *
      * - format ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr") to use different bitcoin address formatter.
      *
@@ -49,6 +54,8 @@ export default class Btc {
      *
      * - bech32 format with 84' paths
      *
+     * - bech32m format with 86' paths
+     *
      * - cashaddr in case of Bitcoin Cash
      *
      * @example
@@ -98,6 +105,8 @@ export default class Btc {
      * - "bech32m" for spending segwit v1+ outputs
      * - "abc" for bch
      * - "gold" for btg
+     * - "decred" for decred
+     * - "zcash" for zcash
      * - "bipxxx" for using BIPxxx
      * - "sapling" to indicate a zec transaction is supporting sapling (to be set over block 419200)
      * @param expiryHeight is an optional Buffer for zec overwinter / sapling Txs
@@ -133,17 +142,32 @@ export default class Btc {
     signP2SHTransaction(arg: SignP2SHTransactionArg): Promise<string[]>;
     /**
      * For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.
+     * @param transactionHex a raw hexadecimal serialized transaction
+     * @param isSegwitSupported is a boolean indicating if the segwit is supported
+     * @param hasTimestamp is a boolean (peercoin includes timestamp in their transactions, others don't)
+     * @param hasExtraData is a boolean (komodo, zencash and zcash include extraData in their transactions, others don't)
+     * @param additionals list of additionnal options
+     * @return the transaction object deserialized from the raw hexadecimal transaction
      * @example
     const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
      */
     splitTransaction(transactionHex: string, isSegwitSupported?: boolean | null | undefined, hasTimestamp?: boolean, hasExtraData?: boolean, additionals?: Array<string>): Transaction;
     /**
-    @example
+     * Serialize a transaction's outputs to hexadecimal
+     * @example
     const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
     const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
     */
     serializeTransactionOutputs(t: Transaction): Buffer;
+    /**
+     * Trusted input is the hash of a UTXO that needs to be signed
+     * For Legacy transactions, the app has some APDUs flows that do the amount check for an UTXO,
+     * by parsing the transaction that created this UTXO
+     */
     getTrustedInput(indexLookup: number, transaction: Transaction, additionals?: Array<string>): Promise<string>;
+    /**
+     * Trusted input is the hash of a UTXO that needs to be signed. BIP143 is used for Segwit inputs.
+     */
     getTrustedInputBIP143(indexLookup: number, transaction: Transaction, additionals?: Array<string>): string;
     changeImplIfNecessary(): Promise<BtcOld | BtcNew>;
 }

package/lib/Btc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Btc.d.ts","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACpD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAG1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,YAAY,EAAE,aAAa,EAAE,CAAC;AAI9B;;;;;;GAMG;AAEH,MAAM,CAAC,OAAO,OAAO,GAAG;IACtB,OAAO,CAAC,UAAU,CAAY;IAC9B,OAAO,CAAC,KAAK,CAAkB;gBAEnB,EACV,SAAS,EACT,WAAmB,EACnB,QAAoB,GACrB,EAAE;QACD,SAAS,EAAE,SAAS,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IA8BD;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,CAChB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB,GACA,OAAO,CAAC;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAmBF;;;;;;;;OAQG;IACH,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QACT,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,wBAAwB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAWpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAInE;;;;OAIG;IACH,gBAAgB,CACd,cAAc,EAAE,MAAM,EACtB,iBAAiB,GAAE,OAAO,GAAG,IAAI,GAAG,SAAiB,EACrD,YAAY,UAAQ,EACpB,YAAY,UAAQ,EACpB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,WAAW;IAUd;;;;MAIE;IACF,2BAA2B,CAAC,CAAC,EAAE,WAAW,GAAG,MAAM;IAInD,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,OAAO,CAAC,MAAM,CAAC;IAIlB,qBAAqB,CACnB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,MAAM;IAIH,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;CAmCxD"}
+{"version":3,"file":"Btc.d.ts","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,SAAS,MAAM,wBAAwB,CAAC;AACpD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGhE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAG1D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,YAAY,EAAE,aAAa,EAAE,CAAC;AAI9B;;;;;;;;;GASG;AAEH,MAAM,CAAC,OAAO,OAAO,GAAG;IAEtB,OAAO,CAAC,UAAU,CAAY;IAG9B,OAAO,CAAC,KAAK,CAAkB;gBACnB,EACV,SAAS,EACT,WAAmB,EACnB,QAAoB,GACrB,EAAE;QACD,SAAS,EAAE,SAAS,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IA8BD;;;;;;;;OAQG;IACH,aAAa,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAM1E;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,kBAAkB,CAChB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB,GACA,OAAO,CAAC;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAmBF;;;;;;;;OAQG;IACH,WAAW,CACT,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC;QACT,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IASF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,wBAAwB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAWpE;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAInE;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,cAAc,EAAE,MAAM,EACtB,iBAAiB,GAAE,OAAO,GAAG,IAAI,GAAG,SAAiB,EACrD,YAAY,UAAQ,EACpB,YAAY,UAAQ,EACpB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,WAAW;IAUd;;;;;MAKE;IACF,2BAA2B,CAAC,CAAC,EAAE,WAAW,GAAG,MAAM;IAInD;;;;OAIG;IACH,eAAe,CACb,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,OAAO,CAAC,MAAM,CAAC;IAIlB;;OAEG;IACH,qBAAqB,CACnB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,MAAM;IAIH,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;CAmCxD"}

package/lib/Btc.js

@@ -23,8 +23,11 @@ const splitTransaction_1 = require("./splitTransaction");
 const signP2SHTransaction_1 = require("./signP2SHTransaction");
 const getAppAndVersion_1 = require("./getAppAndVersion");
 /**
- * Bitcoin API.
- *
+ * @class Btc
+ * @description Bitcoin API.
+ * @param transport The transport layer used for communication.
+ * @param scrambleKey This parameter is deprecated and no longer needed.
+ * @param currency The currency to use, defaults to "bitcoin".
  * @example
  * import Btc from "@ledgerhq/hw-app-btc";
  * const btc = new Btc({ transport, currency: "bitcoin" });
@@ -57,8 +60,10 @@ class Btc {
     /**
      * Get an XPUB with a ledger device
      * @param arg derivation parameter
-     * - path: a BIP 32 path of the account level. e.g. `84'/0'/0'`
-     * - xpubVersion: the XPUBVersion of the coin used. (use @ledgerhq/currencies if needed)
+     * - path: a BIP 32 path of the account level. (e.g. The derivation path `84'/0'/0'`
+     * follows the `purpose' / coin_type' / account'` standard, with purpose=84, coin_type=0, account=0)
+     * - xpubVersion: the XPUBVersion of the coin used. (refer to ledgerjs/packages/cryptoassets/src/currencies.ts
+     * for the XPUBVersion value if needed)
      * @returns XPUB of the account
      */
     getWalletXpub(arg) {
@@ -67,10 +72,10 @@ class Btc {
         });
     }
     /**
-     * @param path a BIP 32 path
+     * @param path a BIP 32 path (i.e. the `purpose’ / coin_type’ / account’ / change / address_index` standard)
      * @param options an object with optional these fields:
      *
-     * - verify (boolean) will ask user to confirm the address on the device
+     * - verify (boolean) whether ask user to confirm the address on the device
      *
      * - format ("legacy" | "p2sh" | "bech32" | "bech32m" | "cashaddr") to use different bitcoin address formatter.
      *
@@ -82,6 +87,8 @@ class Btc {
      *
      * - bech32 format with 84' paths
      *
+     * - bech32m format with 86' paths
+     *
      * - cashaddr in case of Bitcoin Cash
      *
      * @example
@@ -143,6 +150,8 @@ class Btc {
      * - "bech32m" for spending segwit v1+ outputs
      * - "abc" for bch
      * - "gold" for btg
+     * - "decred" for decred
+     * - "zcash" for zcash
      * - "bipxxx" for using BIPxxx
      * - "sapling" to indicate a zec transaction is supporting sapling (to be set over block 419200)
      * @param expiryHeight is an optional Buffer for zec overwinter / sapling Txs
@@ -187,6 +196,12 @@ class Btc {
     }
     /**
      * For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.
+     * @param transactionHex a raw hexadecimal serialized transaction
+     * @param isSegwitSupported is a boolean indicating if the segwit is supported
+     * @param hasTimestamp is a boolean (peercoin includes timestamp in their transactions, others don't)
+     * @param hasExtraData is a boolean (komodo, zencash and zcash include extraData in their transactions, others don't)
+     * @param additionals list of additionnal options
+     * @return the transaction object deserialized from the raw hexadecimal transaction
      * @example
     const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
      */
@@ -194,16 +209,25 @@ class Btc {
         return (0, splitTransaction_1.splitTransaction)(transactionHex, isSegwitSupported, hasTimestamp, hasExtraData, additionals);
     }
     /**
-    @example
+     * Serialize a transaction's outputs to hexadecimal
+     * @example
     const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
     const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
     */
     serializeTransactionOutputs(t) {
         return (0, serializeTransaction_1.serializeTransactionOutputs)(t);
     }
+    /**
+     * Trusted input is the hash of a UTXO that needs to be signed
+     * For Legacy transactions, the app has some APDUs flows that do the amount check for an UTXO,
+     * by parsing the transaction that created this UTXO
+     */
     getTrustedInput(indexLookup, transaction, additionals = []) {
         return (0, getTrustedInput_1.getTrustedInput)(this._transport, indexLookup, transaction, additionals);
     }
+    /**
+     * Trusted input is the hash of a UTXO that needs to be signed. BIP143 is used for Segwit inputs.
+     */
     getTrustedInputBIP143(indexLookup, transaction, additionals = []) {
         return (0, getTrustedInputBIP143_1.getTrustedInputBIP143)(this._transport, indexLookup, transaction, additionals);
     }

package/lib/Btc.js.map

@@ -1 +1 @@
-{"version":3,"file":"Btc.js","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAA4B;AAE5B,sDAA8B;AAC9B,sDAA8B;AAE9B,uDAAoD;AACpD,mEAAgE;AAEhE,kDAA+C;AAC/C,iEAAqE;AAErE,yDAAsD;AAGtD,+DAA4D;AAC5D,yDAAwE;AAExE;;;;;;GAMG;AAEH,MAAqB,GAAG;IAItB,YAAY,EACV,SAAS,EACT,WAAW,GAAG,KAAK,EACnB,QAAQ,GAAG,SAAS,GAKrB;QACC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,IAAI,EACJ;YACE,eAAe;YACf,oBAAoB;YACpB,qBAAqB;YACrB,aAAa;YACb,0BAA0B;YAC1B,iBAAiB;YACjB,uBAAuB;SACxB,EACD,WAAW,CACZ,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,EAAE;YACjB,QAAQ,QAAQ,EAAE;gBAChB,KAAK,SAAS,CAAC;gBACf,KAAK,iBAAiB,CAAC;gBACvB,KAAK,MAAM;oBACT,8EAA8E;oBAC9E,OAAO,IAAI,gBAAM,CAAC,IAAI,qBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBACpD;oBACE,+EAA+E;oBAC/E,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,GAA0C;QACtD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,kBAAkB,CAChB,IAAY,EACZ,IAGC;QAMD,IAAI,OAAO,CAAC;QACZ,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YACrD,OAAO,CAAC,IAAI,CACV,iHAAiH,CAClH,CAAC;YACF,OAAO,GAAG;gBACR,MAAM,EAAE,CAAC,CAAC,IAAI;gBACd,8CAA8C;gBAC9C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ;aACzC,CAAC;SACH;aAAM;YACL,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;SACtB;QACD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,IAAY,EACZ,UAAkB;QAMlB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI;gBACJ,UAAU;aACX,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,wBAAwB,CAAC,GAAyB;QAChD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CACb,2HAA2H,CAC5H,CAAC;SACH;QACD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAA2B;QAC7C,OAAO,IAAA,yCAAmB,EAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CACd,cAAsB,EACtB,oBAAgD,KAAK,EACrD,YAAY,GAAG,KAAK,EACpB,YAAY,GAAG,KAAK,EACpB,cAA6B,EAAE;QAE/B,OAAO,IAAA,mCAAgB,EACrB,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;MAIE;IACF,2BAA2B,CAAC,CAAc;QACxC,OAAO,IAAA,kDAA2B,EAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,eAAe,CACb,WAAmB,EACnB,WAAwB,EACxB,cAA6B,EAAE;QAE/B,OAAO,IAAA,iCAAe,EAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;IAED,qBAAqB,CACnB,WAAmB,EACnB,WAAwB,EACxB,cAA6B,EAAE;QAE/B,OAAO,IAAA,6CAAqB,EAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IACvF,CAAC;IAEK,qBAAqB;;YACzB,4CAA4C;YAC5C,IAAI,IAAI,CAAC,KAAK,YAAY,gBAAM;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC;YAEpD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,mCAAgB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAElE,MAAM,WAAW,GAAG,MAAM,CAAC,GAAS,EAAE;gBACpC,QAAQ,IAAI,EAAE;oBACZ,KAAK,SAAS,CAAC;oBACf,KAAK,cAAc,CAAC,CAAC;wBACnB,0EAA0E;wBAC1E,OAAO,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;qBACpC;oBACD,KAAK,gBAAgB,CAAC;oBACtB,KAAK,qBAAqB;wBACxB,2GAA2G;wBAC3G,OAAO,IAAI,CAAC;oBACd,KAAK,UAAU;wBACb,+EAA+E;wBAC/E,yEAAyE;wBACzE,kFAAkF;wBAClF,OAAO,MAAM,IAAA,mCAAgB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACjD,KAAK,MAAM;wBACT,uEAAuE;wBACvE,OAAO,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACrC;wBACE,OAAO,IAAI,CAAC;iBACf;YACH,CAAC,CAAA,CAAC,EAAE,CAAC;YAEL,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC1C;YACD,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;KAAA;CACF;AAvRD,sBAuRC"}
+{"version":3,"file":"Btc.js","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAA4B;AAE5B,sDAA8B;AAC9B,sDAA8B;AAE9B,uDAAoD;AACpD,mEAAgE;AAEhE,kDAA+C;AAC/C,iEAAqE;AAErE,yDAAsD;AAGtD,+DAA4D;AAC5D,yDAAwE;AAExE;;;;;;;;;GASG;AAEH,MAAqB,GAAG;IAMtB,YAAY,EACV,SAAS,EACT,WAAW,GAAG,KAAK,EACnB,QAAQ,GAAG,SAAS,GAKrB;QACC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CACnC,IAAI,EACJ;YACE,eAAe;YACf,oBAAoB;YACpB,qBAAqB;YACrB,aAAa;YACb,0BAA0B;YAC1B,iBAAiB;YACjB,uBAAuB;SACxB,EACD,WAAW,CACZ,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,EAAE;YACjB,QAAQ,QAAQ,EAAE;gBAChB,KAAK,SAAS,CAAC;gBACf,KAAK,iBAAiB,CAAC;gBACvB,KAAK,MAAM;oBACT,8EAA8E;oBAC9E,OAAO,IAAI,gBAAM,CAAC,IAAI,qBAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBACpD;oBACE,+EAA+E;oBAC/E,OAAO,IAAI,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aACtC;QACH,CAAC,CAAC,EAAE,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CAAC,GAA0C;QACtD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,kBAAkB,CAChB,IAAY,EACZ,IAGC;QAMD,IAAI,OAAO,CAAC;QACZ,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;YACrD,OAAO,CAAC,IAAI,CACV,iHAAiH,CAClH,CAAC;YACF,OAAO,GAAG;gBACR,MAAM,EAAE,CAAC,CAAC,IAAI;gBACd,8CAA8C;gBAC9C,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ;aACzC,CAAC;SACH;aAAM;YACL,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;SACtB;QACD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,WAAW,CACT,IAAY,EACZ,UAAkB;QAMlB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI;gBACJ,UAAU;aACX,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,wBAAwB,CAAC,GAAyB;QAChD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,MAAM,IAAI,KAAK,CACb,2HAA2H,CAC5H,CAAC;SACH;QACD,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC9C,OAAO,IAAI,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mBAAmB,CAAC,GAA2B;QAC7C,OAAO,IAAA,yCAAmB,EAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,cAAsB,EACtB,oBAAgD,KAAK,EACrD,YAAY,GAAG,KAAK,EACpB,YAAY,GAAG,KAAK,EACpB,cAA6B,EAAE;QAE/B,OAAO,IAAA,mCAAgB,EACrB,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;MAKE;IACF,2BAA2B,CAAC,CAAc;QACxC,OAAO,IAAA,kDAA2B,EAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,eAAe,CACb,WAAmB,EACnB,WAAwB,EACxB,cAA6B,EAAE;QAE/B,OAAO,IAAA,iCAAe,EAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IACjF,CAAC;IAED;;OAEG;IACH,qBAAqB,CACnB,WAAmB,EACnB,WAAwB,EACxB,cAA6B,EAAE;QAE/B,OAAO,IAAA,6CAAqB,EAAC,IAAI,CAAC,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;IACvF,CAAC;IAEK,qBAAqB;;YACzB,4CAA4C;YAC5C,IAAI,IAAI,CAAC,KAAK,YAAY,gBAAM;gBAAE,OAAO,IAAI,CAAC,KAAK,CAAC;YAEpD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAA,mCAAgB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAElE,MAAM,WAAW,GAAG,MAAM,CAAC,GAAS,EAAE;gBACpC,QAAQ,IAAI,EAAE;oBACZ,KAAK,SAAS,CAAC;oBACf,KAAK,cAAc,CAAC,CAAC;wBACnB,0EAA0E;wBAC1E,OAAO,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;qBACpC;oBACD,KAAK,gBAAgB,CAAC;oBACtB,KAAK,qBAAqB;wBACxB,2GAA2G;wBAC3G,OAAO,IAAI,CAAC;oBACd,KAAK,UAAU;wBACb,+EAA+E;wBAC/E,yEAAyE;wBACzE,kFAAkF;wBAClF,OAAO,MAAM,IAAA,mCAAgB,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACjD,KAAK,MAAM;wBACT,uEAAuE;wBACvE,OAAO,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBACrC;wBACE,OAAO,IAAI,CAAC;iBACf;YACH,CAAC,CAAA,CAAC,EAAE,CAAC;YAEL,IAAI,WAAW,EAAE;gBACf,IAAI,CAAC,KAAK,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;aAC1C;YACD,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;KAAA;CACF;AA9SD,sBA8SC"}

package/lib/BtcNew.d.ts

@@ -2,8 +2,9 @@ import type { CreateTransactionArg } from "./createTransaction";
 import type { AddressFormat } from "./getWalletPublicKey";
 import { AppClient as Client } from "./newops/appClient";
 /**
- * This class implements the same interface as BtcOld (formerly
- * named Btc), but interacts with Bitcoin hardware app version 2+
+ * @class BtcNew
+ * @description This class implements the same interface as BtcOld (formerly
+ * named Btc), but interacts with Bitcoin hardware app version 2.1.0+
  * which uses a totally new APDU protocol. This new
  * protocol is documented at
  * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/bitcoin.md
@@ -13,6 +14,7 @@ import { AppClient as Client } from "./newops/appClient";
  * input data into the PSBT process. In the future, a new interface should
  * be developed that exposes PSBT to the outer world, which would render
  * a much cleaner implementation.
+ *
  */
 export default class BtcNew {
     private client;

package/lib/BtcNew.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BtcNew.d.ts","sourceRoot":"","sources":["../src/BtcNew.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAS1D,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAQzD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,aAAa,CAAC,EAClB,IAAI,EACJ,WAAW,GACZ,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnB;;;;;;OAMG;IACG,kBAAkB,CACtB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB,GACA,OAAO,CAAC;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAuBF;;;;;;;;;;;;;;OAcG;YACW,gBAAgB;IAyB9B;;;;;;;OAOG;IACG,wBAAwB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IA2G1E;;;;OAIG;IACG,WAAW,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QACrF,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAiBF;;;;;;;OAOG;YACW,cAAc;IAoB5B;;;;OAIG;YACW,QAAQ;IAuCtB;;;;;;;;OAQG;YACW,QAAQ;CA6BvB;AAuED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CA8BlD"}
+{"version":3,"file":"BtcNew.d.ts","sourceRoot":"","sources":["../src/BtcNew.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAS1D,OAAO,EAAE,SAAS,IAAI,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAQzD;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,OAAO,MAAM;IACb,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,MAAM;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,aAAa,CAAC,EAClB,IAAI,EACJ,WAAW,GACZ,EAAE;QACD,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,OAAO,CAAC,MAAM,CAAC;IAYnB;;;;;;OAMG;IACG,kBAAkB,CACtB,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE;QACL,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,aAAa,CAAC;KACxB,GACA,OAAO,CAAC;QACT,SAAS,EAAE,MAAM,CAAC;QAClB,cAAc,EAAE,MAAM,CAAC;QACvB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IAuBF;;;;;;;;;;;;;;OAcG;YACW,gBAAgB;IAyB9B;;;;;;;OAOG;IACG,wBAAwB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IA2G1E;;;;OAIG;IACG,WAAW,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC;QACrF,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IAiBF;;;;;;;OAOG;YACW,cAAc;IAoB5B;;;;OAIG;YACW,QAAQ;IAuCtB;;;;;;;;OAQG;YACW,QAAQ;CA6BvB;AA4ED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CA8BlD"}

package/lib/BtcNew.js

@@ -21,8 +21,9 @@ const psbtFinalizer_1 = require("./newops/psbtFinalizer");
 const psbtv2_1 = require("./newops/psbtv2");
 const serializeTransaction_1 = require("./serializeTransaction");
 /**
- * This class implements the same interface as BtcOld (formerly
- * named Btc), but interacts with Bitcoin hardware app version 2+
+ * @class BtcNew
+ * @description This class implements the same interface as BtcOld (formerly
+ * named Btc), but interacts with Bitcoin hardware app version 2.1.0+
  * which uses a totally new APDU protocol. This new
  * protocol is documented at
  * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/bitcoin.md
@@ -32,6 +33,7 @@ const serializeTransaction_1 = require("./serializeTransaction");
  * input data into the PSBT process. In the future, a new interface should
  * be developed that exposes PSBT to the outer world, which would render
  * a much cleaner implementation.
+ *
  */
 class BtcNew {
     constructor(client) {
@@ -347,6 +349,11 @@ class BtcNew {
     }
 }
 exports.default = BtcNew;
+/**
+ * This function returns a descriptor template based on the address format.
+ * See https://github.com/LedgerHQ/app-bitcoin-new/blob/develop/doc/wallet.md for details of
+ * the bitcoin descriptor template.
+ */
 function descrTemplFrom(addressFormat) {
     if (addressFormat == "legacy")
         return "pkh(@0)";