feat: add estimatedExchangeRate property to quote response

.changeset/mighty-pans-carry.md

@@ -0,0 +1,5 @@
+---
+'@interledger/open-payments': patch
+---
+
+Add `estimatedExchangeRate` property to `Quote`.

openapi/resource-server.yaml

@@ -1193,6 +1193,10 @@ components:
           description: "The total amount that should be deducted from the sender's account when the corresponding outgoing payment has been paid. "
         method:
           $ref: '#/components/schemas/payment-method'
+        estimatedExchangeRate:
+          type: number
+          description: 'Estimated probed exchange rate over the path (ILP specific).'
+          readOnly: true
         expiresAt:
           type: string
           description: The date and time when the calculated `debitAmount` is no longer valid.

packages/open-payments/src/client/quote.test.ts

@@ -36,6 +36,24 @@ describe('quote', (): void => {
 
   describe('getQuote', (): void => {
     test('returns the quote if it passes open api validation', async (): Promise<void> => {
+      const scope = nock(baseUrl).get(`/quotes/${quote.id}`).reply(200, quote)
+      const result = await getQuote(
+        deps,
+        {
+          url: `${baseUrl}/quotes/${quote.id}`,
+          accessToken
+        },
+        openApiValidators.successfulValidator
+      )
+      expect(result).toEqual(quote)
+      expect(result.estimatedExchangeRate).toBeUndefined()
+      scope.done()
+    })
+
+    test('returns the quote with the estimated exchange rate if it passes open api validation', async (): Promise<void> => {
+      const quote = mockQuote({
+        estimatedExchangeRate: 120
+      })
       const scope = nock(baseUrl).get(`/quotes/${quote.id}`).reply(200, quote)
       const result = await getQuote(
         deps,
@@ -79,6 +97,7 @@ describe('quote', (): void => {
         { receiver: quote.receiver, method: 'ilp', walletAddress }
       )
       expect(result).toEqual(quote)
+      expect(result.estimatedExchangeRate).toBeUndefined()
       scope.done()
     })
 
@@ -97,6 +116,25 @@ describe('quote', (): void => {
       ).rejects.toThrowError()
       scope.done()
     })
+
+    test('returns estimated exchange rate if amount can not be sent over the path', async (): Promise<void> => {
+      const quote = mockQuote({
+        receiveAmount: { value: '0', assetCode: 'ZAR', assetScale: 2 },
+        estimatedExchangeRate: 120
+      })
+      const scope = nock(baseUrl).post(`/quotes`).reply(200, quote)
+      const result = await createQuote(
+        deps,
+        {
+          url: baseUrl,
+          accessToken
+        },
+        openApiValidators.successfulValidator,
+        { receiver: quote.receiver, method: 'ilp', walletAddress }
+      )
+      expect(result).toEqual(quote)
+      scope.done()
+    })
   })
 
   describe('routes', (): void => {

packages/open-payments/src/openapi/generated/resource-server-types.ts

@@ -257,6 +257,8 @@ export interface components {
       /** @description The total amount that should be deducted from the sender's account when the corresponding outgoing payment has been paid. */
       debitAmount: external["schemas.yaml"]["components"]["schemas"]["amount"];
       method: components["schemas"]["payment-method"];
+      /** @description Estimated probed exchange rate over the path (ILP specific). */
+      estimatedExchangeRate?: number;
       /** @description The date and time when the calculated `debitAmount` is no longer valid. */
       expiresAt?: string;
       /**