@ledgerhq/coin-xrp 0.8.0-nightly.6 → 0.8.0

package/src/api/index.test.ts

@@ -41,12 +41,14 @@ describe("listOperations", () => {
       const fee = 10;
       mockGetTransactions.mockResolvedValue([
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -54,12 +56,14 @@ describe("listOperations", () => {
           },
         },
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -68,12 +72,14 @@ describe("listOperations", () => {
           },
         },
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -106,7 +112,11 @@ describe("listOperations", () => {
           type: "Payment",
           value: expectedValue,
           fee: BigInt(10),
-          blockHeight: 1,
+          block: {
+            hash: "HASH_VALUE_BLOCK",
+            height: 1,
+            time: new Date("2000-01-01T00:00:01Z"),
+          },
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),
@@ -118,7 +128,11 @@ describe("listOperations", () => {
           type: "Payment",
           value: expectedValue,
           fee: BigInt(10),
-          blockHeight: 1,
+          block: {
+            hash: "HASH_VALUE_BLOCK",
+            height: 1,
+            time: new Date("2000-01-01T00:00:01Z"),
+          },
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),
@@ -133,7 +147,11 @@ describe("listOperations", () => {
           type: "Payment",
           value: expectedValue,
           fee: BigInt(10),
-          blockHeight: 1,
+          block: {
+            hash: "HASH_VALUE_BLOCK",
+            height: 1,
+            time: new Date("2000-01-01T00:00:01Z"),
+          },
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),

package/src/api/index.ts

@@ -45,11 +45,18 @@ async function operations(
   address: string,
   { limit, start }: Pagination,
 ): Promise<[Operation[], number]> {
-  const [ops, index] = await listOperations(address, { limit, mostRecentIndex: start });
+  const [ops, index] = await listOperations(address, { limit, startAt: start ?? 0 });
   return [
     ops.map(op => {
-      const { simpleType, ...rest } = op;
-      return { ...rest } satisfies Operation;
+      const { simpleType, blockHash, blockTime, blockHeight, ...rest } = op;
+      return {
+        ...rest,
+        block: {
+          height: blockHeight,
+          hash: blockHash,
+          time: blockTime,
+        },
+      } satisfies Operation;
     }),
     index,
   ];

package/src/bridge/synchronization.test.ts

@@ -78,12 +78,13 @@ describe("getAccountShape", () => {
     });
     mockGetTransactions.mockResolvedValue([
       {
+        ledger_hash: "HASH_VALUE_BLOCK",
+        hash: "HASH_VALUE",
         meta: { delivered_amount: "100" },
-        tx: {
+        tx_json: {
           TransactionType: "Payment",
           Fee: "10",
-          hash: "HASH_VALUE",
-          inLedger: 1,
+          ledger_index: 1,
           date: 1000,
           Account: "account_addr",
           Destination: "destination_addr",
@@ -117,7 +118,7 @@ describe("getAccountShape", () => {
       operations: [
         {
           accountId: "js:2:ripple:address:",
-          blockHash: null,
+          blockHash: "HASH_VALUE_BLOCK",
           blockHeight: 1,
           date: new Date("2000-01-01T00:16:40.000Z"),
           hash: "HASH_VALUE",

package/src/bridge/synchronization.ts

@@ -74,7 +74,7 @@ async function filterOperations(
         type: op.simpleType,
         value: new BigNumber(op.value.toString()),
         fee: new BigNumber(op.fee.toString()),
-        blockHash: null,
+        blockHash: op.blockHash,
         blockHeight: op.blockHeight,
         senders: op.senders,
         recipients: op.recipients,

package/src/logic/listOperations.test.ts

@@ -39,12 +39,14 @@ describe("listOperations", () => {
       const fee = 10;
       mockGetTransactions.mockResolvedValue([
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -52,12 +54,14 @@ describe("listOperations", () => {
           },
         },
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -66,12 +70,14 @@ describe("listOperations", () => {
           },
         },
         {
+          ledger_hash: "HASH_VALUE_BLOCK",
+          hash: "HASH_VALUE",
+          close_time_iso: "2000-01-01T00:00:01Z",
           meta: { delivered_amount: deliveredAmount.toString() },
-          tx: {
+          tx_json: {
             TransactionType: "Payment",
             Fee: fee.toString(),
-            hash: "HASH_VALUE",
-            inLedger: 1,
+            ledger_index: 1,
             date: 1000,
             Account: opSender,
             Destination: opDestination,
@@ -106,6 +112,8 @@ describe("listOperations", () => {
           value: expectedValue,
           fee: BigInt(10),
           blockHeight: 1,
+          blockHash: "HASH_VALUE_BLOCK",
+          blockTime: new Date("2000-01-01T00:00:01Z"),
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),
@@ -119,6 +127,8 @@ describe("listOperations", () => {
           value: expectedValue,
           fee: BigInt(10),
           blockHeight: 1,
+          blockHash: "HASH_VALUE_BLOCK",
+          blockTime: new Date("2000-01-01T00:00:01Z"),
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),
@@ -135,6 +145,8 @@ describe("listOperations", () => {
           value: expectedValue,
           fee: BigInt(10),
           blockHeight: 1,
+          blockHash: "HASH_VALUE_BLOCK",
+          blockTime: new Date("2000-01-01T00:00:01Z"),
           senders: [opSender],
           recipients: [opDestination],
           date: new Date(1000000 + RIPPLE_EPOCH * 1000),

package/src/logic/listOperations.ts

@@ -26,9 +26,16 @@ export async function listOperations(
   const minLedgerVersion = Number(ledgers[0]);
   const maxLedgerVersion = Number(ledgers[1]);
 
-  let options: { ledger_index_min?: number; ledger_index_max?: number; limit?: number } = {
+  let options: {
+    ledger_index_min?: number;
+    ledger_index_max?: number;
+    limit?: number;
+    tx_type?: string;
+  } = {
     ledger_index_max: mostRecentIndex ?? maxLedgerVersion,
+    tx_type: "Payment",
   };
+
   if (limit) {
     options = {
       ...options,
@@ -39,17 +46,33 @@ export async function listOperations(
     options = {
       ...options,
       // if there is no ops, it might be after a clear and we prefer to pull from the oldest possible history
-      ledger_index_min: Math.max(startAt ?? 0, minLedgerVersion),
+      ledger_index_min: Math.max(startAt, minLedgerVersion),
     };
   }
 
-  const transactions = await getTransactions(address, options);
+  // We need to filter out the transactions that are not "Payment" type because the filter on "tx_type" of the node RPC
+  // is not working as expected. It returns all the transactions. We need to call the node RPC multiple times to get the
+  // desired number of transactions by the limiter.
+  let transactions: XrplOperation[] = [];
+  let needToStop = true;
+  do {
+    const newTransactions = await getTransactions(address, options);
+    const newPaymentsTxs = newTransactions.filter(tx => tx.tx_json.TransactionType === "Payment");
+    if (options.limit) {
+      needToStop = newTransactions.length < options.limit;
+      options.ledger_index_max = newTransactions.slice(-1)[0].tx_json.ledger_index - 1;
+    }
+    transactions = transactions.concat(newPaymentsTxs);
+  } while (
+    options.limit &&
+    !needToStop &&
+    transactions.length < options.limit &&
+    (options.limit -= transactions.length)
+  );
 
   return [
-    transactions
-      .filter(op => op.tx.TransactionType === "Payment")
-      .map(convertToCoreOperation(address)),
-    transactions.slice(-1)[0].tx.ledger_index - 1, // Returns the next index to start from for pagination
+    transactions.map(convertToCoreOperation(address)),
+    transactions.slice(-1)[0].tx_json.ledger_index - 1, // Returns the next index to start from for pagination
   ];
 }
 
@@ -57,18 +80,20 @@ const convertToCoreOperation =
   (address: string) =>
   (operation: XrplOperation): XrpOperation => {
     const {
+      ledger_hash,
+      hash,
+      close_time_iso,
       meta: { delivered_amount },
-      tx: {
+      tx_json: {
         TransactionType,
         Fee,
-        hash,
-        inLedger,
         date,
         Account,
         Destination,
         DestinationTag,
         Sequence,
         Memos,
+        ledger_index,
       },
     } = operation;
 
@@ -112,13 +137,15 @@ const convertToCoreOperation =
     }
 
     let op: XrpOperation = {
+      blockTime: new Date(close_time_iso),
+      blockHash: ledger_hash,
       hash,
       address,
       type: TransactionType,
       simpleType: type,
       value,
       fee,
-      blockHeight: inLedger,
+      blockHeight: ledger_index,
       senders: [Account],
       recipients: [Destination],
       date: new Date(toEpochDate),

package/src/network/index.ts

@@ -72,8 +72,8 @@ export const getTransactions = async (
 ): Promise<XrplOperation[]> => {
   const result = await rpcCall<AccountTxResponse>("account_tx", {
     account: address,
-    ledger_index: "validated",
     ...options,
+    api_version: 2,
   });
 
   return result.transactions;
@@ -109,7 +109,7 @@ async function rpcCall<T extends object>(
   });
 
   if (isResponseStatus(result) && result.status !== "success") {
-    throw new Error(`couldn't fetch ${method} with params ${params}`);
+    throw new Error(`couldn't fetch ${method} with params ${JSON.stringify(params)}`);
   }
 
   return result;

package/src/network/types.ts

@@ -1,4 +1,7 @@
 export type XrplOperation = {
+  ledger_hash: string;
+  hash: string;
+  close_time_iso: string;
   meta: {
     AffectedNodes: {
       ModifiedNode: {
@@ -22,7 +25,7 @@ export type XrplOperation = {
     TransactionResult: string;
     delivered_amount: string;
   };
-  tx: {
+  tx_json: {
     Account: string;
     Amount: string;
     DeliverMax: string;
@@ -44,8 +47,6 @@ export type XrplOperation = {
     TransactionType: string;
     TxnSignature: string;
     date: number;
-    hash: string;
-    inLedger: number;
     ledger_index: number;
   };
   validated: boolean;

package/src/types/model.ts

@@ -11,6 +11,8 @@ export type XrpMemo = {
   type?: string;
 };
 export type XrpOperation = {
+  blockTime: Date;
+  blockHash: string;
   hash: string;
   address: string;
   type: string;