@ledgerhq/live-common 21.16.1 → 21.17.0

package/src/currencies/support.ts

@@ -9,6 +9,7 @@ import {
   hasCryptoCurrencyId,
 } from "@ledgerhq/cryptoassets";
 import { getEnv } from "../env";
+
 // set by user side effect to precise which currencies are considered supported (typically by live)
 let userSupportedCurrencies: CryptoCurrency[] = [];
 let userSupportedFiats: FiatCurrency[] = [];

package/src/families/bitcoin/bech32m.ts

@@ -0,0 +1,197 @@
+// Ported from https://github.com/bitcoinjs/bech32/tree/605655d6b37a782345549cd1388db688a96ad56f
+// until we can use bech32 2.0.0
+// We can't directly use bech32 2.0.0 because many of our dependencies are still using bech32 ^1.1.3
+// which conflict on mobile (root cause of https://ledgerhq.atlassian.net/browse/LL-7930)
+// FIXME Remove that file and use bech32 2.0.0 when all dependencies also uses it.
+
+const ENCODING_CONST = 0x2bc830a3;
+const ALPHABET = "qpzry9x8gf2tvdw0s3jn54khce6mua7l";
+const ALPHABET_MAP: { [key: string]: number } = {};
+for (let z = 0; z < ALPHABET.length; z++) {
+  const x = ALPHABET.charAt(z);
+  ALPHABET_MAP[x] = z;
+}
+
+function prefixChk(prefix) {
+  let chk = 1;
+  for (let i = 0; i < prefix.length; ++i) {
+    const c = prefix.charCodeAt(i);
+    if (c < 33 || c > 126) return "Invalid prefix (" + prefix + ")";
+    chk = polymodStep(chk) ^ (c >> 5);
+  }
+  chk = polymodStep(chk);
+  for (let i = 0; i < prefix.length; ++i) {
+    const v = prefix.charCodeAt(i);
+    chk = polymodStep(chk) ^ (v & 0x1f);
+  }
+  return chk;
+}
+
+function polymodStep(pre: number): number {
+  const b = pre >> 25;
+  return (
+    ((pre & 0x1ffffff) << 5) ^
+    (-((b >> 0) & 1) & 0x3b6a57b2) ^
+    (-((b >> 1) & 1) & 0x26508e6d) ^
+    (-((b >> 2) & 1) & 0x1ea119fa) ^
+    (-((b >> 3) & 1) & 0x3d4233dd) ^
+    (-((b >> 4) & 1) & 0x2a1462b3)
+  );
+}
+
+function encode(
+  prefix: string,
+  words: ArrayLike<number>,
+  LIMIT?: number
+): string {
+  LIMIT = LIMIT || 90;
+  if (prefix.length + 7 + words.length > LIMIT)
+    throw new TypeError("Exceeds length limit");
+
+  prefix = prefix.toLowerCase();
+
+  // determine chk mod
+  let chk = prefixChk(prefix);
+  if (typeof chk === "string") throw new Error(chk);
+
+  let result = prefix + "1";
+  for (let i = 0; i < words.length; ++i) {
+    const x = words[i];
+    if (x >> 5 !== 0) throw new Error("Non 5-bit word");
+
+    chk = polymodStep(chk) ^ x;
+    result += ALPHABET.charAt(x);
+  }
+
+  for (let i = 0; i < 6; ++i) {
+    chk = polymodStep(chk);
+  }
+  chk ^= ENCODING_CONST;
+
+  for (let i = 0; i < 6; ++i) {
+    const v = (chk >> ((5 - i) * 5)) & 0x1f;
+    result += ALPHABET.charAt(v);
+  }
+
+  return result;
+}
+
+function __decode(str: string, LIMIT?: number) {
+  LIMIT = LIMIT || 90;
+  if (str.length < 8) return str + " too short";
+  if (str.length > LIMIT) return "Exceeds length limit";
+
+  // don't allow mixed case
+  const lowered = str.toLowerCase();
+  const uppered = str.toUpperCase();
+  if (str !== lowered && str !== uppered) return "Mixed-case string " + str;
+  str = lowered;
+
+  const split = str.lastIndexOf("1");
+  if (split === -1) return "No separator character for " + str;
+  if (split === 0) return "Missing prefix for " + str;
+
+  const prefix = str.slice(0, split);
+  const wordChars = str.slice(split + 1);
+  if (wordChars.length < 6) return "Data too short";
+
+  let chk = prefixChk(prefix);
+  if (typeof chk === "string") return chk;
+
+  const words: number[] = [];
+  for (let i = 0; i < wordChars.length; ++i) {
+    const c = wordChars.charAt(i);
+    const v = ALPHABET_MAP[c];
+    if (v === undefined) return "Unknown character " + c;
+    chk = polymodStep(chk) ^ v;
+
+    // not in the checksum?
+    if (i + 6 >= wordChars.length) continue;
+    words.push(v);
+  }
+
+  if (chk !== ENCODING_CONST) return "Invalid checksum for " + str;
+  return { prefix, words };
+}
+
+function decodeUnsafe(str: string, LIMIT?: number) {
+  const res = __decode(str, LIMIT);
+  if (typeof res === "object") return res;
+}
+
+function decode(str: string, LIMIT?: number) {
+  const res = __decode(str, LIMIT);
+  if (typeof res === "object") return res;
+
+  throw new Error(res);
+}
+
+function convert(
+  data: ArrayLike<number>,
+  inBits: number,
+  outBits: number,
+  pad: true
+): number[];
+function convert(
+  data: ArrayLike<number>,
+  inBits: number,
+  outBits: number,
+  pad: false
+): number[] | string;
+function convert(
+  data: ArrayLike<number>,
+  inBits: number,
+  outBits: number,
+  pad: boolean
+): number[] | string {
+  let value = 0;
+  let bits = 0;
+  const maxV = (1 << outBits) - 1;
+
+  const result: number[] = [];
+  for (let i = 0; i < data.length; ++i) {
+    value = (value << inBits) | data[i];
+    bits += inBits;
+
+    while (bits >= outBits) {
+      bits -= outBits;
+      result.push((value >> bits) & maxV);
+    }
+  }
+
+  if (pad) {
+    if (bits > 0) {
+      result.push((value << (outBits - bits)) & maxV);
+    }
+  } else {
+    if (bits >= inBits) return "Excess padding";
+    if ((value << (outBits - bits)) & maxV) return "Non-zero padding";
+  }
+
+  return result;
+}
+
+function toWords(bytes: ArrayLike<number>): number[] {
+  return convert(bytes, 8, 5, true);
+}
+
+function fromWordsUnsafe(words: ArrayLike<number>): number[] | undefined {
+  const res = convert(words, 5, 8, false);
+  if (Array.isArray(res)) return res;
+}
+
+function fromWords(words: ArrayLike<number>): number[] {
+  const res = convert(words, 5, 8, false);
+  if (Array.isArray(res)) return res;
+
+  throw new Error(res);
+}
+
+export const bech32m = {
+  decodeUnsafe,
+  decode,
+  encode,
+  toWords,
+  fromWordsUnsafe,
+  fromWords,
+};

package/src/families/bitcoin/js-buildTransaction.ts

@@ -44,7 +44,8 @@ export const buildTransaction = async (
     walletAccount,
     transaction.feePerByte.toNumber(), //!\ wallet-btc handles fees as JS number
     transaction.utxoStrategy.excludeUTXOs,
-    transaction.utxoStrategy.pickUnconfirmedRBF
+    transaction.utxoStrategy.pickUnconfirmedRBF,
+    [transaction.recipient]
   );
   log("btcwallet", "building transaction", transaction);
   const txInfo = await wallet.buildAccountTx({

package/src/families/bitcoin/js-estimateMaxSpendable.ts

@@ -30,7 +30,8 @@ const estimateMaxSpendable = async ({
     walletAccount,
     feePerByte.toNumber(), //!\ wallet-btc handles fees as JS number
     transaction?.utxoStrategy?.excludeUTXOs || [],
-    transaction?.utxoStrategy?.pickUnconfirmedRBF || false
+    transaction?.utxoStrategy?.pickUnconfirmedRBF || false,
+    transaction ? [transaction.recipient] : []
   );
   return maxSpendable.lt(0) ? new BigNumber(0) : maxSpendable;
 };

package/src/families/bitcoin/js-synchronisation.ts

@@ -139,8 +139,10 @@ const mapTxToOperations = (
     if (output.address) {
       if (!accountAddresses.includes(output.address)) {
         // The output doesn't belong to this account
-        if (output.output_index < changeOutputIndex) {
-          // The output isn't the change output
+        if (
+          tx.outputs.length === 1 || // The transaction has only 1 output
+          output.output_index < changeOutputIndex // The output isn't the change output
+        ) {
           recipients.push(
             syncReplaceAddress
               ? syncReplaceAddress(output.address)

package/src/families/bitcoin/wallet-btc/crypto/bitcoin.ts

@@ -1,9 +1,10 @@
 // from https://github.com/LedgerHQ/xpub-scan/blob/master/src/actions/deriveAddresses.ts
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import { bech32, bech32m } from "bech32";
+
+import * as bech32 from "bech32";
+import { bech32m } from "../../bech32m";
 import * as bjs from "bitcoinjs-lib";
 import { publicKeyTweakAdd } from "secp256k1";
+import { InvalidAddress } from "@ledgerhq/errors";
 import { DerivationModes } from "../types";
 import Base from "./base";
 
@@ -87,7 +88,7 @@ class Bitcoin extends Base {
     // Make sure the address is valid on this network
     // otherwise we can't call toOutputScriptTemporary.
     if (!this.validateAddress(address)) {
-      throw new Error("Invalid address");
+      throw new InvalidAddress();
     }
     // bitcoinjs-lib/src/address doesn't yet have released support for bech32m,
     // so we'll implement our own version of toOutputScript while waiting.

package/src/families/bitcoin/wallet-btc/crypto/bitcoincash.ts

@@ -5,6 +5,7 @@ import bchaddr from "bchaddrjs";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { toOutputScript } from "bitcoinjs-lib/src/address";
+import { InvalidAddress } from "@ledgerhq/errors";
 import { DerivationModes } from "../types";
 import { ICrypto } from "./types";
 
@@ -60,7 +61,7 @@ class BitcoinCash implements ICrypto {
 
   toOutputScript(address: string) {
     if (!this.validateAddress(address)) {
-      throw new Error("Invalid address");
+      throw new InvalidAddress();
     }
     // TODO find a better way to calculate the script from bch address instead of converting to bitcoin address
     return toOutputScript(bchaddr.toLegacyAddress(address), this.network);

package/src/families/bitcoin/wallet-btc/crypto/digibyte.ts

@@ -1,4 +1,4 @@
-import { bech32 } from "bech32";
+import * as bech32 from "bech32";
 import bs58check from "bs58check";
 import Base from "./base";
 

package/src/families/bitcoin/wallet-btc/crypto/litecoin.ts

@@ -3,7 +3,7 @@ import * as bip32 from "bip32";
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { toOutputScript } from "bitcoinjs-lib/src/address";
-import { bech32 } from "bech32";
+import * as bech32 from "bech32";
 import { DerivationModes } from "../types";
 import { ICrypto } from "./types";
 import Base from "./base";

package/src/families/bitcoin/wallet-btc/crypto/zec.ts

@@ -5,9 +5,10 @@ import { toOutputScript } from "bitcoinjs-lib/src/address";
 // @ts-ignore
 import zec from "zcash-bitcore-lib";
 import bs58check from "bs58check";
+import coininfo from "coininfo";
+import { InvalidAddress } from "@ledgerhq/errors";
 import { DerivationModes } from "../types";
 import { ICrypto } from "./types";
-import coininfo from "coininfo";
 
 class ZCash implements ICrypto {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -61,7 +62,7 @@ class ZCash implements ICrypto {
 
   toOutputScript(address: string) {
     if (!this.validateAddress(address)) {
-      throw new Error("Invalid address");
+      throw new InvalidAddress();
     }
     // TODO find a better way to calculate the script from zec address instead of converting to bitcoin address
     return toOutputScript(

package/src/families/bitcoin/wallet-btc/crypto/zen.ts

@@ -5,9 +5,10 @@ import { toOutputScript } from "bitcoinjs-lib/src/address";
 // @ts-ignore
 import zec from "zcash-bitcore-lib";
 import bs58check from "bs58check";
+import coininfo from "coininfo";
+import { InvalidAddress } from "@ledgerhq/errors";
 import { DerivationModes } from "../types";
 import { ICrypto } from "./types";
-import coininfo from "coininfo";
 
 class Zen implements ICrypto {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -81,13 +82,18 @@ class Zen implements ICrypto {
 
   toOutputScript(address: string) {
     if (!this.validateAddress(address)) {
-      throw new Error("Invalid address");
+      throw new InvalidAddress();
     }
-    // TODO find a better way to calculate the script from zen address instead of converting to bitcoin address
-    return toOutputScript(
+    const outputScript = toOutputScript(
       Zen.toBitcoinAddr(address),
       coininfo.bitcoin.main.toBitcoinJS()
     );
+    // refer to https://github.com/LedgerHQ/lib-ledger-core/blob/fc9d762b83fc2b269d072b662065747a64ab2816/core/src/wallet/bitcoin/scripts/BitcoinLikeScript.cpp#L139 and https://github.com/LedgerHQ/lib-ledger-core/blob/fc9d762b83fc2b269d072b662065747a64ab2816/core/src/wallet/bitcoin/networks.cpp#L39 for bip115 Script and its network parameters
+    const bip115Script = Buffer.from(
+      "209ec9845acb02fab24e1c0368b3b517c1a4488fba97f0e3459ac053ea0100000003c01f02b4",
+      "hex"
+    );
+    return Buffer.concat([outputScript, bip115Script]);
   }
 
   // eslint-disable-next-line class-methods-use-this

package/src/families/bitcoin/wallet-btc/pickingstrategies/CoinSelect.ts

@@ -7,14 +7,14 @@ import { PickingStrategy } from "./types";
 import * as utils from "../utils";
 import { DeepFirst } from "./DeepFirst";
 import { log } from "@ledgerhq/logs";
+import { OutputInfo } from "..";
 
 export class CoinSelect extends PickingStrategy {
   // eslint-disable-next-line class-methods-use-this
   async selectUnspentUtxosToUse(
     xpub: Xpub,
-    amount: BigNumber,
-    feePerByte: number,
-    nbOutputsWithoutChange: number
+    outputs: OutputInfo[],
+    feePerByte: number
   ) {
     // get the utxos to use as input
     // from all addresses of the account
@@ -34,18 +34,30 @@ export class CoinSelect extends PickingStrategy {
     const TOTAL_TRIES = 100000;
     log("picking strategy", "utxos", unspentUtxos);
     // Compute cost of change
-    const fixedSize = utils.accurateTxSize(
-      0,
+    const fixedSize = utils.maxTxSize(
       0,
+      [],
+      false,
       this.crypto,
       this.derivationMode
     );
+    const outputAddresses = outputs.map((o) => o.address);
     // Size of only 1 output (without fixed size)
     const oneOutputSize =
-      utils.accurateTxSize(0, 1, this.crypto, this.derivationMode) - fixedSize;
+      outputAddresses.length > 0
+        ? utils.maxTxSize(
+            0,
+            [outputAddresses[0]],
+            false,
+            this.crypto,
+            this.derivationMode
+          ) - fixedSize
+        : utils.maxTxSize(0, [], true, this.crypto, this.derivationMode) -
+          fixedSize;
     // Size 1 signed UTXO (signed input)
     const oneInputSize =
-      utils.accurateTxSize(1, 0, this.crypto, this.derivationMode) - fixedSize;
+      utils.maxTxSize(1, [], false, this.crypto, this.derivationMode) -
+      fixedSize;
 
     // Calculate effective value of outputs
     let currentAvailableValue = 0;
@@ -70,12 +82,16 @@ export class CoinSelect extends PickingStrategy {
     // Get no inputs fees
     // At beginning, there are no outputs in tx, so noInputFees are fixed fees
     const notInputFees =
-      feePerByte * (fixedSize + oneOutputSize * nbOutputsWithoutChange);
+      feePerByte * (fixedSize + oneOutputSize * outputs.length);
 
     // Start coin selection algorithm (according to SelectCoinBnb from Bitcoin Core)
     let currentValue = 0;
     const currentSelection: boolean[] = [];
 
+    const amount = outputs.reduce(
+      (sum, output) => sum.plus(output.value),
+      new BigNumber(0)
+    );
     // Actual amount we are targetting
     const actualTarget = notInputFees + amount.toNumber();
 
@@ -102,9 +118,10 @@ export class CoinSelect extends PickingStrategy {
           currentSelectionNeedChangeoutput = true;
           currentWaste =
             feePerByte *
-            utils.estimateTxSize(
+            utils.maxTxSizeCeil(
               nbInput,
-              nbOutputsWithoutChange + 1,
+              outputAddresses,
+              true,
               this.crypto,
               this.derivationMode
             );
@@ -113,9 +130,10 @@ export class CoinSelect extends PickingStrategy {
           currentSelectionNeedChangeoutput = false;
           currentWaste =
             feePerByte *
-              utils.estimateTxSize(
+              utils.maxTxSizeCeil(
                 nbInput,
-                nbOutputsWithoutChange,
+                outputAddresses,
+                false,
                 this.crypto,
                 this.derivationMode
               ) +
@@ -170,11 +188,10 @@ export class CoinSelect extends PickingStrategy {
       }
       const fee =
         feePerByte *
-        utils.estimateTxSize(
+        utils.maxTxSizeCeil(
           unspentUtxoSelected.length,
-          bestSelectionNeedChangeoutput
-            ? nbOutputsWithoutChange + 1
-            : nbOutputsWithoutChange,
+          outputAddresses,
+          bestSelectionNeedChangeoutput,
           this.crypto,
           this.derivationMode
         );
@@ -191,11 +208,6 @@ export class CoinSelect extends PickingStrategy {
       this.derivationMode,
       this.excludedUTXOs
     );
-    return pickingStrategy.selectUnspentUtxosToUse(
-      xpub,
-      amount,
-      feePerByte,
-      nbOutputsWithoutChange
-    );
+    return pickingStrategy.selectUnspentUtxosToUse(xpub, outputs, feePerByte);
   }
 }

package/src/families/bitcoin/wallet-btc/pickingstrategies/DeepFirst.ts

@@ -6,14 +6,14 @@ import Xpub from "../xpub";
 import { PickingStrategy } from "./types";
 import * as utils from "../utils";
 import { log } from "@ledgerhq/logs";
+import { OutputInfo } from "..";
 
 export class DeepFirst extends PickingStrategy {
   // eslint-disable-next-line class-methods-use-this
   async selectUnspentUtxosToUse(
     xpub: Xpub,
-    amount: BigNumber,
-    feePerByte: number,
-    nbOutputsWithoutChange: number
+    outputs: OutputInfo[],
+    feePerByte: number
   ) {
     // get the utxos to use as input
     // from all addresses of the account
@@ -31,26 +31,47 @@ export class DeepFirst extends PickingStrategy {
         ).length
     );
 
+    const outputAddresses = outputs.map((o) => o.address);
     unspentUtxos = sortBy(unspentUtxos, "block_height");
     // https://metamug.com/article/security/bitcoin-transaction-fee-satoshi-per-byte.html
-    const txSizeNoInput = utils.accurateTxSize(
+    const txSizeNoInput = utils.maxTxSize(
       0,
-      nbOutputsWithoutChange,
+      outputAddresses,
+      false,
       this.crypto,
       this.derivationMode
     );
     let fee = txSizeNoInput * feePerByte;
+    const emptyTxSize = utils.maxTxSizeCeil(
+      0,
+      [],
+      false,
+      this.crypto,
+      this.derivationMode
+    );
     const sizePerInput =
-      utils.accurateTxSize(1, 0, this.crypto, this.derivationMode) -
-      utils.accurateTxSize(0, 0, this.crypto, this.derivationMode);
+      utils.maxTxSize(1, [], false, this.crypto, this.derivationMode) -
+      emptyTxSize;
 
     const sizePerOutput =
-      utils.accurateTxSize(0, 1, this.crypto, this.derivationMode) -
-      utils.accurateTxSize(0, 0, this.crypto, this.derivationMode);
+      (outputAddresses[0]
+        ? utils.maxTxSize(
+            0,
+            [outputAddresses[0]],
+            false,
+            this.crypto,
+            this.derivationMode
+          )
+        : utils.maxTxSize(0, [], true, this.crypto, this.derivationMode)) -
+      emptyTxSize;
 
     let total = new BigNumber(0);
     const unspentUtxoSelected: Output[] = [];
 
+    const amount = outputs.reduce(
+      (sum, output) => sum.plus(output.value),
+      new BigNumber(0)
+    );
     let i = 0;
     while (total.lt(amount.plus(fee))) {
       if (!unspentUtxos[i]) {

package/src/families/bitcoin/wallet-btc/pickingstrategies/Merge.ts

@@ -6,14 +6,14 @@ import Xpub from "../xpub";
 import { PickingStrategy } from "./types";
 import * as utils from "../utils";
 import { log } from "@ledgerhq/logs";
+import { OutputInfo } from "..";
 
 export class Merge extends PickingStrategy {
   // eslint-disable-next-line class-methods-use-this
   async selectUnspentUtxosToUse(
     xpub: Xpub,
-    amount: BigNumber,
-    feePerByte: number,
-    nbOutputsWithoutChange: number
+    outputs: OutputInfo[],
+    feePerByte: number
   ) {
     // get the utxos to use as input
     // from all addresses of the account
@@ -31,19 +31,36 @@ export class Merge extends PickingStrategy {
         ).length
     );
 
+    const outputAddresses = outputs.map((o) => o.address);
+    const emptyTxSize = utils.maxTxSizeCeil(
+      0,
+      [],
+      false,
+      this.crypto,
+      this.derivationMode
+    );
     const sizePerInput =
-      utils.accurateTxSize(1, 0, this.crypto, this.derivationMode) -
-      utils.accurateTxSize(0, 0, this.crypto, this.derivationMode);
+      utils.maxTxSize(1, [], false, this.crypto, this.derivationMode) -
+      emptyTxSize;
 
     const sizePerOutput =
-      utils.accurateTxSize(0, 1, this.crypto, this.derivationMode) -
-      utils.accurateTxSize(0, 0, this.crypto, this.derivationMode);
+      (outputAddresses[0]
+        ? utils.maxTxSize(
+            0,
+            [outputAddresses[0]],
+            false,
+            this.crypto,
+            this.derivationMode
+          )
+        : utils.maxTxSize(0, [], true, this.crypto, this.derivationMode)) -
+      emptyTxSize;
 
     unspentUtxos = sortBy(unspentUtxos, (utxo) => parseInt(utxo.value, 10));
     // https://metamug.com/article/security/bitcoin-transaction-fee-satoshi-per-byte.html
-    const txSizeNoInput = utils.accurateTxSize(
+    const txSizeNoInput = utils.maxTxSize(
       0,
-      nbOutputsWithoutChange,
+      outputAddresses,
+      false,
       this.crypto,
       this.derivationMode
     );
@@ -53,6 +70,10 @@ export class Merge extends PickingStrategy {
     const unspentUtxoSelected: Output[] = [];
 
     let i = 0;
+    const amount = outputs.reduce(
+      (sum, output) => sum.plus(output.value),
+      new BigNumber(0)
+    );
     while (total.lt(amount.plus(fee))) {
       if (!unspentUtxos[i]) {
         throw new NotEnoughBalance();

package/src/families/bitcoin/wallet-btc/pickingstrategies/types.ts

@@ -1,4 +1,5 @@
 import BigNumber from "bignumber.js";
+import { OutputInfo } from "..";
 import { ICrypto } from "../crypto/types";
 import { Output } from "../storage/types";
 import Xpub from "../xpub";
@@ -29,9 +30,8 @@ export abstract class PickingStrategy {
 
   abstract selectUnspentUtxosToUse(
     xpub: Xpub,
-    amount: BigNumber,
-    feePerByte: number,
-    nbOutputsWithoutChange: number
+    outputs: OutputInfo[],
+    feePerByte: number
   ): Promise<{
     unspentUtxos: Output[];
     totalValue: BigNumber;