663/mk/create outgoing payment

packages/backend/src/open_payments/payment/outgoing/service.ts

@@ -419,10 +419,10 @@ async function addSentAmount(
 ): Promise<OutgoingPayment> {
   const fundingZeroOrUndefined =
     payment.state === OutgoingPaymentState.Funding ? BigInt(0) : undefined
-  let sent = value || (await deps.accountingService.getTotalSent(payment.id))
-  if (sent === undefined) {
-    sent = fundingZeroOrUndefined
-  }
+  const sent =
+    value ??
+    (await deps.accountingService.getTotalSent(payment.id)) ??
+    fundingZeroOrUndefined
 
   if (sent !== undefined) {
     payment.sentAmount = {

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

@@ -12,12 +12,13 @@ describe('grant', (): void => {
 
   const axiosInstance = defaultAxiosInstance
   const logger = silentLogger
+  const client = 'https://example.com/.well-known/pay'
 
   describe('createGrantRoutes', (): void => {
     test('creates response validator for grant requests', async (): Promise<void> => {
       jest.spyOn(openApi, 'createResponseValidator')
 
-      createGrantRoutes({ axiosInstance, openApi, logger })
+      createGrantRoutes({ axiosInstance, openApi, logger, client })
       expect(openApi.createResponseValidator).toHaveBeenCalledTimes(1)
       expect(openApi.createResponseValidator).toHaveBeenCalledWith({
         path: '/',

packages/open-payments/src/client/incoming-payment.test.ts

@@ -46,15 +46,15 @@ describe('incoming-payment', (): void => {
     test('returns incoming payment if passes validation', async (): Promise<void> => {
       const incomingPayment = mockIncomingPayment()
 
-      nock(baseUrl).get('/incoming-payment').reply(200, incomingPayment)
+      nock(baseUrl).get('/incoming-payments').reply(200, incomingPayment)
 
       const result = await getIncomingPayment(
         {
           axiosInstance,
           logger
         },
         {
-          url: `${baseUrl}/incoming-payment`,
+          url: `${baseUrl}/incoming-payments`,
           accessToken: 'accessToken'
         },
         openApiValidators.successfulValidator
@@ -76,7 +76,7 @@ describe('incoming-payment', (): void => {
         }
       })
 
-      nock(baseUrl).get('/incoming-payment').reply(200, incomingPayment)
+      nock(baseUrl).get('/incoming-payments').reply(200, incomingPayment)
 
       await expect(() =>
         getIncomingPayment(
@@ -85,7 +85,7 @@ describe('incoming-payment', (): void => {
             logger
           },
           {
-            url: `${baseUrl}/incoming-payment`,
+            url: `${baseUrl}/incoming-payments`,
             accessToken: 'accessToken'
           },
           openApiValidators.successfulValidator
@@ -96,7 +96,7 @@ describe('incoming-payment', (): void => {
     test('throws if incoming payment does not pass open api validation', async (): Promise<void> => {
       const incomingPayment = mockIncomingPayment()
 
-      nock(baseUrl).get('/incoming-payment').reply(200, incomingPayment)
+      nock(baseUrl).get('/incoming-payments').reply(200, incomingPayment)
 
       await expect(() =>
         getIncomingPayment(
@@ -105,7 +105,7 @@ describe('incoming-payment', (): void => {
             logger
           },
           {
-            url: `${baseUrl}/incoming-payment`,
+            url: `${baseUrl}/incoming-payments`,
             accessToken: 'accessToken'
           },
           openApiValidators.failedValidator

packages/open-payments/src/client/outgoing-payment.test.ts

@@ -1,4 +1,5 @@
 import {
+  createOutgoingPayment,
   createOutgoingPaymentRoutes,
   getOutgoingPayment,
   validateOutgoingPayment
@@ -12,6 +13,7 @@ import {
   silentLogger
 } from '../test/helpers'
 import nock from 'nock'
+import { v4 as uuid } from 'uuid'
 
 describe('outgoing-payment', (): void => {
   let openApi: OpenAPI
@@ -39,21 +41,35 @@ describe('outgoing-payment', (): void => {
         method: HttpMethod.GET
       })
     })
+
+    test('creates createOutgoingPaymentOpenApiValidator properly', async (): Promise<void> => {
+      jest.spyOn(openApi, 'createResponseValidator')
+
+      createOutgoingPaymentRoutes({
+        axiosInstance,
+        openApi,
+        logger
+      })
+      expect(openApi.createResponseValidator).toHaveBeenCalledWith({
+        path: '/outgoing-payments',
+        method: HttpMethod.POST
+      })
+    })
   })
 
   describe('getOutgoingPayment', (): void => {
     test('returns outgoing payment if passes validation', async (): Promise<void> => {
       const outgoingPayment = mockOutgoingPayment()
 
-      nock(baseUrl).get('/outgoing-payment').reply(200, outgoingPayment)
+      nock(baseUrl).get('/outgoing-payments').reply(200, outgoingPayment)
 
       const result = await getOutgoingPayment(
         {
           axiosInstance,
           logger
         },
         {
-          url: `${baseUrl}/outgoing-payment`,
+          url: `${baseUrl}/outgoing-payments`,
           accessToken: 'accessToken'
         },
         openApiValidators.successfulValidator
@@ -84,15 +100,15 @@ describe('outgoing-payment', (): void => {
             logger
           },
           {
-            url: `${baseUrl}/outgoing-payment`,
+            url: `${baseUrl}/outgoing-payments`,
             accessToken: 'accessToken'
           },
           openApiValidators.successfulValidator
         )
       ).rejects.toThrowError()
     })
 
-    test('throws is outgoing payment does not pass open api validation', async (): Promise<void> => {
+    test('throws if outgoing payment does not pass open api validation', async (): Promise<void> => {
       const outgoingPayment = mockOutgoingPayment()
 
       nock(baseUrl).get('/outgoing-payment').reply(200, outgoingPayment)
@@ -104,7 +120,7 @@ describe('outgoing-payment', (): void => {
             logger
           },
           {
-            url: `${baseUrl}/outgoing-payment`,
+            url: `${baseUrl}/outgoing-payments`,
             accessToken: 'accessToken'
           },
           openApiValidators.failedValidator
@@ -113,6 +129,111 @@ describe('outgoing-payment', (): void => {
     })
   })
 
+  describe('createOutgoingPayment', (): void => {
+    const quoteId = `${baseUrl}/quotes/${uuid()}`
+
+    test.each`
+      description           | externalRef
+      ${'Some description'} | ${'#INV-1'}
+      ${undefined}          | ${undefined}
+    `(
+      'creates outgoing payment',
+      async ({ description, externalRef }): Promise<void> => {
+        const outgoingPayment = mockOutgoingPayment({
+          quoteId,
+          description,
+          externalRef
+        })
+
+        const scope = nock(baseUrl)
+          .post('/outgoing-payments')
+          .reply(200, outgoingPayment)
+
+        const result = await createOutgoingPayment(
+          {
+            axiosInstance,
+            logger
+          },
+          {
+            url: `${baseUrl}/outgoing-payments`,
+            accessToken: 'accessToken',
+            body: {
+              quoteId,
+              description,
+              externalRef
+            }
+          },
+          openApiValidators.successfulValidator
+        )
+        expect(result).toEqual(outgoingPayment)
+        scope.done()
+      }
+    )
+
+    test('throws if outgoing payment does not pass validation', async (): Promise<void> => {
+      const outgoingPayment = mockOutgoingPayment({
+        sendAmount: {
+          assetCode: 'USD',
+          assetScale: 3,
+          value: '5'
+        },
+        sentAmount: {
+          assetCode: 'CAD',
+          assetScale: 3,
+          value: '0'
+        }
+      })
+
+      const scope = nock(baseUrl)
+        .post('/outgoing-payments')
+        .reply(200, outgoingPayment)
+
+      await expect(() =>
+        createOutgoingPayment(
+          {
+            axiosInstance,
+            logger
+          },
+          {
+            url: `${baseUrl}/outgoing-payments`,
+            accessToken: 'accessToken',
+            body: {
+              quoteId: uuid()
+            }
+          },
+          openApiValidators.successfulValidator
+        )
+      ).rejects.toThrowError()
+      scope.done()
+    })
+
+    test('throws if outgoing payment does not pass open api validation', async (): Promise<void> => {
+      const outgoingPayment = mockOutgoingPayment()
+
+      const scope = nock(baseUrl)
+        .post('/outgoing-payments')
+        .reply(200, outgoingPayment)
+
+      await expect(() =>
+        createOutgoingPayment(
+          {
+            axiosInstance,
+            logger
+          },
+          {
+            url: `${baseUrl}/outgoing-payments`,
+            accessToken: 'accessToken',
+            body: {
+              quoteId: uuid()
+            }
+          },
+          openApiValidators.failedValidator
+        )
+      ).rejects.toThrowError()
+      scope.done()
+    })
+  })
+
   describe('validateOutgoingPayment', (): void => {
     test('returns outgoing payment if passes validation', async (): Promise<void> => {
       const outgoingPayment = mockOutgoingPayment()

packages/open-payments/src/client/outgoing-payment.ts

@@ -1,15 +1,22 @@
 import { HttpMethod, ResponseValidator } from 'openapi'
 import { BaseDeps, RouteDeps } from '.'
-import { getRSPath, OutgoingPayment } from '../types'
-import { get } from './requests'
+import { CreateOutgoingPaymentArgs, getRSPath, OutgoingPayment } from '../types'
+import { get, post } from './requests'
 
 interface GetArgs {
   url: string
   accessToken: string
 }
 
+interface PostArgs<T> {
+  url: string
+  body: T
+  accessToken: string
+}
+
 export interface OutgoingPaymentRoutes {
   get(args: GetArgs): Promise<OutgoingPayment>
+  create(args: PostArgs<CreateOutgoingPaymentArgs>): Promise<OutgoingPayment>
 }
 
 export const createOutgoingPaymentRoutes = (
@@ -23,12 +30,24 @@ export const createOutgoingPaymentRoutes = (
       method: HttpMethod.GET
     })
 
+  const createOutgoingPaymentOpenApiValidator =
+    openApi.createResponseValidator<OutgoingPayment>({
+      path: getRSPath('/outgoing-payments'),
+      method: HttpMethod.POST
+    })
+
   return {
     get: (args: GetArgs) =>
       getOutgoingPayment(
         { axiosInstance, logger },
         args,
         getOutgoingPaymentOpenApiValidator
+      ),
+    create: (args: PostArgs<CreateOutgoingPaymentArgs>) =>
+      createOutgoingPayment(
+        { axiosInstance, logger },
+        args,
+        createOutgoingPaymentOpenApiValidator
       )
   }
 }
@@ -39,11 +58,35 @@ export const getOutgoingPayment = async (
   validateOpenApiResponse: ResponseValidator<OutgoingPayment>
 ) => {
   const { axiosInstance, logger } = deps
-  const { url } = args
+  const { url, accessToken } = args
 
   const outgoingPayment = await get(
     { axiosInstance, logger },
-    args,
+    { url, accessToken },
+    validateOpenApiResponse
+  )
+
+  try {
+    return validateOutgoingPayment(outgoingPayment)
+  } catch (error) {
+    const errorMessage = 'Could not validate outgoing payment'
+    logger.error({ url, validateError: error?.message }, errorMessage)
+
+    throw new Error(errorMessage)
+  }
+}
+
+export const createOutgoingPayment = async (
+  deps: BaseDeps,
+  args: PostArgs<CreateOutgoingPaymentArgs>,
+  validateOpenApiResponse: ResponseValidator<OutgoingPayment>
+) => {
+  const { axiosInstance, logger } = deps
+  const { url, body, accessToken } = args
+
+  const outgoingPayment = await post(
+    { axiosInstance, logger },
+    { url, body, accessToken },
     validateOpenApiResponse
   )