feat(outgoing-payment): add grantId to admin api (#2841)

* feat(backend): support for returning grantId when querying outgoing payment

When querying outgoing payment, either single one, or list of them via pagination, etc., it will be
possible to also get a grantId under which the outgoing

* test(outgoing-payment): check if grantId is returned

* docs(bruno): include grantId when fetching outgoing payment

bruno/collections/Rafiki/Examples/Admin API - only locally/Peer-to-Peer Payment/Get Outgoing Payment.bru

@@ -17,6 +17,7 @@ body:graphql {
       error
       metadata
       id
+      grantId
       walletAddressId
       quote {
         id

bruno/collections/Rafiki/Rafiki Admin APIs/Get Outgoing Payment.bru

@@ -17,6 +17,7 @@ body:graphql {
       error
       metadata
       id
+      grantId
       walletAddressId
       client
       quote {

packages/backend/src/graphql/resolvers/outgoing_payment.test.ts

@@ -10,7 +10,10 @@ import { AppServices } from '../../app'
 import { initIocContainer } from '../..'
 import { Config } from '../../config/app'
 import { createAsset } from '../../tests/asset'
-import { createOutgoingPayment } from '../../tests/outgoingPayment'
+import {
+  createOutgoingPayment,
+  CreateTestQuoteAndOutgoingPaymentOptions
+} from '../../tests/outgoingPayment'
 import { createWalletAddress } from '../../tests/walletAddress'
 import { truncateTables } from '../../tests/tableManager'
 import {
@@ -61,11 +64,14 @@ describe('OutgoingPayment Resolvers', (): void => {
     await appContainer.shutdown()
   })
 
-  const createPayment = async (options: {
-    walletAddressId: string
-    metadata?: Record<string, unknown>
-  }): Promise<OutgoingPaymentModel> => {
-    return await createOutgoingPayment(deps, {
+  const createPayment = async (
+    options: {
+      walletAddressId: string
+      metadata?: Record<string, unknown>
+    },
+    grantId?: string
+  ): Promise<OutgoingPaymentModel> => {
+    const obj: CreateTestQuoteAndOutgoingPaymentOptions = {
       ...options,
       method: 'ilp',
       receiver: `${Config.openPaymentsUrl}/${uuid()}`,
@@ -75,12 +81,54 @@ describe('OutgoingPayment Resolvers', (): void => {
         assetScale: asset.scale
       },
       validDestination: false
-    })
+    }
+
+    if (grantId) {
+      obj.grant = { id: grantId }
+    }
+
+    return await createOutgoingPayment(deps, obj)
   }
 
   describe('Query.outgoingPayment', (): void => {
     let payment: OutgoingPaymentModel
 
+    describe('grantId', (): void => {
+      it('should return grantId', async (): Promise<void> => {
+        const grantId = uuid()
+
+        const { id: walletAddressId } = await createWalletAddress(deps, {
+          assetId: asset.id
+        })
+
+        const payment = await createPayment({ walletAddressId }, grantId)
+
+        const query = await appContainer.apolloClient
+          .query({
+            query: gql`
+              query OutgoingPayment($paymentId: String!) {
+                outgoingPayment(id: $paymentId) {
+                  id
+                  grantId
+                  walletAddressId
+                }
+              }
+            `,
+            variables: {
+              paymentId: payment.id
+            }
+          })
+          .then((query): OutgoingPayment => query.data?.outgoingPayment)
+
+        expect(query).toEqual({
+          id: payment.id,
+          grantId: payment.grantId,
+          walletAddressId: payment.walletAddressId,
+          __typename: 'OutgoingPayment'
+        })
+      })
+    })
+
     describe('metadata', (): void => {
       const metadata = {
         description: 'rent',

packages/backend/src/graphql/resolvers/outgoing_payment.ts

@@ -172,6 +172,7 @@ export function paymentToGraphql(
     receiveAmount: payment.receiveAmount,
     metadata: payment.metadata,
     createdAt: new Date(+payment.createdAt).toISOString(),
-    quote: quoteToGraphql(payment.quote)
+    quote: quoteToGraphql(payment.quote),
+    grantId: payment.grantId
   }
 }

packages/backend/src/graphql/schema.graphql

@@ -849,6 +849,8 @@ type OutgoingPayment implements BasePayment & Model {
   sentAmount: Amount!
   "Date-time of creation"
   createdAt: String!
+  "Id of the Grant under which this outgoing payment was created"
+  grantId: String
 }
 
 enum OutgoingPaymentState {

packages/backend/src/tests/outgoingPayment.ts

@@ -14,7 +14,7 @@ import { IncomingPayment } from '../open_payments/payment/incoming/model'
 import { createIncomingPayment } from './incomingPayment'
 import assert from 'assert'
 
-type CreateTestQuoteAndOutgoingPaymentOptions = Omit<
+export type CreateTestQuoteAndOutgoingPaymentOptions = Omit<
   CreateOutgoingPaymentOptions & CreateTestQuoteOptions,
   'quoteId'
 >