662/mk/use open payments types

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

@@ -6,7 +6,10 @@ import { AppServices } from '../../app'
 import { initIocContainer } from '../..'
 import { Config } from '../../config/app'
 import { Amount, serializeAmount } from '../../open_payments/amount'
-import { mockIncomingPayment, mockPaymentPointer } from 'open-payments'
+import {
+  mockIncomingPaymentWithConnection,
+  mockPaymentPointer
+} from 'open-payments'
 import { CreateReceiverResponse } from '../generated/graphql'
 import { ReceiverService } from '../../open_payments/receiver/service'
 import { Receiver } from '../../open_payments/receiver/model'
@@ -49,7 +52,7 @@ describe('Receiver Resolver', (): void => {
         incomingAmount
       }): Promise<void> => {
         const receiver = Receiver.fromIncomingPayment(
-          mockIncomingPayment({
+          mockIncomingPaymentWithConnection({
             id: `${paymentPointer.id}/incoming-payments/${uuid()}`,
             paymentPointer: paymentPointer.id,
             description,

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

@@ -4,14 +4,6 @@ import { IlpAddress } from 'ilp-packet'
 import { ILPStreamConnection } from 'open-payments'
 import { IncomingPayment } from '../payment/incoming/model'
 
-export type ConnectionJSON = {
-  id: string
-  ilpAddress: IlpAddress
-  sharedSecret: string
-  assetCode: string
-  assetScale: number
-}
-
 export abstract class ConnectionBase {
   protected constructor(
     public readonly ilpAddress: IlpAddress,
@@ -55,16 +47,6 @@ export class Connection extends ConnectionBase {
     return `${this.openPaymentsUrl}/connections/${this.id}`
   }
 
-  public toJSON(): ConnectionJSON {
-    return {
-      id: this.url,
-      ilpAddress: this.ilpAddress,
-      sharedSecret: base64url(this.sharedSecret),
-      assetCode: this.assetCode,
-      assetScale: this.assetScale
-    }
-  }
-
   public toOpenPaymentsType(): ILPStreamConnection {
     return {
       id: this.url,

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

@@ -36,5 +36,5 @@ async function getConnection(
 
   const connection = deps.connectionService.get(incomingPayment)
   if (!connection) return ctx.throw(404)
-  ctx.body = connection.toJSON()
+  ctx.body = connection.toOpenPaymentsType()
 }

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

@@ -57,7 +57,7 @@ describe('Connection Service', (): void => {
       expect(connection.url).toEqual(
         `${Config.openPaymentsUrl}/connections/${incomingPayment.connectionId}`
       )
-      expect(connection.toJSON()).toEqual({
+      expect(connection.toOpenPaymentsType()).toEqual({
         id: connection.url,
         ilpAddress: connection.ilpAddress,
         sharedSecret: base64url(connection.sharedSecret || ''),

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

@@ -2,7 +2,7 @@ import { Model, ModelOptions, Pojo, QueryContext } from 'objection'
 import { v4 as uuid } from 'uuid'
 
 import { Amount, AmountJSON, serializeAmount } from '../../amount'
-import { Connection, ConnectionJSON } from '../../connection/model'
+import { Connection } from '../../connection/model'
 import {
   PaymentPointer,
   PaymentPointerSubresource
@@ -11,7 +11,11 @@ import { Asset } from '../../../asset/model'
 import { LiquidityAccount, OnCreditOptions } from '../../../accounting/service'
 import { ConnectorAccount } from '../../../connector/core/rafiki'
 import { WebhookEvent } from '../../../webhook/model'
-import { IncomingPayment as OpenPaymentsIncomingPayment } from 'open-payments'
+import {
+  IncomingPayment as OpenPaymentsIncomingPayment,
+  IncomingPaymentWithConnection as OpenPaymentsIncomingPaymentWithConnection,
+  IncomingPaymentWithConnectionUrl as OpenPaymentsIncomingPaymentWithConnectionUrl
+} from 'open-payments'
 
 export enum IncomingPaymentEventType {
   IncomingPaymentExpired = 'incoming_payment.expired',
@@ -80,7 +84,6 @@ export class IncomingPayment
     }
   }
 
-  public paymentPointer!: PaymentPointer
   public description?: string
   public expiresAt!: Date
   public state!: IncomingPaymentState
@@ -127,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({
@@ -239,39 +249,56 @@ export class IncomingPayment
     return payment
   }
 
-  public toOpenPaymentsType({
-    ilpStreamConnection
-  }: {
+  public async toOpenPaymentsType(): Promise<OpenPaymentsIncomingPayment>
+  public async toOpenPaymentsType(
     ilpStreamConnection: Connection
-  }): OpenPaymentsIncomingPayment {
-    return {
-      id: this.url,
-      paymentPointer: this.paymentPointer.url,
+  ): Promise<OpenPaymentsIncomingPaymentWithConnection>
+  public async toOpenPaymentsType(
+    ilpStreamConnection: string
+  ): Promise<OpenPaymentsIncomingPaymentWithConnectionUrl>
+  public async toOpenPaymentsType(
+    ilpStreamConnection?: Connection | string
+  ): Promise<
+    | OpenPaymentsIncomingPaymentWithConnection
+    | OpenPaymentsIncomingPaymentWithConnectionUrl
+  >
+  public async toOpenPaymentsType(
+    ilpStreamConnection?: Connection | string
+  ): Promise<
+    | OpenPaymentsIncomingPayment
+    | OpenPaymentsIncomingPaymentWithConnection
+    | OpenPaymentsIncomingPaymentWithConnectionUrl
+  > {
+    const paymentPointer = await this.getPaymentPointer()
+    const baseIncomingPayment: OpenPaymentsIncomingPayment = {
+      id: await this.getUrl(paymentPointer),
+      paymentPointer: paymentPointer.url,
       incomingAmount: this.incomingAmount
         ? serializeAmount(this.incomingAmount)
         : undefined,
       receivedAmount: serializeAmount(this.receivedAmount),
       completed: this.completed,
+      description: this.description ?? undefined,
+      externalRef: this.externalRef ?? undefined,
       createdAt: this.createdAt.toISOString(),
       updatedAt: this.updatedAt.toISOString(),
-      expiresAt: this.expiresAt.toISOString(),
+      expiresAt: this.expiresAt.toISOString()
+    }
+
+    if (!ilpStreamConnection) {
+      return baseIncomingPayment
+    }
+
+    if (typeof ilpStreamConnection === 'string') {
+      return {
+        ...baseIncomingPayment,
+        ilpStreamConnection
+      }
+    }
+
+    return {
+      ...baseIncomingPayment,
       ilpStreamConnection: ilpStreamConnection.toOpenPaymentsType()
     }
   }
 }
-
-// TODO: disallow undefined
-// https://github.com/interledger/rafiki/issues/594
-export type IncomingPaymentJSON = {
-  id: string
-  paymentPointer: string
-  incomingAmount?: AmountJSON
-  receivedAmount: AmountJSON
-  completed: boolean
-  description?: string
-  externalRef?: string
-  createdAt: string
-  updatedAt: string
-  expiresAt?: string
-  ilpStreamConnection?: ConnectionJSON | string
-}

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/incoming/routes.ts

@@ -1,4 +1,3 @@
-import { AccessAction } from 'open-payments'
 import { Logger } from 'pino'
 import {
   ReadContext,
@@ -8,7 +7,7 @@ import {
 } from '../../../app'
 import { IAppConfig } from '../../../config/app'
 import { IncomingPaymentService } from './service'
-import { IncomingPayment, IncomingPaymentJSON } from './model'
+import { IncomingPayment } from './model'
 import {
   errorToCode,
   errorToMessage,
@@ -17,8 +16,14 @@ import {
 } from './errors'
 import { AmountJSON, parseAmount } from '../../amount'
 import { listSubresource } from '../../payment_pointer/routes'
-import { ConnectionJSON } from '../../connection/model'
+import { Connection } from '../../connection/model'
 import { ConnectionService } from '../../connection/service'
+import {
+  AccessAction,
+  IncomingPayment as OpenPaymentsIncomingPayment,
+  IncomingPaymentWithConnection as OpenPaymentsIncomingPaymentWithConnection,
+  IncomingPaymentWithConnectionUrl as OpenPaymentsIncomingPaymentWithConnectionUrl
+} from 'open-payments'
 
 // Don't allow creating an incoming payment too far out. Incoming payments with no payments before they expire are cleaned up, since incoming payments creation is unauthenticated.
 // TODO what is a good default value for this?
@@ -70,7 +75,7 @@ async function getIncomingPayment(
   }
   if (!incomingPayment) return ctx.throw(404)
   const connection = deps.connectionService.get(incomingPayment)
-  ctx.body = incomingPaymentToBody(deps, incomingPayment, connection?.toJSON())
+  ctx.body = await incomingPaymentToBody(incomingPayment, connection)
 }
 
 export type CreateBody = {
@@ -111,11 +116,7 @@ async function createIncomingPayment(
 
   ctx.status = 201
   const connection = deps.connectionService.get(incomingPaymentOrError)
-  ctx.body = incomingPaymentToBody(
-    deps,
-    incomingPaymentOrError,
-    connection?.toJSON()
-  )
+  ctx.body = await incomingPaymentToBody(incomingPaymentOrError, connection)
 }
 
 async function completeIncomingPayment(
@@ -137,7 +138,7 @@ async function completeIncomingPayment(
       errorToMessage[incomingPaymentOrError]
     )
   }
-  ctx.body = incomingPaymentToBody(deps, incomingPaymentOrError)
+  ctx.body = await incomingPaymentToBody(incomingPaymentOrError)
 }
 
 async function listIncomingPayments(
@@ -148,9 +149,8 @@ async function listIncomingPayments(
     await listSubresource({
       ctx,
       getPaymentPointerPage: deps.incomingPaymentService.getPaymentPointerPage,
-      toBody: (payment) =>
-        incomingPaymentToBody(
-          deps,
+      toBody: async (payment) =>
+        await incomingPaymentToBody(
           payment,
           deps.connectionService.getUrl(payment)
         )
@@ -159,19 +159,13 @@ async function listIncomingPayments(
     ctx.throw(500, 'Error trying to list incoming payments')
   }
 }
-
-function incomingPaymentToBody(
-  deps: ServiceDependencies,
+async function incomingPaymentToBody(
   incomingPayment: IncomingPayment,
-  ilpStreamConnection?: ConnectionJSON | string
-): IncomingPaymentJSON {
-  const body = {
-    ...incomingPayment.toJSON(),
-    id: incomingPayment.url,
-    paymentPointer: incomingPayment.paymentPointer.url
-  } as unknown as IncomingPaymentJSON
-  if (ilpStreamConnection) {
-    body.ilpStreamConnection = ilpStreamConnection
-  }
-  return body
+  ilpStreamConnection?: Connection | string
+): Promise<
+  | OpenPaymentsIncomingPayment
+  | OpenPaymentsIncomingPaymentWithConnection
+  | OpenPaymentsIncomingPaymentWithConnectionUrl
+> {
+  return incomingPayment.toOpenPaymentsType(ilpStreamConnection)
 }

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

@@ -11,10 +11,10 @@ import {
   AuthenticatedClient as OpenPaymentsClient,
   AccessAction,
   AccessType,
-  mockIncomingPayment,
   mockInteractiveGrant,
   mockNonInteractiveGrant,
-  mockPaymentPointer
+  mockPaymentPointer,
+  mockIncomingPaymentWithConnection
 } from 'open-payments'
 import { GrantService } from '../../grant/service'
 import { RemoteIncomingPaymentError } from './errors'
@@ -90,7 +90,7 @@ describe('Remote Incoming Payment Service', (): void => {
         ${undefined}   | ${undefined}                     | ${undefined}               | ${undefined}
         ${amount}      | ${new Date(Date.now() + 30_000)} | ${'Test incoming payment'} | ${'#123'}
       `('creates remote incoming payment ($#)', async (args): Promise<void> => {
-        const mockedIncomingPayment = mockIncomingPayment({
+        const mockedIncomingPayment = mockIncomingPaymentWithConnection({
           ...args,
           paymentPointerUrl: paymentPointer.id
         })
@@ -178,7 +178,7 @@ describe('Remote Incoming Payment Service', (): void => {
         ${undefined}   | ${undefined}                     | ${undefined}               | ${undefined}
         ${amount}      | ${new Date(Date.now() + 30_000)} | ${'Test incoming payment'} | ${'#123'}
       `('creates remote incoming payment ($#)', async (args): Promise<void> => {
-        const mockedIncomingPayment = mockIncomingPayment({
+        const mockedIncomingPayment = mockIncomingPaymentWithConnection({
           ...args,
           paymentPointerUrl: paymentPointer.id
         })