feat(backend): remove payment pointer from url, retrieve it from request query or body

packages/backend/migrations/20230918113102_rename_payment_pointer_tables.js

@@ -40,27 +40,21 @@ exports.up = function (knex) {
       table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
       table.renameColumn('paymentPointerId', 'walletAddressId')
       table.foreign('walletAddressId').references('walletAddresses.id')
-      table.index(['walletAddressId'])
-      table.index(['createdAt'])
-      table.index(['id'])
+      table.index(['walletAddressId', 'createdAt', 'id'])
     }),
     knex.schema.alterTable('incomingPayments', function (table) {
       table.dropForeign(['paymentPointerId'])
       table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
       table.renameColumn('paymentPointerId', 'walletAddressId')
       table.foreign('walletAddressId').references('walletAddresses.id')
-      table.index(['walletAddressId'])
-      table.index(['createdAt'])
-      table.index(['id'])
+      table.index(['walletAddressId', 'createdAt', 'id'])
     }),
     knex.schema.alterTable('outgoingPayments', function (table) {
       table.dropForeign(['paymentPointerId'])
       table.dropIndex(['paymentPointerId', 'createdAt', 'id'])
       table.renameColumn('paymentPointerId', 'walletAddressId')
       table.foreign('walletAddressId').references('walletAddresses.id')
-      table.index(['walletAddressId'])
-      table.index(['createdAt'])
-      table.index(['id'])
+      table.index(['walletAddressId', 'createdAt', 'id'])
     }),
     knex('webhookEvents')
       .update({
@@ -113,7 +107,7 @@ exports.down = function (knex) {
       'ALTER INDEX "walletAddresses_pkey" RENAME TO "paymentPointers_pkey"'
     ),
     knex.raw(
-      'ALTER INDEX "walletAddresses_url_index" RENAME TO "paymentPointers_url_index"'
+      'ALTER INDEX "walletaddresses_url_index" RENAME TO "paymentpointers_url_index"'
     ),
     knex.raw(
       'ALTER INDEX "walletaddresses_processat_index" RENAME TO "paymentpointers_processat_index"'
@@ -122,19 +116,18 @@ exports.down = function (knex) {
       'ALTER TABLE "paymentPointers" DROP CONSTRAINT "walletaddresses_url_unique"'
     ),
     knex.raw(
-      'ALTER TABLE "paymentPointers" DROP CONSTRAINT "walletaddreses_assetid_foreign"'
+      'ALTER TABLE "paymentPointers" DROP CONSTRAINT "walletaddresses_assetid_foreign"'
     ),
     knex.schema.renameTable('walletAddressKeys', 'paymentPointerKeys'),
     knex.schema.alterTable('paymentPointerKeys', function (table) {
-      table.dropForeign(['walletAddressId'])
       table.renameColumn('walletAddressId', 'paymentPointerId')
       table.foreign('paymentPointerId').references('paymentPointers.id')
     }),
     knex.raw(
       'ALTER INDEX "walletAddressKeys_pkey" RENAME TO "paymentPointerKeys_pkey"'
     ),
     knex.raw(
-      'ALTER TABLE "paymentpointerKeys" DROP CONSTRAINT "walletaddresskeys_paymentpointerid_foreign"'
+      'ALTER TABLE "paymentPointerKeys" DROP CONSTRAINT "walletaddresskeys_walletaddressid_foreign"'
     ),
     knex.schema.alterTable('quotes', function (table) {
       table.dropForeign(['walletAddressId'])

packages/backend/package.json

@@ -53,7 +53,7 @@
     "@graphql-tools/load": "^8.0.0",
     "@graphql-tools/schema": "^10.0.0",
     "@interledger/http-signature-utils": "1.1.0",
-    "@interledger/open-payments": "5.0.0",
+    "@interledger/open-payments": "5.2.0",
     "@interledger/openapi": "1.0.3",
     "@interledger/pay": "0.4.0-alpha.9",
     "@interledger/stream-receiver": "^0.3.3-alpha.3",

packages/backend/src/app.ts

@@ -132,10 +132,14 @@ export type HttpSigContext = AppContext & {
   client: string
 }
 
-// Wallet address subresources
 export type HttpSigWithAuthenticatedStatusContext = HttpSigContext &
   AuthenticatedStatusContext
 
+// Wallet address subresources
+interface GetCollectionQuery {
+  'wallet-address': string
+}
+
 type CollectionRequest<BodyT = never, QueryT = ParsedUrlQuery> = Omit<
   WalletAddressContext['request'],
   'body'
@@ -371,7 +375,7 @@ export class App {
     // POST /incoming-payments
     // Create incoming payment
     router.post<DefaultState, SignedCollectionContext<IncomingCreateBody>>(
-      WALLET_ADDRESS_PATH + '/incoming-payments',
+      '/incoming-payments',
       createWalletAddressMiddleware(),
       createValidatorMiddleware<
         ContextType<SignedCollectionContext<IncomingCreateBody>>
@@ -389,16 +393,18 @@ export class App {
 
     // GET /incoming-payments
     // List incoming payments
-    router.get<DefaultState, SignedCollectionContext>(
-      WALLET_ADDRESS_PATH + '/incoming-payments',
+    router.get<
+      DefaultState,
+      SignedCollectionContext<never, GetCollectionQuery>
+    >(
+      '/incoming-payments',
       createWalletAddressMiddleware(),
-      createValidatorMiddleware<ContextType<SignedCollectionContext>>(
-        resourceServerSpec,
-        {
-          path: '/incoming-payments',
-          method: HttpMethod.GET
-        }
-      ),
+      createValidatorMiddleware<
+        ContextType<SignedCollectionContext<never, GetCollectionQuery>>
+      >(resourceServerSpec, {
+        path: '/incoming-payments',
+        method: HttpMethod.GET
+      }),
       createTokenIntrospectionMiddleware({
         requestType: AccessType.IncomingPayment,
         requestAction: RequestAction.List
@@ -410,7 +416,7 @@ export class App {
     // POST /outgoing-payment
     // Create outgoing payment
     router.post<DefaultState, SignedCollectionContext<OutgoingCreateBody>>(
-      WALLET_ADDRESS_PATH + '/outgoing-payments',
+      '/outgoing-payments',
       createWalletAddressMiddleware(),
       createValidatorMiddleware<
         ContextType<SignedCollectionContext<OutgoingCreateBody>>
@@ -428,16 +434,18 @@ export class App {
 
     // GET /outgoing-payment
     // List outgoing payments
-    router.get<DefaultState, SignedCollectionContext>(
-      WALLET_ADDRESS_PATH + '/outgoing-payments',
+    router.get<
+      DefaultState,
+      SignedCollectionContext<never, GetCollectionQuery>
+    >(
+      '/outgoing-payments',
       createWalletAddressMiddleware(),
-      createValidatorMiddleware<ContextType<SignedCollectionContext>>(
-        resourceServerSpec,
-        {
-          path: '/outgoing-payments',
-          method: HttpMethod.GET
-        }
-      ),
+      createValidatorMiddleware<
+        ContextType<SignedCollectionContext<never, GetCollectionQuery>>
+      >(resourceServerSpec, {
+        path: '/outgoing-payments',
+        method: HttpMethod.GET
+      }),
       createTokenIntrospectionMiddleware({
         requestType: AccessType.OutgoingPayment,
         requestAction: RequestAction.List
@@ -449,7 +457,7 @@ export class App {
     // POST /quotes
     // Create quote
     router.post<DefaultState, SignedCollectionContext<QuoteCreateBody>>(
-      WALLET_ADDRESS_PATH + '/quotes',
+      '/quotes',
       createWalletAddressMiddleware(),
       createValidatorMiddleware<
         ContextType<SignedCollectionContext<QuoteCreateBody>>
@@ -468,8 +476,7 @@ export class App {
     // GET /incoming-payments/{id}
     // Read incoming payment
     router.get<DefaultState, SubresourceContextWithAuthenticatedStatus>(
-      WALLET_ADDRESS_PATH + '/incoming-payments/:id',
-      createWalletAddressMiddleware(),
+      '/incoming-payments/:id',
       createValidatorMiddleware<
         ContextType<SubresourceContextWithAuthenticatedStatus>
       >(resourceServerSpec, {
@@ -488,8 +495,7 @@ export class App {
     // POST /incoming-payments/{id}/complete
     // Complete incoming payment
     router.post<DefaultState, SignedSubresourceContext>(
-      WALLET_ADDRESS_PATH + '/incoming-payments/:id/complete',
-      createWalletAddressMiddleware(),
+      '/incoming-payments/:id/complete',
       createValidatorMiddleware<ContextType<SignedSubresourceContext>>(
         resourceServerSpec,
         {
@@ -508,8 +514,7 @@ export class App {
     // GET /outgoing-payments/{id}
     // Read outgoing payment
     router.get<DefaultState, SignedSubresourceContext>(
-      WALLET_ADDRESS_PATH + '/outgoing-payments/:id',
-      createWalletAddressMiddleware(),
+      '/outgoing-payments/:id',
       createValidatorMiddleware<ContextType<SignedSubresourceContext>>(
         resourceServerSpec,
         {
@@ -528,7 +533,7 @@ export class App {
     // GET /quotes/{id}
     // Read quote
     router.get<DefaultState, SignedSubresourceContext>(
-      WALLET_ADDRESS_PATH + '/quotes/:id',
+      '/quotes/:id',
       createWalletAddressMiddleware(),
       createValidatorMiddleware<ContextType<SignedSubresourceContext>>(
         resourceServerSpec,

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

@@ -297,7 +297,7 @@ describe('Incoming Payment Routes', (): void => {
   describe('get unauthenticated incoming payment', (): void => {
     test('Can get incoming payment with public fields', async (): Promise<void> => {
       const incomingPayment = await createIncomingPayment(deps, {
-        paymentPointerId: paymentPointer.id,
+        walletAddressId: walletAddress.id,
         expiresAt,
         incomingAmount,
         metadata
@@ -312,7 +312,7 @@ describe('Incoming Payment Routes', (): void => {
         params: {
           id: incomingPayment.id
         },
-        paymentPointer
+        walletAddress
       })
       ctx.authenticated = false
 

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

@@ -81,7 +81,7 @@ async function getIncomingPaymentPublic(
     const incomingPayment = await deps.incomingPaymentService.get({
       id: ctx.params.id,
       client: ctx.accessAction === AccessAction.Read ? ctx.client : undefined,
-      paymentPointerId: ctx.paymentPointer.id
+      walletAddressId: ctx.walletAddress.id
     })
     ctx.body = incomingPayment?.toPublicOpenPaymentsType()
   } catch (err) {
@@ -105,16 +105,17 @@ async function getIncomingPaymentPrivate(
   } catch (err) {
     ctx.throw(500, 'Error trying to get incoming payment')
   }
-  if (!incomingPayment) return ctx.throw(404)
+  if (!incomingPayment || !incomingPayment.walletAddress) return ctx.throw(404)
   const connection = deps.connectionService.get(incomingPayment)
   ctx.body = incomingPaymentToBody(
-    ctx.walletAddress,
+    incomingPayment.walletAddress,
     incomingPayment,
     connection
   )
 }
 
 export type CreateBody = {
+  walletAddress: string
   expiresAt?: string
   incomingAmount?: AmountJSON
   metadata?: Record<string, unknown>
@@ -146,10 +147,14 @@ async function createIncomingPayment(
     )
   }
 
+  if (!incomingPaymentOrError.walletAddress) {
+    ctx.throw(404)
+  }
+
   ctx.status = 201
   const connection = deps.connectionService.get(incomingPaymentOrError)
   ctx.body = incomingPaymentToBody(
-    ctx.walletAddress,
+    incomingPaymentOrError.walletAddress,
     incomingPaymentOrError,
     connection
   )
@@ -174,7 +179,12 @@ async function completeIncomingPayment(
       errorToMessage[incomingPaymentOrError]
     )
   }
-  ctx.body = incomingPaymentToBody(ctx.walletAddress, incomingPaymentOrError)
+
+  if (!incomingPaymentOrError.walletAddress) {
+    ctx.throw(404)
+  }
+
+  ctx.body = incomingPaymentToBody(incomingPaymentOrError.walletAddress, incomingPaymentOrError)
 }
 
 async function listIncomingPayments(

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

@@ -66,10 +66,11 @@ async function create(
   try {
     return await deps.openPaymentsClient.incomingPayment.create(
       {
-        walletAddress: walletAddressUrl,
+        url: walletAddressUrl,
         accessToken: grantOrError.accessToken
       },
       {
+        walletAddress: walletAddressUrl,
         incomingAmount: args.incomingAmount
           ? serializeAmount(args.incomingAmount)
           : undefined,

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

@@ -47,17 +47,20 @@ async function getOutgoingPayment(
   try {
     outgoingPayment = await deps.outgoingPaymentService.get({
       id: ctx.params.id,
-      client: ctx.accessAction === AccessAction.Read ? ctx.client : undefined,
-      walletAddressId: ctx.walletAddress.id
+      client: ctx.accessAction === AccessAction.Read ? ctx.client : undefined
     })
   } catch (_) {
     ctx.throw(500, 'Error trying to get outgoing payment')
   }
-  if (!outgoingPayment) return ctx.throw(404)
-  ctx.body = outgoingPaymentToBody(ctx.walletAddress, outgoingPayment)
+  if (!outgoingPayment || !outgoingPayment.walletAddress) return ctx.throw(404)
+  ctx.body = outgoingPaymentToBody(
+    outgoingPayment.walletAddress,
+    outgoingPayment
+  )
 }
 
 export type CreateBody = {
+  walletAddress: string
   quoteId: string
   metadata?: Record<string, unknown>
 }

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

@@ -37,11 +37,10 @@ async function getQuote(
 ): Promise<void> {
   const quote = await deps.quoteService.get({
     id: ctx.params.id,
-    client: ctx.accessAction === AccessAction.Read ? ctx.client : undefined,
-    walletAddressId: ctx.walletAddress.id
+    client: ctx.accessAction === AccessAction.Read ? ctx.client : undefined
   })
-  if (!quote) return ctx.throw(404)
-  ctx.body = quoteToBody(ctx.walletAddress, quote)
+  if (!quote || !quote.walletAddress) return ctx.throw(404)
+  ctx.body = quoteToBody(quote.walletAddress, quote)
 }
 
 interface CreateBodyBase {

packages/backend/src/open_payments/wallet_address/middleware.ts

@@ -1,11 +1,28 @@
 import { AppContext } from '../../app'
+import { CreateBody as IncomingCreateBody } from '../../open_payments/payment/incoming/routes'
+import { CreateBody as OutgoingCreateBody } from '../../open_payments/payment/outgoing/routes'
+
+type CreateBody = IncomingCreateBody | OutgoingCreateBody
 
 export function createWalletAddressMiddleware() {
   return async (
     ctx: AppContext,
     next: () => Promise<unknown>
   ): Promise<void> => {
-    ctx.walletAddressUrl = `https://${ctx.request.host}/${ctx.params.walletAddressPath}`
+    if (
+      ctx.path === '/incoming-payments' ||
+      ctx.path === '/outgoing-payments'
+    ) {
+      if (ctx.method === 'GET') {
+        ctx.walletAddressUrl = ctx.query['wallet-address'] as string
+      } else if (ctx.method === 'POST') {
+        ctx.walletAddressUrl = (ctx.request.body as CreateBody).walletAddress
+      } else {
+        ctx.throw(401)
+      }
+    } else {
+      ctx.walletAddressUrl = `https://${ctx.request.host}/${ctx.params.walletAddressPath}`
+    }
     const config = await ctx.container.use('config')
     if (ctx.walletAddressUrl !== config.walletAddressUrl) {
       const walletAddressService = await ctx.container.use(

packages/backend/src/shared/pagination.ts

@@ -1,7 +1,9 @@
-import { PaginationArgs } from '@interledger/open-payments'
+import { PaginationArgs as OpenPaymentsPaginationArgs } from '@interledger/open-payments'
 
 import { BaseModel, PageInfo, Pagination } from './baseModel'
 
+type PaginationArgs = Omit<OpenPaymentsPaginationArgs, 'wallet-address'>
+
 export function parsePaginationQueryParameters({
   first,
   last,