@ledgerhq/coin-xrp 3.2.0 → 4.0.0-next.0

package/src/api/index.test.ts

@@ -1,8 +1,8 @@
 import { Operation, TransactionIntent } from "@ledgerhq/coin-framework/api/types";
 import * as LogicFunctions from "../logic";
 import { GetTransactionsOptions } from "../network";
-import { NetworkInfo } from "../types";
-import { createApi } from "./index";
+import { NetworkInfo, XrpAsset } from "../types";
+import { createApi, TransactionIntentExtra } from "./index";
 
 const mockGetServerInfos = jest.fn().mockResolvedValue({
   info: {
@@ -183,6 +183,7 @@ describe("listOperations", () => {
       // the order is reversed so that the result is always sorted by newest tx first element of the list
       expect(results).toEqual([
         {
+          asset: { type: "native" },
           operationIndex: 0,
           tx: {
             hash: "HASH_VALUE",
@@ -210,6 +211,7 @@ describe("listOperations", () => {
           },
         },
         {
+          asset: { type: "native" },
           operationIndex: 0,
           tx: {
             hash: "HASH_VALUE",
@@ -232,6 +234,7 @@ describe("listOperations", () => {
           },
         },
         {
+          asset: { type: "native" },
           operationIndex: 0,
           tx: {
             hash: "HASH_VALUE",
@@ -252,7 +255,7 @@ describe("listOperations", () => {
             sequence: 1,
           },
         },
-      ] satisfies Operation<void>[]);
+      ] satisfies Operation<XrpAsset>[]);
     },
   );
 });
@@ -281,7 +284,7 @@ describe("Testing craftTransaction function", () => {
 
   it("should use custom user fees when user provides it for crafting a transaction", async () => {
     const customFees = 99n;
-    await api.craftTransaction({} as TransactionIntent<void>, customFees);
+    await api.craftTransaction({} as TransactionIntent<XrpAsset>, customFees);
 
     expect(logicCraftTransactionSpy).toHaveBeenCalledWith(
       expect.any(Object),
@@ -292,7 +295,7 @@ describe("Testing craftTransaction function", () => {
   });
 
   it("should use default fees when user does not provide them for crafting a transaction", async () => {
-    await api.craftTransaction({} as TransactionIntent<void>);
+    await api.craftTransaction({} as TransactionIntent<XrpAsset>);
 
     expect(logicCraftTransactionSpy).toHaveBeenCalledWith(
       expect.any(Object),
@@ -301,4 +304,30 @@ describe("Testing craftTransaction function", () => {
       }),
     );
   });
+
+  it("should pass memos when user provides it for crafting a transaction", async () => {
+    await api.craftTransaction({
+      memos: [{ data: "testdata", format: "testformat", type: "testtype" }],
+    } as TransactionIntent<XrpAsset, TransactionIntentExtra>);
+
+    expect(logicCraftTransactionSpy).toHaveBeenCalledWith(
+      expect.any(Object),
+      expect.objectContaining({
+        memos: [{ data: "testdata", format: "testformat", type: "testtype" }],
+      }),
+    );
+  });
+
+  it("should pass destination tag when user provides it for crafting a transaction", async () => {
+    await api.craftTransaction({
+      destinationTag: 1337,
+    } as TransactionIntent<XrpAsset, TransactionIntentExtra>);
+
+    expect(logicCraftTransactionSpy).toHaveBeenCalledWith(
+      expect.any(Object),
+      expect.objectContaining({
+        destinationTag: 1337,
+      }),
+    );
+  });
 });

package/src/api/index.ts

@@ -15,10 +15,11 @@ import {
   getNextValidSequence,
   lastBlock,
   listOperations,
+  MemoInput,
 } from "../logic";
-import { ListOperationsOptions } from "../types";
+import { ListOperationsOptions, XrpAsset } from "../types";
 
-export function createApi(config: XrpConfig): Api<void> {
+export function createApi(config: XrpConfig): Api<XrpAsset> {
   coinConfig.setCoinConfig(() => ({ ...config, status: { type: "active" } }));
 
   return {
@@ -32,8 +33,13 @@ export function createApi(config: XrpConfig): Api<void> {
   };
 }
 
+export type TransactionIntentExtra = {
+  destinationTag?: number | null | undefined;
+  memos?: MemoInput[];
+};
+
 async function craft(
-  transactionIntent: TransactionIntent<void>,
+  transactionIntent: TransactionIntent<XrpAsset, TransactionIntentExtra>,
   customFees?: bigint,
 ): Promise<string> {
   const nextSequenceNumber = await getNextValidSequence(transactionIntent.sender);
@@ -44,6 +50,8 @@ async function craft(
       recipient: transactionIntent.recipient,
       amount: transactionIntent.amount,
       fee: estimatedFees,
+      destinationTag: transactionIntent.destinationTag,
+      memos: transactionIntent.memos ?? [],
     },
   );
   return tx.serializedTransaction;
@@ -56,13 +64,13 @@ type PaginationState = {
   readonly minHeight: number;
   continueIterations: boolean;
   apiNextCursor?: string;
-  accumulator: Operation<void>[];
+  accumulator: Operation<XrpAsset>[];
 };
 
 async function operationsFromHeight(
   address: string,
   minHeight: number,
-): Promise<[Operation<void>[], string]> {
+): Promise<[Operation<XrpAsset>[], string]> {
   async function fetchNextPage(state: PaginationState): Promise<PaginationState> {
     const options: ListOperationsOptions = {
       limit: state.pageSize,
@@ -110,7 +118,7 @@ async function operationsFromHeight(
 async function operations(
   address: string,
   { minHeight }: Pagination,
-): Promise<[Operation<void>[], string]> {
+): Promise<[Operation<XrpAsset>[], string]> {
   // TODO token must be implemented properly (waiting ack from the design document)
   return await operationsFromHeight(address, minHeight);
 }

package/src/bridge/synchronization.ts

@@ -7,7 +7,7 @@ import BigNumber from "bignumber.js";
 import { listOperations, parseAPIValue } from "../logic";
 import { getAccountInfo, getServerInfos } from "../network";
 import { ServerInfoResponse } from "../network/types";
-import { AccountInfo } from "../types";
+import { AccountInfo, XrpAsset } from "../types";
 
 export const getAccountShape: GetAccountShape = async info => {
   const { address, initialAccount, currency, derivationMode } = info;
@@ -69,7 +69,10 @@ async function filterOperations(
   return operations.map(op => adaptCoreOperationToLiveOperation(accountId, op) satisfies Operation);
 }
 
-function adaptCoreOperationToLiveOperation(accountId: string, op: CoreOperation<void>): Operation {
+function adaptCoreOperationToLiveOperation(
+  accountId: string,
+  op: CoreOperation<XrpAsset>,
+): Operation {
   return {
     id: encodeOperationId(accountId, op.tx.hash, op.type),
     hash: op.tx.hash,

package/src/logic/craftTransaction.ts

@@ -31,7 +31,7 @@ type XrplTransaction = {
   Memos?: MemoWrapper[];
 };
 
-type MemoInput = {
+export type MemoInput = {
   data?: string;
   format?: string;
   type?: string;

package/src/logic/getBalance.test.ts

@@ -25,6 +25,6 @@ describe("getBalance", () => {
     // Then
     expect(mockGetAccountInfo).toHaveBeenCalledTimes(1);
     expect(mockGetAccountInfo.mock.lastCall[0]).toEqual(address);
-    expect(result).toEqual(balance);
+    expect(result).toEqual([{ value: balance, asset: { type: "native" } }]);
   });
 });

package/src/logic/getBalance.ts

@@ -1,6 +1,8 @@
+import { Balance } from "@ledgerhq/coin-framework/api/types";
 import { getAccountInfo } from "../network";
+import { XrpAsset } from "../types";
 
-export async function getBalance(address: string): Promise<bigint> {
+export async function getBalance(address: string): Promise<Balance<XrpAsset>[]> {
   const accountInfo = await getAccountInfo(address);
-  return BigInt(accountInfo.balance);
+  return [{ value: BigInt(accountInfo.balance), asset: { type: "native" } }];
 }

package/src/logic/index.ts

@@ -1,6 +1,7 @@
 export { broadcast } from "./broadcast";
 export { combine } from "./combine";
 export { craftTransaction } from "./craftTransaction";
+export type { MemoInput } from "./craftTransaction";
 export { estimateFees } from "./estimateFees";
 export { getBalance } from "./getBalance";
 export { lastBlock } from "./lastBlock";

package/src/logic/listOperations.test.ts

@@ -3,6 +3,7 @@ import { listOperations } from "./listOperations";
 import { RIPPLE_EPOCH } from "./utils";
 import { Marker } from "../network/types";
 import { Operation } from "@ledgerhq/coin-framework/api/types";
+import { XrpAsset } from "../types";
 
 const maxHeight = 2;
 const minHeight = 1;
@@ -75,6 +76,7 @@ describe("listOperations", () => {
       Account: "sender",
       Destination: "dest",
       Sequence: 1,
+      SigningPubKey: "DEADBEEF",
     },
   };
   const otherTx = { ...paymentTx, tx_json: { ...paymentTx.tx_json, TransactionType: "Other" } };
@@ -97,7 +99,7 @@ describe("listOperations", () => {
     expect(JSON.parse(token)).toEqual(someMarker);
   });
 
-  it("should make enough calls so that the limit requested is satified", async () => {
+  it("should make enough calls so that the limit requested is satisfied", async () => {
     const txs = [paymentTx, paymentTx, otherTx, otherTx, otherTx, otherTx, otherTx, otherTx];
     assert(txs.length === 8);
     mockNetworkGetTransactions.mockResolvedValue(mockNetworkTxs(txs));
@@ -161,6 +163,7 @@ describe("listOperations", () => {
               Account: opSender,
               Destination: opDestination,
               Sequence: 1,
+              SigningPubKey: "DEADBEEF",
             },
           },
           {
@@ -177,6 +180,7 @@ describe("listOperations", () => {
               Destination: opDestination,
               DestinationTag: 509555,
               Sequence: 1,
+              SigningPubKey: "DEADBEEF",
             },
           },
           {
@@ -200,6 +204,7 @@ describe("listOperations", () => {
                 },
               ],
               Sequence: 1,
+              SigningPubKey: "DEADBEEF",
             },
           },
         ]),
@@ -216,6 +221,7 @@ describe("listOperations", () => {
         expectedType === "IN" ? BigInt(deliveredAmount) : BigInt(deliveredAmount + fee);
       expect(results).toEqual([
         {
+          asset: { type: "native" },
           operationIndex: 0,
           tx: {
             fees: BigInt(10),
@@ -240,9 +246,11 @@ describe("listOperations", () => {
                 data: "72656e74",
               },
             ],
+            signingPubKey: "DEADBEEF",
           },
         },
         {
+          asset: { type: "native" },
           operationIndex: 0,
           tx: {
             hash: "HASH_VALUE",
@@ -262,9 +270,11 @@ describe("listOperations", () => {
             sequence: 1,
             destinationTag: 509555,
             xrpTxType: "Payment",
+            signingPubKey: "DEADBEEF",
           },
         },
         {
+          asset: { type: "native" },
           tx: {
             hash: "HASH_VALUE",
             fees: BigInt(10),
@@ -278,6 +288,7 @@ describe("listOperations", () => {
           details: {
             sequence: 1,
             xrpTxType: "Payment",
+            signingPubKey: "DEADBEEF",
           },
           type: expectedType,
           value: expectedValue,
@@ -285,7 +296,7 @@ describe("listOperations", () => {
           recipients: [opDestination],
           operationIndex: 0,
         },
-      ] satisfies Operation<void>[]);
+      ] satisfies Operation<XrpAsset>[]);
     },
   );
 });

package/src/logic/listOperations.ts

@@ -1,7 +1,7 @@
 import { Operation } from "@ledgerhq/coin-framework/api/types";
 import { getServerInfos, getTransactions, GetTransactionsOptions } from "../network";
 import type { XrplOperation } from "../network/types";
-import { ListOperationsOptions, XrpMemo } from "../types";
+import { ListOperationsOptions, XrpAsset, XrpMemo } from "../types";
 import { RIPPLE_EPOCH } from "./utils";
 
 /**
@@ -20,7 +20,7 @@ import { RIPPLE_EPOCH } from "./utils";
 export async function listOperations(
   address: string,
   { limit, minHeight, token, order }: ListOperationsOptions,
-): Promise<[Operation<void>[], string]> {
+): Promise<[Operation<XrpAsset>[], string]> {
   const serverInfo = await getServerInfos();
   const ledgers = serverInfo.info.complete_ledgers.split("-");
   const minLedgerVersion = Number(ledgers[0]);
@@ -99,7 +99,7 @@ export async function listOperations(
 
 const convertToCoreOperation =
   (address: string) =>
-  (operation: XrplOperation): Operation<void> => {
+  (operation: XrplOperation): Operation<XrpAsset> => {
     const {
       ledger_hash,
       hash,
@@ -115,6 +115,7 @@ const convertToCoreOperation =
         Memos,
         ledger_index,
         Sequence,
+        SigningPubKey,
       },
     } = operation;
 
@@ -161,9 +162,11 @@ const convertToCoreOperation =
       ...details,
       xrpTxType: TransactionType,
       sequence: Sequence,
+      signingPubKey: SigningPubKey,
     };
 
-    let op: Operation<void> = {
+    let op: Operation<XrpAsset> = {
+      asset: { type: "native" },
       operationIndex: 0,
       tx: {
         hash: hash,

package/src/types/assets.ts

@@ -0,0 +1,3 @@
+import { Asset } from "@ledgerhq/coin-framework/api/types";
+
+export type XrpAsset = Asset;

package/src/types/index.ts

@@ -1,3 +1,4 @@
+export * from "./assets";
 export * from "./bridge";
 export * from "./model";
 export * from "./signer";