@ledgerhq/live-common 21.4.0 → 21.4.1-btcjs.6

package/src/families/bitcoin/transaction.ts

@@ -25,6 +25,102 @@ import { formatCurrencyUnit } from "../../currencies";
 import type { CryptoCurrencyIds } from "../../types";
 import { libcoreAmountToBigNumber } from "../../libcore/buildBigNumber";
 
+const fromFeeItemsRaw = (fir: FeeItemsRaw): FeeItems => ({
+  items: fir.items.map((fi) => ({
+    key: fi.key,
+    speed: fi.speed,
+    feePerByte: new BigNumber(fi.feePerByte),
+  })),
+  defaultFeePerByte: new BigNumber(fir.defaultFeePerByte),
+});
+
+const toFeeItemsRaw = (fir: FeeItems): FeeItemsRaw => ({
+  items: fir.items.map((fi) => ({
+    key: fi.key,
+    speed: fi.speed,
+    feePerByte: fi.feePerByte.toString(),
+  })),
+  defaultFeePerByte: fir.defaultFeePerByte.toString(),
+});
+
+export const fromTransactionRaw = (tr: TransactionRaw): Transaction => {
+  const common = fromTransactionCommonRaw(tr);
+  return {
+    ...common,
+    rbf: tr.rbf,
+    utxoStrategy: tr.utxoStrategy,
+    family: tr.family,
+    feePerByte: tr.feePerByte ? new BigNumber(tr.feePerByte) : null,
+    networkInfo: tr.networkInfo && {
+      family: tr.networkInfo.family,
+      feeItems: fromFeeItemsRaw(tr.networkInfo.feeItems),
+    },
+    feesStrategy: tr.feesStrategy,
+  };
+};
+export const toTransactionRaw = (t: Transaction): TransactionRaw => {
+  const common = toTransactionCommonRaw(t);
+  return {
+    ...common,
+    rbf: t.rbf,
+    utxoStrategy: t.utxoStrategy,
+    family: t.family,
+    feePerByte: t.feePerByte ? t.feePerByte.toString() : null,
+    networkInfo: t.networkInfo && {
+      family: t.networkInfo.family,
+      feeItems: toFeeItemsRaw(t.networkInfo.feeItems),
+    },
+    feesStrategy: t.feesStrategy,
+  };
+};
+
+const formatNetworkInfo = (
+  networkInfo:
+    | {
+        feeItems: FeeItems;
+      }
+    | null
+    | undefined
+) => {
+  if (!networkInfo) return "network info not loaded";
+  return `network fees: ${networkInfo.feeItems.items
+    .map((i) => i.key + "=" + i.feePerByte.toString())
+    .join(", ")}`;
+};
+
+export const formatTransaction = (t: Transaction, account: Account): string => {
+  const n = getEnv("DEBUG_UTXO_DISPLAY");
+  const { excludeUTXOs, strategy, pickUnconfirmedRBF } = t.utxoStrategy;
+  const displayAll = excludeUTXOs.length <= n;
+  return `
+SEND ${
+    t.useAllAmount
+      ? "MAX"
+      : formatCurrencyUnit(getAccountUnit(account), t.amount, {
+          showCode: true,
+          disableRounding: true,
+        })
+  }
+TO ${t.recipient}
+with feePerByte=${
+    t.feePerByte ? t.feePerByte.toString() : "?"
+  } (${formatNetworkInfo(t.networkInfo)})
+${[
+  Object.keys(bitcoinPickingStrategy).find(
+    (k) => bitcoinPickingStrategy[k] === strategy
+  ),
+  pickUnconfirmedRBF && "pick-unconfirmed",
+  t.rbf && "RBF-enabled",
+]
+  .filter(Boolean)
+  .join(" ")}${excludeUTXOs
+    .slice(0, displayAll ? excludeUTXOs.length : n)
+    .map((utxo) => `\nexclude ${utxo.hash} @${utxo.outputIndex}`)
+    .join("")}`;
+};
+
+// TODO vvvvv DEPRECATED, TO BE REMOVED vvvvv
+
 function bchExplicit(str: string): string {
   const explicit = str.includes(":") ? str : "bitcoincash:" + str;
 
@@ -158,6 +254,7 @@ export async function parseBitcoinOutput(
     outputIndex,
     blockHeight,
     address,
+    isChange: false,
     path,
     value,
     rbf,
@@ -201,100 +298,8 @@ export function isChangeOutput(output: BitcoinOutput): boolean {
   const p = output.path.split("/");
   return p[p.length - 2] === "1";
 }
+// ==============================================================================
 
-const fromFeeItemsRaw = (fir: FeeItemsRaw): FeeItems => ({
-  items: fir.items.map((fi) => ({
-    key: fi.key,
-    speed: fi.speed,
-    feePerByte: new BigNumber(fi.feePerByte),
-  })),
-  defaultFeePerByte: new BigNumber(fir.defaultFeePerByte),
-});
-
-const toFeeItemsRaw = (fir: FeeItems): FeeItemsRaw => ({
-  items: fir.items.map((fi) => ({
-    key: fi.key,
-    speed: fi.speed,
-    feePerByte: fi.feePerByte.toString(),
-  })),
-  defaultFeePerByte: fir.defaultFeePerByte.toString(),
-});
-
-export const fromTransactionRaw = (tr: TransactionRaw): Transaction => {
-  const common = fromTransactionCommonRaw(tr);
-  return {
-    ...common,
-    rbf: tr.rbf,
-    utxoStrategy: tr.utxoStrategy,
-    family: tr.family,
-    feePerByte: tr.feePerByte ? new BigNumber(tr.feePerByte) : null,
-    networkInfo: tr.networkInfo && {
-      family: tr.networkInfo.family,
-      feeItems: fromFeeItemsRaw(tr.networkInfo.feeItems),
-    },
-    feesStrategy: tr.feesStrategy,
-  };
-};
-export const toTransactionRaw = (t: Transaction): TransactionRaw => {
-  const common = toTransactionCommonRaw(t);
-  return {
-    ...common,
-    rbf: t.rbf,
-    utxoStrategy: t.utxoStrategy,
-    family: t.family,
-    feePerByte: t.feePerByte ? t.feePerByte.toString() : null,
-    networkInfo: t.networkInfo && {
-      family: t.networkInfo.family,
-      feeItems: toFeeItemsRaw(t.networkInfo.feeItems),
-    },
-    feesStrategy: t.feesStrategy,
-  };
-};
-
-const formatNetworkInfo = (
-  networkInfo:
-    | {
-        feeItems: FeeItems;
-      }
-    | null
-    | undefined
-) => {
-  if (!networkInfo) return "network info not loaded";
-  return `network fees: ${networkInfo.feeItems.items
-    .map((i) => i.key + "=" + i.feePerByte.toString())
-    .join(", ")}`;
-};
-
-export const formatTransaction = (t: Transaction, account: Account): string => {
-  const n = getEnv("DEBUG_UTXO_DISPLAY");
-  const { excludeUTXOs, strategy, pickUnconfirmedRBF } = t.utxoStrategy;
-  const displayAll = excludeUTXOs.length <= n;
-  return `
-SEND ${
-    t.useAllAmount
-      ? "MAX"
-      : formatCurrencyUnit(getAccountUnit(account), t.amount, {
-          showCode: true,
-          disableRounding: true,
-        })
-  }
-TO ${t.recipient}
-with feePerByte=${
-    t.feePerByte ? t.feePerByte.toString() : "?"
-  } (${formatNetworkInfo(t.networkInfo)})
-${[
-  Object.keys(bitcoinPickingStrategy).find(
-    (k) => bitcoinPickingStrategy[k] === strategy
-  ),
-  pickUnconfirmedRBF && "pick-unconfirmed",
-  t.rbf && "RBF-enabled",
-]
-  .filter(Boolean)
-  .join(" ")}${excludeUTXOs
-    .slice(0, displayAll ? excludeUTXOs.length : n)
-    .map((utxo) => `\nexclude ${utxo.hash} @${utxo.outputIndex}`)
-    .join("")}`;
-};
 export default {
   fromTransactionRaw,
   toTransactionRaw,

package/src/families/bitcoin/types.ts

@@ -1,4 +1,6 @@
 import type { BigNumber } from "bignumber.js";
+import type { SerializedAccount as WalletSerializedAccount } from "@ledgerhq/wallet-btc";
+
 import type {
   TransactionCommon,
   TransactionCommonRaw,
@@ -9,43 +11,8 @@ import type {
   CoreDerivationPath,
   Spec,
 } from "../../libcore/types";
-export type BitcoinInput = {
-  address: string | null | undefined;
-  value: BigNumber | null | undefined;
-  previousTxHash: string | null | undefined;
-  previousOutputIndex: number;
-};
-export type BitcoinInputRaw = [
-  string | null | undefined,
-  string | null | undefined,
-  string | null | undefined,
-  number
-];
-export type BitcoinOutput = {
-  hash: string;
-  outputIndex: number;
-  blockHeight: number | null | undefined;
-  address: string | null | undefined;
-  path: string | null | undefined;
-  value: BigNumber;
-  rbf: boolean;
-};
-export type BitcoinOutputRaw = [
-  string,
-  number,
-  number | null | undefined,
-  string | null | undefined,
-  string | null | undefined,
-  string,
-  number // rbf 0/1 for compression
-];
-export type BitcoinResources = {
-  utxos: BitcoinOutput[];
-};
-export type BitcoinResourcesRaw = {
-  utxos: BitcoinOutputRaw[];
-};
 
+//* TODO REPLACE <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 declare class CoreBitcoinLikeInput {
   getPreviousTransaction(): Promise<string>;
   getPreviousTxHash(): Promise<string | null | undefined>;
@@ -130,6 +97,93 @@ export type CoreOperationSpecifics = {
 export type CoreCurrencySpecifics = {
   getBitcoinLikeNetworkParameters(): Promise<CoreBitcoinLikeNetworkParameters>;
 };
+/*/ WITH >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+export type CoreStatics = Record<string, never>;
+export type CoreAccountSpecifics = Record<string, never>;
+export type CoreOperationSpecifics = Record<string, never>;
+export type CoreCurrencySpecifics = Record<string, never>;
+//*/ // ====================================================
+
+export type BitcoinInput = {
+  address: string | null | undefined;
+  value: BigNumber | null | undefined;
+  previousTxHash: string | null | undefined;
+  previousOutputIndex: number;
+};
+export type BitcoinInputRaw = [
+  string | null | undefined,
+  string | null | undefined,
+  string | null | undefined,
+  number
+];
+export type BitcoinOutput = {
+  hash: string;
+  outputIndex: number;
+  blockHeight: number | null | undefined;
+  address: string | null | undefined;
+  isChange: boolean;
+  path: string | null | undefined; // TODO DEPRECATED, TO BE REMOVED
+  value: BigNumber;
+  rbf: boolean;
+};
+export type BitcoinOutputRaw = [
+  string,
+  number,
+  number | null | undefined,
+  string | null | undefined,
+  number,
+  string | null | undefined, // TODO DEPRECATED, TO BE REMOVED
+  string,
+  number // rbf 0/1 for compression
+];
+export type BitcoinResources = {
+  utxos: BitcoinOutput[];
+  serializedData?: WalletSerializedAccount; // TODO '?' TO BE REMOVED
+};
+export type BitcoinResourcesRaw = {
+  utxos: BitcoinOutputRaw[];
+  serializedData?: WalletSerializedAccount; // TODO '?' TO BE REMOVED
+};
+
+export const BitcoinLikeFeePolicy = Object.freeze({
+  PER_BYTE: "PER_BYTE",
+  PER_KBYTE: "PER_KBYTE",
+});
+
+export const BitcoinLikeSigHashType = Object.freeze({
+  SIGHASH_ALL: 0x01,
+  SIGHASH_NONE: 0x02,
+  SIGHASH_SINGLE: 0x03,
+  SIGHASH_FORKID: 0x40,
+  SIGHASH_ANYONECANPAY: 0x80,
+});
+
+// TODO maybe not all fields are useful
+export type BitcoinLikeNetworkParameters = {
+  // Name of the network.
+  identifier: string;
+  // Version of the Pay To Public Hash standard.
+  P2PKHVersion: Buffer;
+  // Version of the Pay To Script Hash standard.
+  P2SHVersion: Buffer;
+  // Version of the Extended Public Key standard.
+  xpubVersion: Buffer;
+  // Policy to use when expressing fee amount, values in BitcoinLikeFeePolicy
+  feePolicy: string;
+  // Minimal amount a UTXO should have before being considered BTC dust.
+  dustAmount: BigNumber;
+  // Constant prefix to prepend all signature messages.
+  messagePrefix: string;
+  // Are transactions encoded with timestamp?
+  usesTimestampedTransaction: boolean;
+  // Delay applied to all timestamps. Used to debounce transactions.
+  timestampDelay: BigNumber;
+  // Bitcoin signature flag indicating what part of a transaction a signature signs, values in BitcoinLikeSigHashType
+  sigHash: number;
+  // Addition BIPs enabled for this network.
+  additionalBIPs: string[];
+};
+
 export type FeeItem = {
   key: string;
   speed: string;
@@ -163,7 +217,6 @@ export const bitcoinPickingStrategy = {
 };
 export type BitcoinPickingStrategy =
   typeof bitcoinPickingStrategy[keyof typeof bitcoinPickingStrategy];
-// FIXME the UtxoStrategy level should be flattened back in Transaction
 export type UtxoStrategy = {
   strategy: BitcoinPickingStrategy;
   pickUnconfirmedRBF: boolean;
@@ -186,6 +239,8 @@ export type TransactionRaw = TransactionCommonRaw & {
   feePerByte: string | null | undefined;
   networkInfo: NetworkInfoRaw | null | undefined;
 };
+
+//* TODO REPLACE <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
 export const reflect = (
   declare: (arg0: string, arg1: Spec) => void
 ): {
@@ -315,3 +370,6 @@ export const reflect = (
     },
   };
 };
+/*/ WITH >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+export const reflect = (_declare: any): void => {};
+//*/ // ====================================================

package/src/families/bitcoin/wallet.ts

@@ -0,0 +1,21 @@
+import { WalletLedger } from "@ledgerhq/wallet-btc";
+import type { Account } from "./../../types";
+let wallet: WalletLedger | null = null;
+export const getWalletAccount = async (account: Account) => {
+  const walletData = account.bitcoinResources?.serializedData;
+  if (!walletData) {
+    throw new Error("bitcoin wallet account expected");
+  }
+  const walletInstance = getWallet();
+  return await walletInstance.importFromSerializedAccount(walletData);
+};
+
+const getWallet = () => {
+  if (!wallet) {
+    wallet = new WalletLedger();
+  }
+
+  return wallet;
+};
+
+export default getWallet();

package/src/families/ethereum/modules/__snapshots__/compound.resilience.test.ts.snap

@@ -2,7 +2,7 @@
 
 exports[`if API is down, an account still sync fine 1`] = `
 Object {
-  "balance": "2092658623260253",
+  "balance": "0",
   "blockHeight": 0,
   "creationDate": "",
   "currencyId": "ethereum",
@@ -15,6 +15,47 @@ Object {
   "lastSyncDate": "",
   "name": "Ethereum legacy xpub6Bem...JyAdpYZy",
   "operations": Array [
+    Object {
+      "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
+      "blockHash": "0x3d995e1931a059b0acb13a1595d4c6668b4c5ca384de8823c4a72c828507e984",
+      "blockHeight": 0,
+      "date": "",
+      "extra": Object {},
+      "fee": "2110500000000000",
+      "hasFailed": false,
+      "hash": "0x12bcdadf67b905eb6955b4c435f78b8c4eb4fb3a8c8bc16305331474b2897174",
+      "id": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:-0x12bcdadf67b905eb6955b4c435f78b8c4eb4fb3a8c8bc16305331474b2897174-OUT",
+      "internalOperations": Array [],
+      "recipients": Array [
+        "0x17733CAb76d9A2112576443F21735789733B1ca3",
+      ],
+      "senders": Array [
+        "0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5",
+      ],
+      "transactionSequenceNumber": 225,
+      "type": "OUT",
+      "value": "102193757957260253",
+    },
+    Object {
+      "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
+      "blockHash": "0x912d8feccc2c943daa396ec2a20f6149d2bfeef3828fc9f47ee98b3151b5d4f9",
+      "blockHeight": 0,
+      "date": "",
+      "extra": Object {},
+      "fee": "1903135989909000",
+      "hash": "0xa54eb928a2f7e522517133f22ebdc2b599d130e86f0118658a7884a7df9265cc",
+      "id": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:-0xa54eb928a2f7e522517133f22ebdc2b599d130e86f0118658a7884a7df9265cc-IN",
+      "internalOperations": Array [],
+      "recipients": Array [
+        "0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5",
+      ],
+      "senders": Array [
+        "0x86D3E894b5CDb6a80affFd35eD348868fb98DD3f",
+      ],
+      "transactionSequenceNumber": 67292,
+      "type": "IN",
+      "value": "100101099334000000",
+    },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
       "blockHash": "0x2f43388babd05ea277497a0afd03d61324ad4b2b5d1e603470d29951e987e279",
@@ -157,7 +198,7 @@ Object {
       ],
       "transactionSequenceNumber": 221,
       "type": "FEES",
-      "value": "0",
+      "value": "72825000000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -797,7 +838,7 @@ Object {
       ],
       "transactionSequenceNumber": 201,
       "type": "FEES",
-      "value": "0",
+      "value": "359040000000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -1399,7 +1440,7 @@ Object {
       ],
       "transactionSequenceNumber": 179,
       "type": "FEES",
-      "value": "0",
+      "value": "79359000000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -2720,7 +2761,7 @@ Object {
       ],
       "transactionSequenceNumber": 138,
       "type": "FEES",
-      "value": "0",
+      "value": "239390000000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -5741,7 +5782,7 @@ Object {
       ],
       "transactionSequenceNumber": 57,
       "type": "FEES",
-      "value": "0",
+      "value": "679610000000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -6937,7 +6978,7 @@ Object {
       ],
       "transactionSequenceNumber": 21,
       "type": "FEES",
-      "value": "0",
+      "value": "758734820000000",
     },
     Object {
       "accountId": "js:2:ethereum:0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5:",
@@ -7601,10 +7642,10 @@ Object {
       "value": "331419644025820000",
     },
   ],
-  "operationsCount": 365,
+  "operationsCount": 367,
   "pendingOperations": Array [],
   "seedIdentifier": "0x0E3F0bb9516F01f2C34c25E0957518b8aC9414c5",
-  "spendableBalance": "2092658623260253",
+  "spendableBalance": "0",
   "starred": false,
   "subAccounts": Array [
     Object {

package/src/generated/bridge/js.ts

@@ -1,3 +1,5 @@
+import bitcoin from "../../families/bitcoin/bridge/js";
+
 import crypto_org from "../../families/crypto_org/bridge/js";
 
 import elrond from "../../families/elrond/bridge/js";
@@ -18,6 +20,7 @@ import tron from "../../families/tron/bridge/js";
 
 
 export default {
+  bitcoin,
   crypto_org,
   elrond,
   ethereum,

package/src/migrations/accounts-dataset.ts

@@ -1,3 +1,4 @@
+import type { SerializedAccount as WalletSerializedAccount } from "@ledgerhq/wallet-btc";
 import { fromAccountRaw } from "../account";
 import type { Account, AccountRaw } from "../types";
 
@@ -26,6 +27,7 @@ const accounts: Account[] = [
     xpub: "xpub6DACJs4ZgE67HEu53j2osRtw51wfJybJ88ccVQnHpmjqr9XJfMYXn6Fxt3u772FonuWfqYUrb9Z9wxe2S9pTzxGDiQZDk1cMPiDH2S5HjYa",
     bitcoinResources: {
       utxos: [],
+      serializedData: {} as WalletSerializedAccount,
     },
     swapHistory: [
       {
@@ -88,6 +90,7 @@ const accounts: Account[] = [
     xpub: "Ltub2Zx1tbqWB7AbC4fb7aWgsuyXBm2qt97gzG5av4PHAjdAhvdZQFHS7nmcScgtAvpgcGAkVQQvR9BXwu54ny6Yqwst4KQAnyD1Yx6VezNf1S8",
     bitcoinResources: {
       utxos: [],
+      serializedData: {} as WalletSerializedAccount,
     },
     swapHistory: [
       {

package/src/migrations/accounts.ts

@@ -16,6 +16,24 @@ function sameSwap(a: SwapOperation, b: SwapOperation) {
 }
 
 export const implicitMigration = (accounts: Account[]): Account[] => {
+  // TODO Need this for BTC-JS?
+  /*
+  // this infer the next account id following ongoing libcore->js migration
+  function targetBitcoinJSaccountId(a: AccountLike) {
+    if (a.type === "Account") {
+      const decoded = decodeAccountId(a.id);
+      if (decoded.type !== "libcore") {
+        return a.id;
+      }
+      if (decoded.currencyId !== "bitcoin") {
+        return a.id;
+      }
+      return `js:2:${decoded.currencyId}:${a.freshAddress}:${decoded.derivationMode}`;
+    }
+    return a.id;
+  }
+  */
+
   // this infer the next account id following ongoing libcore->js migration
   function targetEthereumJSaccountId(a: AccountLike) {
     if (a.type === "Account") {

package/src/mock/account.ts

@@ -1,5 +1,6 @@
 import Prando from "prando";
 import { BigNumber } from "bignumber.js";
+import type { SerializedAccount as WalletSerializedAccount } from "@ledgerhq/wallet-btc";
 import {
   listCryptoCurrencies,
   listTokensForCryptoCurrency,
@@ -412,6 +413,7 @@ export function genAccount(
   if (currency.family === "bitcoin") {
     account.bitcoinResources = {
       utxos: [],
+      serializedData: {} as WalletSerializedAccount,
     };
   }