@ledgerhq/live-common 34.45.0 → 34.45.1-nightly.1

package/src/bridge/generic-alpaca/tests/estimateMaxSpendable.test.ts

@@ -11,66 +11,91 @@ jest.mock("../alpaca", () => ({
 const mockedGetAlpacaApi = alpaca.getAlpacaApi as jest.Mock;
 
 // Dummy data
-const dummyAccount = {
-  id: "js:2:ripple:r123:",
-  type: "Account", // <-- this is mandatory for getMainAccount to work
-  spendableBalance: new BigNumber(50000000),
-  currency: { id: "ripple", name: "XRP", units: [{ name: "XRP", magnitude: 6 }] },
-  freshAddress: "r123",
-} as unknown as Account;
+const dummyAccounts = [
+  {
+    id: "js:2:ripple:r123:",
+    type: "Account",
+    spendableBalance: new BigNumber(50000000),
+    balance: new BigNumber(60000000),
+    currency: { id: "ripple", family: "xrp", name: "XRP", units: [{ name: "XRP", magnitude: 6 }] },
+    freshAddress: "r123",
+    pendingOperations: [],
+  },
+  {
+    id: "js:2:stellar:s123:",
+    type: "Account",
+    spendableBalance: new BigNumber(50000000),
+    balance: new BigNumber(60000000),
+    currency: {
+      id: "stellar",
+      family: "stellar",
+      name: "Stellar",
+      units: [{ name: "XLM", magnitude: 7 }],
+    },
+    freshAddress: "s123",
+    pendingOperations: [],
+  },
+] as unknown as Account[];
 
-describe("genericEstimateMaxSpendable", () => {
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
+["xrp", "stellar"].forEach((currencyName, idx) => {
+  describe(`genericEstimateMaxSpendable for ${currencyName}`, () => {
+    const dummyAccount = dummyAccounts[idx];
 
-  it("subtracts estimated fee from spendable balance", async () => {
-    mockedGetAlpacaApi.mockReturnValue({
-      estimateFees: jest.fn().mockResolvedValue({ value: 10000n }), // 0.01 XRP
+    afterEach(() => {
+      jest.clearAllMocks();
     });
 
-    const estimate = genericEstimateMaxSpendable("xrp", "local");
-    const result = await estimate({
-      account: dummyAccount,
-      parentAccount: null,
-      transaction: {},
+    it("subtracts estimated fee from spendable balance", async () => {
+      mockedGetAlpacaApi.mockReturnValue({
+        estimateFees: jest.fn().mockResolvedValue({ value: 10000n }),
+        validateIntent: jest.fn().mockResolvedValue({ amount: 49990000n }),
+      });
+
+      const estimate = genericEstimateMaxSpendable(currencyName, "local");
+      const result = await estimate({
+        account: dummyAccount,
+        parentAccount: null,
+        transaction: {},
+      });
+
+      expect(result.toString()).toBe("49990000");
     });
 
-    expect(result.toString()).toBe("49990000"); // 50_000_000 - 10_000
-  });
+    it("returns 0 if fee is higher than spendable", async () => {
+      const poorAccount = {
+        ...dummyAccount,
+        spendableBalance: new BigNumber(5000),
+      };
 
-  it("returns 0 if fee is higher than spendable", async () => {
-    const poorAccount = {
-      ...dummyAccount,
-      spendableBalance: new BigNumber(5000), // very low
-    };
+      mockedGetAlpacaApi.mockReturnValue({
+        estimateFees: jest.fn().mockResolvedValue({ value: 10000n }),
+        validateIntent: jest.fn().mockResolvedValue({ amount: 0n }),
+      });
 
-    mockedGetAlpacaApi.mockReturnValue({
-      estimateFees: jest.fn().mockResolvedValue({ value: 10000n }),
-    });
+      const estimate = genericEstimateMaxSpendable(currencyName, "local");
+      const result = await estimate({
+        account: poorAccount,
+        parentAccount: null,
+        transaction: {},
+      });
 
-    const estimate = genericEstimateMaxSpendable("xrp", "local");
-    const result = await estimate({
-      account: poorAccount,
-      parentAccount: null,
-      transaction: {},
+      expect(result.toString()).toBe("0");
     });
 
-    expect(result.toString()).toBe("0");
-  });
+    it("returns full spendable balance if fee is 0", async () => {
+      mockedGetAlpacaApi.mockReturnValue({
+        estimateFees: jest.fn().mockResolvedValue({ value: 0n }),
+        validateIntent: jest.fn().mockResolvedValue({ amount: 50000000n }),
+      });
 
-  it("returns full spendable balance if fee is 0", async () => {
-    mockedGetAlpacaApi.mockReturnValue({
-      estimateFees: jest.fn().mockResolvedValue({ value: 0n }),
-    });
+      const estimate = genericEstimateMaxSpendable(currencyName, "local");
+      const result = await estimate({
+        account: dummyAccount,
+        parentAccount: null,
+        transaction: {},
+      });
 
-    const estimate = genericEstimateMaxSpendable("xrp", "local");
-    const result = await estimate({
-      account: dummyAccount,
-      parentAccount: null,
-      transaction: {},
+      expect(result.toString()).toBe("50000000");
     });
-
-    expect(result.toString()).toBe("50000000");
   });
 });

package/src/bridge/generic-alpaca/tests/prepareTransaction.test.ts

@@ -47,7 +47,7 @@ describe("genericPrepareTransaction", () => {
     expect((result as any).fees.toString()).toBe(newFee.toString());
     expect(transactionToIntent).toHaveBeenCalledWith(
       account,
-      expect.objectContaining(baseTransaction),
+      expect.objectContaining({ ...baseTransaction, fees: 500n }),
     );
   });
 

package/src/bridge/generic-alpaca/tests/signOperation.test.ts

@@ -13,9 +13,8 @@ jest.mock("../utils", () => ({
   buildOptimisticOperation: jest.fn(),
   transactionToIntent: jest.fn(),
 }));
-
 describe("genericSignOperation", () => {
-  const network = "xrp";
+  const networks = ["xrp", "stellar"];
   const kind = "local";
 
   const mockSignerContext = jest.fn();
@@ -55,6 +54,7 @@ describe("genericSignOperation", () => {
       craftTransaction: jest.fn().mockResolvedValue(unsignedTx),
       getAccountInfo: jest.fn().mockResolvedValue(pubKey),
       combine: jest.fn().mockResolvedValue(signedTx),
+      getSequence: jest.fn().mockResolvedValue(1),
     });
 
     (transactionToIntent as jest.Mock).mockReturnValue(txIntent);
@@ -65,33 +65,35 @@ describe("genericSignOperation", () => {
     mockSignerContext.mockImplementation(async (_deviceId, cb) => cb(mockSigner));
   });
 
-  it("emits full sign operation flow", async () => {
-    const signOperation = genericSignOperation(network, kind)(mockSignerContext);
-    const observable = signOperation({ account, transaction, deviceId });
-
-    const events = await lastValueFrom(observable.pipe(toArray()));
-
-    expect(events[0]).toEqual({ type: "device-signature-requested" });
-    expect(events[1]).toEqual({ type: "device-signature-granted" });
-    expect(events[2]).toEqual({
-      type: "signed",
-      signedOperation: {
-        operation: { id: "mock-op" },
-        signature: signedTx,
-      },
+  networks.forEach(network => {
+    it(`emits full sign operation flow for ${network}`, async () => {
+      const signOperation = genericSignOperation(network, kind)(mockSignerContext);
+      const observable = signOperation({ account, transaction, deviceId });
+
+      const events = await lastValueFrom(observable.pipe(toArray()));
+
+      expect(events[0]).toEqual({ type: "device-signature-requested" });
+      expect(events[1]).toEqual({ type: "device-signature-granted" });
+      expect(events[2]).toEqual({
+        type: "signed",
+        signedOperation: {
+          operation: { id: "mock-op" },
+          signature: signedTx,
+        },
+      });
+
+      expect(transactionToIntent).toHaveBeenCalledWith(account, transaction);
+      expect(txIntent.memo.memos.get("destinationTag")).toBe("1234");
     });
 
-    expect(transactionToIntent).toHaveBeenCalledWith(account, transaction);
-    expect(txIntent.memo.memos.get("destinationTag")).toBe("1234");
-  });
-
-  it("throws FeeNotLoaded if fees are missing", async () => {
-    const txWithoutFees = { ...transaction };
-    delete txWithoutFees.fees;
+    it(`throws FeeNotLoaded if fees are missing for ${network}`, async () => {
+      const txWithoutFees = { ...transaction };
+      delete txWithoutFees.fees;
 
-    const signOperation = genericSignOperation(network, kind)(mockSignerContext);
-    const observable = signOperation({ account, transaction: txWithoutFees, deviceId });
+      const signOperation = genericSignOperation(network, kind)(mockSignerContext);
+      const observable = signOperation({ account, transaction: txWithoutFees, deviceId });
 
-    await expect(observable.toPromise()).rejects.toThrow(FeeNotLoaded);
+      await expect(observable.toPromise()).rejects.toThrow(FeeNotLoaded);
+    });
   });
 });

package/src/bridge/generic-alpaca/{utils.test.ts → tests/utils.test.ts}

@@ -1,4 +1,4 @@
-import { extractBalance } from "./utils";
+import { extractBalance } from "../utils";
 
 describe("Alpaca utils", () => {
   describe("extractBalance", () => {

package/src/bridge/generic-alpaca/utils.ts

@@ -1,23 +1,56 @@
 import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
 import { Account, Operation, OperationType, TransactionCommon } from "@ledgerhq/types-live";
+import BigNumber from "bignumber.js";
+import { fromBigNumberToBigInt } from "@ledgerhq/coin-framework/utils";
 import {
   Balance,
   Operation as CoreOperation,
   TransactionIntent,
 } from "@ledgerhq/coin-framework/api/types";
-import BigNumber from "bignumber.js";
-import { fromBigNumberToBigInt } from "@ledgerhq/coin-framework/utils";
 
 export function extractBalance(balances: Balance[], type: string): Balance {
-  return balances.find(balance => balance.asset.type === type) ?? { asset: { type }, value: 0n };
+  return (
+    balances.find(balance => balance.asset.type === type) ?? {
+      asset: { type },
+      value: 0n,
+    }
+  );
 }
 
 export function adaptCoreOperationToLiveOperation(accountId: string, op: CoreOperation): Operation {
-  return {
-    id: encodeOperationId(accountId, op.tx.hash, op.type),
+  const opType = op.type as OperationType;
+
+  const extra: {
+    assetReference?: string;
+    assetOwner?: string;
+    assetAmount?: string | undefined;
+    ledgerOpType?: string | undefined;
+    memo?: string | undefined;
+  } = {};
+
+  if (op.details?.ledgerOpType !== undefined) {
+    extra.ledgerOpType = op.details.ledgerOpType as string;
+  }
+
+  if (op.details?.assetAmount !== undefined) {
+    extra.assetAmount = op.details.assetAmount as string;
+  }
+
+  if (op.asset?.type !== "native") {
+    extra.assetReference =
+      "assetReference" in (op.asset ?? {}) ? (op.asset as any).assetReference : "";
+    extra.assetOwner = "assetOwner" in (op.asset ?? {}) ? (op.asset as any).assetOwner : "";
+  }
+  if (op.details?.memo) {
+    extra.memo = op.details.memo as string;
+  }
+  const res = {
+    id: extra.ledgerOpType
+      ? encodeOperationId(accountId, op.tx.hash, extra.ledgerOpType)
+      : encodeOperationId(accountId, op.tx.hash, op.type),
     hash: op.tx.hash,
     accountId,
-    type: op.type as OperationType,
+    type: opType,
     value: new BigNumber(op.value.toString()),
     fee: new BigNumber(op.tx.fees.toString()),
     blockHash: op.tx.block.hash,
@@ -26,21 +59,94 @@ export function adaptCoreOperationToLiveOperation(accountId: string, op: CoreOpe
     recipients: op.recipients,
     date: op.tx.date,
     transactionSequenceNumber: op.details?.sequence as number,
-    extra: {},
+    hasFailed: (op.details as unknown as { status?: string })?.status === "failed",
+    extra,
   };
+
+  return res;
 }
 
+/**
+ * Converts a transaction object into a `TransactionIntent` object, which is used to represent
+ * the intent of a transaction in a standardized format.
+ *
+ * @template MemoType - The type of memo supported by the transaction, defaults to `MemoNotSupported`.
+ *
+ * @param account - The account initiating the transaction. Contains details such as the sender's address.
+ * @param transaction - The transaction object containing details about the operation to be performed.
+ *   - `assetOwner` (optional): The issuer of the asset, if applicable.
+ *   - `assetReference` (optional): The code of the asset, if applicable.
+ *   - `mode` (optional): The mode of the transaction, e.g., "changetrust" or "send".
+ *   - `fees` (optional): The fees associated with the transaction.
+ *   - `memoType` (optional): The type of memo to attach to the transaction.
+ *   - `memoValue` (optional): The value of the memo to attach to the transaction.
+ *
+ * @returns A `TransactionIntent` object containing the standardized representation of the transaction.
+ *   - Includes details such as type, sender, recipient, amount, fees, asset, and an optional memo.
+ *   - If `assetReference` and `assetOwner` are provided, the asset is represented as a token.
+ *   - If `memoType` and `memoValue` are provided, a memo is included; otherwise, a default memo of type "NO_MEMO" is added.
+ *
+ * @throws An error if the transaction mode is unsupported.
+ */
 export function transactionToIntent(
   account: Account,
-  transaction: TransactionCommon,
-): TransactionIntent<any> {
-  return {
-    type: "Payment",
+  transaction: TransactionCommon & {
+    assetOwner?: string;
+    assetReference?: string;
+    mode?: string;
+    fees?: bigint | null | undefined;
+    memoType?: string;
+    memoValue?: string;
+    useAllAmount?: boolean;
+  },
+): TransactionIntent<any> & { memo?: { type: string; value?: string } } {
+  let transactionType = "Payment"; // NOTE: assuming payment by default here, can be changed based on transaction.mode
+  if (transaction.mode) {
+    switch (transaction.mode) {
+      case "changeTrust":
+        transactionType = "changeTrust";
+        break;
+      case "send":
+        transactionType = "send";
+        break;
+      default:
+        throw new Error(`Unsupported transaction mode: ${transaction.mode}`);
+    }
+  }
+  const res: TransactionIntent & { memo?: { type: string; value?: string } } = {
+    fees: transaction?.fees ? transaction.fees : null,
+    type: transactionType,
     sender: account.freshAddress,
     recipient: transaction.recipient,
     amount: fromBigNumberToBigInt(transaction.amount, BigInt(0)),
-    asset: { type: "native" },
+    asset: { type: "native", name: account.currency.name, unit: account.currency.units[0] },
+    useAllAmount: !!transaction.useAllAmount,
   };
+  if (transaction.assetReference && transaction.assetOwner) {
+    const { subAccountId } = transaction;
+    const { subAccounts } = account;
+
+    const tokenAccount = !subAccountId
+      ? null
+      : subAccounts && subAccounts.find(ta => ta.id === subAccountId);
+
+    res.asset = {
+      type: tokenAccount?.token.tokenType ?? "token",
+      assetReference: transaction.assetReference,
+      name: tokenAccount?.token.name ?? transaction.assetReference, // NOTE: for stellar, assetReference = tokenAccount.name, this is futureproofing
+      unit: account.currency.units[0],
+      assetOwner: transaction.assetOwner,
+    };
+  }
+  if (transaction.memoType && transaction.memoValue) {
+    res.memo = {
+      type: transaction.memoType,
+      value: transaction.memoValue,
+    };
+  } else {
+    res.memo = { type: "NO_MEMO" };
+  }
+  return res;
 }
 
 export const buildOptimisticOperation = (
@@ -48,12 +154,17 @@ export const buildOptimisticOperation = (
   transaction: TransactionCommon,
   sequenceNumber?: number,
 ): Operation => {
-  return {
-    id: encodeOperationId(account.id, "", "OUT"),
+  const type = transaction["mode"] === "changeTrust" ? "OPT_IN" : "OUT";
+  const fees = BigInt(transaction["fees"]?.toString() || "0");
+  const { subAccountId } = transaction;
+  const { subAccounts } = account;
+
+  const operation: Operation = {
+    id: encodeOperationId(account.id, "", type),
     hash: "",
-    type: "OUT",
-    value: transaction.amount,
-    fee: transaction["fees"] ?? BigNumber(0),
+    type: type,
+    value: subAccountId ? new BigNumber(fees.toString()) : transaction.amount, // match old behavior
+    fee: new BigNumber(fees.toString()),
     blockHash: null,
     blockHeight: null,
     senders: [account.freshAddress.toString()],
@@ -61,6 +172,35 @@ export const buildOptimisticOperation = (
     transactionSequenceNumber: sequenceNumber ?? 0,
     accountId: account.id,
     date: new Date(),
-    extra: {},
+    extra: {
+      ledgerOpType: type,
+      blockTime: new Date(),
+      index: "0",
+    },
   };
+
+  const tokenAccount = !subAccountId
+    ? null
+    : subAccounts && subAccounts.find(ta => ta.id === subAccountId);
+  if (tokenAccount && subAccountId) {
+    operation.subOperations = [
+      {
+        id: `${subAccountId}--OUT`,
+        hash: "",
+        type: "OUT",
+        value: transaction.useAllAmount ? tokenAccount.balance : transaction.amount,
+        fee: new BigNumber(0),
+        blockHash: null,
+        blockHeight: null,
+        senders: [account.freshAddress],
+        recipients: [transaction.recipient],
+        accountId: subAccountId,
+        date: new Date(),
+        extra: {
+          ledgerOpType: type,
+        },
+      },
+    ];
+  }
+  return operation;
 };

package/src/bridge/impl.ts

@@ -26,11 +26,12 @@ import { getCryptoAssetsStore, setCryptoAssetsStore } from "./crypto-assets";
 
 const alpacaized = {
   xrp: true,
+  stellar: true,
 };
 
 // let accountBridgeInstance: AccountBridge<any> | null = null;
 const bridgeCache: Record<string, AccountBridge<any>> = {};
-let currencyBridgeInstance: CurrencyBridge | null = null;
+const currencyBridgeCache: Record<string, CurrencyBridge> = {};
 
 export const getCurrencyBridge = (currency: CryptoCurrency): CurrencyBridge => {
   if (getEnv("MOCK")) {
@@ -42,10 +43,10 @@ export const getCurrencyBridge = (currency: CryptoCurrency): CurrencyBridge => {
   }
 
   if (alpacaized[currency.family]) {
-    if (!currencyBridgeInstance) {
-      currencyBridgeInstance = getAlpacaCurrencyBridge(currency.family, "local");
+    if (!currencyBridgeCache[currency.family]) {
+      currencyBridgeCache[currency.family] = getAlpacaCurrencyBridge(currency.family, "local");
     }
-    return currencyBridgeInstance;
+    return currencyBridgeCache[currency.family];
   }
 
   const jsBridge = jsBridges[currency.family];

package/src/e2e/enum/Account.ts

@@ -94,25 +94,25 @@ export class Account {
 
   static readonly BSC_1 = new Account(
     Currency.BSC,
-    "Binance Smart Chain 1",
+    "BNB Chain 1",
     "0x4BE2E2B8872AA298D6d123b9211B53E41f611566",
     0,
   );
   static readonly BSC_BUSD_1 = new Account(
     Currency.BSC_BUSD,
-    "Binance Smart Chain 1",
+    "BNB Chain 1",
     "0x4BE2E2B8872AA298D6d123b9211B53E41f611566",
     0,
   );
   static readonly BSC_BUSD_2 = new Account(
     Currency.BSC_BUSD,
-    "Binance Smart Chain 2",
+    "BNB Chain 2",
     "0xa1baa625c5E6A9304cB7AcD86d2fee6B710eC3eB",
     1,
   );
   static readonly BSC_SHIBA = new Account(
     Currency.BSC_SHIBA,
-    "Binance Smart Chain 1",
+    "BNB Chain 1",
     "0x4BE2E2B8872AA298D6d123b9211B53E41f611566",
     0,
   );

package/src/e2e/enum/AppInfos.ts

@@ -43,7 +43,7 @@ export class AppInfos {
 
   static readonly POLYGON = new AppInfos("Polygon");
 
-  static readonly BINANCE_SMART_CHAIN = new AppInfos("Binance Smart Chain");
+  static readonly BNB_CHAIN = new AppInfos("BNB Chain");
 
   static readonly TON = new AppInfos("Ton");