@ledgerhq/hw-app-btc 6.24.1 → 6.25.1-alpha.3

package/lib-es/Btc.js.flow

@@ -0,0 +1,280 @@
+//@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

@@ -0,0 +1,13 @@
+// @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

@@ -0,0 +1,8 @@
+// @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

@@ -0,0 +1,13 @@
+// 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;