663/mk/use open payments client

.github/workflows/lint_test_build.yml

@@ -27,6 +27,7 @@ jobs:
       - uses: ./.github/workflows/rafiki/env-setup
       - run: pnpm --filter openapi build
       - run: pnpm --filter auth build
+      - run: pnpm --filter open-payments build
       - run: pnpm --filter backend test
 
   frontend:

packages/backend/package.json

@@ -4,7 +4,7 @@
     "test": "jest --passWithNoTests --maxWorkers=50%",
     "knex": "knex",
     "generate": "graphql-codegen --config codegen.yml",
-    "build:deps": "pnpm --filter openapi build && pnpm --filter auth build",
+    "build:deps": "pnpm --filter openapi build && pnpm --filter auth build && pnpm --filter open-payments build",
     "build": "pnpm build:deps && tsc --build tsconfig.json && pnpm copy-files",
     "clean": "rm -fr dist/",
     "copy-files": "cp src/graphql/schema.graphql dist/graphql/",
@@ -82,6 +82,7 @@
     "objection-db-errors": "^1.1.2",
     "oer-utils": "5.1.3-alpha.1",
     "openapi": "workspace:../openapi",
+    "open-payments": "workspace:../open-payments",
     "pg": "^8.6.0",
     "pino": "^8.4.2",
     "pino-pretty": "^9.0.1",

packages/backend/src/app.ts

@@ -50,6 +50,7 @@ import { createValidatorMiddleware, HttpMethod, isHttpMethod } from 'openapi'
 import { ClientKeysService } from './clientKeys/service'
 import { ClientService } from './clients/service'
 import { GrantReferenceService } from './open_payments/grantReference/service'
+import { OpenPaymentsClient } from 'open-payments'
 
 export interface AppContextData {
   logger: Logger
@@ -154,6 +155,7 @@ export interface AppServices {
   clientService: Promise<ClientService>
   clientKeysService: Promise<ClientKeysService>
   grantReferenceService: Promise<GrantReferenceService>
+  openPaymentsClient: Promise<OpenPaymentsClient>
 }
 
 export type AppContainer = IocContract<AppServices>

packages/backend/src/index.ts

@@ -37,11 +37,13 @@ import { createConnectorService } from './connector'
 import { createSessionService } from './session/service'
 import { createApiKeyService } from './apiKey/service'
 import { createOpenAPI } from 'openapi'
+import { createClient as createOpenPaymentsClient } from 'open-payments'
 import { createConnectionService } from './open_payments/connection/service'
 import { createConnectionRoutes } from './open_payments/connection/routes'
 import { createClientKeysService } from './clientKeys/service'
 import { createClientService } from './clients/service'
 import { createGrantReferenceService } from './open_payments/grantReference/service'
+import { createReceiverService } from './open_payments/receiver/service'
 
 BigInt.prototype.toJSON = function () {
   return this.toString()
@@ -113,6 +115,10 @@ export function initIocContainer(
     const config = await deps.use('config')
     return await createOpenAPI(config.authServerSpec)
   })
+  container.singleton('openPaymentsClient', async (deps) => {
+    const logger = await deps.use('logger')
+    return createOpenPaymentsClient({ logger })
+  })
 
   /**
    * Add services to the container.
@@ -229,6 +235,19 @@ export function initIocContainer(
       connectionService: await deps.use('connectionService')
     })
   })
+  container.singleton('receiverService', async (deps) => {
+    const config = await deps.use('config')
+    return await createReceiverService({
+      logger: await deps.use('logger'),
+      // TODO: https://github.com/interledger/rafiki/issues/583
+      accessToken: config.devAccessToken,
+      connectionService: await deps.use('connectionService'),
+      incomingPaymentService: await deps.use('incomingPaymentService'),
+      openPaymentsUrl: config.openPaymentsUrl,
+      paymentPointerService: await deps.use('paymentPointerService'),
+      openPaymentsClient: await deps.use('openPaymentsClient')
+    })
+  })
   container.singleton('openPaymentsClientService', async (deps) => {
     const config = await deps.use('config')
     return await createOpenPaymentsClientService({
@@ -288,7 +307,7 @@ export function initIocContainer(
       logger: await deps.use('logger'),
       knex: await deps.use('knex'),
       makeIlpPlugin: await deps.use('makeIlpPlugin'),
-      clientService: await deps.use('openPaymentsClientService'),
+      receiverService: await deps.use('receiverService'),
       paymentPointerService: await deps.use('paymentPointerService'),
       ratesService: await deps.use('ratesService')
     })
@@ -308,7 +327,7 @@ export function initIocContainer(
       logger: await deps.use('logger'),
       knex: await deps.use('knex'),
       accountingService: await deps.use('accountingService'),
-      clientService: await deps.use('openPaymentsClientService'),
+      receiverService: await deps.use('receiverService'),
       grantReferenceService: await deps.use('grantReferenceService'),
       makeIlpPlugin: await deps.use('makeIlpPlugin'),
       peerService: await deps.use('peerService')

packages/backend/src/open_payments/client/service.ts

@@ -7,7 +7,7 @@ import { URL } from 'url'
 
 import { Amount, parseAmount } from '../amount'
 import { ConnectionRoutes } from '../connection/routes'
-import { ConnectionBase, ConnectionJSON } from '../connection/service'
+import { ConnectionBase, ConnectionJSON } from '../connection/model'
 import { IncomingPaymentJSON } from '../payment/incoming/model'
 import { IncomingPaymentRoutes } from '../payment/incoming/routes'
 import { PaymentPointerService } from '../payment_pointer/service'

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

@@ -0,0 +1,74 @@
+import { StreamCredentials } from '@interledger/stream-receiver'
+import base64url from 'base64url'
+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,
+    public readonly sharedSecret: Buffer,
+    public readonly assetCode: string,
+    public readonly assetScale: number
+  ) {}
+}
+
+export class Connection extends ConnectionBase {
+  static fromPayment(options: {
+    payment: IncomingPayment
+    credentials: StreamCredentials
+    openPaymentsUrl: string
+  }): Connection {
+    return new this(
+      options.payment.connectionId,
+      options.openPaymentsUrl,
+      options.credentials.ilpAddress,
+      options.credentials.sharedSecret,
+      options.payment.asset.code,
+      options.payment.asset.scale
+    )
+  }
+
+  private constructor(
+    public readonly id: string,
+    private readonly openPaymentsUrl: string,
+    ilpAddress: IlpAddress,
+    sharedSecret: Buffer,
+    assetCode: string,
+    assetScale: number
+  ) {
+    super(ilpAddress, sharedSecret, assetCode, assetScale)
+  }
+
+  public get url(): string {
+    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,
+      ilpAddress: this.ilpAddress,
+      sharedSecret: base64url(this.sharedSecret),
+      assetCode: this.assetCode,
+      assetScale: this.assetScale
+    }
+  }
+}

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

@@ -1,68 +1,8 @@
-import base64url from 'base64url'
-import { IlpAddress } from 'ilp-packet'
-import { StreamCredentials, StreamServer } from '@interledger/stream-receiver'
+import { StreamServer } from '@interledger/stream-receiver'
 
 import { BaseService } from '../../shared/baseService'
 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,
-    public readonly sharedSecret: Buffer,
-    public readonly assetCode: string,
-    public readonly assetScale: number
-  ) {}
-}
-
-export class Connection extends ConnectionBase {
-  static fromPayment(options: {
-    payment: IncomingPayment
-    credentials: StreamCredentials
-    openPaymentsUrl: string
-  }): Connection {
-    return new this(
-      options.payment.connectionId,
-      options.openPaymentsUrl,
-      options.credentials.ilpAddress,
-      options.credentials.sharedSecret,
-      options.payment.asset.code,
-      options.payment.asset.scale
-    )
-  }
-
-  private constructor(
-    public readonly id: string,
-    private readonly openPaymentsUrl: string,
-    ilpAddress: IlpAddress,
-    sharedSecret: Buffer,
-    assetCode: string,
-    assetScale: number
-  ) {
-    super(ilpAddress, sharedSecret, assetCode, assetScale)
-  }
-
-  public get url(): string {
-    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
-    }
-  }
-}
+import { Connection } from './model'
 
 export interface ConnectionService {
   get(payment: IncomingPayment): Connection | undefined

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 } from '../../amount'
-import { ConnectionJSON } from '../../connection/service'
+import { Connection, ConnectionJSON } from '../../connection/model'
 import {
   PaymentPointer,
   PaymentPointerSubresource
@@ -11,6 +11,7 @@ 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'
 
 export enum IncomingPaymentEventType {
   IncomingPaymentExpired = 'incoming_payment.expired',
@@ -237,6 +238,30 @@ export class IncomingPayment
     }
     return payment
   }
+
+  public toOpenPaymentsType({
+    ilpStreamConnection
+  }: {
+    ilpStreamConnection: Connection
+  }): OpenPaymentsIncomingPayment {
+    return {
+      id: this.id,
+      paymentPointer: this.paymentPointer.url,
+      incomingAmount: {
+        ...this.incomingAmount,
+        value: this.incomingAmount.value.toString()
+      },
+      receivedAmount: {
+        ...this.receivedAmount,
+        value: this.receivedAmount.value.toString()
+      },
+      completed: this.completed,
+      createdAt: this.createdAt.toISOString(),
+      updatedAt: this.updatedAt.toISOString(),
+      expiresAt: this.expiresAt.toISOString(),
+      ilpStreamConnection: ilpStreamConnection.toOpenPaymentsType()
+    }
+  }
 }
 
 // TODO: disallow undefined

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

@@ -16,7 +16,8 @@ import {
 } from './errors'
 import { AmountJSON, parseAmount } from '../../amount'
 import { listSubresource } from '../../payment_pointer/routes'
-import { ConnectionJSON, ConnectionService } from '../../connection/service'
+import { ConnectionJSON } from '../../connection/model'
+import { ConnectionService } from '../../connection/service'
 
 // 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?

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

@@ -8,7 +8,7 @@ import {
   PaymentEventType
 } from './model'
 import { ServiceDependencies } from './service'
-import { Receiver } from '../../client/service'
+import { Receiver } from '../../receiver/model'
 import { IlpPlugin } from '../../../shared/ilp_plugin'
 
 // "payment" is locked by the "deps.knex" transaction.
@@ -19,7 +19,7 @@ export async function handleSending(
 ): Promise<void> {
   if (!payment.quote) throw LifecycleError.MissingQuote
 
-  const receiver = await deps.clientService.receiver.get(payment.receiver)
+  const receiver = await deps.receiverService.get(payment.receiver)
 
   // TODO: Query Tigerbeetle transfers by code to distinguish sending debits from withdrawals
   const amountSent = await deps.accountingService.getTotalSent(payment.id)

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

@@ -15,7 +15,7 @@ import {
 import { AccountingService } from '../../../accounting/service'
 import { PeerService } from '../../../peer/service'
 import { Grant, AccessLimits, getInterval } from '../../auth/grant'
-import { OpenPaymentsClientService } from '../../client/service'
+import { ReceiverService } from '../../receiver/service'
 import { GetOptions, ListOptions } from '../../payment_pointer/model'
 import { PaymentPointerSubresourceService } from '../../payment_pointer/service'
 import { IlpPlugin, IlpPluginOptions } from '../../../shared/ilp_plugin'
@@ -43,7 +43,7 @@ export interface OutgoingPaymentService
 export interface ServiceDependencies extends BaseService {
   knex: TransactionOrKnex
   accountingService: AccountingService
-  clientService: OpenPaymentsClientService
+  receiverService: ReceiverService
   peerService: PeerService
   grantReferenceService: GrantReferenceService
   makeIlpPlugin: (options: IlpPluginOptions) => IlpPlugin
@@ -126,7 +126,7 @@ async function createOutgoingPayment(
           throw OutgoingPaymentError.InsufficientGrant
         }
       }
-      const receiver = await deps.clientService.receiver.get(payment.receiver)
+      const receiver = await deps.receiverService.get(payment.receiver)
       if (!receiver) {
         throw OutgoingPaymentError.InvalidQuote
       }

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

@@ -8,7 +8,8 @@ import { BaseService } from '../../shared/baseService'
 import { QuoteError, isQuoteError } from './errors'
 import { Quote } from './model'
 import { Amount, parseAmount } from '../amount'
-import { OpenPaymentsClientService, Receiver } from '../client/service'
+import { ReceiverService } from '../receiver/service'
+import { Receiver } from '../receiver/model'
 import {
   PaymentPointer,
   GetOptions,
@@ -34,7 +35,7 @@ export interface ServiceDependencies extends BaseService {
   quoteLifespan: number // milliseconds
   signatureSecret?: string
   signatureVersion: number
-  clientService: OpenPaymentsClientService
+  receiverService: ReceiverService
   paymentPointerService: PaymentPointerService
   ratesService: RatesService
   makeIlpPlugin: (options: IlpPluginOptions) => IlpPlugin
@@ -167,7 +168,7 @@ export async function resolveReceiver(
   deps: ServiceDependencies,
   options: CreateQuoteOptions
 ): Promise<Receiver> {
-  const receiver = await deps.clientService.receiver.get(options.receiver)
+  const receiver = await deps.receiverService.get(options.receiver)
   if (!receiver) {
     throw QuoteError.InvalidReceiver
   }