@ledgerhq/hw-app-btc 6.25.1-alpha.3 → 6.27.2-nightly.0

package/src/newops/psbtv2.ts

@@ -427,9 +427,10 @@ export class PsbtV2 {
     this.writeBip32Derivation(buf, masterFingerprint, path);
     return buf.buffer();
   }
-  private decodeBip32Derivation(
-    buffer: Buffer
-  ): { masterFingerprint: Buffer; path: number[] } {
+  private decodeBip32Derivation(buffer: Buffer): {
+    masterFingerprint: Buffer;
+    path: number[];
+  } {
     const buf = new BufferReader(buffer);
     return this.readBip32Derivation(buf);
   }
@@ -443,9 +444,10 @@ export class PsbtV2 {
       buf.writeUInt32(element);
     });
   }
-  private readBip32Derivation(
-    buf: BufferReader
-  ): { masterFingerprint: Buffer; path: number[] } {
+  private readBip32Derivation(buf: BufferReader): {
+    masterFingerprint: Buffer;
+    path: number[];
+  } {
     const masterFingerprint = buf.readSlice(4);
     const path: number[] = [];
     while (buf.offset < buf.buffer.length) {
@@ -466,9 +468,11 @@ export class PsbtV2 {
     this.writeBip32Derivation(buf, masterFingerprint, path);
     return buf.buffer();
   }
-  private decodeTapBip32Derivation(
-    buffer: Buffer
-  ): { hashes: Buffer[]; masterFingerprint: Buffer; path: number[] } {
+  private decodeTapBip32Derivation(buffer: Buffer): {
+    hashes: Buffer[];
+    masterFingerprint: Buffer;
+    path: number[];
+  } {
     const buf = new BufferReader(buffer);
     const hashCount = buf.readVarInt();
     const hashes: Buffer[] = [];

package/LICENSE

@@ -1,202 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-

package/lib-es/Btc.js.flow

@@ -1,280 +0,0 @@
-//@flow
-import type Transport from "@ledgerhq/hw-transport";
-import { signMessage } from "./signMessage";
-import { getWalletPublicKey } from "./getWalletPublicKey";
-import type { AddressFormat } from "./getWalletPublicKey";
-import { splitTransaction } from "./splitTransaction";
-import { getTrustedInput } from "./getTrustedInput";
-import { getTrustedInputBIP143 } from "./getTrustedInputBIP143";
-import type { Transaction } from "./types";
-import { createTransaction } from "./createTransaction";
-import type { CreateTransactionArg } from "./createTransaction";
-import { signP2SHTransaction } from "./signP2SHTransaction";
-import type { SignP2SHTransactionArg } from "./signP2SHTransaction";
-import { serializeTransactionOutputs } from "./serializeTransaction";
-
-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 = "BTC") {
-    this.transport = transport;
-    transport.decorateAppAPIMethods(
-      this,
-      [
-        "getWalletPublicKey",
-        "signP2SHTransaction",
-        "signMessageNew",
-        "createPaymentTransactionNew",
-        "getTrustedInput",
-        "getTrustedInputBIP143",
-      ],
-      scrambleKey
-    );
-  }
-
-  /**
-   * @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" | "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
-   *
-   * - 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?: boolean | { verify?: boolean, format?: AddressFormat }
-  ): Promise<{
-    publicKey: string,
-    bitcoinAddress: string,
-    chainCode: string,
-  }> {
-    let 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,
-        format: arguments[2] ? "p2sh" : "legacy",
-      };
-    } else {
-      options = opts || {};
-    }
-    return getWalletPublicKey(this.transport, { ...options, path });
-  }
-
-  /**
-   * 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 }> {
-    return signMessage(this.transport, { 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
-   * @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
-   * @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
-   * - "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
-   * @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) {
-    if (arguments.length > 1) {
-      console.warn(
-        "@ledgerhq/hw-app-btc: createPaymentTransactionNew multi argument signature is deprecated. please switch to named parameters."
-      );
-      arg = fromDeprecateArguments(arguments, [
-        "inputs",
-        "associatedKeysets",
-        "changePath",
-        "outputScriptHex",
-        "lockTime",
-        "sigHashType",
-        "segwit",
-        "initialTimestamp",
-        "additionals",
-        "expiryHeight",
-        "useTrustedInputForSegwit",
-      ]);
-    }
-    return createTransaction(this.transport, 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 => ...);
-   */
-  signP2SHTransaction(arg: SignP2SHTransactionArg) {
-    if (arguments.length > 1) {
-      console.warn(
-        "@ledgerhq/hw-app-btc: signP2SHTransaction multi argument signature is deprecated. please switch to named parameters."
-      );
-      const [
-        inputs,
-        associatedKeysets,
-        outputScriptHex,
-        lockTime,
-        sigHashType,
-        segwit,
-        transactionVersion,
-      ] = arguments;
-      arg = {
-        inputs,
-        associatedKeysets,
-        outputScriptHex,
-        lockTime,
-        sigHashType,
-        segwit,
-        transactionVersion,
-      };
-      arg = fromDeprecateArguments(arguments, [
-        "inputs",
-        "associatedKeysets",
-        "outputScriptHex",
-        "lockTime",
-        "sigHashType",
-        "segwit",
-        "transactionVersion",
-      ]);
-    }
-    return 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.
-   * @example
-const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
-   */
-  splitTransaction(
-    transactionHex: string,
-    isSegwitSupported: ?boolean = false,
-    hasTimestamp?: boolean = false,
-    hasExtraData?: boolean = false,
-    additionals: Array<string> = []
-  ): Transaction {
-    return splitTransaction(
-      transactionHex,
-      isSegwitSupported,
-      hasTimestamp,
-      hasExtraData,
-      additionals
-    );
-  }
-
-  /**
-  @example
-const tx1 = btc.splitTransaction("01000000014ea60aeac5252c14291d428915bd7ccd1bfc4af009f4d4dc57ae597ed0420b71010000008a47304402201f36a12c240dbf9e566bc04321050b1984cd6eaf6caee8f02bb0bfec08e3354b022012ee2aeadcbbfd1e92959f57c15c1c6debb757b798451b104665aa3010569b49014104090b15bde569386734abf2a2b99f9ca6a50656627e77de663ca7325702769986cf26cc9dd7fdea0af432c8e2becc867c932e1b9dd742f2a108997c2252e2bdebffffffff0281b72e00000000001976a91472a5d75c8d2d0565b656a5232703b167d50d5a2b88aca0860100000000001976a9144533f5fb9b4817f713c48f0bfe96b9f50c476c9b88ac00000000");
-const outputScript = btc.serializeTransactionOutputs(tx1).toString('hex');
-  */
-  serializeTransactionOutputs(t: Transaction): Buffer {
-    return serializeTransactionOutputs(t);
-  }
-
-  getTrustedInput(
-    indexLookup: number,
-    transaction: Transaction,
-    additionals: Array<string> = []
-  ): Promise<string> {
-    return getTrustedInput(
-      this.transport,
-      indexLookup,
-      transaction,
-      additionals
-    );
-  }
-
-  getTrustedInputBIP143(
-    indexLookup: number,
-    transaction: Transaction,
-    additionals: Array<string> = []
-  ): string {
-    return getTrustedInputBIP143(
-      this.transport,
-      indexLookup,
-      transaction,
-      additionals
-    );
-  }
-}
-
-function fromDeprecateArguments(args, keys) {
-  const obj = {};
-  keys.forEach((key, i) => {
-    const value = args[i];
-    if (value !== undefined) {
-      obj[key] = value;
-    }
-  });
-  return obj;
-}

package/lib-es/bip32.js.flow

@@ -1,13 +0,0 @@
-// @flow
-
-import bippath from "bip32-path";
-
-export function bip32asBuffer(path: string): Buffer {
-  const paths = !path ? [] : bippath.fromString(path).toPathArray();
-  let buffer = Buffer.alloc(1 + paths.length * 4);
-  buffer[0] = paths.length;
-  paths.forEach((element, index) => {
-    buffer.writeUInt32BE(element, 1 + 4 * index);
-  });
-  return buffer;
-}

package/lib-es/compressPublicKey.js.flow

@@ -1,8 +0,0 @@
-// @flow
-
-export function compressPublicKey(publicKey: Buffer): Buffer {
-  const prefix = (publicKey[64] & 1) !== 0 ? 0x03 : 0x02;
-  const prefixBuffer = Buffer.alloc(1);
-  prefixBuffer[0] = prefix;
-  return Buffer.concat([prefixBuffer, publicKey.slice(1, 1 + 32)]);
-}

package/lib-es/constants.js.flow

@@ -1,13 +0,0 @@
-// flow
-
-export const MAX_SCRIPT_BLOCK = 50;
-export const DEFAULT_VERSION = 1;
-export const DEFAULT_LOCKTIME = 0;
-export const DEFAULT_SEQUENCE = 0xffffffff;
-export const SIGHASH_ALL = 1;
-export const OP_DUP = 0x76;
-export const OP_HASH160 = 0xa9;
-export const HASH_SIZE = 0x14;
-export const OP_EQUALVERIFY = 0x88;
-export const OP_CHECKSIG = 0xac;
-export const OP_RETURN = 0x6a;