LL-7930 Ensure bech32 version 1.1.x and 2.0.0 are not used together (#…

…1528)

* LL-7930 Fallback using bech32 ^1.1.3 instead of 2.0.0

* Revert wrong modif

* Update yarn.lock

* Fix from review

* Add jira ticket info

package.json

@@ -76,7 +76,7 @@
     "axios-retry": "^3.2.4",
     "base32-decode": "^1.0.0",
     "bchaddrjs": "^0.5.2",
-    "bech32": "^2.0.0",
+    "bech32": "^1.1.3",
     "bignumber.js": "^9.0.1",
     "bip32": "^2.0.6",
     "bip32-path": "^0.4.2",

src/__tests__/families/bitcoin/wallet-btc/utils.test.ts

@@ -1,4 +1,5 @@
-import { bech32m, bech32, BechLib } from "bech32";
+import * as bech32 from "bech32";
+import { bech32m } from "../../../../families/bitcoin/bech32m";
 import * as utils from "../../../../families/bitcoin/wallet-btc/utils";
 import { Currency } from "../../../../families/bitcoin/wallet-btc/crypto/types";
 import cryptoFactory from "../../../../families/bitcoin/wallet-btc/crypto/factory";
@@ -18,7 +19,8 @@ function toBech32(
   data: Buffer,
   version: number,
   prefix: string,
-  bech32variant: BechLib
+  //bech32variant: BechLib // FIXME Restore this
+  bech32variant: any
 ): string {
   const words = bech32.toWords(data);
   words.unshift(version);

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,
+};

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.

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);

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";
 

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";

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(

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,7 +82,7 @@ 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(

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

@@ -227,7 +227,6 @@ class BitcoinLikeWallet {
       btc,
       fromAccount,
       txInfo,
-      segwit,
       additionals,
       hasExtraData,
       onDeviceSignatureRequested,
@@ -260,7 +259,7 @@ class BitcoinLikeWallet {
     const inputs: Inputs = txInfo.inputs.map((i) => {
       log("hw", `splitTransaction`, {
         transactionHex: i.txHex,
-        isSegwitSupported: segwit,
+        isSegwitSupported: true,
         hasTimestamp: false,
         hasExtraData,
         additionals,

src/families/elrond/logic.ts

@@ -1,6 +1,6 @@
 import type { Account } from "../../types";
 import type { Transaction } from "./types";
-import { bech32 } from "bech32";
+import * as bech32 from "bech32";
 
 /**
  * The human-readable-part of the bech32 addresses.

yarn.lock

@@ -2609,7 +2609,7 @@ bchaddrjs@^0.5.2:
     cashaddrjs "0.4.4"
     stream-browserify "^3.0.0"
 
-[email protected], bech32@^1.1.2, bech32@^1.1.4:
+[email protected], bech32@^1.1.2, bech32@^1.1.3, bech32@^1.1.4:
   version "1.1.4"
   resolved "https://registry.npmjs.org/bech32/-/bech32-1.1.4.tgz"
   integrity sha512-s0IrSOzLlbvX7yp4WBfPITzpAU8sqQcpsmwXDiKwrG4r491vwCO/XpejasRNl0piBMe/DvP4Tz0mIS/X1DPJBQ==
@@ -2619,11 +2619,6 @@ bech32@=1.1.3:
   resolved "https://registry.yarnpkg.com/bech32/-/bech32-1.1.3.tgz#bd47a8986bbb3eec34a56a097a84b8d3e9a2dfcd"
   integrity sha512-yuVFUvrNcoJi0sv5phmqc6P+Fl1HjRDRNOOkHY2X/3LBy2bIGNSFx4fZ95HMaXHupuS7cZR15AsvtmCIF4UEyg==
 
-bech32@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/bech32/-/bech32-2.0.0.tgz#078d3686535075c8c79709f054b1b226a133b355"
-  integrity sha512-LcknSilhIGatDAsY1ak2I8VtGaHNhgMSYVxFrGLXv+xLHytaKZKcaUJJUE7qmBr7h33o5YQwP55pMI0xmkpJwg==
-
 benchmark@^2.1.4:
   version "2.1.4"
   resolved "https://registry.npmjs.org/benchmark/-/benchmark-2.1.4.tgz"