@ledgerhq/coin-xrp 7.24.0 → 7.25.2

package/src/api/listOperations.ts

@@ -248,9 +248,7 @@ function findXrpBalanceDiff(
         typeof data.FinalFields?.Balance === 'string' &&
         typeof data.PreviousFields?.Balance === 'string'
       ) {
-        return (
-          BigInt(data.FinalFields.Balance as string) - BigInt(data.PreviousFields.Balance as string)
-        )
+        return BigInt(data.FinalFields.Balance) - BigInt(data.PreviousFields.Balance)
       }
     } else if ('CreatedNode' in node) {
       const data = node.CreatedNode
@@ -259,7 +257,7 @@ function findXrpBalanceDiff(
         data.NewFields?.Account === address &&
         typeof data.NewFields?.Balance === 'string'
       ) {
-        return BigInt(data.NewFields.Balance as string)
+        return BigInt(data.NewFields.Balance)
       }
     } else if ('DeletedNode' in node) {
       const data = node.DeletedNode
@@ -271,7 +269,7 @@ function findXrpBalanceDiff(
         data.FinalFields?.Account === address &&
         typeof data.FinalFields?.Balance === 'string'
       ) {
-        const balance = BigInt(data.FinalFields.Balance as string)
+        const balance = BigInt(data.FinalFields.Balance)
         // Include the fee in the diff so the caller's adjustedDiff = (-balance - fee) + fee = -balance
         return -(balance + fee)
       }

package/src/api/validateIntent.test.ts

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: © 2024 LEDGER SAS
 // SPDX-License-Identifier: Apache-2.0
 
-import { TransactionIntent } from '@ledgerhq/coin-module-framework/api/types'
+import { createSendTransactionIntentMockData } from '@ledgerhq/coin-module-framework/test-utils'
 import { XrpMapMemo } from '../types'
 import { XrpDestinationTagRequired, XrpInvalidMemoError } from '../utils/errors'
 import * as logicValidateMemo from '../utils/validateMemo'
@@ -41,7 +41,7 @@ const SENDER = 'rPSCfmnX3t9jQJG5RNcZtSaP5UhExZDue4'
 const RECIPIENT = 'rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe'
 
 describe('validateIntent', () => {
-  const spiedValidateMemo = logicValidateMemo.validateMemo as jest.Mock
+  const spiedValidateMemo = jest.mocked(logicValidateMemo.validateMemo)
 
   afterEach(() => {
     jest.clearAllMocks()
@@ -57,18 +57,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 20_000_000n,
         recipient: RECIPIENT,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -96,18 +91,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 1_000_000n,
         recipient: RECIPIENT,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -134,18 +124,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 10_000_000n,
         recipient: RECIPIENT,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 30_000_000n,
@@ -168,18 +153,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 10_000_000n,
         recipient: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -203,18 +183,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 5_000_000n,
         recipient: RECIPIENT_NEW,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -238,18 +213,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
         amount: 0n,
         recipient: RECIPIENT,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -273,18 +243,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 1_000_000n,
         recipient: 'not-an-address',
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -308,18 +273,13 @@ describe('validateIntent', () => {
     })
 
     const result = await validateIntent(
-      // account as any,
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 1_000_000n,
         recipient: '',
-        memo: {
-          type: '',
-          memos: new Map<string, Record<string, unknown>>(),
-        },
-      } as any,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [
         {
           value: 50_000_000n,
@@ -352,26 +312,19 @@ describe('validateIntent', () => {
 
     spiedValidateMemo.mockReturnValueOnce(true)
 
-    const memos = new Map<string, string | string[]>()
-    memos.set('destinationTag', 'random memo for unit test')
-
     const status = await validateIntent(
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 1_000_000n,
         recipient: '',
-        memo: {
-          type: '',
-          memos,
-        },
-      } as TransactionIntent<XrpMapMemo>,
+        memo: { type: 'map', memos: new Map([['destinationTag', 'random memo for unit test']]) },
+      }),
       [{ value: 10_000n, asset: { type: 'native' }, locked: 0n }]
     )
     expect(status.errors.transaction).not.toBeDefined()
 
-    expect(spiedValidateMemo).toHaveBeenCalledWith(memos.get('destinationTag'))
+    expect(spiedValidateMemo).toHaveBeenCalledWith('random memo for unit test')
   })
 
   it('should set error on transaction when memo is invalidated', async () => {
@@ -393,21 +346,14 @@ describe('validateIntent', () => {
 
     spiedValidateMemo.mockReturnValueOnce(false)
 
-    const memos = new Map<string, string | string[]>()
-    memos.set('destinationTag', 'random memo for unit test')
-
     const status = await validateIntent(
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 1_000_000n,
         recipient: '',
-        memo: {
-          type: '',
-          memos,
-        },
-      } as TransactionIntent<XrpMapMemo>,
+        memo: { type: 'map', memos: new Map([['destinationTag', 'random memo for unit test']]) },
+      }),
       [
         {
           value: 10_000n,
@@ -418,7 +364,7 @@ describe('validateIntent', () => {
     )
     expect(status.errors.transaction).toBeInstanceOf(XrpInvalidMemoError)
 
-    expect(spiedValidateMemo).toHaveBeenCalledWith(memos.get('destinationTag'))
+    expect(spiedValidateMemo).toHaveBeenCalledWith('random memo for unit test')
   })
 
   it('errors when destinationTag is not a single string value', async () => {
@@ -430,21 +376,14 @@ describe('validateIntent', () => {
       },
     })
 
-    const memos = new Map<string, string | string[]>()
-    memos.set('destinationTag', ['12345', '67890'])
-
     const status = await validateIntent(
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 1_000_000n,
         recipient: RECIPIENT,
-        memo: {
-          type: '',
-          memos,
-        },
-      } as TransactionIntent<XrpMapMemo>,
+        memo: { type: 'map', memos: new Map([['destinationTag', ['12345', '67890']]]) },
+      }),
       [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
       { value: 10_000n } // fees
     )
@@ -462,17 +401,13 @@ describe('validateIntent', () => {
     })
 
     const status = await validateIntent(
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 20_000_000n,
         recipient: RECIPIENT_TAG_REQUIRED,
-        memo: {
-          type: '',
-          memos: new Map<string, string | string[]>(),
-        },
-      } as TransactionIntent<XrpMapMemo>,
+        memo: { type: 'map', memos: new Map() },
+      }),
       [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
       { value: 10_000n } // fees
     )
@@ -491,21 +426,14 @@ describe('validateIntent', () => {
 
     spiedValidateMemo.mockReturnValueOnce(true)
 
-    const memos = new Map<string, string | string[]>()
-    memos.set('destinationTag', '12345')
-
     const status = await validateIntent(
-      {
-        intentType: 'transaction',
+      createSendTransactionIntentMockData<XrpMapMemo>({
+        type: 'Payment',
         sender: SENDER,
-        asset: { unit: { code: 'XRP', magnitude: 6 } },
         amount: 20_000_000n,
         recipient: RECIPIENT_TAG_REQUIRED,
-        memo: {
-          type: '',
-          memos,
-        },
-      } as TransactionIntent<XrpMapMemo>,
+        memo: { type: 'map', memos: new Map([['destinationTag', '12345']]) },
+      }),
       [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
       { value: 10_000n } // fees
     )

package/src/network/index.test.ts

@@ -2,25 +2,21 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import network from '@ledgerhq/live-network'
-import coinConfig, { type XrpCoinConfig } from '../config'
+import coinConfig from '../config'
 import { getAccountInfo, getLedgerIndex, getLedgerByIndex, getLedgerInfoByIndex } from '.'
 
 jest.mock('@ledgerhq/live-network')
 
 beforeAll(() => {
-  coinConfig.setCoinConfig(
-    () =>
-      ({
-        node: '',
-      }) as XrpCoinConfig
-  )
+  coinConfig.setCoinConfig(() => ({ node: '', status: { type: 'active' } }))
 })
 
 describe('getAccountInfo', () => {
   it("returns an empty AccountInfo when returns an error 'actNotFound'", async () => {
     // Given
     const emptyAddress = 'rNCgVpHinUDjXP2vHDFDMjm7ssBwpveHya'
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           account: emptyAddress,
@@ -56,7 +52,8 @@ describe('getAccountInfo', () => {
   it('returns a valid AccountInfo when return a correct AccountInfo', async () => {
     // Given
     const address = 'rh1HPuRVsYYvThxG2Bs1MfjmrVC73S16Fb'
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           account_data: {
@@ -93,7 +90,8 @@ describe('getAccountInfo', () => {
 
   it('returns requireDestinationTag true when the account_flags flag is set', async () => {
     const address = 'rwnYLUsoBQX3ECa1A5bSKLdbPoHKnqf63J'
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           account_data: {
@@ -124,33 +122,27 @@ describe('getAccountInfo', () => {
   it('throws an error when backend returns any other error', async () => {
     // Given
     const invalidAddress = 'rNCgVpHinUDjXP2vHDFDMjm7ssBwpveHyaa'
-    ;(network as jest.Mock).mockResolvedValue({
-      result: {
-        error: 'actMalformed',
-        error_code: 35,
-        error_message: 'Account malformed.',
-        ledger_hash: '87DE2DD287BCAD6E81720BC6E6361EF01A66EE70A37B6BDF1EFF2E719D9410AE',
-        ledger_index: 91772741,
-        request: {
-          account: invalidAddress,
-          command: 'account_info',
-          ledger_index: 'validated',
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
+      data: {
+        result: {
+          error: 'tooBusy',
+          status: 'error',
         },
-        status: 'error',
-        validated: true,
       },
     })
 
     // When & Then
     await expect(getAccountInfo(invalidAddress)).rejects.toThrow(
-      "Cannot read properties of undefined (reading 'result')"
+      `couldn't fetch account info ${invalidAddress}`
     )
   })
 })
 
 describe('getLedgerIndex', () => {
   it('returns error_message from rpc call errors', async () => {
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           error: 'issou',
@@ -165,7 +157,8 @@ describe('getLedgerIndex', () => {
   })
 
   it('returns error if there is no error_message', async () => {
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           error: 'issou',
@@ -178,7 +171,8 @@ describe('getLedgerIndex', () => {
   })
 
   it("returns error code if it's the only thing available", async () => {
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           error_code: 42,
@@ -197,7 +191,8 @@ describe('getLedgerByIndex', () => {
     const blockIndex = 101665314
     const mockLedgerHash = 'ABC123DEF456'
     const mockTxHash = 'TXHASH1'
-    ;(network as jest.Mock).mockResolvedValue({
+    jest.mocked(network).mockResolvedValue({
+      status: 200,
       data: {
         result: {
           status: 'success',

package/src/network/index.ts

@@ -2,21 +2,20 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import type { AccountInfo } from '../types/model'
-import network from '@ledgerhq/live-network'
-import { makeLRUCache, minutes } from '@ledgerhq/live-network/cache'
-import coinConfig from '../config'
-import {
+import type {
   LedgerTxResponse,
-  isErrorResponse,
-  isResponseStatus,
   Marker,
-  type AccountInfoResponse,
-  type AccountTxResponse,
-  type ErrorResponse,
-  type LedgerResponse,
-  type ServerInfoResponse,
-  type SubmitReponse,
+  AccountInfoResponse,
+  AccountTxResponse,
+  ErrorResponse,
+  LedgerResponse,
+  ServerInfoResponse,
+  SubmitReponse,
 } from './types'
+import network from '@ledgerhq/live-network'
+import { makeLRUCache, minutes } from '@ledgerhq/live-network/cache'
+import coinConfig from '../config'
+import { isErrorResponse } from '../utils/predicates'
 
 const getNodeUrl = () => coinConfig.getCoinConfig().node
 
@@ -165,10 +164,8 @@ async function rpcCall<T extends object>(
     },
   })
 
-  if (isResponseStatus(result) && result.status !== 'success') {
-    const errResponse = result as unknown as ErrorResponse
-    const parsedError =
-      errResponse.error_message ?? errResponse.error ?? `error code ${errResponse.error_code}`
+  if (isErrorResponse(result)) {
+    const parsedError = result.error_message ?? result.error ?? `error code ${result.error_code}`
     throw new Error(
       `couldn't fetch ${method} with params ${JSON.stringify(params)}: ${parsedError}`
     )

package/src/network/types.ts

@@ -256,6 +256,3 @@ export type ErrorResponse = {
   status: string
   validated: boolean
 }
-export function isErrorResponse(obj: object): obj is ErrorResponse {
-  return 'status' in obj && obj.status === 'error' && 'error' in obj
-}

package/src/utils/predicates.ts

@@ -0,0 +1,25 @@
+// SPDX-FileCopyrightText: © 2024 LEDGER SAS
+// SPDX-License-Identifier: Apache-2.0
+
+import type { ErrorResponse } from '../network/types'
+import type { SignerEntry } from '../types'
+
+export function isSignerEntry(obj: unknown): obj is SignerEntry {
+  return (
+    typeof obj === 'object' &&
+    obj !== null &&
+    'Signer' in obj &&
+    typeof obj.Signer === 'object' &&
+    obj.Signer !== null &&
+    'Account' in obj.Signer &&
+    typeof obj.Signer.Account === 'string' &&
+    'SigningPubKey' in obj.Signer &&
+    typeof obj.Signer.SigningPubKey === 'string' &&
+    'TxnSignature' in obj.Signer &&
+    typeof obj.Signer.TxnSignature === 'string'
+  )
+}
+
+export function isErrorResponse(obj: object): obj is ErrorResponse {
+  return 'status' in obj && obj.status === 'error'
+}

package/jest.config.js

@@ -1,32 +0,0 @@
-// SPDX-FileCopyrightText: © 2024 LEDGER SAS
-// SPDX-License-Identifier: Apache-2.0
-
-// `workerThreads: true` is required for validating object with `bigint` values
-module.exports = {
-  testEnvironment: "node",
-  transform: {
-    "^.+\\.(ts|tsx)$": [
-      "@swc/jest",
-      {
-        jsc: {
-          target: "esnext",
-        },
-      },
-    ],
-  },
-  passWithNoTests: true,
-  testPathIgnorePatterns: ["lib/", "lib-es/", ".*\\.(integ|integration)\\.test\\.[tj]s"],
-  collectCoverageFrom: [
-    "src/**/*.ts",
-    "!src/**/*.test.ts",
-    "!src/**/*.spec.ts",
-    "!src/test/**/*.ts",
-  ],
-  coverageReporters: ["json", ["lcov", { file: "lcov.info", projectRoot: "../../../" }], "text"],
-  workerThreads: true,
-  reporters: [
-    "default",
-    ["jest-sonar", { outputName: "sonar-executionTests-report.xml", reportedFilePath: "absolute" }],
-  ],
-  setupFilesAfterEnv: [/* "@ledgerhq/disable-network-setup" */],
-};

package/jest.integ.config.js

@@ -1,21 +0,0 @@
-// SPDX-FileCopyrightText: © 2024 LEDGER SAS
-// SPDX-License-Identifier: Apache-2.0
-
-/** @type {import('jest').Config} */
-module.exports = {
-  testEnvironment: "node",
-  testRegex: ".integ.test.ts$",
-  testPathIgnorePatterns: ["lib/", "lib-es/"],
-  testTimeout: 60_000,
-  forceExit: true,
-  transform: {
-    "^.+\\.(t|j)sx?$": [
-      "@swc/jest",
-      {
-        jsc: {
-          target: "esnext",
-        },
-      },
-    ],
-  },
-};

package/knip.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/knip@5.34.1/schema.json",
-  "entry": [
-    "src/api/index.ts",
-    "src/index.ts",
-    "src/api/validateAddress.ts",
-    "src/supportedFeatures.ts"
-  ],
-  "project": ["src/**/*.ts"],
-  "ignoreDependencies": ["@ledgerhq/coin-module-framework"]
-}

package/tsconfig.build.json

@@ -1,22 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "customConditions": [],
-    "types": [
-      "node"
-    ]
-  },
-  "exclude": [
-    "**/*.test.ts",
-    "**/*.test.tsx",
-    "**/*.spec.ts",
-    "**/*.spec.tsx",
-    "**/__tests__/**/*",
-    "**/tests/**/*",
-    "**/__mocks__/**/*",
-    "**/*.test.js",
-    "**/*.test.jsx",
-    "**/*.spec.js",
-    "**/*.spec.jsx"
-  ]
-}