@ledgerhq/coin-xrp 7.1.0 → 7.1.1-nightly.1

package/src/logic/getTransactionStatus.test.ts

@@ -1,8 +1,14 @@
 import { getTransactionStatus } from "./getTransactionStatus";
 import * as utils from "./utils";
 
+const mockGetBalance = jest.fn();
+
 const mockGetServerInfos = jest.fn();
 
+jest.mock("./getBalance", () => ({
+  getBalance: () => mockGetBalance(),
+}));
+
 jest.mock("../network", () => ({
   getServerInfos: () => mockGetServerInfos(),
 }));
@@ -20,21 +26,9 @@ const SENDER = "rPSCfmnX3t9jQJG5RNcZtSaP5UhExZDue4";
 const RECIPIENT = "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe";
 const RECIPIENT_NEW = "rDKsbvy9uaNpPtvVFraJyNGfjvTw8xivgK";
 
-const account = {
-  address: SENDER,
-  balance: 50_000_000n,
-  currencyUnit: {
-    code: "XRP",
-    magnitude: 6,
-    name: "XRP",
-    symbol: "XRP",
-  },
-  currencyName: "XRP",
-};
-
 describe("getTransactionStatus", () => {
   afterEach(() => {
-    mockGetServerInfos.mockReset();
+    jest.clearAllMocks();
   });
 
   it("returns no errors on valid transaction", async () => {
@@ -45,13 +39,22 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 20_000_000n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: RECIPIENT,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -68,13 +71,22 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 1_000_000n,
-        fee: 200_000n, // 20%
+        fees: 200_000n, // 20%
         recipient: RECIPIENT,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -90,12 +102,21 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 30_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 10_000_000n,
         recipient: RECIPIENT,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -110,13 +131,22 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 10_000_000n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: SENDER,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -131,13 +161,22 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 5_000_000n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: RECIPIENT_NEW,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -152,13 +191,22 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
         amount: 0n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: RECIPIENT,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
       } as any,
     );
 
@@ -173,12 +221,21 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
         amount: 1_000_000n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: "not-an-address",
       } as any,
     );
@@ -194,12 +251,21 @@ describe("getTransactionStatus", () => {
         },
       },
     });
+    mockGetBalance.mockResolvedValue([
+      {
+        value: 50_000_000n,
+        asset: { type: "native" },
+        locked: 0n,
+      },
+    ]);
 
     const result = await getTransactionStatus(
-      account as any,
+      // account as any,
       {
+        sender: SENDER,
+        asset: { unit: { code: "XRP", magnitude: 6 } },
         amount: 1_000_000n,
-        fee: 10_000n,
+        fees: 10_000n,
         recipient: "",
       } as any,
     );

package/src/logic/getTransactionStatus.ts

@@ -14,11 +14,12 @@ import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
 import { getServerInfos } from "../network";
 import { cachedRecipientIsNew } from "./utils";
 import { parseAPIValue } from "./common";
-import { Transaction, TransactionValidation, Account } from "@ledgerhq/coin-framework/api/types";
+import { TransactionValidation, TransactionIntent } from "@ledgerhq/coin-framework/api/types";
+import { XrpMapMemo } from "../types";
+import { getBalance } from "./getBalance";
 
 export const getTransactionStatus = async (
-  account: Account,
-  transaction: Transaction,
+  transactionIntent: TransactionIntent<XrpMapMemo>,
 ): Promise<TransactionValidation> => {
   const errors: Record<string, Error> = {};
   const warnings: Record<string, Error> = {};
@@ -26,51 +27,61 @@ export const getTransactionStatus = async (
   const reserveBaseXRP = parseAPIValue(
     serverInfos.info.validated_ledger.reserve_base_xrp.toString(),
   );
-  const estimatedFees = transaction.fee || 0n;
-  const totalSpent = transaction.amount + estimatedFees;
-  const amount = transaction.amount;
+  const estimatedFees = transactionIntent.fees || 0n;
+  const totalSpent = transactionIntent.amount + estimatedFees;
+  const amount = transactionIntent.amount;
 
   if (amount > 0 && estimatedFees * 10n > amount) {
     warnings.feeTooHigh = new FeeTooHigh();
   }
 
-  if (!transaction.fee) {
+  const balances = await getBalance(transactionIntent.sender);
+  const nativeBalance = balances.find(b => b.asset.type === "native");
+  if (nativeBalance === undefined) {
+    throw Error("Shouldn't happen");
+  }
+
+  if (!transactionIntent.fees) {
     errors.fee = new FeeNotLoaded();
-  } else if (transaction.fee == 0n) {
+  } else if (transactionIntent.fees === 0n) {
     errors.fee = new FeeRequired();
-  } else if (totalSpent > account.balance - BigInt(reserveBaseXRP.toString())) {
+  } else if (totalSpent > nativeBalance.value - BigInt(reserveBaseXRP.toString())) {
     errors.amount = new NotEnoughSpendableBalance("", {
-      minimumAmount: formatCurrencyUnit(account.currencyUnit, reserveBaseXRP, {
-        disableRounding: true,
-        useGrouping: false,
-        showCode: true,
-      }),
+      minimumAmount: transactionIntent.asset.unit
+        ? formatCurrencyUnit(transactionIntent.asset.unit, reserveBaseXRP, {
+            disableRounding: true,
+            useGrouping: false,
+            showCode: true,
+          })
+        : "Unknown unit",
     });
   } else if (
-    transaction.recipient &&
-    (await cachedRecipientIsNew(transaction.recipient)) &&
-    transaction.amount < BigInt(reserveBaseXRP.toString())
+    transactionIntent.recipient &&
+    (await cachedRecipientIsNew(transactionIntent.recipient)) &&
+    transactionIntent.amount < BigInt(reserveBaseXRP.toString())
   ) {
     errors.amount = new NotEnoughBalanceBecauseDestinationNotCreated("", {
-      minimalAmount: formatCurrencyUnit(account.currencyUnit, reserveBaseXRP, {
-        disableRounding: true,
-        useGrouping: false,
-        showCode: true,
-      }),
+      minimalAmount: transactionIntent.asset.unit
+        ? formatCurrencyUnit(transactionIntent.asset.unit, reserveBaseXRP, {
+            disableRounding: true,
+            useGrouping: false,
+            showCode: true,
+          })
+        : "Unknown unit",
     });
   }
 
-  if (!transaction.recipient) {
+  if (!transactionIntent.recipient) {
     errors.recipient = new RecipientRequired("");
-  } else if (account.address === transaction.recipient) {
+  } else if (transactionIntent.sender === transactionIntent.recipient) {
     errors.recipient = new InvalidAddressBecauseDestinationIsAlsoSource();
-  } else if (!isValidClassicAddress(transaction.recipient)) {
+  } else if (!isValidClassicAddress(transactionIntent.recipient)) {
     errors.recipient = new InvalidAddress("", {
-      currencyName: account.currencyName,
+      currencyName: transactionIntent.asset.name ?? "",
     });
   }
 
-  if (!errors.amount && amount == 0n) {
+  if (!errors.amount && amount === 0n) {
     errors.amount = new AmountRequired();
   }
 

package/src/logic/listOperations.test.ts

@@ -146,7 +146,7 @@ describe("listOperations", () => {
     async ({ address, opSender, opDestination, expectedType }) => {
       // Given
       const deliveredAmount = 100;
-      const fee = 10;
+      const fees = 10;
       mockNetworkGetTransactions.mockResolvedValue(
         mockNetworkTxs([
           {
@@ -156,7 +156,7 @@ describe("listOperations", () => {
             meta: { delivered_amount: deliveredAmount.toString() },
             tx_json: {
               TransactionType: "Payment",
-              Fee: fee.toString(),
+              Fee: fees.toString(),
               ledger_index: 1,
               date: 1000,
               Account: opSender,
@@ -172,7 +172,7 @@ describe("listOperations", () => {
             meta: { delivered_amount: deliveredAmount.toString() },
             tx_json: {
               TransactionType: "Payment",
-              Fee: fee.toString(),
+              Fee: fees.toString(),
               ledger_index: 1,
               date: 1000,
               Account: opSender,
@@ -189,7 +189,7 @@ describe("listOperations", () => {
             meta: { delivered_amount: deliveredAmount.toString() },
             tx_json: {
               TransactionType: "Payment",
-              Fee: fee.toString(),
+              Fee: fees.toString(),
               ledger_index: 1,
               date: 1000,
               Account: opSender,
@@ -217,7 +217,7 @@ describe("listOperations", () => {
       expect(mockNetworkGetTransactions).toHaveBeenCalledTimes(1);
       // if expectedType is "OUT", compute value with fees (i.e. delivered_amount + Fee)
       const expectedValue =
-        expectedType === "IN" ? BigInt(deliveredAmount) : BigInt(deliveredAmount + fee);
+        expectedType === "IN" ? BigInt(deliveredAmount) : BigInt(deliveredAmount + fees);
       expect(results).toEqual([
         {
           id: "HASH_VALUE",

package/src/logic/listOperations.ts

@@ -125,10 +125,10 @@ const convertToCoreOperation =
         ? BigInt(delivered_amount)
         : BigInt(0);
 
-    const fee = BigInt(Fee);
+    const fees = BigInt(Fee);
     if (type === "OUT") {
-      if (!Number.isNaN(fee)) {
-        value = value + fee;
+      if (!Number.isNaN(fees)) {
+        value = value + fees;
       }
     }
 
@@ -170,7 +170,7 @@ const convertToCoreOperation =
       asset: { type: "native" },
       tx: {
         hash: hash,
-        fees: fee,
+        fees: fees,
         date: new Date(toEpochDate),
         block: {
           time: new Date(close_time_iso),
@@ -184,7 +184,7 @@ const convertToCoreOperation =
       recipients: [Destination],
     };
 
-    if (Object.keys(details).length != 0) {
+    if (Object.keys(details).length !== 0) {
       op = {
         ...op,
         details,

package/src/test/bridgeDatasetTest.ts

@@ -40,7 +40,7 @@ export const dataset: DatasetTest<Transaction> = {
             recipient: "rB6pwovsyrFWhPYUsjj9V3CHck985QjiXi",
             amount: "15000000",
             tag: null,
-            fee: "1",
+            fees: "1",
             feeCustomUnit: null,
             networkInfo: null,
           }),
@@ -75,7 +75,7 @@ export const dataset: DatasetTest<Transaction> = {
             recipient: newAddress1,
             amount: "10000000",
             tag: null,
-            fee: "1",
+            fees: "1",
             feeCustomUnit: null,
             networkInfo: null
           }),
@@ -97,7 +97,7 @@ export const dataset: DatasetTest<Transaction> = {
                 recipient: "rageXHB6Q4VbvvWdTzKANwjeCT4HXFCKX7",
                 amount: "10000000",
                 tag: null,
-                fee: "10", // NOTE: fee is not customizable, this field is ignored
+                fees: "10", // NOTE: fee is not customizable, this field is ignored
                 feeCustomUnit: null,
                 networkInfo: null,
               }),
@@ -118,7 +118,7 @@ export const dataset: DatasetTest<Transaction> = {
                 recipient: "rB6pwovsyrFWhPYUsjj9V3CHck985QjiXi",
                 amount: "10000000",
                 tag: 12345,
-                fee: "10", // NOTE: fee is not customizable, this field is ignored
+                fees: "10", // NOTE: fee is not customizable, this field is ignored
                 feeCustomUnit: null,
                 networkInfo: null,
               }),

package/src/test/cli.ts

@@ -30,7 +30,7 @@ function inferTransactions(
     invariant(transaction.family === "xrp", "XRP family");
     return {
       ...transaction,
-      fee: inferAmount(account, opts.fee || "0.001xrp"),
+      fees: inferAmount(account, opts.fee || "0.001xrp"),
       tag: opts.tag,
     };
   });

package/src/transaction.ts

@@ -12,7 +12,7 @@ import { getAccountCurrency } from "@ledgerhq/coin-framework/account/index";
 import { formatCurrencyUnit } from "@ledgerhq/coin-framework/currencies/index";
 
 export const formatTransaction = (
-  { amount, recipient, fee, tag, useAllAmount }: Transaction,
+  { amount, recipient, fees, tag, useAllAmount }: Transaction,
   account: Account,
 ): string => `
 SEND ${
@@ -25,9 +25,9 @@ SEND ${
 }
 TO ${recipient}
 with fee=${
-  !fee
+  !fees
     ? "?"
-    : formatCurrencyUnit(getAccountCurrency(account).units[0], fee, {
+    : formatCurrencyUnit(getAccountCurrency(account).units[0], fees, {
         showCode: true,
         disableRounding: true,
       })
@@ -40,7 +40,7 @@ export const fromTransactionRaw = (tr: TransactionRaw): Transaction => {
     ...common,
     family: tr.family,
     tag: tr.tag,
-    fee: tr.fee ? new BigNumber(tr.fee) : null,
+    fees: tr.fees ? new BigNumber(tr.fees) : null,
     feeCustomUnit: tr.feeCustomUnit,
     // FIXME remove this field. this is not good.. we're dereferencing here. we should instead store an index (to lookup in currency.units on UI)
     networkInfo: networkInfo && {
@@ -58,7 +58,7 @@ export const toTransactionRaw = (t: Transaction): TransactionRaw => {
     ...common,
     family: t.family,
     tag: t.tag,
-    fee: t.fee ? t.fee.toString() : null,
+    fees: t.fees ? t.fees.toString() : null,
     feeCustomUnit: t.feeCustomUnit,
     // FIXME remove this field. this is not good.. we're dereferencing here. we should instead store an index (to lookup in currency.units on UI)
     networkInfo: networkInfo && {

package/src/types/bridge.ts

@@ -21,7 +21,7 @@ export type NetworkInfoRaw = {
 
 export type Transaction = TransactionCommon & {
   family: "xrp";
-  fee: BigNumber | null | undefined;
+  fees: BigNumber | null | undefined;
   networkInfo: NetworkInfo | null | undefined;
   tag: number | null | undefined;
   feeCustomUnit: Unit | null | undefined;
@@ -29,7 +29,7 @@ export type Transaction = TransactionCommon & {
 
 export type TransactionRaw = TransactionCommonRaw & {
   family: "xrp";
-  fee: string | null | undefined;
+  fees: string | null | undefined;
   networkInfo: NetworkInfoRaw | null | undefined;
   tag: number | null | undefined;
   feeCustomUnit: Unit | null | undefined;