@ledgerhq/live-common 21.36.2 → 22.0.0

package/src/families/bitcoin/account.ts

@@ -30,7 +30,6 @@ export function formatOutput(account: Account, o: BitcoinOutput): string {
       showCode: false,
     }).padEnd(12),
     o.address,
-    o.path,
     o.isChange ? "(change)" : "",
     o.rbf ? "rbf" : "",
     o.hash,

package/src/families/bitcoin/bridge.test.ts

@@ -0,0 +1,6 @@
+import { setup } from "../../__tests__/test-helpers/libcore-setup";
+import { testBridge } from "../../__tests__/test-helpers/bridge";
+import dataset from "./test-dataset";
+
+setup("bitcoin");
+testBridge("bitcoin", dataset);

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

@@ -5,7 +5,7 @@ import { log } from "@ledgerhq/logs";
 import type { Account, Operation, SignOperationEvent } from "./../../types";
 import { isSegwitDerivationMode } from "./../../derivation";
 import { encodeOperationId } from "./../../operation";
-import { open, close } from "./../../hw";
+import { withDevice } from "../../hw/deviceAccess";
 import type { Transaction } from "./types";
 import { getNetworkParameters } from "./networks";
 import { buildTransaction } from "./js-buildTransaction";
@@ -22,14 +22,13 @@ const signOperation = ({
   deviceId: any;
   transaction: Transaction;
 }): Observable<SignOperationEvent> =>
-  Observable.create((o) => {
-    async function main() {
-      const { currency } = account;
-      const transport = await open(deviceId);
-      const hwApp = new Btc(transport);
-      const walletAccount = getWalletAccount(account);
-
-      try {
+  withDevice(deviceId)((transport) =>
+    Observable.create((o) => {
+      async function main() {
+        const { currency } = account;
+        const hwApp = new Btc(transport);
+        const walletAccount = getWalletAccount(account);
+
         log("hw", `signTransaction ${currency.id} for account ${account.id}`);
         const txInfo = await buildTransaction(account, transaction);
         let senders = new Set<string>();
@@ -48,11 +47,6 @@ const signOperation = ({
           fee = res.fees;
         });
 
-        // FIXME (legacy)
-        // should be `transaction.getLockTime()` as soon as lock time is
-        // handled by libcore (actually: it always returns a default value
-        // and that caused issue with zcash (see #904))
-        // cf. https://github.com/LedgerHQ/lib-ledger-core/blob/fc9d762b83fc2b269d072b662065747a64ab2816/core/src/wallet/bitcoin/transaction_builders/BitcoinLikeUtxoPicker.cpp#L156-L159
         let lockTime;
 
         // (legacy) Set lockTime for Komodo to enable reward claiming on UTXOs created by
@@ -152,15 +146,13 @@ const signOperation = ({
             expirationDate: null,
           },
         });
-      } finally {
-        close(transport, deviceId);
       }
-    }
 
-    main().then(
-      () => o.complete(),
-      (e) => o.error(e)
-    );
-  });
+      main().then(
+        () => o.complete(),
+        (e) => o.error(e)
+      );
+    })
+  );
 
 export default signOperation;

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

@@ -62,7 +62,6 @@ const fromWalletUtxo = (utxo: WalletOutput): BitcoinOutput => {
     value: new BigNumber(utxo.value),
     rbf: utxo.rbf,
     isChange: false, // wallet-btc limitation: doesn't provide it
-    path: "",
   };
 };
 

package/src/families/bitcoin/logic.ts

@@ -1,5 +1,4 @@
 import cashaddr from "cashaddrjs";
-import bchaddr from "bchaddrjs";
 import { Currency, isValidAddress } from "./wallet-btc";
 import { RecipientRequired, InvalidAddress } from "@ledgerhq/errors";
 import type { Account, CryptoCurrency, CryptoCurrencyIds } from "./../../types";
@@ -9,11 +8,7 @@ import type {
   Transaction,
   NetworkInfo,
   UtxoStrategy,
-  CoreBitcoinLikeOutput,
-  CoreBitcoinLikeInput,
-  BitcoinInput,
 } from "./types";
-import { libcoreAmountToBigNumber } from "../../libcore/buildBigNumber";
 
 // correspond ~ to min relay fees but determined empirically for a tx to be accepted by network
 const minFees = {
@@ -70,12 +65,6 @@ export const isValidRecipient = async (params: {
   }
   return Promise.resolve(null);
 };
-export function isChangeOutput(output: BitcoinOutput): boolean {
-  if (!output.path) return false;
-  const p = output.path.split("/");
-  return p[p.length - 2] === "1";
-}
-
 type UTXOStatus =
   | {
       excluded: true;
@@ -143,8 +132,8 @@ type CoinLogic = {
   injectGetAddressParams?: (arg0: Account) => any;
 };
 
-const bchToCashaddrAddressWithoutPrefix = (recipient) =>
-  recipient ? bchaddr.toCashAddress(recipient).split(":")[1] : recipient;
+export const bchToCashaddrAddressWithoutPrefix = (recipient) =>
+  recipient ? recipient.substring(recipient.indexOf(":") + 1) : recipient;
 
 export const perCoinLogic: Record<
   CryptoCurrencyIds,
@@ -192,67 +181,3 @@ export const perCoinLogic: Record<
     }),
   },
 };
-
-// vvvvv DEPRECATED - used only by legacy libcore implementation vvvvv
-
-export async function parseBitcoinInput(
-  input: CoreBitcoinLikeInput
-): Promise<BitcoinInput> {
-  const address = await input.getAddress();
-  const rawValue = await input.getValue();
-  const value = rawValue ? await libcoreAmountToBigNumber(rawValue) : null;
-  const previousTxHash = await input.getPreviousTxHash();
-  const previousOutputIndex = await input.getPreviousOutputIndex();
-  return {
-    address,
-    value,
-    previousTxHash,
-    previousOutputIndex,
-  };
-}
-
-export async function parseBitcoinOutput(
-  output: CoreBitcoinLikeOutput
-): Promise<BitcoinOutput> {
-  let blockHeight = await output.getBlockHeight();
-
-  if (!blockHeight || blockHeight < 0) {
-    blockHeight = undefined;
-  }
-
-  const hash = await output.getTransactionHash();
-  const outputIndex = await output.getOutputIndex();
-  const address = await output.getAddress();
-  const derivationPath = await output.getDerivationPath();
-  let path;
-
-  if (derivationPath) {
-    const isDerivationPathNull = await derivationPath.isNull();
-
-    if (!isDerivationPathNull) {
-      path = await derivationPath.toString();
-    }
-  }
-
-  const value = await libcoreAmountToBigNumber(await output.getValue());
-  const rbf = false; // this is unsafe to generically call this at the moment. libcore segfault.
-
-  return {
-    hash,
-    outputIndex,
-    blockHeight,
-    address,
-    isChange: false,
-    path,
-    value,
-    rbf,
-  };
-}
-
-export async function parseBitcoinUTXO(
-  output: CoreBitcoinLikeOutput
-): Promise<BitcoinOutput> {
-  const utxo = await parseBitcoinOutput(output);
-  utxo.rbf = await output.isReplaceable();
-  return utxo;
-}

package/src/families/bitcoin/networks.ts

@@ -173,7 +173,7 @@ export const getNetworkParameters = (
       dustAmount: new BigNumber(10000),
       messagePrefix: "StealthCoin Signed Message:\n",
       usesTimestampedTransaction: false,
-      // Used to depend on "version", cf. https://github.com/LedgerHQ/lib-ledger-core/blob/fc9d762b83fc2b269d072b662065747a64ab2816/core/src/wallet/bitcoin/networks.cpp#L250
+      // Used to depend on "version"
       timestampDelay: new BigNumber(15),
       sigHash: BitcoinLikeSigHashType.SIGHASH_ALL,
       additionalBIPs: [],

package/src/families/bitcoin/serialization.ts

@@ -40,7 +40,6 @@ export function toBitcoinOutputRaw({
   outputIndex,
   blockHeight,
   address,
-  path,
   value,
   rbf,
   isChange,
@@ -50,7 +49,6 @@ export function toBitcoinOutputRaw({
     outputIndex,
     blockHeight,
     address,
-    path,
     value.toString(),
     rbf ? 1 : 0,
     isChange ? 1 : 0,
@@ -61,7 +59,6 @@ export function fromBitcoinOutputRaw([
   outputIndex,
   blockHeight,
   address,
-  path,
   value,
   rbf,
   isChange,
@@ -71,7 +68,6 @@ export function fromBitcoinOutputRaw([
     outputIndex,
     blockHeight: blockHeight || undefined,
     address: address || undefined,
-    path: path || undefined,
     value: new BigNumber(value),
     rbf: !!rbf,
     isChange: !!isChange,

package/src/families/bitcoin/specs.ts

@@ -10,7 +10,7 @@ import { pickSiblings } from "../../bot/specs";
 import { bitcoinPickingStrategy } from "./types";
 import type { MutationSpec, AppSpec } from "../../bot/types";
 import { LowerThanMinimumRelayFee } from "../../errors";
-import { getMinRelayFee, getUTXOStatus, isChangeOutput } from "./logic";
+import { getMinRelayFee, getUTXOStatus } from "./logic";
 import { DeviceModelId } from "@ledgerhq/devices";
 type Arg = Partial<{
   minimalAmount: BigNumber;
@@ -80,7 +80,7 @@ const genericTest = ({
         ? operation.senders
         : txInputs.map((t) => t.address).filter(Boolean),
       recipients: txOutputs
-        .filter((o) => o.address && !o.isChange && !isChangeOutput(o))
+        .filter((o) => o.address && !o.isChange)
         .map((o) => o.address)
         .filter(Boolean),
     })
@@ -257,7 +257,9 @@ const bitcoinLikeMutations = ({
     test: ({ account }) => {
       expect(
         account.bitcoinResources?.utxos
-          .filter((u) => u.blockHeight && u.blockHeight < account.blockHeight) // Exclude pending UTXOs and the Utxos just written into new block
+          .filter(
+            (u) => u.blockHeight && u.blockHeight < account.blockHeight - 10
+          ) // Exclude pending UTXOs and the Utxos just written into new block (10 blocks time)
           .reduce((p, c) => p.plus(c.value), new BigNumber(0))
           .toString()
       ).toBe("0");

package/src/families/bitcoin/transaction.ts

@@ -1,17 +1,9 @@
 import { BigNumber } from "bignumber.js";
-import bchaddr from "bchaddrjs";
-import cashaddr from "cashaddrjs";
 import type {
   Transaction,
   TransactionRaw,
   FeeItems,
   FeeItemsRaw,
-  BitcoinOutput,
-  UtxoStrategy,
-  CoreBitcoinLikeOutput,
-  CoreBitcoinLikeInput,
-  BitcoinInput,
-  BitcoinResources,
 } from "./types";
 import type { Account } from "../../types";
 import { bitcoinPickingStrategy } from "./types";
@@ -22,8 +14,6 @@ import {
 } from "../../transaction/common";
 import { getAccountUnit } from "../../account";
 import { formatCurrencyUnit } from "../../currencies";
-import type { CryptoCurrencyIds } from "../../types";
-import { libcoreAmountToBigNumber } from "../../libcore/buildBigNumber";
 
 const fromFeeItemsRaw = (fir: FeeItemsRaw): FeeItems => ({
   items: fir.items.map((fi) => ({
@@ -119,187 +109,6 @@ ${[
     .join("")}`;
 };
 
-// vvvvv DEPRECATED - used only by legacy libcore implementation vvvvv
-
-function bchExplicit(str: string): string {
-  const explicit = str.includes(":") ? str : "bitcoincash:" + str;
-
-  try {
-    const { type } = cashaddr.decode(explicit);
-    if (type === "P2PKH") return explicit;
-  } catch (e) {
-    // ignore errors
-  }
-
-  return str;
-}
-
-const bchToCashaddrAddressWithoutPrefix = (recipient) =>
-  recipient ? bchaddr.toCashAddress(recipient).split(":")[1] : recipient;
-
-export type CoinLogic = {
-  hasExtraData?: boolean;
-  hasExpiryHeight?: boolean;
-  getAdditionals?: (arg0: { transaction: Transaction }) => string[];
-  asLibcoreTransactionRecipient?: (arg0: string) => string;
-  onScreenTransactionRecipient?: (arg0: string) => string;
-  postBuildBitcoinResources?: (
-    arg0: Account,
-    arg1: BitcoinResources
-  ) => BitcoinResources;
-  syncReplaceAddress?: (
-    existingAccount: Account | null | undefined,
-    addr: string
-  ) => string;
-  injectGetAddressParams?: (arg0: Account) => any;
-};
-export const perCoinLogic: Record<
-  CryptoCurrencyIds,
-  CoinLogic | null | undefined
-> = {
-  zencash: {
-    hasExtraData: true, // FIXME investigate why we need this here and drop
-  },
-  zcash: {
-    hasExtraData: true,
-    hasExpiryHeight: true,
-    getAdditionals: () => ["sapling"], // FIXME drop in ledgerjs. we always use sapling now for zcash & kmd
-  },
-  komodo: {
-    hasExtraData: true,
-    hasExpiryHeight: true,
-    getAdditionals: () => ["sapling"], // FIXME drop in ledgerjs. we always use sapling now for zcash & kmd
-  },
-  decred: {
-    hasExpiryHeight: true,
-  },
-  bitcoin_gold: {
-    getAdditionals: () => ["bip143"],
-  },
-  bitcoin_cash: {
-    getAdditionals: ({ transaction }) => {
-      const additionals = ["bip143"];
-
-      if (bchExplicit(transaction.recipient).startsWith("bitcoincash:")) {
-        additionals.push("cashaddr");
-      }
-
-      return additionals;
-    },
-    // due to libcore minimal support, we need to return the explicit format of bitcoincash:.. if it's a P2PKH
-    asLibcoreTransactionRecipient: bchExplicit,
-    // to represent what happens on the device, which do not display the bitcoincash: prefix
-    onScreenTransactionRecipient: (str: string): string => {
-      const prefix = "bitcoincash:";
-      return str.startsWith(prefix) ? str.slice(prefix.length) : str;
-    },
-    syncReplaceAddress: (existingAccount, addr) =>
-      bchToCashaddrAddressWithoutPrefix(addr),
-    injectGetAddressParams: () => ({
-      forceFormat: "cashaddr",
-    }),
-  },
-};
-export type UTXOStatus =
-  | {
-      excluded: true;
-      reason: "pickUnconfirmedRBF" | "userExclusion";
-    }
-  | {
-      excluded: false;
-    };
-export async function parseBitcoinInput(
-  input: CoreBitcoinLikeInput
-): Promise<BitcoinInput> {
-  const address = await input.getAddress();
-  const rawValue = await input.getValue();
-  const value = rawValue ? await libcoreAmountToBigNumber(rawValue) : null;
-  const previousTxHash = await input.getPreviousTxHash();
-  const previousOutputIndex = await input.getPreviousOutputIndex();
-  return {
-    address,
-    value,
-    previousTxHash,
-    previousOutputIndex,
-  };
-}
-export async function parseBitcoinOutput(
-  output: CoreBitcoinLikeOutput
-): Promise<BitcoinOutput> {
-  let blockHeight = await output.getBlockHeight();
-
-  if (!blockHeight || blockHeight < 0) {
-    blockHeight = undefined;
-  }
-
-  const hash = await output.getTransactionHash();
-  const outputIndex = await output.getOutputIndex();
-  const address = await output.getAddress();
-  const derivationPath = await output.getDerivationPath();
-  let path;
-
-  if (derivationPath) {
-    const isDerivationPathNull = await derivationPath.isNull();
-
-    if (!isDerivationPathNull) {
-      path = await derivationPath.toString();
-    }
-  }
-
-  const value = await libcoreAmountToBigNumber(await output.getValue());
-  const rbf = false; // this is unsafe to generically call this at the moment. libcore segfault.
-
-  return {
-    hash,
-    outputIndex,
-    blockHeight,
-    address,
-    isChange: false,
-    path,
-    value,
-    rbf,
-  };
-}
-export async function parseBitcoinUTXO(
-  output: CoreBitcoinLikeOutput
-): Promise<BitcoinOutput> {
-  const utxo = await parseBitcoinOutput(output);
-  utxo.rbf = await output.isReplaceable();
-  return utxo;
-}
-export function getUTXOStatus(
-  utxo: BitcoinOutput,
-  utxoStrategy: UtxoStrategy
-): UTXOStatus {
-  if (!utxoStrategy.pickUnconfirmedRBF && utxo.rbf && !utxo.blockHeight) {
-    return {
-      excluded: true,
-      reason: "pickUnconfirmedRBF",
-    };
-  }
-
-  if (
-    utxoStrategy.excludeUTXOs.some(
-      (u) => u.hash === utxo.hash && u.outputIndex === utxo.outputIndex
-    )
-  ) {
-    return {
-      excluded: true,
-      reason: "userExclusion",
-    };
-  }
-
-  return {
-    excluded: false,
-  };
-}
-export function isChangeOutput(output: BitcoinOutput): boolean {
-  if (!output.path) return false;
-  const p = output.path.split("/");
-  return p[p.length - 2] === "1";
-}
-// ==============================================================================
-
 export default {
   fromTransactionRaw,
   toTransactionRaw,