@ledgerhq/coin-stellar 6.2.0 → 6.3.0-nightly.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/coin-stellar",
-  "version": "6.2.0",
+  "version": "6.3.0-nightly.0",
   "description": "Ledger Stellar Coin integration",
   "license": "Apache-2.0",
   "keywords": [
@@ -102,20 +102,20 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@stellar/stellar-sdk": "^11.3.0",
+    "@stellar/stellar-sdk": "^14.0.0",
     "bignumber.js": "^9.1.2",
     "expect": "^27.4.6",
     "invariant": "^2.2.2",
     "rxjs": "^7.8.1",
     "@exodus/patch-broken-hermes-typed-arrays": "1.0.0-alpha.1",
-    "@ledgerhq/coin-framework": "^6.2.0",
-    "@ledgerhq/cryptoassets": "^13.26.0",
-    "@ledgerhq/devices": "8.5.0",
-    "@ledgerhq/errors": "^6.24.0",
-    "@ledgerhq/live-env": "^2.14.0",
-    "@ledgerhq/live-network": "^2.0.15",
+    "@ledgerhq/coin-framework": "^6.2.1-nightly.0",
+    "@ledgerhq/cryptoassets": "^13.27.0-nightly.0",
+    "@ledgerhq/devices": "8.5.1-nightly.0",
+    "@ledgerhq/errors": "^6.25.0-nightly.0",
+    "@ledgerhq/live-env": "^2.15.0-nightly.1",
+    "@ledgerhq/live-network": "^2.0.16-nightly.1",
     "@ledgerhq/logs": "^6.13.0",
-    "@ledgerhq/types-cryptoassets": "^7.25.0",
+    "@ledgerhq/types-cryptoassets": "^7.26.0-nightly.1",
     "@ledgerhq/types-live": "^6.82.0"
   },
   "devDependencies": {
@@ -132,7 +132,7 @@
   "scripts": {
     "clean": "rimraf lib lib-es",
     "build": "tsc && tsc -m esnext --moduleResolution bundler --outDir lib-es",
-    "coverage": "jest --coverage || true",
+    "coverage": "jest --coverage",
     "prewatch": "pnpm build",
     "watch": "tsc --watch",
     "watch:es": "tsc --watch -m esnext --moduleResolution bundler --outDir lib-es",

package/src/api/index.ts

@@ -77,8 +77,7 @@ async function craft(
   transactionIntent: TransactionIntent<StellarMemo>,
   customFees?: FeeEstimation,
 ): Promise<string> {
-  const fees =
-    customFees?.value || transactionIntent.fees || (await estimateFees(transactionIntent.sender));
+  const fees = customFees?.value || (await estimateFees());
 
   // NOTE: check how many memos, throw if more than one?
   // if (transactionIntent.memos && transactionIntent.memos.length > 1) {
@@ -116,10 +115,8 @@ function compose(tx: string, signature: string, pubkey?: string): string {
   return combine(envelopeFromAnyXDR(tx, "base64"), signature, pubkey);
 }
 
-async function estimate(transactionIntent: TransactionIntent): Promise<FeeEstimation> {
-  const value = transactionIntent?.fees
-    ? transactionIntent?.fees
-    : await estimateFees(transactionIntent.sender);
+async function estimate(_transactionIntent: TransactionIntent): Promise<FeeEstimation> {
+  const value = await estimateFees();
   return { value };
 }
 

package/src/logic/estimateFees.ts

@@ -1,10 +1,10 @@
-import { fetchAccountNetworkInfo } from "../network";
+import { fetchBaseFee } from "../network";
 
 /**
  * Estimate the fees for one transaction
  * @see {@link https://developers.stellar.org/docs/learn/fundamentals/fees-resource-limits-metering#inclusion-fee}
  */
-export async function estimateFees(account: string): Promise<bigint> {
-  const { fees } = await fetchAccountNetworkInfo(account);
-  return BigInt(fees.toString());
+export async function estimateFees(): Promise<bigint> {
+  const baseFee = await fetchBaseFee();
+  return BigInt(baseFee.recommendedFee);
 }

package/src/logic/getBalance.test.ts

@@ -1,26 +1,137 @@
-import coinConfig, { StellarCoinConfig } from "../config";
 import { getBalance } from "./getBalance";
-import { AccountCallBuilder } from "@stellar/stellar-sdk/lib/horizon/account_call_builder";
+import { fetchAccount } from "../network";
+import { findTokenById } from "@ledgerhq/cryptoassets/tokens";
+import { getAssetIdFromAsset } from "./utils";
+import { parseCurrencyUnit } from "@ledgerhq/coin-framework/currencies/parseCurrencyUnit";
+
+jest.mock("../network", () => ({
+  fetchAccount: jest.fn(),
+}));
+
+jest.mock("@ledgerhq/cryptoassets/tokens", () => ({
+  findTokenById: jest.fn(),
+}));
+
+jest.mock("./utils", () => ({
+  getAssetIdFromAsset: jest.fn(),
+}));
+
+jest.mock("@ledgerhq/coin-framework/currencies/parseCurrencyUnit", () => ({
+  parseCurrencyUnit: jest.fn(),
+}));
 
 describe("getBalance", () => {
-  coinConfig.setCoinConfig(
-    () =>
-      ({
-        status: { type: "active" },
-        explorer: { url: "https://stellar.explorer.com" },
-      }) as unknown as StellarCoinConfig,
-  );
-  it("gets the balance of a Stellar account", async () => {
-    jest.spyOn(AccountCallBuilder.prototype, "accountId").mockReturnValue({
-      call: () => Promise.resolve({ balances: [{ asset_type: "native", balance: "50" }] }),
-    } as any);
-
-    expect(await getBalance("GC65CUPW2IMTJJY6CII7F3OBPVG4YGASEPBBLM4V3LBKX62P6LA24OFV")).toEqual([
+  it("returns native balance when no assets are present", async () => {
+    (fetchAccount as jest.Mock).mockResolvedValue({
+      balance: 100000000,
+      spendableBalance: 99999990,
+      assets: [],
+    });
+
+    const result = await getBalance("test-address");
+
+    expect(result).toEqual([
+      {
+        value: BigInt(100000000),
+        asset: { type: "native" },
+        locked: BigInt(10),
+      },
+    ]);
+  });
+
+  it("returns native and asset balances when assets are present", async () => {
+    (fetchAccount as jest.Mock).mockResolvedValue({
+      balance: 100000000,
+      spendableBalance: 99999990,
+      assets: [
+        {
+          asset_type: "credit_alphanum4",
+          asset_code: "USDC",
+          asset_issuer: "issuer-address",
+          balance: "50.1234567",
+        },
+      ],
+    });
+
+    (getAssetIdFromAsset as jest.Mock).mockReturnValue("USDC-issuer-address");
+    (findTokenById as jest.Mock).mockReturnValue({
+      units: [{ code: "USDC", magnitude: 7 }],
+    });
+    (parseCurrencyUnit as jest.Mock).mockReturnValue({
+      toString: () => "50.1234567",
+    });
+
+    const result = await getBalance("test-address");
+
+    expect(result).toEqual([
       {
-        value: BigInt(500000000),
+        value: BigInt(100000000),
         asset: { type: "native" },
-        locked: BigInt(500000000 - 499999900),
+        locked: BigInt(10),
+      },
+      {
+        value: BigInt(50),
+        asset: {
+          type: "credit_alphanum4",
+          assetReference: "USDC",
+          assetOwner: "issuer-address",
+        },
       },
     ]);
+
+    expect(fetchAccount).toHaveBeenCalledWith("test-address");
+    expect(getAssetIdFromAsset).toHaveBeenCalledWith({
+      asset_type: "credit_alphanum4",
+      asset_code: "USDC",
+      asset_issuer: "issuer-address",
+      balance: "50.1234567",
+    });
+    expect(findTokenById).toHaveBeenCalledWith("stellar/asset/USDC-issuer-address");
+    expect(parseCurrencyUnit).toHaveBeenCalledWith({ code: "USDC", magnitude: 7 }, "50.1234567");
+  });
+
+  it("handles assets without matching tokens gracefully", async () => {
+    (fetchAccount as jest.Mock).mockResolvedValue({
+      balance: 100000000,
+      spendableBalance: 99999990,
+      assets: [
+        {
+          asset_type: "credit_alphanum4",
+          asset_code: "USDT",
+          asset_issuer: "issuer-address",
+          balance: "25.0000000",
+        },
+      ],
+    });
+
+    (getAssetIdFromAsset as jest.Mock).mockReturnValue("USDT-issuer-address");
+    (findTokenById as jest.Mock).mockReturnValue(null);
+
+    const result = await getBalance("test-address");
+
+    expect(result).toEqual([
+      {
+        value: BigInt(100000000),
+        asset: { type: "native" },
+        locked: BigInt(10),
+      },
+      {
+        value: BigInt(0),
+        asset: {
+          type: "credit_alphanum4",
+          assetReference: "USDT",
+          assetOwner: "issuer-address",
+        },
+      },
+    ]);
+
+    expect(fetchAccount).toHaveBeenCalledWith("test-address");
+    expect(getAssetIdFromAsset).toHaveBeenCalledWith({
+      asset_type: "credit_alphanum4",
+      asset_code: "USDT",
+      asset_issuer: "issuer-address",
+      balance: "25.0000000",
+    });
+    expect(findTokenById).toHaveBeenCalledWith("stellar/asset/USDT-issuer-address");
   });
 });

package/src/logic/listOperations.unit.test.ts

@@ -1,7 +1,8 @@
 import { listOperations } from "./listOperations";
 import coinConfig from "../config";
-import { OperationCallBuilder } from "@stellar/stellar-sdk/lib/horizon/operation_call_builder";
-import { HorizonApi } from "@stellar/stellar-sdk/lib/horizon";
+import { Horizon } from "@stellar/stellar-sdk";
+
+jest.mock("@stellar/stellar-sdk");
 
 describe("listOperations", () => {
   coinConfig.setCoinConfig(() => ({
@@ -9,8 +10,34 @@ describe("listOperations", () => {
     explorer: { url: "https://stellar.coin.ledger.com" },
   }));
 
+  const mockCall = jest.fn();
+
+  beforeEach(() => {
+    (Horizon.Server as jest.Mock).mockImplementation(() => ({
+      operations: () => ({
+        forAccount: () => ({
+          limit: () => ({
+            order: () => ({
+              cursor: () => ({
+                includeFailed: () => ({
+                  join: () => ({
+                    call: mockCall,
+                  }),
+                }),
+              }),
+            }),
+          }),
+        }),
+      }),
+    }));
+  });
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
   it("lists operations associated with an address", async () => {
-    jest.spyOn(OperationCallBuilder.prototype, "call").mockResolvedValue({
+    mockCall.mockResolvedValueOnce({
       records: [
         {
           id: "operation_id1",
@@ -20,7 +47,7 @@ describe("listOperations", () => {
           from: "address",
           to: "receiver1",
           amount: "46.0600000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: true,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -40,7 +67,7 @@ describe("listOperations", () => {
           from: "address",
           to: "receiver2",
           amount: "666.0000000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: false,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -60,7 +87,7 @@ describe("listOperations", () => {
           from: "sender",
           to: "address",
           amount: "50.5000000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: true,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -85,6 +112,7 @@ describe("listOperations", () => {
             ledgerOpType: "OUT",
             sequence: undefined,
             memo: undefined,
+            status: "success",
           },
           senders: ["address"],
           recipients: ["receiver1"],
@@ -105,6 +133,7 @@ describe("listOperations", () => {
             ledgerOpType: "OUT",
             sequence: undefined,
             memo: undefined,
+            status: "failed",
           },
           senders: ["address"],
           recipients: ["receiver2"],
@@ -125,6 +154,7 @@ describe("listOperations", () => {
             ledgerOpType: "IN",
             sequence: undefined,
             memo: undefined,
+            status: "success",
           },
           senders: ["sender"],
           recipients: ["address"],
@@ -143,7 +173,7 @@ describe("listOperations", () => {
   });
 
   it("stops at minHeight", async () => {
-    jest.spyOn(OperationCallBuilder.prototype, "call").mockResolvedValue({
+    mockCall.mockResolvedValueOnce({
       records: [
         {
           id: "operation_id1",
@@ -153,7 +183,7 @@ describe("listOperations", () => {
           from: "address",
           to: "receiver1",
           amount: "46.0600000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: true,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -173,7 +203,7 @@ describe("listOperations", () => {
           from: "address",
           to: "receiver2",
           amount: "666.0000000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: false,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -193,7 +223,7 @@ describe("listOperations", () => {
           from: "sender",
           to: "address",
           amount: "50.5000000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: true,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -218,6 +248,7 @@ describe("listOperations", () => {
             ledgerOpType: "OUT",
             sequence: undefined,
             memo: undefined,
+            status: "success",
           },
           senders: ["address"],
           recipients: ["receiver1"],
@@ -238,6 +269,7 @@ describe("listOperations", () => {
             ledgerOpType: "OUT",
             sequence: undefined,
             memo: undefined,
+            status: "failed",
           },
           senders: ["address"],
           recipients: ["receiver2"],
@@ -256,7 +288,7 @@ describe("listOperations", () => {
   });
 
   it("should return memo if set", async () => {
-    jest.spyOn(OperationCallBuilder.prototype, "call").mockResolvedValue({
+    mockCall.mockResolvedValueOnce({
       records: [
         {
           id: "operation_id1",
@@ -266,7 +298,7 @@ describe("listOperations", () => {
           from: "address",
           to: "receiver1",
           amount: "46.0600000",
-          type: HorizonApi.OperationResponseType.payment,
+          type: Horizon.HorizonApi.OperationResponseType.payment,
           transaction_successful: true,
           created_at: "2025-01-01",
           transaction: () => ({
@@ -306,6 +338,7 @@ describe("listOperations", () => {
               type: "MEMO_TEXT",
               value: "momo",
             },
+            status: "success",
           },
         },
       ],

package/src/logic/validateIntent.ts

@@ -8,14 +8,13 @@ import {
   InvalidAddress,
 } from "@ledgerhq/errors";
 import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
-import { TransactionValidation, TransactionIntent } from "@ledgerhq/coin-framework/api/types";
-import { isAddressValid, isAccountMultiSign, isMemoValid } from "./utils";
 import {
-  BASE_RESERVE,
-  MIN_BALANCE,
-  fetchAccountNetworkInfo,
-  getRecipientAccount,
-} from "../network";
+  TransactionValidation,
+  TransactionIntent,
+  FeeEstimation,
+} from "@ledgerhq/coin-framework/api/types";
+import { isAddressValid, isAccountMultiSign, isMemoValid } from "./utils";
+import { fetchAccountNetworkInfo, getRecipientAccount } from "../network";
 import {
   StellarWrongMemoFormat,
   StellarAssetRequired,
@@ -32,9 +31,11 @@ import {
 import BigNumber from "bignumber.js";
 import { getBalance } from "./getBalance";
 import { fetchAccount } from "../network/horizon";
+import { BASE_RESERVE, MIN_BALANCE } from "../network/serialization";
 
 export const validateIntent = async (
   transactionIntent: TransactionIntent<StellarMemo>,
+  customFees?: FeeEstimation,
 ): Promise<TransactionValidation> => {
   const errors: Record<string, Error> = {};
   const warnings: Record<string, Error> = {};
@@ -47,7 +48,7 @@ export const validateIntent = async (
   const { spendableBalance, balance } = await fetchAccount(transactionIntent.sender);
   const networkInfo = await fetchAccountNetworkInfo(transactionIntent.sender);
 
-  const estimatedFees = transactionIntent.fees ?? 0n;
+  const estimatedFees = customFees?.value ?? 0n;
   const baseReserve = networkInfo.baseReserve
     ? BigInt(Math.round(networkInfo.baseReserve.toNumber() * 10)) / 10n
     : 0n;
@@ -203,7 +204,7 @@ export const validateIntent = async (
       }
     }
 
-    if (!errors.amount && amount === 0n) {
+    if (amount === 0n) {
       errors.amount = new AmountRequired();
     }
   }

package/src/network/horizon.ts

@@ -26,11 +26,7 @@ import {
   NetworkCongestionLevel,
   StellarOperation,
 } from "../types";
-import {
-  getAccountSpendableBalance,
-  getReservedBalance,
-  rawOperationsToOperations,
-} from "./serialization";
+import { getReservedBalance, rawOperationsToOperations } from "./serialization";
 import { patchHermesTypedArraysIfNeeded, unpatchHermesTypedArrays } from "../polyfill";
 
 const FALLBACK_BASE_FEE = 100;
@@ -52,11 +48,6 @@ function getServer(): Horizon.Server {
   return server;
 }
 
-// Constants
-export const BASE_RESERVE = 0.5;
-export const BASE_RESERVE_MIN_COUNT = 2;
-export const MIN_BALANCE = 1;
-
 // Due to the inconsistency between the axios version (1.6.5) used by `stellar-sdk`
 // and the version (0.26.1) used by `@ledgerhq/live-network/network`, it is not possible to use the interceptors
 // provided by `@ledgerhq/live-network/network`.
@@ -78,6 +69,19 @@ function useConfigHost(url: string): string {
   return u.toString();
 }
 
+const getMinimumBalance = (account: Horizon.ServerApi.AccountRecord): BigNumber => {
+  return parseCurrencyUnit(currency.units[0], getReservedBalance(account).toString());
+};
+
+export async function getAccountSpendableBalance(
+  balance: BigNumber,
+  account: Horizon.ServerApi.AccountRecord,
+): Promise<BigNumber> {
+  const minimumBalance = getMinimumBalance(account);
+  const { recommendedFee } = await fetchBaseFee();
+  return BigNumber.max(balance.minus(minimumBalance).minus(recommendedFee), 0);
+}
+
 Horizon.AxiosClient.interceptors.response.use(response => {
   if (coinConfig.getCoinConfig().enableNetworkLogs) {
     const { url, method } = response.config;
@@ -323,7 +327,7 @@ export async function fetchOperations({
 
     // in this context, if we have filtered out operations it means those operations were < minHeight, so we are done
     const nextCursor =
-      filteredOps.length == rawOps.length ? rawOps[rawOps.length - 1].paging_token : "";
+      filteredOps.length === rawOps.length ? rawOps[rawOps.length - 1].paging_token : "";
 
     return [filteredOps, nextCursor];
   } catch (e: unknown) {
@@ -396,14 +400,18 @@ export async function fetchSigners(account: string): Promise<Signer[]> {
 }
 
 export async function broadcastTransaction(signedTransaction: string): Promise<string> {
-  patchHermesTypedArraysIfNeeded();
-  const transaction = new StellarSdkTransaction(signedTransaction, Networks.PUBLIC);
-  // Immediately restore
-  unpatchHermesTypedArrays();
-  const res = await getServer().submitTransaction(transaction, {
-    skipMemoRequiredCheck: true,
-  });
-  return res.hash;
+  try {
+    patchHermesTypedArraysIfNeeded();
+    const transaction = new StellarSdkTransaction(signedTransaction, Networks.PUBLIC);
+
+    const res = await getServer().submitTransaction(transaction, {
+      skipMemoRequiredCheck: true,
+    });
+    return res.hash;
+  } finally {
+    // Restore
+    unpatchHermesTypedArrays();
+  }
 }
 
 export async function loadAccount(addr: string): Promise<AccountRecord | null> {

package/src/network/index.ts

@@ -10,7 +10,4 @@ export {
   getLastBlock,
   getRecipientAccount,
   loadAccount,
-  BASE_RESERVE,
-  BASE_RESERVE_MIN_COUNT,
-  MIN_BALANCE,
 } from "./horizon";

package/src/network/serialization.ts

@@ -7,24 +7,15 @@ import { encodeOperationId } from "@ledgerhq/coin-framework/operation";
 import { getCryptoCurrencyById } from "@ledgerhq/cryptoassets/currencies";
 import { parseCurrencyUnit } from "@ledgerhq/coin-framework/currencies/parseCurrencyUnit";
 import { Horizon } from "@stellar/stellar-sdk";
-import { BASE_RESERVE, BASE_RESERVE_MIN_COUNT, fetchBaseFee } from "./horizon";
 import type { BalanceAsset, RawOperation, StellarMemo, StellarOperation } from "../types";
 import BigNumber from "bignumber.js";
 
 const currency = getCryptoCurrencyById("stellar");
 
-export async function getAccountSpendableBalance(
-  balance: BigNumber,
-  account: Horizon.ServerApi.AccountRecord,
-): Promise<BigNumber> {
-  const minimumBalance = getMinimumBalance(account);
-  const { recommendedFee } = await fetchBaseFee();
-  return BigNumber.max(balance.minus(minimumBalance).minus(recommendedFee), 0);
-}
-
-const getMinimumBalance = (account: Horizon.ServerApi.AccountRecord): BigNumber => {
-  return parseCurrencyUnit(currency.units[0], getReservedBalance(account).toString());
-};
+// Constants
+const BASE_RESERVE_MIN_COUNT = 2;
+export const BASE_RESERVE = 0.5;
+export const MIN_BALANCE = 1;
 
 export function getReservedBalance(account: Horizon.ServerApi.AccountRecord): BigNumber {
   const numOfSponsoringEntries = Number(account.num_sponsoring);

package/src/polyfill.ts

@@ -22,7 +22,10 @@ export function patchHermesTypedArraysIfNeeded() {
   if (global.HermesInternal && !hermesTypedArrayPatched) {
     try {
       log("coin:stellar", "🔵 Patching TypedArray because of Hermes bug");
-      require("@exodus/patch-broken-hermes-typed-arrays");
+      // Only require the module when we're actually running on Hermes
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const fixHermesTypedArrayBug = require("@exodus/patch-broken-hermes-typed-arrays");
+      fixHermesTypedArrayBug();
       hermesTypedArrayPatched = true;
     } catch (e) {
       log("coin:stellar", "Failed to patch typed arrays");

package/src/types/bridge.ts

@@ -9,6 +9,7 @@ import type {
   TransactionStatusCommon,
   TransactionStatusCommonRaw,
 } from "@ledgerhq/types-live";
+import { FeeEstimation } from "@ledgerhq/coin-framework/api/types";
 
 export type NetworkInfo = {
   family: "stellar";
@@ -52,6 +53,7 @@ export type StellarTransactionMode = "send" | "changeTrust";
 export type Transaction = TransactionCommon & {
   family: "stellar";
   networkInfo?: NetworkInfo | null | undefined;
+  customFees?: FeeEstimation;
   fees?: BigNumber | null;
   baseReserve?: BigNumber | null;
   memoType?: string | null;