662/mk/use open payments types

packages/backend/src/open_payments/payment/incoming/model.ts

@@ -84,7 +84,6 @@ export class IncomingPayment
     }
   }
 
-  public paymentPointer!: PaymentPointer
   public description?: string
   public expiresAt!: Date
   public state!: IncomingPaymentState
@@ -131,8 +130,15 @@ export class IncomingPayment
     this.receivedAmountValue = amount.value
   }
 
-  public get url(): string {
-    return `${this.paymentPointer.url}${IncomingPayment.urlPath}/${this.id}`
+  public async getUrl(fetchedPaymentPointer?: PaymentPointer): Promise<string> {
+    const paymentPointer =
+      fetchedPaymentPointer || (await this.getPaymentPointer())
+
+    return `${paymentPointer.url}${IncomingPayment.urlPath}/${this.id}`
+  }
+
+  public async getPaymentPointer(): Promise<PaymentPointer> {
+    return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
   }
 
   public async onCredit({
@@ -243,22 +249,24 @@ export class IncomingPayment
     return payment
   }
 
-  public toOpenPaymentsType(): OpenPaymentsIncomingPayment
-  public toOpenPaymentsType(
+  public async toOpenPaymentsType(): Promise<OpenPaymentsIncomingPayment>
+  public async toOpenPaymentsType(
     ilpStreamConnection: Connection
-  ): OpenPaymentsIncomingPaymentWithConnection
-  public toOpenPaymentsType(
+  ): Promise<OpenPaymentsIncomingPaymentWithConnection>
+  public async toOpenPaymentsType(
     ilpStreamConnection: string
-  ): OpenPaymentsIncomingPaymentWithConnectionUrl
-  public toOpenPaymentsType(
+  ): Promise<OpenPaymentsIncomingPaymentWithConnectionUrl>
+  public async toOpenPaymentsType(
     ilpStreamConnection?: Connection | string
-  ):
+  ): Promise<
     | OpenPaymentsIncomingPayment
     | OpenPaymentsIncomingPaymentWithConnection
-    | OpenPaymentsIncomingPaymentWithConnectionUrl {
+    | OpenPaymentsIncomingPaymentWithConnectionUrl
+  > {
+    const paymentPointer = await this.getPaymentPointer()
     const baseIncomingPayment: OpenPaymentsIncomingPayment = {
-      id: this.url,
-      paymentPointer: this.paymentPointer.url,
+      id: await this.getUrl(paymentPointer),
+      paymentPointer: paymentPointer.url,
       incomingAmount: this.incomingAmount
         ? serializeAmount(this.incomingAmount)
         : undefined,

packages/backend/src/open_payments/payment/incoming/routes.test.ts

@@ -82,31 +82,33 @@ describe('Incoming Payment Routes', (): void => {
           externalRef
         }),
       get: (ctx) => incomingPaymentRoutes.get(ctx),
-      getBody: (incomingPayment, list) => ({
-        id: incomingPayment.url,
-        paymentPointer: paymentPointer.url,
-        completed: false,
-        incomingAmount:
-          incomingPayment.incomingAmount &&
-          serializeAmount(incomingPayment.incomingAmount),
-        description: incomingPayment.description,
-        expiresAt: incomingPayment.expiresAt.toISOString(),
-        createdAt: incomingPayment.createdAt.toISOString(),
-        updatedAt: incomingPayment.updatedAt.toISOString(),
-        receivedAmount: serializeAmount(incomingPayment.receivedAmount),
-        externalRef: '#123',
-        ilpStreamConnection: list
-          ? `${config.openPaymentsUrl}/connections/${incomingPayment.connectionId}`
-          : {
-              id: `${config.openPaymentsUrl}/connections/${incomingPayment.connectionId}`,
-              ilpAddress: expect.stringMatching(
-                /^test\.rafiki\.[a-zA-Z0-9_-]{95}$/
-              ),
-              sharedSecret: expect.stringMatching(/^[a-zA-Z0-9-_]{43}$/),
-              assetCode: incomingPayment.receivedAmount.assetCode,
-              assetScale: incomingPayment.receivedAmount.assetScale
-            }
-      }),
+      getBody: async (incomingPayment, list) => {
+        return {
+          id: await incomingPayment.getUrl(),
+          paymentPointer: paymentPointer.url,
+          completed: false,
+          incomingAmount:
+            incomingPayment.incomingAmount &&
+            serializeAmount(incomingPayment.incomingAmount),
+          description: incomingPayment.description,
+          expiresAt: incomingPayment.expiresAt.toISOString(),
+          createdAt: incomingPayment.createdAt.toISOString(),
+          updatedAt: incomingPayment.updatedAt.toISOString(),
+          receivedAmount: serializeAmount(incomingPayment.receivedAmount),
+          externalRef: '#123',
+          ilpStreamConnection: list
+            ? `${config.openPaymentsUrl}/connections/${incomingPayment.connectionId}`
+            : {
+                id: `${config.openPaymentsUrl}/connections/${incomingPayment.connectionId}`,
+                ilpAddress: expect.stringMatching(
+                  /^test\.rafiki\.[a-zA-Z0-9_-]{95}$/
+                ),
+                sharedSecret: expect.stringMatching(/^[a-zA-Z0-9-_]{43}$/),
+                assetCode: incomingPayment.receivedAmount.assetCode,
+                assetScale: incomingPayment.receivedAmount.assetScale
+              }
+        }
+      },
       list: (ctx) => incomingPaymentRoutes.list(ctx),
       urlPath: IncomingPayment.urlPath
     })
@@ -263,7 +265,7 @@ describe('Incoming Payment Routes', (): void => {
       await expect(incomingPaymentRoutes.complete(ctx)).resolves.toBeUndefined()
       expect(ctx.response).toSatisfyApiSpec()
       expect(ctx.body).toEqual({
-        id: incomingPayment.url,
+        id: await incomingPayment.getUrl(),
         paymentPointer: paymentPointer.url,
         incomingAmount: {
           value: '123',

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

@@ -4,7 +4,10 @@ import { DbErrors } from 'objection-db-errors'
 import { LiquidityAccount } from '../../../accounting/service'
 import { Asset } from '../../../asset/model'
 import { ConnectorAccount } from '../../../connector/core/rafiki'
-import { PaymentPointerSubresource } from '../../payment_pointer/model'
+import {
+  PaymentPointerSubresource,
+  PaymentPointer
+} from '../../payment_pointer/model'
 import { Quote } from '../../quote/model'
 import { Amount, AmountJSON, serializeAmount } from '../../amount'
 import { WebhookEvent } from '../../../webhook/model'
@@ -73,10 +76,6 @@ export class OutgoingPayment
     return this.quote.asset
   }
 
-  public get url(): string {
-    return `${this.paymentPointerId}${OutgoingPayment.urlPath}/${this.id}`
-  }
-
   public get failed(): boolean {
     return this.state === OutgoingPaymentState.Failed
   }
@@ -178,10 +177,16 @@ export class OutgoingPayment
     }
   }
 
-  public toOpenPaymentsType(): OpenPaymentsOutgoingPayment {
+  public async getPaymentPointer(): Promise<PaymentPointer> {
+    return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
+  }
+
+  public async toOpenPaymentsType(): Promise<OpenPaymentsOutgoingPayment> {
+    const paymentPointer = await this.getPaymentPointer()
+
     return {
-      id: this.url,
-      paymentPointer: this.paymentPointerId,
+      id: `${paymentPointer.url}${OutgoingPayment.urlPath}/${this.id}`,
+      paymentPointer: paymentPointer.id,
       quoteId: this.quote.id,
       receiveAmount: serializeAmount(this.receiveAmount),
       sendAmount: serializeAmount(this.sendAmount),

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

@@ -50,7 +50,7 @@ async function getOutgoingPayment(
     ctx.throw(500, 'Error trying to get outgoing payment')
   }
   if (!outgoingPayment) return ctx.throw(404)
-  ctx.body = outgoingPaymentToBody(outgoingPayment)
+  ctx.body = await outgoingPaymentToBody(outgoingPayment)
 }
 
 export type CreateBody = {
@@ -84,7 +84,7 @@ async function createOutgoingPayment(
     return ctx.throw(errorToCode[paymentOrErr], errorToMessage[paymentOrErr])
   }
   ctx.status = 201
-  ctx.body = outgoingPaymentToBody(paymentOrErr)
+  ctx.body = await outgoingPaymentToBody(paymentOrErr)
 }
 
 async function listOutgoingPayments(
@@ -95,15 +95,15 @@ async function listOutgoingPayments(
     await listSubresource({
       ctx,
       getPaymentPointerPage: deps.outgoingPaymentService.getPaymentPointerPage,
-      toBody: (payment) => outgoingPaymentToBody(payment)
+      toBody: outgoingPaymentToBody
     })
   } catch (_) {
     ctx.throw(500, 'Error trying to list outgoing payments')
   }
 }
 
-function outgoingPaymentToBody(
+async function outgoingPaymentToBody(
   outgoingPayment: OutgoingPayment
-): OpenPaymentsOutgoingPayment {
+): Promise<OpenPaymentsOutgoingPayment> {
   return outgoingPayment.toOpenPaymentsType()
 }

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

@@ -266,7 +266,7 @@ describe('OutgoingPaymentService', (): void => {
     incomingPayment = await createIncomingPayment(deps, {
       paymentPointerId: receiverPaymentPointer.id
     })
-    receiver = incomingPayment.url
+    receiver = await incomingPayment.getUrl()
 
     amtDelivered = BigInt(0)
   })
@@ -858,7 +858,9 @@ describe('OutgoingPaymentService', (): void => {
         const fetchedReceiver = connectionService.getUrl(incomingPayment)
         assert.ok(fetchedReceiver)
         const paymentId = await setup({
-          receiver: toConnection ? fetchedReceiver : incomingPayment.url,
+          receiver: toConnection
+            ? fetchedReceiver
+            : await incomingPayment.getUrl(),
           receiveAmount
         })
 

packages/backend/src/open_payments/payment_pointer/model.test.ts

@@ -194,7 +194,10 @@ type RouteTestsOptions<M> = Omit<
 > & {
   getPaymentPointer: () => Promise<PaymentPointer>
   get: (ctx: ReadContext) => Promise<void>
-  getBody: (model: M, list?: boolean) => Record<string, unknown>
+  getBody: (
+    model: M,
+    list?: boolean
+  ) => Record<string, unknown> | Promise<Record<string, unknown>>
   list?: (ctx: ListContext) => Promise<void>
   urlPath: string
 }
@@ -230,7 +233,7 @@ export const getRouteTests = <M extends PaymentPointerSubresource>({
       expect(ctx.response).toSatisfyApiSpec()
     }
     expect(ctx.body).toEqual({
-      result: expectedMatch ? [getBody(expectedMatch, true)] : [],
+      result: expectedMatch ? [await getBody(expectedMatch, true)] : [],
       pagination: {
         hasPreviousPage: false,
         hasNextPage: false,

packages/backend/src/open_payments/payment_pointer/routes.ts

@@ -40,7 +40,9 @@ export async function getPaymentPointer(
 interface ListSubresourceOptions<M extends PaymentPointerSubresource> {
   ctx: ListContext
   getPaymentPointerPage: PaymentPointerSubresourceService<M>['getPaymentPointerPage']
-  toBody: (model: M) => Record<string, unknown>
+  toBody:
+    | ((model: M) => Record<string, unknown>)
+    | ((model: M) => Promise<Record<string, unknown>>)
 }
 
 export const listSubresource = async <M extends PaymentPointerSubresource>({
@@ -66,9 +68,9 @@ export const listSubresource = async <M extends PaymentPointerSubresource>({
   )
   const result = {
     pagination: pageInfo,
-    result: page.map((item: M) => {
+    result: page.map(async (item: M) => {
       item.paymentPointer = ctx.paymentPointer
-      return toBody(item)
+      return await toBody(item)
     })
   }
   ctx.body = result

packages/backend/src/open_payments/quote/model.ts

@@ -2,7 +2,10 @@ import { Model, Pojo } from 'objection'
 import * as Pay from '@interledger/pay'
 
 import { Amount, serializeAmount } from '../amount'
-import { PaymentPointerSubresource } from '../payment_pointer/model'
+import {
+  PaymentPointer,
+  PaymentPointerSubresource
+} from '../payment_pointer/model'
 import { Asset } from '../../asset/model'
 import { Quote as OpenPaymentsQuote } from 'open-payments'
 
@@ -44,8 +47,15 @@ export class Quote extends PaymentPointerSubresource {
 
   private sendAmountValue!: bigint
 
-  public get url(): string {
-    return `${this.paymentPointerId}${Quote.urlPath}/${this.id}`
+  public async getPaymentPointer(): Promise<PaymentPointer> {
+    return this.paymentPointer ?? (await this.$relatedQuery('paymentPointer'))
+  }
+
+  public async getUrl(fetchedPaymentPointer?: PaymentPointer): Promise<string> {
+    const paymentPointer =
+      fetchedPaymentPointer || (await this.getPaymentPointer())
+
+    return `${paymentPointer.url}${Quote.urlPath}/${this.id}`
   }
 
   public get sendAmount(): Amount {
@@ -154,10 +164,12 @@ export class Quote extends PaymentPointerSubresource {
     }
   }
 
-  public toOpenPaymentsType(): OpenPaymentsQuote {
+  public async toOpenPaymentsType(): Promise<OpenPaymentsQuote> {
+    const paymentPointer = await this.getPaymentPointer()
+
     return {
-      id: this.url,
-      paymentPointer: this.paymentPointerId,
+      id: await this.getUrl(paymentPointer),
+      paymentPointer: paymentPointer.url,
       receiveAmount: serializeAmount(this.receiveAmount),
       sendAmount: serializeAmount(this.sendAmount),
       receiver: this.receiver,

packages/backend/src/open_payments/quote/routes.ts

@@ -80,7 +80,7 @@ async function createQuote(
     }
 
     ctx.status = 201
-    ctx.body = quoteToBody(quoteOrErr)
+    ctx.body = await quoteToBody(quoteOrErr)
   } catch (err) {
     if (isQuoteError(err)) {
       return ctx.throw(errorToCode[err], errorToMessage[err])
@@ -90,6 +90,6 @@ async function createQuote(
   }
 }
 
-function quoteToBody(quote: Quote): OpenPaymentsQuote {
+async function quoteToBody(quote: Quote): Promise<OpenPaymentsQuote> {
   return quote.toOpenPaymentsType()
 }

packages/backend/src/open_payments/quote/service.test.ts

@@ -247,7 +247,7 @@ describe('QuoteService', (): void => {
             paymentPointerId,
             receiver: toConnection
               ? connectionService.getUrl(incomingPayment)
-              : incomingPayment.url
+              : await incomingPayment.getUrl()
           }
           if (sendAmount) options.sendAmount = sendAmount
           if (receiveAmount) options.receiveAmount = receiveAmount
@@ -575,7 +575,7 @@ describe('QuoteService', (): void => {
         })
         const options: CreateQuoteOptions = {
           paymentPointerId,
-          receiver: incomingPayment.url,
+          receiver: await incomingPayment.getUrl(),
           receiveAmount
         }
         const expected: ExpectedQuote = {
@@ -653,11 +653,11 @@ describe('QuoteService', (): void => {
       async ({ sendAmount, receiveAmount }): Promise<void> => {
         const options: CreateQuoteOptions = {
           paymentPointerId,
-          receiver: (
+          receiver: await (
             await createIncomingPayment(deps, {
               paymentPointerId: receivingPaymentPointer.id
             })
-          ).url
+          ).getUrl()
         }
         if (sendAmount) options.sendAmount = sendAmount
         if (receiveAmount) options.receiveAmount = receiveAmount
@@ -675,11 +675,11 @@ describe('QuoteService', (): void => {
       await expect(
         quoteService.create({
           paymentPointerId,
-          receiver: (
+          receiver: await (
             await createIncomingPayment(deps, {
               paymentPointerId: receivingPaymentPointer.id
             })
-          ).url,
+          ).getUrl(),
           sendAmount
         })
       ).rejects.toThrow('missing prices')