feat: tenanted rates endpoints - first iteration, WIP

sanducb · sanducb · commit 7d0a177f24c9 · 2025-03-04T16:53:51.000+02:00
diff --git a/packages/backend/src/index.ts b/packages/backend/src/index.ts
@@ -253,15 +253,18 @@ export function initIocContainer(
     return createRatesService({
       logger: await deps.use('logger'),
       exchangeRatesUrl: config.exchangeRatesUrl,
-      exchangeRatesLifetime: config.exchangeRatesLifetime
+      exchangeRatesLifetime: config.exchangeRatesLifetime,
+      tenantSettingService: await deps.use('tenantSettingService')
     })
   })
 
   container.singleton('internalRatesService', async (deps) => {
     return createRatesService({
       logger: await deps.use('logger'),
       exchangeRatesUrl: config.telemetryExchangeRatesUrl,
-      exchangeRatesLifetime: config.telemetryExchangeRatesLifetime
+      exchangeRatesLifetime: config.telemetryExchangeRatesLifetime,
+      //TODO maybe not use this for the internal rates service?
+      tenantSettingService: await deps.use('tenantSettingService')
     })
   })
 
diff --git a/packages/backend/src/payment-method/ilp/connector/core/middleware/balance.ts b/packages/backend/src/payment-method/ilp/connector/core/middleware/balance.ts
@@ -40,11 +40,14 @@ export function createBalanceMiddleware(): ILPMiddleware {
     }
 
     const sourceAmount = BigInt(amount)
-    const destinationAmountOrError = await services.rates.convertSource({
-      sourceAmount,
-      sourceAsset: accounts.incoming.asset,
-      destinationAsset: accounts.outgoing.asset
-    })
+    const destinationAmountOrError = await services.rates.convertSource(
+      {
+        sourceAmount,
+        sourceAsset: accounts.incoming.asset,
+        destinationAsset: accounts.outgoing.asset
+      },
+      AppConfig.operatorTenantId //TODO when tenanted peers gets merged, this will replaced by: services.peers.get(accounts.incoming.id).tenantId
+    )
     if (isConvertError(destinationAmountOrError)) {
       logger.error(
         {
diff --git a/packages/backend/src/payment-method/ilp/service.test.ts b/packages/backend/src/payment-method/ilp/service.test.ts
@@ -27,6 +27,11 @@ import { truncateTables } from '../../tests/tableManager'
 import { createOutgoingPaymentWithReceiver } from '../../tests/outgoingPayment'
 import { v4 as uuid } from 'uuid'
 import { IlpQuoteDetails } from './quote-details/model'
+import { CreateOptions } from '../../tenants/settings/service'
+import {
+  createTenantSettings,
+  exchangeRatesSetting
+} from '../../tests/tenantSettings'
 
 const nock = (global as unknown as { nock: typeof import('nock') }).nock
 
@@ -38,7 +43,9 @@ describe('IlpPaymentService', (): void => {
   let config: IAppConfig
   let tenantId: string
 
+  //TODO tests for both default and tenanted exchange rates
   const exchangeRatesUrl = 'https://example-rates.com'
+  let tenantExchangeRatesUrl: string
 
   const assetMap: Record<string, Asset> = {}
   const walletAddressMap: Record<string, WalletAddress> = {}
@@ -77,6 +84,14 @@ describe('IlpPaymentService', (): void => {
       tenantId,
       assetId: assetMap['EUR'].id
     })
+
+    const createOptions: CreateOptions = {
+      tenantId,
+      setting: [exchangeRatesSetting()]
+    }
+
+    const tenantSetting = createTenantSettings(deps, createOptions)
+    tenantExchangeRatesUrl = (await tenantSetting).value
   })
 
   afterEach(async (): Promise<void> => {
@@ -95,7 +110,7 @@ describe('IlpPaymentService', (): void => {
 
   describe('getQuote', (): void => {
     test('calls rates service with correct base asset', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
         quoteId: uuid(),
@@ -113,12 +128,12 @@ describe('IlpPaymentService', (): void => {
 
       await ilpPaymentService.getQuote(options)
 
-      expect(ratesServiceSpy).toHaveBeenCalledWith('USD')
+      expect(ratesServiceSpy).toHaveBeenCalledWith('USD', tenantId)
       ratesScope.done()
     })
 
     test('inserts ilpQuoteDetails', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
       const quoteId = uuid()
       const options: StartQuoteOptions = {
         quoteId,
@@ -180,7 +195,7 @@ describe('IlpPaymentService', (): void => {
     })
 
     test('creates a quote with large exchange rate amounts', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
       const quoteId = uuid()
       const options: StartQuoteOptions = {
         quoteId,
@@ -298,7 +313,7 @@ describe('IlpPaymentService', (): void => {
     })
 
     test('returns all fields correctly', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
         quoteId: uuid(),
@@ -330,7 +345,7 @@ describe('IlpPaymentService', (): void => {
     })
 
     test('uses receiver.incomingAmount if receiveAmount is not provided', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const incomingAmount = {
         assetCode: 'USD',
@@ -370,7 +385,7 @@ describe('IlpPaymentService', (): void => {
         () => config,
         { slippage: 101 },
         async () => {
-          mockRatesApi(exchangeRatesUrl, () => ({}))
+          mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
           expect.assertions(4)
           try {
@@ -398,7 +413,7 @@ describe('IlpPaymentService', (): void => {
       )())
 
     test('throws if quote returns invalid maxSourceAmount', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
         quoteId: uuid(),
@@ -428,7 +443,7 @@ describe('IlpPaymentService', (): void => {
     })
 
     test('throws if quote returns invalid minDeliveryAmount', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
         quoteId: uuid(),
@@ -469,7 +484,7 @@ describe('IlpPaymentService', (): void => {
     })
 
     test('throws if quote returns with a non-positive estimated delivery amount', async (): Promise<void> => {
-      const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({}))
+      const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({}))
 
       const options: StartQuoteOptions = {
         quoteId: uuid(),
@@ -524,7 +539,7 @@ describe('IlpPaymentService', (): void => {
               () => config,
               { slippage },
               async () => {
-                const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({
+                const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({
                   [incomingAssetCode]: exchangeRate
                 }))
 
@@ -584,7 +599,7 @@ describe('IlpPaymentService', (): void => {
               () => config,
               { slippage },
               async () => {
-                const ratesScope = mockRatesApi(exchangeRatesUrl, () => ({
+                const ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({
                   [incomingAssetCode]: exchangeRate
                 }))
 
diff --git a/packages/backend/src/payment-method/ilp/service.ts b/packages/backend/src/payment-method/ilp/service.ts
@@ -64,7 +64,10 @@ async function getQuote(
 
   let rates
   try {
-    rates = await deps.ratesService.rates(options.walletAddress.asset.code)
+    rates = await deps.ratesService.rates(
+      options.walletAddress.asset.code,
+      options.walletAddress.tenantId
+    )
   } catch (_err) {
     throw new PaymentMethodHandlerError('Received error during ILP quoting', {
       description: 'Could not get rates from service',
diff --git a/packages/backend/src/payment-method/local/service.test.ts b/packages/backend/src/payment-method/local/service.test.ts
@@ -24,6 +24,11 @@ import { IncomingPaymentService } from '../../open_payments/payment/incoming/ser
 import { errorToMessage, TransferError } from '../../accounting/errors'
 import { PaymentMethodHandlerError } from '../handler/errors'
 import { ConvertError } from '../../rates/service'
+import {
+  createTenantSettings,
+  exchangeRatesSetting
+} from '../../tests/tenantSettings'
+import { CreateOptions } from '../../tenants/settings/service'
 
 const nock = (global as unknown as { nock: typeof import('nock') }).nock
 
@@ -35,7 +40,9 @@ describe('LocalPaymentService', (): void => {
   let incomingPaymentService: IncomingPaymentService
   let tenantId: string
 
+  //TODO tests for both default and tenanted exchange rates
   const exchangeRatesUrl = 'https://example-rates.com'
+  let tenantExchangeRatesUrl: string
 
   const assetMap: Record<string, Asset> = {}
   const walletAddressMap: Record<string, WalletAddress> = {}
@@ -84,6 +91,14 @@ describe('LocalPaymentService', (): void => {
       tenantId,
       assetId: assetMap['EUR'].id
     })
+
+    const createOptions: CreateOptions = {
+      tenantId,
+      setting: [exchangeRatesSetting()]
+    }
+
+    const tenantSetting = createTenantSettings(deps, createOptions)
+    tenantExchangeRatesUrl = (await tenantSetting).value
   })
 
   afterEach(async (): Promise<void> => {
@@ -290,7 +305,7 @@ describe('LocalPaymentService', (): void => {
             let ratesScope
 
             if (incomingAssetCode !== debitAssetCode) {
-              ratesScope = mockRatesApi(exchangeRatesUrl, () => ({
+              ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({
                 [incomingAssetCode]: exchangeRate
               }))
             }
@@ -346,7 +361,7 @@ describe('LocalPaymentService', (): void => {
             let ratesScope
 
             if (debitAssetCode !== incomingAssetCode) {
-              ratesScope = mockRatesApi(exchangeRatesUrl, () => ({
+              ratesScope = mockRatesApi(tenantExchangeRatesUrl, () => ({
                 [incomingAssetCode]: exchangeRate
               }))
             }
diff --git a/packages/backend/src/payment-method/local/service.ts b/packages/backend/src/payment-method/local/service.ts
@@ -67,14 +67,15 @@ async function getQuote(
   let exchangeRate: number
 
   const convert = async (
-    opts: RateConvertSourceOpts | RateConvertDestinationOpts
+    opts: RateConvertSourceOpts | RateConvertDestinationOpts,
+    tenantId?: string
   ): Promise<ConvertResults | ConvertError> => {
     let convertResults: ConvertResults | ConvertError
     try {
       convertResults =
         'sourceAmount' in opts
-          ? await deps.ratesService.convertSource(opts)
-          : await deps.ratesService.convertDestination(opts)
+          ? await deps.ratesService.convertSource(opts, tenantId)
+          : await deps.ratesService.convertDestination(opts, tenantId)
     } catch (err) {
       deps.logger.error(
         { opts, err },
@@ -93,17 +94,20 @@ async function getQuote(
 
   if (debitAmount) {
     debitAmountValue = debitAmount.value
-    const convertResults = await convert({
-      sourceAmount: debitAmountValue,
-      sourceAsset: {
-        code: walletAddress.asset.code,
-        scale: walletAddress.asset.scale
+    const convertResults = await convert(
+      {
+        sourceAmount: debitAmountValue,
+        sourceAsset: {
+          code: walletAddress.asset.code,
+          scale: walletAddress.asset.scale
+        },
+        destinationAsset: {
+          code: receiver.assetCode,
+          scale: receiver.assetScale
+        }
       },
-      destinationAsset: {
-        code: receiver.assetCode,
-        scale: receiver.assetScale
-      }
-    })
+      options.walletAddress.tenantId
+    )
     if (isConvertError(convertResults)) {
       throw new PaymentMethodHandlerError(
         'Received error during local quoting',
@@ -117,17 +121,20 @@ async function getQuote(
     exchangeRate = convertResults.scaledExchangeRate
   } else if (receiveAmount) {
     receiveAmountValue = receiveAmount.value
-    const convertResults = await convert({
-      destinationAmount: receiveAmountValue,
-      sourceAsset: {
-        code: walletAddress.asset.code,
-        scale: walletAddress.asset.scale
+    const convertResults = await convert(
+      {
+        destinationAmount: receiveAmountValue,
+        sourceAsset: {
+          code: walletAddress.asset.code,
+          scale: walletAddress.asset.scale
+        },
+        destinationAsset: {
+          code: receiveAmount.assetCode,
+          scale: receiveAmount.assetScale
+        }
       },
-      destinationAsset: {
-        code: receiveAmount.assetCode,
-        scale: receiveAmount.assetScale
-      }
-    })
+      options.walletAddress.tenantId
+    )
     if (isConvertError(convertResults)) {
       throw new PaymentMethodHandlerError(
         'Received error during local quoting',
@@ -141,17 +148,20 @@ async function getQuote(
     exchangeRate = convertResults.scaledExchangeRate
   } else if (receiver.incomingAmount) {
     receiveAmountValue = receiver.incomingAmount.value
-    const convertResults = await convert({
-      destinationAmount: receiveAmountValue,
-      sourceAsset: {
-        code: walletAddress.asset.code,
-        scale: walletAddress.asset.scale
+    const convertResults = await convert(
+      {
+        destinationAmount: receiveAmountValue,
+        sourceAsset: {
+          code: walletAddress.asset.code,
+          scale: walletAddress.asset.scale
+        },
+        destinationAsset: {
+          code: receiver.incomingAmount.assetCode,
+          scale: receiver.incomingAmount.assetScale
+        }
       },
-      destinationAsset: {
-        code: receiver.incomingAmount.assetCode,
-        scale: receiver.incomingAmount.assetScale
-      }
-    })
+      options.walletAddress.tenantId
+    )
     if (isConvertError(convertResults)) {
       throw new PaymentMethodHandlerError(
         'Received error during local quoting',
diff --git a/packages/backend/src/rates/service.test.ts b/packages/backend/src/rates/service.test.ts
diff --git a/packages/backend/src/rates/service.ts b/packages/backend/src/rates/service.ts
