@ledgerhq/coin-xrp 7.23.4 → 7.24.0

package/src/api/validateIntent.test.ts

@@ -3,7 +3,7 @@
 
 import { TransactionIntent } from '@ledgerhq/coin-module-framework/api/types'
 import { XrpMapMemo } from '../types'
-import { XrpInvalidMemoError } from '../utils/errors'
+import { XrpDestinationTagRequired, XrpInvalidMemoError } from '../utils/errors'
 import * as logicValidateMemo from '../utils/validateMemo'
 import { validateIntent } from './validateIntent'
 
@@ -12,6 +12,17 @@ const mockGetBalance = jest.fn()
 const mockGetServerInfos = jest.fn()
 
 const RECIPIENT_NEW = 'rDKsbvy9uaNpPtvVFraJyNGfjvTw8xivgK'
+const RECIPIENT_TAG_REQUIRED = 'rwnYLUsoBQX3ECa1A5bSKLdbPoHKnqf63J'
+
+const mockGetAccountInfo = jest.fn((addr: string) =>
+  Promise.resolve({
+    isNewAccount: addr === RECIPIENT_NEW,
+    balance: '0',
+    ownerCount: 0,
+    sequence: 0,
+    requireDestinationTag: addr === RECIPIENT_TAG_REQUIRED,
+  })
+)
 
 jest.mock('./getBalance', () => ({
   getBalance: () => mockGetBalance(),
@@ -19,16 +30,7 @@ jest.mock('./getBalance', () => ({
 
 jest.mock('../network', () => ({
   getServerInfos: () => mockGetServerInfos(),
-}))
-
-jest.mock('../utils', () => ({
-  ...jest.requireActual('../utils'),
-  recipientIsNew: jest.fn((addr: string) => {
-    if (addr === RECIPIENT_NEW) {
-      return Promise.resolve(true)
-    }
-    return Promise.resolve(false)
-  }),
+  getAccountInfo: (addr: string) => mockGetAccountInfo(addr),
 }))
 
 jest.mock('../utils/validateMemo')
@@ -418,4 +420,96 @@ describe('validateIntent', () => {
 
     expect(spiedValidateMemo).toHaveBeenCalledWith(memos.get('destinationTag'))
   })
+
+  it('errors when destinationTag is not a single string value', async () => {
+    mockGetServerInfos.mockResolvedValue({
+      info: {
+        validated_ledger: {
+          reserve_base_xrp: reserveBase / 1_000_000n,
+        },
+      },
+    })
+
+    const memos = new Map<string, string | string[]>()
+    memos.set('destinationTag', ['12345', '67890'])
+
+    const status = await validateIntent(
+      {
+        intentType: 'transaction',
+        sender: SENDER,
+        asset: { unit: { code: 'XRP', magnitude: 6 } },
+        amount: 1_000_000n,
+        recipient: RECIPIENT,
+        memo: {
+          type: '',
+          memos,
+        },
+      } as TransactionIntent<XrpMapMemo>,
+      [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
+      { value: 10_000n } // fees
+    )
+
+    expect(status.errors.transaction).toBeInstanceOf(XrpInvalidMemoError)
+  })
+
+  it('errors when recipient requires a destination tag and none is provided', async () => {
+    mockGetServerInfos.mockResolvedValue({
+      info: {
+        validated_ledger: {
+          reserve_base_xrp: reserveBase / 1_000_000n,
+        },
+      },
+    })
+
+    const status = await validateIntent(
+      {
+        intentType: 'transaction',
+        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>,
+      [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
+      { value: 10_000n } // fees
+    )
+
+    expect(status.errors.transaction).toBeInstanceOf(XrpDestinationTagRequired)
+  })
+
+  it('does not error when recipient requires a destination tag and one is provided', async () => {
+    mockGetServerInfos.mockResolvedValue({
+      info: {
+        validated_ledger: {
+          reserve_base_xrp: reserveBase / 1_000_000n,
+        },
+      },
+    })
+
+    spiedValidateMemo.mockReturnValueOnce(true)
+
+    const memos = new Map<string, string | string[]>()
+    memos.set('destinationTag', '12345')
+
+    const status = await validateIntent(
+      {
+        intentType: 'transaction',
+        sender: SENDER,
+        asset: { unit: { code: 'XRP', magnitude: 6 } },
+        amount: 20_000_000n,
+        recipient: RECIPIENT_TAG_REQUIRED,
+        memo: {
+          type: '',
+          memos,
+        },
+      } as TransactionIntent<XrpMapMemo>,
+      [{ value: 50_000_000n, asset: { type: 'native' }, locked: 0n }],
+      { value: 10_000n } // fees
+    )
+
+    expect(status.errors.transaction).not.toBeDefined()
+  })
 })

package/src/api/validateIntent.ts

@@ -19,11 +19,10 @@ import {
   RecipientRequired,
 } from '@ledgerhq/errors'
 import { isValidClassicAddress } from 'ripple-address-codec'
-import { getServerInfos } from '../network'
+import { getAccountInfo, getServerInfos } from '../network'
 import { XrpMapMemo } from '../types'
-import { recipientIsNew } from '../utils'
 import { parseAPIValue } from '../utils/common'
-import { XrpInvalidMemoError } from '../utils/errors'
+import { XrpDestinationTagRequired, XrpInvalidMemoError } from '../utils/errors'
 import { validateMemo } from '../utils/validateMemo'
 
 export const validateIntent = async (
@@ -41,6 +40,11 @@ export const validateIntent = async (
   const totalSpent = transactionIntent.amount + estimatedFees
   const amount = transactionIntent.amount
 
+  const recipientInfo =
+    transactionIntent.recipient && isValidClassicAddress(transactionIntent.recipient)
+      ? await getAccountInfo(transactionIntent.recipient)
+      : undefined
+
   if (amount > 0 && estimatedFees * 10n > amount) {
     warnings.feeTooHigh = new FeeTooHigh()
   }
@@ -63,8 +67,7 @@ export const validateIntent = async (
         : 'Unknown unit',
     })
   } else if (
-    transactionIntent.recipient &&
-    (await recipientIsNew(transactionIntent.recipient)) &&
+    recipientInfo?.isNewAccount &&
     transactionIntent.amount < BigInt(reserveBaseXRP.toString())
   ) {
     errors.amount = new NotEnoughBalanceBecauseDestinationNotCreated('', {
@@ -92,11 +95,13 @@ export const validateIntent = async (
     errors.amount = new AmountRequired()
   }
 
-  const destinationTag = transactionIntent.memo?.memos
-    ? transactionIntent.memo.memos.get('destinationTag')
-    : undefined
-  if (destinationTag && typeof destinationTag === 'string' && !validateMemo(destinationTag)) {
+  const destinationTag = transactionIntent.memo?.memos?.get('destinationTag')
+  if (destinationTag !== undefined && typeof destinationTag !== 'string') {
+    errors.transaction = new XrpInvalidMemoError()
+  } else if (destinationTag && !validateMemo(destinationTag)) {
     errors.transaction = new XrpInvalidMemoError()
+  } else if (!errors.recipient && !destinationTag && recipientInfo?.requireDestinationTag) {
+    errors.transaction = new XrpDestinationTagRequired()
   }
 
   return {

package/src/network/index.test.ts

@@ -49,6 +49,7 @@ describe('getAccountInfo', () => {
       balance: '0',
       ownerCount: 0,
       sequence: 0,
+      requireDestinationTag: false,
     })
   })
 
@@ -86,9 +87,40 @@ describe('getAccountInfo', () => {
       balance: '999441667919804',
       ownerCount: 0,
       sequence: 153743,
+      requireDestinationTag: false,
     })
   })
 
+  it('returns requireDestinationTag true when the account_flags flag is set', async () => {
+    const address = 'rwnYLUsoBQX3ECa1A5bSKLdbPoHKnqf63J'
+    ;(network as jest.Mock).mockResolvedValue({
+      data: {
+        result: {
+          account_data: {
+            Account: address,
+            Balance: '100000000',
+            Flags: 131072,
+            LedgerEntryType: 'AccountRoot',
+            OwnerCount: 0,
+            Sequence: 100,
+            index: 'BC0DAE09C0BFBC4A49AA94B849266588BFD6E1F554B184B5788AC55D6E07EB95',
+          },
+          account_flags: {
+            requireDestinationTag: true,
+          },
+          ledger_hash: '93E952B2770233B0ABFBFBBFBC3E2E2159DCABD07FEB5F4C49174027935D9FBB',
+          ledger_index: 1908009,
+          status: 'success',
+          validated: true,
+        },
+      },
+    })
+
+    const result = await getAccountInfo(address)
+
+    expect(result.requireDestinationTag).toBe(true)
+  })
+
   it('throws an error when backend returns any other error', async () => {
     // Given
     const invalidAddress = 'rNCgVpHinUDjXP2vHDFDMjm7ssBwpveHyaa'

package/src/network/index.ts

@@ -61,6 +61,7 @@ export const getAccountInfo = async (
       balance: '0',
       ownerCount: 0,
       sequence: 0,
+      requireDestinationTag: false,
     }
   } else {
     return {
@@ -68,6 +69,7 @@ export const getAccountInfo = async (
       balance: result.account_data.Balance,
       ownerCount: result.account_data.OwnerCount,
       sequence: result.account_data.Sequence,
+      requireDestinationTag: result.account_flags?.requireDestinationTag ?? false,
     }
   }
 }

package/src/types/model.ts

@@ -19,6 +19,7 @@ export type AccountInfo = {
   balance: string
   ownerCount: number
   sequence: number
+  requireDestinationTag: boolean
 }
 
 export type XrpMemo = {

package/src/utils/errors.ts

@@ -4,3 +4,5 @@
 import { createCustomErrorClass } from '@ledgerhq/errors'
 
 export const XrpInvalidMemoError = createCustomErrorClass('XrpInvalidMemo')
+
+export const XrpDestinationTagRequired = createCustomErrorClass('XrpDestinationTagRequired')