662/mk/use open payments types

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',
@@ -239,12 +243,13 @@ export class IncomingPayment
     return payment
   }
 
-  public toOpenPaymentsType({
-    ilpStreamConnection
-  }: {
-    ilpStreamConnection: Connection
-  }): OpenPaymentsIncomingPayment {
-    return {
+  public toOpenPaymentsType(
+    ilpStreamConnection: Connection | string | undefined
+  ):
+    | OpenPaymentsIncomingPayment
+    | OpenPaymentsIncomingPaymentWithConnection
+    | OpenPaymentsIncomingPaymentWithConnectionUrl {
+    const baseIncomingPayment: OpenPaymentsIncomingPayment = {
       id: this.url,
       paymentPointer: this.paymentPointer.url,
       incomingAmount: this.incomingAmount
@@ -254,24 +259,23 @@ export class IncomingPayment
       completed: this.completed,
       createdAt: this.createdAt.toISOString(),
       updatedAt: this.updatedAt.toISOString(),
-      expiresAt: this.expiresAt.toISOString(),
-      ilpStreamConnection: ilpStreamConnection.toOpenPaymentsType()
+      expiresAt: this.expiresAt.toISOString()
     }
-  }
-}
 
-// 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
+    if (!ilpStreamConnection) {
+      return baseIncomingPayment
+    }
+
+    if (typeof ilpStreamConnection === 'string') {
+      return {
+        ...baseIncomingPayment,
+        ilpStreamConnection
+      }
+    }
+
+    return {
+      ...baseIncomingPayment,
+      ilpStreamConnection: ilpStreamConnection.toOpenPaymentsType().id
+    }
+  }
 }

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

@@ -7,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,
@@ -16,8 +16,13 @@ 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 {
+  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?
@@ -69,7 +74,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 = incomingPaymentToBody(incomingPayment, connection)
 }
 
 export type CreateBody = {
@@ -110,11 +115,7 @@ async function createIncomingPayment(
 
   ctx.status = 201
   const connection = deps.connectionService.get(incomingPaymentOrError)
-  ctx.body = incomingPaymentToBody(
-    deps,
-    incomingPaymentOrError,
-    connection?.toJSON()
-  )
+  ctx.body = incomingPaymentToBody(incomingPaymentOrError, connection)
 }
 
 async function completeIncomingPayment(
@@ -136,7 +137,7 @@ async function completeIncomingPayment(
       errorToMessage[incomingPaymentOrError]
     )
   }
-  ctx.body = incomingPaymentToBody(deps, incomingPaymentOrError)
+  ctx.body = incomingPaymentToBody(incomingPaymentOrError)
 }
 
 async function listIncomingPayments(
@@ -148,29 +149,18 @@ async function listIncomingPayments(
       ctx,
       getPaymentPointerPage: deps.incomingPaymentService.getPaymentPointerPage,
       toBody: (payment) =>
-        incomingPaymentToBody(
-          deps,
-          payment,
-          deps.connectionService.getUrl(payment)
-        )
+        incomingPaymentToBody(payment, deps.connectionService.getUrl(payment))
     })
   } catch (_) {
     ctx.throw(500, 'Error trying to list incoming payments')
   }
 }
-
 function incomingPaymentToBody(
-  deps: ServiceDependencies,
   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
+):
+  | OpenPaymentsIncomingPayment
+  | OpenPaymentsIncomingPaymentWithConnection
+  | OpenPaymentsIncomingPaymentWithConnectionUrl {
+  return incomingPayment.toOpenPaymentsType(ilpStreamConnection)
 }

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

@@ -6,8 +6,9 @@ import { Asset } from '../../../asset/model'
 import { ConnectorAccount } from '../../../connector/core/rafiki'
 import { PaymentPointerSubresource } from '../../payment_pointer/model'
 import { Quote } from '../../quote/model'
-import { Amount, AmountJSON } from '../../amount'
+import { Amount, AmountJSON, serializeAmount } from '../../amount'
 import { WebhookEvent } from '../../../webhook/model'
+import { OutgoingPayment as OpenPaymentsOutgoingPayment } from 'open-payments'
 
 export class OutgoingPaymentGrant extends DbErrors(Model) {
   public static get modelPaths(): string[] {
@@ -72,6 +73,14 @@ 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
+  }
+
   // Outgoing peer
   public peerId?: string
 
@@ -168,6 +177,23 @@ export class OutgoingPayment
       updatedAt: json.updatedAt
     }
   }
+
+  public toOpenPaymentsType(): OpenPaymentsOutgoingPayment {
+    return {
+      id: this.url,
+      paymentPointer: this.paymentPointerId,
+      quoteId: this.quote.id,
+      receiveAmount: serializeAmount(this.receiveAmount),
+      sendAmount: serializeAmount(this.sendAmount),
+      sentAmount: serializeAmount(this.sentAmount),
+      receiver: this.receiver,
+      failed: this.failed,
+      externalRef: this.externalRef,
+      description: this.description,
+      createdAt: this.createdAt.toISOString(),
+      updatedAt: this.updatedAt.toISOString(),
+    }
+  }
 }
 
 export enum OutgoingPaymentState {
@@ -236,16 +262,3 @@ export class PaymentEvent extends WebhookEvent {
   public type!: PaymentEventType
   public data!: PaymentData
 }
-
-export type OutgoingPaymentJSON = {
-  id: string
-  paymentPointer: string
-  receiver: string
-  sendAmount: AmountJSON
-  sentAmount: AmountJSON
-  receiveAmount: AmountJSON
-  description: string | null
-  externalRef: string | null
-  createdAt: string
-  updatedAt: string
-}

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

@@ -3,9 +3,9 @@ import { ReadContext, CreateContext, ListContext } from '../../../app'
 import { IAppConfig } from '../../../config/app'
 import { OutgoingPaymentService } from './service'
 import { isOutgoingPaymentError, errorToCode, errorToMessage } from './errors'
-import { OutgoingPayment, OutgoingPaymentState } from './model'
+import { OutgoingPayment } from './model'
 import { listSubresource } from '../../payment_pointer/routes'
-import { PaymentPointer } from '../../payment_pointer/model'
+import { OutgoingPayment as OpenPaymentsOutgoingPayment } from 'open-payments'
 
 interface ServiceDependencies {
   config: IAppConfig
@@ -49,8 +49,7 @@ async function getOutgoingPayment(
     ctx.throw(500, 'Error trying to get outgoing payment')
   }
   if (!outgoingPayment) return ctx.throw(404)
-  const body = outgoingPaymentToBody(deps, outgoingPayment, ctx.paymentPointer)
-  ctx.body = body
+  ctx.body = outgoingPaymentToBody(outgoingPayment)
 }
 
 export type CreateBody = {
@@ -84,8 +83,7 @@ async function createOutgoingPayment(
     return ctx.throw(errorToCode[paymentOrErr], errorToMessage[paymentOrErr])
   }
   ctx.status = 201
-  const res = outgoingPaymentToBody(deps, paymentOrErr, ctx.paymentPointer)
-  ctx.body = res
+  ctx.body = outgoingPaymentToBody(paymentOrErr)
 }
 
 async function listOutgoingPayments(
@@ -96,26 +94,15 @@ async function listOutgoingPayments(
     await listSubresource({
       ctx,
       getPaymentPointerPage: deps.outgoingPaymentService.getPaymentPointerPage,
-      toBody: (payment) =>
-        outgoingPaymentToBody(deps, payment, ctx.paymentPointer)
+      toBody: (payment) => outgoingPaymentToBody(payment)
     })
   } catch (_) {
     ctx.throw(500, 'Error trying to list outgoing payments')
   }
 }
 
 function outgoingPaymentToBody(
-  deps: ServiceDependencies,
-  outgoingPayment: OutgoingPayment,
-  paymentPointer: PaymentPointer
-) {
-  return Object.fromEntries(
-    Object.entries({
-      ...outgoingPayment.toJSON(),
-      id: `${paymentPointer.url}/outgoing-payments/${outgoingPayment.id}`,
-      paymentPointer: paymentPointer.url,
-      state: null,
-      failed: outgoingPayment.state === OutgoingPaymentState.Failed
-    }).filter(([_, v]) => v != null)
-  )
+  outgoingPayment: OutgoingPayment
+): OpenPaymentsOutgoingPayment {
+  return outgoingPayment.toOpenPaymentsType()
 }

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

@@ -1,9 +1,10 @@
 import { Model, Pojo } from 'objection'
 import * as Pay from '@interledger/pay'
 
-import { Amount, AmountJSON } from '../amount'
+import { Amount, AmountJSON, serializeAmount } from '../amount'
 import { PaymentPointerSubresource } from '../payment_pointer/model'
 import { Asset } from '../../asset/model'
+import { Quote as OpenPaymentsQuote } from 'open-payments'
 
 export class Quote extends PaymentPointerSubresource {
   public static readonly tableName = 'quotes'
@@ -43,6 +44,10 @@ export class Quote extends PaymentPointerSubresource {
 
   private sendAmountValue!: bigint
 
+  public get url(): string {
+    return `${this.paymentPointerId}${Quote.urlPath}/${this.id}`
+  }
+
   public get sendAmount(): Amount {
     return {
       value: this.sendAmountValue,
@@ -148,6 +153,18 @@ export class Quote extends PaymentPointerSubresource {
       expiresAt: json.expiresAt.toISOString()
     }
   }
+
+  public toOpenPaymentsType(): OpenPaymentsQuote {
+    return {
+      id: this.url,
+      paymentPointer: this.paymentPointerId,
+      receiveAmount: serializeAmount(this.receiveAmount),
+      sendAmount: serializeAmount(this.sendAmount),
+      receiver: this.receiver,
+      expiresAt: this.expiresAt.toISOString(),
+      createdAt: this.createdAt.toISOString(),
+    }
+  }
 }
 
 export type QuoteJSON = {