@ledgerhq/hw-app-btc 6.24.2-monorepo.0 → 6.24.2-monorepo.4

package/.turbo/turbo-build.log

@@ -1 +1,5 @@
-@ledgerhq/hw-app-btc:build: cache hit, replaying output e581e0d2100315c4
+@ledgerhq/hw-app-btc:build: cache hit, replaying output 35b2dc24fb93f7bd
+@ledgerhq/hw-app-btc:build: 
+@ledgerhq/hw-app-btc:build: > @ledgerhq/hw-app-btc@6.24.2-monorepo.4 build /home/runner/work/ledger-live/ledger-live/libs/ledgerjs/packages/hw-app-btc
+@ledgerhq/hw-app-btc:build: > bash ../../script/build.sh
+@ledgerhq/hw-app-btc:build: 

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @ledgerhq/hw-app-btc
 
+## 6.24.2-monorepo.4
+
+### Patch Changes
+
+- f6cb87454: test prerelease
+- Updated dependencies [f6cb87454]
+  - @ledgerhq/hw-transport@6.24.2-monorepo.4
+  - @ledgerhq/logs@6.10.1-monorepo.4
+
+## 6.24.2-monorepo.3
+
+### Patch Changes
+
+- 7f4a91716: clean pnpm-lock file
+- Updated dependencies [7f4a91716]
+  - @ledgerhq/hw-transport@6.24.2-monorepo.3
+  - @ledgerhq/logs@6.10.1-monorepo.3
+
+## 6.24.2-monorepo.2
+
+### Patch Changes
+
+- a439963a7: test prerelease
+- Updated dependencies [a439963a7]
+  - @ledgerhq/hw-transport@6.24.2-monorepo.2
+  - @ledgerhq/logs@6.10.1-monorepo.2
+
+## 6.24.2-monorepo.1
+
+### Patch Changes
+
+- 1b6fec9db: monorepo prelease 2
+- Updated dependencies [1b6fec9db]
+  - @ledgerhq/hw-transport@6.24.2-monorepo.1
+  - @ledgerhq/logs@6.10.1-monorepo.1
+
 ## 6.24.2-monorepo.0
 
 ### Patch Changes

package/lib/Btc.d.ts

@@ -0,0 +1,149 @@
+/// <reference types="node" />
+import type Transport from "@ledgerhq/hw-transport";
+import BtcNew from "./BtcNew";
+import BtcOld from "./BtcOld";
+import type { CreateTransactionArg } from "./createTransaction";
+import type { AddressFormat } from "./getWalletPublicKey";
+import type { SignP2SHTransactionArg } from "./signP2SHTransaction";
+import type { Transaction } from "./types";
+export type { AddressFormat };
+/**
+ * Bitcoin API.
+ *
+ * @example
+ * import Btc from "@ledgerhq/hw-app-btc";
+ * const btc = new Btc(transport)
+ */
+export default class Btc {
+    transport: Transport;
+    constructor(transport: Transport, scrambleKey?: string);
+    /**
+     * 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)
+     * @returns XPUB of the account
+     */
+    getWalletXpub(arg: {
+        path: string;
+        xpubVersion: number;
+    }): Promise<string>;
+    /**
+     * @param path a BIP 32 path
+     * @param options an object with optional these fields:
+     *
+     * - verify (boolean) will 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
+     *
+     * - p2sh format with 49' paths
+     *
+     * - bech32 format with 84' paths
+     *
+     * - cashaddr in case of Bitcoin Cash
+     *
+     * @example
+     * btc.getWalletPublicKey("44'/0'/0'/0/0").then(o => o.bitcoinAddress)
+     * btc.getWalletPublicKey("49'/0'/0'/0/0", { format: "p2sh" }).then(o => o.bitcoinAddress)
+     */
+    getWalletPublicKey(path: string, opts?: {
+        verify?: boolean;
+        format?: AddressFormat;
+    }): Promise<{
+        publicKey: string;
+        bitcoinAddress: string;
+        chainCode: string;
+    }>;
+    /**
+     * 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) {
+       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<{
+        v: number;
+        r: string;
+        s: string;
+    }>;
+    /**
+     * To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
+     * @param inputs is an array of [ transaction, output_index, optional 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 optional redeem script to use when consuming a Segregated Witness input
+     * * sequence is the sequence number to use for this input (when using RBF), or non present
+     * @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
+     * @param changePath is an optional BIP 32 path pointing to the path to the public key used to compute the change address
+     * @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign, including leading vararg voutCount
+     * @param lockTime is the optional lockTime of the transaction to sign, or default (0)
+     * @param sigHashType is the hash type of the transaction to sign, or default (all)
+     * @param segwit is an optional boolean indicating wether to use segwit or not. This includes wrapped segwit.
+     * @param initialTimestamp is an optional timestamp of the function call to use for coins that necessitate timestamps only, (not the one that the tx will include)
+     * @param additionals list of additionnal options
+     *
+     * - "bech32" for spending native segwit outputs
+     * - "bech32m" for spending segwit v1+ outputs
+     * - "abc" for bch
+     * - "gold" for btg
+     * - "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
+     * @param useTrustedInputForSegwit trust inputs for segwit transactions. If app version >= 1.4.0 this should be true.
+     * @return the signed transaction ready to be broadcast
+     * @example
+    btc.createTransaction({
+     inputs: [ [tx1, 1] ],
+     associatedKeysets: ["0'/0/0"],
+     outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
+    }).then(res => ...);
+     */
+    createPaymentTransactionNew(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
+     * * 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
+     * @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
+     * @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign
+     * @param lockTime is the optional lockTime of the transaction to sign, or default (0)
+     * @param sigHashType is the hash type of the transaction to sign, or default (all)
+     * @return the signed transaction ready to be broadcast
+     * @example
+    btc.signP2SHTransaction({
+    inputs: [ [tx, 1, "52210289b4a3ad52a919abd2bdd6920d8a6879b1e788c38aa76f0440a6f32a9f1996d02103a3393b1439d1693b063482c04bd40142db97bdf139eedd1b51ffb7070a37eac321030b9a409a1e476b0d5d17b804fcdb81cf30f9b99c6f3ae1178206e08bc500639853ae"] ],
+    associatedKeysets: ["0'/0/0"],
+    outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
+    }).then(result => ...);
+     */
+    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.
+     * @example
+    const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
+     */
+    splitTransaction(transactionHex: string, isSegwitSupported?: boolean | null | undefined, hasTimestamp?: boolean, hasExtraData?: boolean, additionals?: Array<string>): Transaction;
+    /**
+    @example
+    const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
+    const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
+    */
+    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;
+}
+//# sourceMappingURL=Btc.d.ts.map

package/lib/Btc.d.ts.map

@@ -0,0 +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"}

package/lib/Btc.js

@@ -0,0 +1,357 @@
+"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) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+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 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");
+/**
+ * Bitcoin API.
+ *
+ * @example
+ * import Btc from "@ledgerhq/hw-app-btc";
+ * const btc = new Btc(transport)
+ */
+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, [
+            "getWalletXpub",
+            "getWalletPublicKey",
+            "signP2SHTransaction",
+            "signMessageNew",
+            "createPaymentTransactionNew",
+            "getTrustedInput",
+            "getTrustedInputBIP143",
+        ], scrambleKey);
+    }
+    /**
+     * 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)
+     * @returns XPUB of the account
+     */
+    Btc.prototype.getWalletXpub = function (arg) {
+        return this.getCorrectImpl().then(function (impl) { return impl.getWalletXpub(arg); });
+    };
+    /**
+     * @param path a BIP 32 path
+     * @param options an object with optional these fields:
+     *
+     * - verify (boolean) will 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
+     *
+     * - p2sh format with 49' paths
+     *
+     * - bech32 format with 84' paths
+     *
+     * - cashaddr in case of Bitcoin Cash
+     *
+     * @example
+     * btc.getWalletPublicKey("44'/0'/0'/0/0").then(o => o.bitcoinAddress)
+     * 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 })");
+            options = {
+                verify: !!opts,
+                // eslint-disable-next-line prefer-rest-params
+                format: arguments[2] ? "p2sh" : "legacy"
+            };
+        }
+        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);
+            }
+        });
+    };
+    /**
+     * 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) {
+       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);
+    };
+    /**
+     * To sign a transaction involving standard (P2PKH) inputs, call createTransaction with the following parameters
+     * @param inputs is an array of [ transaction, output_index, optional 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 optional redeem script to use when consuming a Segregated Witness input
+     * * sequence is the sequence number to use for this input (when using RBF), or non present
+     * @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
+     * @param changePath is an optional BIP 32 path pointing to the path to the public key used to compute the change address
+     * @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign, including leading vararg voutCount
+     * @param lockTime is the optional lockTime of the transaction to sign, or default (0)
+     * @param sigHashType is the hash type of the transaction to sign, or default (all)
+     * @param segwit is an optional boolean indicating wether to use segwit or not. This includes wrapped segwit.
+     * @param initialTimestamp is an optional timestamp of the function call to use for coins that necessitate timestamps only, (not the one that the tx will include)
+     * @param additionals list of additionnal options
+     *
+     * - "bech32" for spending native segwit outputs
+     * - "bech32m" for spending segwit v1+ outputs
+     * - "abc" for bch
+     * - "gold" for btg
+     * - "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
+     * @param useTrustedInputForSegwit trust inputs for segwit transactions. If app version >= 1.4.0 this should be true.
+     * @return the signed transaction ready to be broadcast
+     * @example
+    btc.createTransaction({
+     inputs: [ [tx1, 1] ],
+     associatedKeysets: ["0'/0/0"],
+     outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
+    }).then(res => ...);
+     */
+    Btc.prototype.createPaymentTransactionNew = function (arg) {
+        if (arguments.length > 1) {
+            console.warn("@ledgerhq/hw-app-btc: createPaymentTransactionNew multi argument signature is deprecated. please switch to named parameters.");
+        }
+        return this.getCorrectImpl().then(function (impl) {
+            return impl.createPaymentTransactionNew(arg);
+        });
+    };
+    /**
+     * 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
+     * * 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
+     * @param associatedKeysets is an array of BIP 32 paths pointing to the path to the private key used for each UTXO
+     * @param outputScriptHex is the hexadecimal serialized outputs of the transaction to sign
+     * @param lockTime is the optional lockTime of the transaction to sign, or default (0)
+     * @param sigHashType is the hash type of the transaction to sign, or default (all)
+     * @return the signed transaction ready to be broadcast
+     * @example
+    btc.signP2SHTransaction({
+    inputs: [ [tx, 1, "52210289b4a3ad52a919abd2bdd6920d8a6879b1e788c38aa76f0440a6f32a9f1996d02103a3393b1439d1693b063482c04bd40142db97bdf139eedd1b51ffb7070a37eac321030b9a409a1e476b0d5d17b804fcdb81cf30f9b99c6f3ae1178206e08bc500639853ae"] ],
+    associatedKeysets: ["0'/0/0"],
+    outputScriptHex: "01905f0100000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88ac"
+    }).then(result => ...);
+     */
+    Btc.prototype.signP2SHTransaction = function (arg) {
+        return this.old().signP2SHTransaction(arg);
+    };
+    /**
+     * For each UTXO included in your transaction, create a transaction object from the raw serialized version of the transaction used in this UTXO.
+     * @example
+    const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
+     */
+    Btc.prototype.splitTransaction = function (transactionHex, isSegwitSupported, hasTimestamp, hasExtraData, additionals) {
+        if (isSegwitSupported === void 0) { isSegwitSupported = false; }
+        if (hasTimestamp === void 0) { hasTimestamp = false; }
+        if (hasExtraData === void 0) { hasExtraData = false; }
+        if (additionals === void 0) { additionals = []; }
+        return (0, splitTransaction_1.splitTransaction)(transactionHex, isSegwitSupported, hasTimestamp, hasExtraData, additionals);
+    };
+    /**
+    @example
+    const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
+    const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
+    */
+    Btc.prototype.serializeTransactionOutputs = function (t) {
+        return (0, serializeTransaction_1.serializeTransactionOutputs)(t);
+    };
+    Btc.prototype.getTrustedInput = function (indexLookup, transaction, additionals) {
+        if (additionals === void 0) { 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];
+                }
+            });
+        });
+    };
+    Btc.prototype.inferCorrectImpl = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var appAndVersion, canUseNewImplementation;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    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"]()];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    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

package/lib/Btc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Btc.js","sourceRoot":"","sources":["../src/Btc.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iCAA4C;AAC5C,iDAAiD;AACjD,oDAA8B;AAE9B,uDAAsD;AACtD,qDAAoD;AACpD,iEAAgE;AAEhE,gDAA+C;AAC/C,+DAAqE;AAErE,uDAAsD;AAGtD;;;;;;GAMG;AAEH;IAGE,aAAY,SAAoB,EAAE,WAAmB;QAAnB,4BAAA,EAAA,mBAAmB;QA4RrD,kDAAkD;QAC1C,cAAS,GAA2B,IAAI,CAAC;QA5R/C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,SAAS,CAAC,qBAAqB,CAC7B,IAAI,EACJ;YACE,eAAe;YACf,oBAAoB;YACpB,qBAAqB;YACrB,gBAAgB;YAChB,6BAA6B;YAC7B,iBAAiB;YACjB,uBAAuB;SACxB,EACD,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,2BAAa,GAAb,UAAc,GAA0C;QACtD,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAvB,CAAuB,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,gCAAkB,GAAlB,UACE,IAAY,EACZ,IAGC;QALH,iBAyFC;QA9EC,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,cAAc,EAAE,CAAC,IAAI,CAAC,UAAC,IAAI;YACrC;;;;;;;;;;;;;;;;;;;;;;eAsBG;YACH,IACE,IAAI,YAAY,mBAAM;gBACtB,OAAO,CAAC,MAAM,IAAI,SAAS;gBAC3B,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,IAAI,KAAK,CAAC;gBAC5C,CAAC,YAAY,CAAC,IAAI,CAAC,EACnB;gBACA,OAAO,CAAC,IAAI,CAAC,8lCA6BwC,CAAC,CAAC;gBACvD,OAAO,KAAI,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;aACrD;iBAAM;gBACL,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;aAC/C;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;OAQG;IACH,4BAAc,GAAd,UACE,IAAY,EACZ,UAAkB;QAMlB,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,yCAA2B,GAA3B,UAA4B,GAAyB;QACnD,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,OAAO,CAAC,IAAI,CACV,8HAA8H,CAC/H,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,UAAC,IAAI;YACrC,OAAO,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,iCAAmB,GAAnB,UAAoB,GAA2B;QAC7C,OAAO,IAAI,CAAC,GAAG,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,8BAAgB,GAAhB,UACE,cAAsB,EACtB,iBAAqD,EACrD,YAAoB,EACpB,YAAoB,EACpB,WAA+B;QAH/B,kCAAA,EAAA,yBAAqD;QACrD,6BAAA,EAAA,oBAAoB;QACpB,6BAAA,EAAA,oBAAoB;QACpB,4BAAA,EAAA,gBAA+B;QAE/B,OAAO,IAAA,mCAAgB,EACrB,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,WAAW,CACZ,CAAC;IACJ,CAAC;IAED;;;;MAIE;IACF,yCAA2B,GAA3B,UAA4B,CAAc;QACxC,OAAO,IAAA,kDAA2B,EAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,6BAAe,GAAf,UACE,WAAmB,EACnB,WAAwB,EACxB,WAA+B;QAA/B,4BAAA,EAAA,gBAA+B;QAE/B,OAAO,IAAA,iCAAe,EACpB,IAAI,CAAC,SAAS,EACd,WAAW,EACX,WAAW,EACX,WAAW,CACZ,CAAC;IACJ,CAAC;IAED,mCAAqB,GAArB,UACE,WAAmB,EACnB,WAAwB,EACxB,WAA+B;QAA/B,4BAAA,EAAA,gBAA+B;QAE/B,OAAO,IAAA,6CAAqB,EAC1B,IAAI,CAAC,SAAS,EACd,WAAW,EACX,WAAW,EACX,WAAW,CACZ,CAAC;IACJ,CAAC;IAIa,4BAAc,GAA5B;;;;;;wBACU,SAAS,GAAK,IAAI,UAAT,CAAU;wBAC3B,IAAI,SAAS;4BAAE,sBAAO,SAAS,EAAC;wBACnB,qBAAM,IAAI,CAAC,gBAAgB,EAAE,EAAA;;wBAApC,IAAI,GAAG,SAA6B;wBAC1C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;wBACtB,sBAAO,IAAI,EAAC;;;;KACb;IAEa,8BAAgB,GAA9B;;;;;4BACwB,qBAAM,IAAA,mCAAgB,EAAC,IAAI,CAAC,SAAS,CAAC,EAAA;;wBAAtD,aAAa,GAAG,SAAsC;wBACtD,uBAAuB,GAAG,IAAA,sBAAa,EAAC,aAAa,CAAC,CAAC;wBAC7D,IAAI,CAAC,uBAAuB,EAAE;4BAC5B,sBAAO,IAAI,CAAC,GAAG,EAAE,EAAC;yBACnB;6BAAM;4BACL,sBAAO,IAAI,CAAC,KAAG,CAAA,EAAE,EAAC;yBACnB;;;;;KACF;IAES,iBAAG,GAAb;QACE,OAAO,IAAI,mBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACpC,CAAC;IAES,cAAA,KAAG,CAAA,GAAb;QACE,OAAO,IAAI,mBAAM,CAAC,IAAI,qBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACnD,CAAC;IACH,UAAC;AAAD,CAAC,AA1TD,IA0TC;;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,4EAA4E;IAC5E,IAAM,CAAC,GAAG,UAAU,CAAC;IACrB,IAAM,SAAS,GAAG,IAAA,yBAAiB,EAAC,IAAI,CAAC,CAAC;IAE1C,IAAM,IAAI,GAAG,UAAC,CAAS,IAAK,OAAA,CAAC,IAAI,CAAC,EAAN,CAAM,CAAC;IACnC,IAAM,IAAI,GAAG,UAAC,CAAqB,IAAK,OAAA,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAX,CAAW,CAAC;IACpD,IAAM,MAAM,GAAG,UAAC,CAAqB,IAAK,OAAA,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAtB,CAAsB,CAAC;IAEjE,IACE,SAAS,CAAC,MAAM,IAAI,CAAC;QACrB,SAAS,CAAC,MAAM,IAAI,CAAC;QACrB,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAjB,CAAiB,CAAC;QAC/D,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAjB,CAAiB,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAClB;QACA,OAAO,IAAI,CAAC;KACb;IACD,IACE,SAAS,CAAC,MAAM,IAAI,CAAC;QACrB,SAAS,CAAC,MAAM,IAAI,CAAC;QACrB,EAAE,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC;QACtB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,EAAjB,CAAiB,CAAC;QAC7C,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAClB,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAClB;QACA,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}