@ledgerhq/hw-app-btc 9.0.1 → 9.1.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ledgerhq/hw-app-btc
 
+## 9.1.0-next.0
+
+### Minor Changes
+
+- [#1959](https://github.com/LedgerHQ/ledger-live/pull/1959) [`2aa8cc9c33`](https://github.com/LedgerHQ/ledger-live/commit/2aa8cc9c339ce8c9677b24e70218cc45847d799b) Thanks [@hzheng-ledger](https://github.com/hzheng-ledger)! - Change hw-app-btc to remove any dependency to the legacy Bitcoin Nano app API. Update hw-app-btc API (refer to hw-app-btc/src/Btc.ts for new method signature)
+
 ## 9.0.1
 
 ### Patch Changes

package/README.md

@@ -35,10 +35,10 @@ For a smooth and quick integration:
     *   [getWalletPublicKey](#getwalletpublickey)
         *   [Parameters](#parameters-2)
         *   [Examples](#examples-1)
-    *   [signMessageNew](#signmessagenew)
+    *   [signMessage](#signmessage)
         *   [Parameters](#parameters-3)
         *   [Examples](#examples-2)
-    *   [createPaymentTransactionNew](#createpaymenttransactionnew)
+    *   [createPaymentTransaction](#createpaymenttransaction)
         *   [Parameters](#parameters-4)
         *   [Examples](#examples-3)
     *   [signP2SHTransaction](#signp2shtransaction)
@@ -50,14 +50,13 @@ For a smooth and quick integration:
     *   [serializeTransactionOutputs](#serializetransactionoutputs)
         *   [Parameters](#parameters-7)
         *   [Examples](#examples-6)
-*   [impl](#impl)
 *   [BtcNew](#btcnew)
     *   [Parameters](#parameters-8)
     *   [getWalletXpub](#getwalletxpub-1)
         *   [Parameters](#parameters-9)
     *   [getWalletPublicKey](#getwalletpublickey-1)
         *   [Parameters](#parameters-10)
-    *   [createPaymentTransactionNew](#createpaymenttransactionnew-1)
+    *   [createPaymentTransaction](#createpaymenttransaction-1)
         *   [Parameters](#parameters-11)
 *   [BtcOld](#btcold)
     *   [Parameters](#parameters-12)
@@ -65,53 +64,47 @@ For a smooth and quick integration:
     *   [getWalletPublicKey](#getwalletpublickey-2)
         *   [Parameters](#parameters-13)
         *   [Examples](#examples-8)
-    *   [signMessageNew](#signmessagenew-1)
+    *   [createPaymentTransaction](#createpaymenttransaction-2)
         *   [Parameters](#parameters-14)
         *   [Examples](#examples-9)
-    *   [createPaymentTransactionNew](#createpaymenttransactionnew-2)
-        *   [Parameters](#parameters-15)
-        *   [Examples](#examples-10)
-    *   [signP2SHTransaction](#signp2shtransaction-1)
-        *   [Parameters](#parameters-16)
-        *   [Examples](#examples-11)
 *   [CreateTransactionArg](#createtransactionarg)
     *   [Properties](#properties)
 *   [AddressFormat](#addressformat)
 *   [AccountType](#accounttype)
     *   [spendingCondition](#spendingcondition)
-        *   [Parameters](#parameters-17)
+        *   [Parameters](#parameters-15)
     *   [setInput](#setinput)
-        *   [Parameters](#parameters-18)
+        *   [Parameters](#parameters-16)
     *   [setOwnOutput](#setownoutput)
-        *   [Parameters](#parameters-19)
+        *   [Parameters](#parameters-17)
     *   [getDescriptorTemplate](#getdescriptortemplate)
 *   [SingleKeyAccount](#singlekeyaccount)
 *   [getTaprootOutputKey](#gettaprootoutputkey)
-    *   [Parameters](#parameters-20)
+    *   [Parameters](#parameters-18)
 *   [AppClient](#appclient)
-    *   [Parameters](#parameters-21)
+    *   [Parameters](#parameters-19)
 *   [ClientCommandInterpreter](#clientcommandinterpreter)
-    *   [Parameters](#parameters-22)
+    *   [Parameters](#parameters-20)
 *   [MerkelizedPsbt](#merkelizedpsbt)
-    *   [Parameters](#parameters-23)
+    *   [Parameters](#parameters-21)
 *   [Merkle](#merkle)
-    *   [Parameters](#parameters-24)
+    *   [Parameters](#parameters-22)
 *   [MerkleMap](#merklemap)
-    *   [Parameters](#parameters-25)
+    *   [Parameters](#parameters-23)
 *   [WalletPolicy](#walletpolicy)
-    *   [Parameters](#parameters-26)
+    *   [Parameters](#parameters-24)
 *   [extract](#extract)
-    *   [Parameters](#parameters-27)
+    *   [Parameters](#parameters-25)
 *   [finalize](#finalize)
-    *   [Parameters](#parameters-28)
+    *   [Parameters](#parameters-26)
 *   [clearFinalizedInput](#clearfinalizedinput)
-    *   [Parameters](#parameters-29)
+    *   [Parameters](#parameters-27)
 *   [writePush](#writepush)
-    *   [Parameters](#parameters-30)
+    *   [Parameters](#parameters-28)
 *   [PsbtV2](#psbtv2)
 *   [serializeTransactionOutputs](#serializetransactionoutputs-1)
-    *   [Parameters](#parameters-31)
-    *   [Examples](#examples-12)
+    *   [Parameters](#parameters-29)
+    *   [Examples](#examples-10)
 *   [SignP2SHTransactionArg](#signp2shtransactionarg)
     *   [Properties](#properties-1)
 *   [TransactionInput](#transactioninput)
@@ -124,14 +117,17 @@ Bitcoin API.
 
 #### Parameters
 
-*   `transport` **Transport** 
-*   `scrambleKey`   (optional, default `"BTC"`)
+*   `$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"`)
 
 #### Examples
 
 ```javascript
 import Btc from "@ledgerhq/hw-app-btc";
-const btc = new Btc(transport)
+const btc = new Btc({ transport, currency: "bitcoin" });
 ```
 
 #### getWalletXpub
@@ -170,7 +166,7 @@ btc.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinA
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{publicKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), bitcoinAddress: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), chainCode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** 
 
-#### signMessageNew
+#### signMessage
 
 You can sign a message according to the Bitcoin Signature format and retrieve v, r, s given the message and the BIP 32 path of the account to sign.
 
@@ -182,7 +178,7 @@ You can sign a message according to the Bitcoin Signature format and retrieve v,
 ##### Examples
 
 ```javascript
-btc.signMessageNew_async("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
+btc.signMessage("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
 var v = result['v'] + 27 + 4;
 var signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
 console.log("Signature : " + signature);
@@ -191,7 +187,7 @@ console.log("Signature : " + signature);
 
 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)}>** 
 
-#### createPaymentTransactionNew
+#### createPaymentTransaction
 
 To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
 
@@ -293,31 +289,6 @@ const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
 
 Returns **[Buffer](https://nodejs.org/api/buffer.html)** 
 
-### impl
-
-Definition: A "normal path" is a prefix of a standard path where all
-the hardened steps of the standard path are included. For example, the
-paths m/44'/1'/17' and m/44'/1'/17'/1 are normal paths, but m/44'/1'
-is not. m/'199/1'/17'/0/1 is not a normal path either.
-
-There's a compatiblity issue between old and new app: When exporting
-the key of a non-normal path with verify=false, the new app would
-return an error, whereas the old app would return the key.
-
-See
-https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/bitcoin.md#get_extended_pubkey
-
-If format bech32m is used, we'll not use old, because it doesn't
-support it.
-
-When to use new (given the app supports it)
-
-*   format is bech32m or
-*   path is normal or
-*   verify is true
-
-Otherwise use old.
-
 ### BtcNew
 
 This class implements the same interface as BtcOld (formerly
@@ -391,9 +362,9 @@ will be the empty string "", see this.getWalletAddress() for details.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{publicKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), bitcoinAddress: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), chainCode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** 
 
-#### createPaymentTransactionNew
+#### createPaymentTransaction
 
-Build and sign a transaction. See Btc.createPaymentTransactionNew for
+Build and sign a transaction. See Btc.createPaymentTransaction for
 details on how to use this method.
 
 This method will convert the legacy arguments, CreateTransactionArg, into
@@ -418,7 +389,7 @@ Bitcoin API.
 
 ```javascript
 import Btc from "@ledgerhq/hw-app-btc";
-const btc = new Btc(transport)
+const btc = new Btc({ transport, currency: "zcash" });
 ```
 
 #### getWalletPublicKey
@@ -446,28 +417,7 @@ btc.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinA
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{publicKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), bitcoinAddress: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), chainCode: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** 
 
-#### signMessageNew
-
-You can sign a message according to the Bitcoin Signature format and retrieve v, r, s given the message and the BIP 32 path of the account to sign.
-
-##### Parameters
-
-*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `messageHex` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
-##### Examples
-
-```javascript
-btc.signMessageNew_async("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
-var v = result['v'] + 27 + 4;
-var signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
-console.log("Signature : " + signature);
-}).catch(function(ex) {console.log(ex);});
-```
-
-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)}>** 
-
-#### createPaymentTransactionNew
+#### createPaymentTransaction
 
 To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
 
@@ -505,34 +455,6 @@ outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d
 
 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)>** the signed transaction ready to be broadcast
 
-#### signP2SHTransaction
-
-To obtain the signature of multisignature (P2SH) inputs, call signP2SHTransaction_async with the folowing parameters
-
-##### Parameters
-
-*   `arg` **[SignP2SHTransactionArg](#signp2shtransactionarg)** 
-*   `inputs`  is an array of \[ transaction, output_index, redeem script, optional sequence ] where*   transaction is the previously computed transaction object for this UTXO
-    *   output_index is the output in the transaction used as input for this UTXO (counting from 0)
-    *   redeem script is the mandatory redeem script associated to the current P2SH input
-    *   sequence is the sequence number to use for this input (when using RBF), or non present
-*   `associatedKeysets`  is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
-*   `outputScriptHex`  is the hexadecimal serialized outputs of the transaction to sign
-*   `lockTime`  is the optional lockTime of the transaction to sign, or default (0)
-*   `sigHashType`  is the hash type of the transaction to sign, or default (all)
-
-##### Examples
-
-```javascript
-btc.signP2SHTransaction({
-inputs: [ [tx, 1, "52210289b4a3ad52a919abd2bdd6920d8a6879b1e788c38aa76f0440a6f32a9f1996d02103a3393b1439d1693b063482c04bd40142db97bdf139eedd1b51ffb7070a37eac321030b9a409a1e476b0d5d17b804fcdb81cf30f9b99c6f3ae1178206e08bc500639853ae"] ],
-associatedKeysets: ["0'/0/0"],
-outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
-}).then(result => ...);
-```
-
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>>** the signed transaction ready to be broadcast
-
 ### CreateTransactionArg
 
 Type: {inputs: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<\[[Transaction](#transaction), [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)), ([number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) | null | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))]>, associatedKeysets: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, changePath: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?, outputScriptHex: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), lockTime: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, sigHashType: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, segwit: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, initialTimestamp: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?, 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)>, expiryHeight: [Buffer](https://nodejs.org/api/buffer.html)?, useTrustedInputForSegwit: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, onDeviceStreaming: function (arg0: {progress: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), total: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number), index: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)}): void?, onDeviceSignatureRequested: function (): void?, onDeviceSignatureGranted: function (): void?}

package/lib/Btc.d.ts

@@ -12,11 +12,16 @@ export type { AddressFormat };
  *
  * @example
  * import Btc from "@ledgerhq/hw-app-btc";
- * const btc = new Btc(transport)
+ * const btc = new Btc({ transport, currency: "bitcoin" });
  */
 export default class Btc {
-    transport: Transport;
-    constructor(transport: Transport, scrambleKey?: string);
+    private _transport;
+    private _impl;
+    constructor({ transport, scrambleKey, currency, }: {
+        transport: Transport;
+        scrambleKey?: string;
+        currency?: string;
+    });
     /**
      * Get an XPUB with a ledger device
      * @param arg derivation parameter
@@ -61,13 +66,13 @@ export default class Btc {
     /**
      * You can sign a message according to the Bitcoin Signature format and retrieve v, r, s given the message and the BIP 32 path of the account to sign.
      * @example
-     btc.signMessageNew_async("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
+     btc.signMessage("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
        var v = result['v'] + 27 + 4;
        var signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
        console.log("Signature : " + signature);
      }).catch(function(ex) {console.log(ex);});
      */
-    signMessageNew(path: string, messageHex: string): Promise<{
+    signMessage(path: string, messageHex: string): Promise<{
         v: number;
         r: string;
         s: string;
@@ -105,7 +110,7 @@ export default class Btc {
      outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
     }).then(res => ...);
      */
-    createPaymentTransactionNew(arg: CreateTransactionArg): Promise<string>;
+    createPaymentTransaction(arg: CreateTransactionArg): Promise<string>;
     /**
      * To obtain the signature of multisignature (P2SH) inputs, call signP2SHTransaction_async with the folowing parameters
      * @param inputs is an array of [ transaction, output_index, redeem script, optional sequence ] where
@@ -140,10 +145,6 @@ export default class Btc {
     serializeTransactionOutputs(t: Transaction): Buffer;
     getTrustedInput(indexLookup: number, transaction: Transaction, additionals?: Array<string>): Promise<string>;
     getTrustedInputBIP143(indexLookup: number, transaction: Transaction, additionals?: Array<string>): string;
-    private _lazyImpl;
-    private getCorrectImpl;
-    private inferCorrectImpl;
-    protected old(): BtcOld;
-    protected new(): BtcNew;
+    changeImplIfNecessary(): Promise<BtcOld | BtcNew>;
 }
 //# sourceMappingURL=Btc.d.ts.map

package/lib/Btc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Btc.d.ts","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,SAAS,MAAM,wBAAwB,CAAC;AAEpD,OAAO,MAAyB,MAAM,UAAU,CAAC;AACjD,OAAO,MAAM,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAIhE,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;AAC9B;;;;;;GAMG;AAEH,MAAM,CAAC,OAAO,OAAO,GAAG;IACtB,SAAS,EAAE,SAAS,CAAC;gBAET,SAAS,EAAE,SAAS,EAAE,WAAW,SAAQ;IAiBrD;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAI1E;;;;;;;;;;;;;;;;;;;;;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;IAiFF;;;;;;;;OAQG;IACH,cAAc,CACZ,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;IAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,2BAA2B,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAWvE;;;;;;;;;;;;;;;;;;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;IASlB,qBAAqB,CACnB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,MAAM;IAUT,OAAO,CAAC,SAAS,CAAgC;YACnC,cAAc;YAQd,gBAAgB;IAU9B,SAAS,CAAC,GAAG,IAAI,MAAM;IAIvB,SAAS,CAAC,GAAG,IAAI,MAAM;CAGxB"}
+{"version":3,"file":"Btc.d.ts","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";AAAA,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;AAK9B;;;;;;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;IAuBD;;;;;;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;IAOF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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;IASlB,qBAAqB,CACnB,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,WAAW,GAAE,KAAK,CAAC,MAAM,CAAM,GAC9B,MAAM;IASH,qBAAqB,IAAI,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;CAUxD"}

package/lib/Btc.js

@@ -1,27 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -62,37 +39,43 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-var bip32_1 = require("./bip32");
-var BtcNew_1 = __importStar(require("./BtcNew"));
+var BtcNew_1 = __importDefault(require("./BtcNew"));
 var BtcOld_1 = __importDefault(require("./BtcOld"));
-var getAppAndVersion_1 = require("./getAppAndVersion");
 var getTrustedInput_1 = require("./getTrustedInput");
 var getTrustedInputBIP143_1 = require("./getTrustedInputBIP143");
 var appClient_1 = require("./newops/appClient");
 var serializeTransaction_1 = require("./serializeTransaction");
 var splitTransaction_1 = require("./splitTransaction");
+var signP2SHTransaction_1 = require("./signP2SHTransaction");
+var signMessage_1 = require("./signMessage");
+var getAppAndVersion_1 = require("./getAppAndVersion");
 /**
  * Bitcoin API.
  *
  * @example
  * import Btc from "@ledgerhq/hw-app-btc";
- * const btc = new Btc(transport)
+ * const btc = new Btc({ transport, currency: "bitcoin" });
  */
 var Btc = /** @class */ (function () {
-    function Btc(transport, scrambleKey) {
-        if (scrambleKey === void 0) { scrambleKey = "BTC"; }
-        // cache the underlying implementation (only once)
-        this._lazyImpl = null;
-        this.transport = transport;
-        transport.decorateAppAPIMethods(this, [
+    function Btc(_a) {
+        var transport = _a.transport, _b = _a.scrambleKey, scrambleKey = _b === void 0 ? "BTC" : _b, _c = _a.currency, currency = _c === void 0 ? "bitcoin" : _c;
+        this._transport = transport;
+        this._transport.decorateAppAPIMethods(this, [
             "getWalletXpub",
             "getWalletPublicKey",
             "signP2SHTransaction",
-            "signMessageNew",
-            "createPaymentTransactionNew",
+            "signMessage",
+            "createPaymentTransaction",
             "getTrustedInput",
             "getTrustedInputBIP143",
         ], scrambleKey);
+        // new APDU (nano app API) for bitcoin and old APDU for altcoin
+        if (currency === "bitcoin" || currency === "bitcoin_testnet") {
+            this._impl = new BtcNew_1["default"](new appClient_1.AppClient(this._transport));
+        }
+        else {
+            this._impl = new BtcOld_1["default"](this._transport);
+        }
     }
     /**
      * Get an XPUB with a ledger device
@@ -102,7 +85,9 @@ var Btc = /** @class */ (function () {
      * @returns XPUB of the account
      */
     Btc.prototype.getWalletXpub = function (arg) {
-        return this.getCorrectImpl().then(function (impl) { return impl.getWalletXpub(arg); });
+        return this.changeImplIfNecessary().then(function (impl) {
+            return impl.getWalletXpub(arg);
+        });
     };
     /**
      * @param path a BIP 32 path
@@ -127,7 +112,6 @@ var Btc = /** @class */ (function () {
      * btc.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinAddress)
      */
     Btc.prototype.getWalletPublicKey = function (path, opts) {
-        var _this = this;
         var options;
         if (arguments.length > 2 || typeof opts === "boolean") {
             console.warn("btc.getWalletPublicKey deprecated signature used. Please switch to getWalletPublicKey(path, { format, verify })");
@@ -140,53 +124,24 @@ var Btc = /** @class */ (function () {
         else {
             options = opts || {};
         }
-        return this.getCorrectImpl().then(function (impl) {
-            /**
-             * Definition: A "normal path" is a prefix of a standard path where all
-             * the hardened steps of the standard path are included. For example, the
-             * paths m/44'/1'/17' and m/44'/1'/17'/1 are normal paths, but m/44'/1'
-             * is not. m/'199/1'/17'/0/1 is not a normal path either.
-             *
-             * There's a compatiblity issue between old and new app: When exporting
-             * the key of a non-normal path with verify=false, the new app would
-             * return an error, whereas the old app would return the key.
-             *
-             * See
-             * https://github.com/LedgerHQ/app-bitcoin-new/blob/master/doc/bitcoin.md#get_extended_pubkey
-             *
-             * If format bech32m is used, we'll not use old, because it doesn't
-             * support it.
-             *
-             * When to use new (given the app supports it)
-             *   * format is bech32m or
-             *   * path is normal or
-             *   * verify is true
-             *
-             * Otherwise use old.
-             */
-            if (impl instanceof BtcNew_1["default"] &&
-                options.format != "bech32m" &&
-                (!options.verify || options.verify == false) &&
-                !isPathNormal(path)) {
-                console.warn("WARNING: Using deprecated device protocol to get the public key because\n        \n        * a non-standard path is requested, and\n        * verify flag is false\n        \n        The new protocol only allows export of non-standard paths if the \n        verify flag is true. Standard paths are (currently):\n\n        M/44'/(1|0)'/X'\n        M/49'/(1|0)'/X'\n        M/84'/(1|0)'/X'\n        M/86'/(1|0)'/X'\n        M/48'/(1|0)'/X'/Y'\n\n        followed by \"\", \"(0|1)\", or \"(0|1)/b\", where a and b are \n        non-hardened. For example, the following paths are standard\n        \n        M/48'/1'/99'/7'\n        M/86'/1'/99'/0\n        M/48'/0'/99'/7'/1/17\n\n        The following paths are non-standard\n\n        M/48'/0'/99'           // Not deepest hardened path\n        M/48'/0'/99'/7'/1/17/2 // Too many non-hardened derivation steps\n        M/199'/0'/1'/0/88      // Not a known purpose 199\n        M/86'/1'/99'/2         // Change path item must be 0 or 1\n\n        This compatibility safeguard will be removed in the future.\n        Please consider calling Btc.getWalletXpub() instead.");
-                return _this.old().getWalletPublicKey(path, options);
-            }
-            else {
-                return impl.getWalletPublicKey(path, options);
-            }
+        return this.changeImplIfNecessary().then(function (impl) {
+            return impl.getWalletPublicKey(path, options);
         });
     };
     /**
      * You can sign a message according to the Bitcoin Signature format and retrieve v, r, s given the message and the BIP 32 path of the account to sign.
      * @example
-     btc.signMessageNew_async("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
+     btc.signMessage("44'/60'/0'/0'/0", Buffer.from("test").toString("hex")).then(function(result) {
        var v = result['v'] + 27 + 4;
        var signature = Buffer.from(v.toString(16) + result['r'] + result['s'], 'hex').toString('base64');
        console.log("Signature : " + signature);
      }).catch(function(ex) {console.log(ex);});
      */
-    Btc.prototype.signMessageNew = function (path, messageHex) {
-        return this.old().signMessageNew(path, messageHex);
+    Btc.prototype.signMessage = function (path, messageHex) {
+        return (0, signMessage_1.signMessage)(this._transport, {
+            path: path,
+            messageHex: messageHex
+        });
     };
     /**
      * To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
@@ -221,12 +176,12 @@ var Btc = /** @class */ (function () {
      outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
     }).then(res => ...);
      */
-    Btc.prototype.createPaymentTransactionNew = function (arg) {
+    Btc.prototype.createPaymentTransaction = function (arg) {
         if (arguments.length > 1) {
-            console.warn("@ledgerhq/hw-app-btc: createPaymentTransactionNew multi argument signature is deprecated. please switch to named parameters.");
+            throw new Error("@ledgerhq/hw-app-btc: createPaymentTransaction multi argument signature is deprecated. please switch to named parameters.");
         }
-        return this.getCorrectImpl().then(function (impl) {
-            return impl.createPaymentTransactionNew(arg);
+        return this.changeImplIfNecessary().then(function (impl) {
+            return impl.createPaymentTransaction(arg);
         });
     };
     /**
@@ -249,7 +204,7 @@ var Btc = /** @class */ (function () {
     }).then(result => ...);
      */
     Btc.prototype.signP2SHTransaction = function (arg) {
-        return this.old().signP2SHTransaction(arg);
+        return (0, signP2SHTransaction_1.signP2SHTransaction)(this._transport, arg);
     };
     /**
      * For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.
@@ -273,85 +228,34 @@ var Btc = /** @class */ (function () {
     };
     Btc.prototype.getTrustedInput = function (indexLookup, transaction, additionals) {
         if (additionals === void 0) { additionals = []; }
-        return (0, getTrustedInput_1.getTrustedInput)(this.transport, indexLookup, transaction, additionals);
+        return (0, getTrustedInput_1.getTrustedInput)(this._transport, indexLookup, transaction, additionals);
     };
     Btc.prototype.getTrustedInputBIP143 = function (indexLookup, transaction, additionals) {
         if (additionals === void 0) { additionals = []; }
-        return (0, getTrustedInputBIP143_1.getTrustedInputBIP143)(this.transport, indexLookup, transaction, additionals);
-    };
-    Btc.prototype.getCorrectImpl = function () {
-        return __awaiter(this, void 0, void 0, function () {
-            var _lazyImpl, impl;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        _lazyImpl = this._lazyImpl;
-                        if (_lazyImpl)
-                            return [2 /*return*/, _lazyImpl];
-                        return [4 /*yield*/, this.inferCorrectImpl()];
-                    case 1:
-                        impl = _a.sent();
-                        this._lazyImpl = impl;
-                        return [2 /*return*/, impl];
-                }
-            });
-        });
+        return (0, getTrustedInputBIP143_1.getTrustedInputBIP143)(this._transport, indexLookup, transaction, additionals);
     };
-    Btc.prototype.inferCorrectImpl = function () {
+    Btc.prototype.changeImplIfNecessary = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var appAndVersion, canUseNewImplementation;
+            var appAndVersion, isBtcLegacy;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, getAppAndVersion_1.getAppAndVersion)(this.transport)];
+                    case 0: return [4 /*yield*/, (0, getAppAndVersion_1.getAppAndVersion)(this._transport)];
                     case 1:
                         appAndVersion = _a.sent();
-                        canUseNewImplementation = (0, BtcNew_1.canSupportApp)(appAndVersion);
-                        if (!canUseNewImplementation) {
-                            return [2 /*return*/, this.old()];
-                        }
-                        else {
-                            return [2 /*return*/, this["new"]()];
+                        if (!(appAndVersion.name === "Exchange" && this._impl instanceof BtcNew_1["default"])) return [3 /*break*/, 3];
+                        return [4 /*yield*/, (0, getAppAndVersion_1.checkIsBtcLegacy)(this._transport)];
+                    case 2:
+                        isBtcLegacy = _a.sent();
+                        if (isBtcLegacy) {
+                            this._impl = new BtcOld_1["default"](this._transport);
                         }
-                        return [2 /*return*/];
+                        _a.label = 3;
+                    case 3: return [2 /*return*/, this._impl];
                 }
             });
         });
     };
-    Btc.prototype.old = function () {
-        return new BtcOld_1["default"](this.transport);
-    };
-    Btc.prototype["new"] = function () {
-        return new BtcNew_1["default"](new appClient_1.AppClient(this.transport));
-    };
     return Btc;
 }());
 exports["default"] = Btc;
-function isPathNormal(path) {
-    //path is not deepest hardened node of a standard path or deeper, use BtcOld
-    var h = 0x80000000;
-    var pathElems = (0, bip32_1.pathStringToArray)(path);
-    var hard = function (n) { return n >= h; };
-    var soft = function (n) { return !n || n < h; };
-    var change = function (n) { return !n || n == 0 || n == 1; };
-    if (pathElems.length >= 3 &&
-        pathElems.length <= 5 &&
-        [44 + h, 49 + h, 84 + h, 86 + h].some(function (v) { return v == pathElems[0]; }) &&
-        [0 + h, 1 + h].some(function (v) { return v == pathElems[1]; }) &&
-        hard(pathElems[2]) &&
-        change(pathElems[3]) &&
-        soft(pathElems[4])) {
-        return true;
-    }
-    if (pathElems.length >= 4 &&
-        pathElems.length <= 6 &&
-        48 + h == pathElems[0] &&
-        [0 + h, 1 + h].some(function (v) { return v == pathElems[1]; }) &&
-        hard(pathElems[2]) &&
-        hard(pathElems[3]) &&
-        change(pathElems[4]) &&
-        soft(pathElems[5])) {
-        return true;
-    }
-    return false;
-}
 //# sourceMappingURL=Btc.js.map