chore(backend): remove peer id from outgoing payment model (#3617)

* chore(backend): remove peer id from outgoing payment model

* chore(backend): delete peer id from webhooks spec

Author: sanducb

bruno/collections/Rafiki/Sample Webhook Events/Outgoing Payment Completed.bru

@@ -41,8 +41,7 @@ body:json {
       "balance": "0",
       "metadata": {
         "description": "Free Money!"
-      },
-      "peerId": "f4b35b6f-7125-485f-8a28-48367ad42557"
+      }
     }
   }
 }

bruno/collections/Rafiki/Sample Webhook Events/Outgoing Payment Created.bru

@@ -41,8 +41,7 @@ body:json {
       "balance": "2",
       "metadata": {
         "description": "Free Money!"
-      },
-      "peerId": "f4b35b6f-7125-485f-8a28-48367ad42557"
+      }
     }
   }
 }

bruno/collections/Rafiki/Sample Webhook Events/Outgoing Payment Failed.bru

@@ -41,8 +41,7 @@ body:json {
       "balance": "52",
       "metadata": {
         "description": "Free Money!"
-      },
-      "peerId": "f4b35b6f-7125-485f-8a28-48367ad42557"
+      }
     }
   }
 }

packages/backend/migrations/20250827153829_drop_peer_id_from_outgoing_payments.js

@@ -0,0 +1,21 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('outgoingPayments', function (table) {
+    table.dropForeign(['peerId'])
+    table.dropColumn('peerId')
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('outgoingPayments', function (table) {
+    table.uuid('peerId').nullable()
+    table.foreign('peerId').references('peers.id')
+  })
+}

packages/backend/src/index.ts

@@ -662,7 +662,6 @@ export function initIocContainer(
       paymentMethodHandlerService: await deps.use(
         'paymentMethodHandlerService'
       ),
-      peerService: await deps.use('peerService'),
       walletAddressService: await deps.use('walletAddressService'),
       quoteService: await deps.use('quoteService'),
       assetService: await deps.use('assetService'),

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

@@ -123,9 +123,6 @@ export class OutgoingPayment
     ].includes(this.state)
   }
 
-  // Outgoing peer
-  public peerId?: string
-
   public tenantId!: string
 
   static get relationMappings() {
@@ -194,9 +191,6 @@ export class OutgoingPayment
     if (this.error) {
       data.error = this.error
     }
-    if (this.peerId) {
-      data.peerId = this.peerId
-    }
 
     if (this.grantId) {
       data.grantId = this.grantId
@@ -287,7 +281,6 @@ export type PaymentData = Omit<OutgoingPaymentResponse, 'failed'> & {
   state: OutgoingPaymentState
   stateAttempts: number
   balance: string
-  peerId?: string
   grantId?: string
 }
 

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

@@ -910,8 +910,7 @@ describe('OutgoingPaymentService', (): void => {
               receiveAmount: quote.receiveAmount,
               metadata: options.metadata,
               state: OutgoingPaymentState.Funding,
-              asset: quote.asset,
-              peerId: outgoingPeer ? peer.id : null
+              asset: quote.asset
             })
 
             await expect(
@@ -924,9 +923,6 @@ describe('OutgoingPaymentService', (): void => {
               id: payment.id,
               client: payment.client
             }
-            if (outgoingPeer) {
-              expectedPaymentData.peerId = peer.id
-            }
             await expect(
               OutgoingPaymentEvent.query(knex).where({
                 type: OutgoingPaymentEventType.PaymentCreated

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

@@ -23,7 +23,6 @@ import {
   AccountingService,
   LiquidityAccountType
 } from '../../../accounting/service'
-import { PeerService } from '../../../payment-method/ilp/peer/service'
 import { ReceiverService } from '../../receiver/service'
 import { GetOptions, ListOptions } from '../../wallet_address/model'
 import {
@@ -67,7 +66,6 @@ export interface ServiceDependencies extends BaseService {
   knex: TransactionOrKnex
   accountingService: AccountingService
   receiverService: ReceiverService
-  peerService: PeerService
   paymentMethodHandlerService: PaymentMethodHandlerService
   walletAddressService: WalletAddressService
   quoteService: QuoteService
@@ -346,23 +344,6 @@ async function createOutgoingPayment(
         if (!receiver || !receiver.isActive()) {
           throw OutgoingPaymentError.InvalidQuote
         }
-        const stopTimerPeer = deps.telemetry.startTimer(
-          'outgoing_payment_service_getpeer_time_ms',
-          {
-            callName: 'PeerService:getByDestinationAddress',
-            description: 'Time to retrieve peer in outgoing payment'
-          }
-        )
-        const ilpPaymentMethod = receiver.paymentMethods.find(
-          (method) => method.type === 'ilp'
-        )
-        const peer = ilpPaymentMethod
-          ? await deps.peerService.getByDestinationAddress(
-              ilpPaymentMethod.ilpAddress,
-              tenantId
-            )
-          : undefined
-        stopTimerPeer()
 
         const payment = await OutgoingPayment.transaction(async (trx) => {
           if (grantId) {
@@ -434,16 +415,6 @@ async function createOutgoingPayment(
             }
           }
 
-          const stopTimerPeerUpdate = deps.telemetry.startTimer(
-            'outgoing_payment_service_patchpeer_time_ms',
-            {
-              callName: 'OutgoingPaymentModel:patch',
-              description: 'Time to patch peer in outgoing payment'
-            }
-          )
-          if (peer) await payment.$query(trx).patch({ peerId: peer.id })
-          stopTimerPeerUpdate()
-
           const stopTimerWebhook = deps.telemetry.startTimer(
             'outgoing_payment_service_webhook_event_time_ms',
             {

packages/backend/src/openapi/specs/webhooks.yaml

@@ -239,9 +239,6 @@ components:
             balance:
               type: string
               format: uint64
-            peerId:
-              type: string
-              format: uuid
             grantId:
               type: string
               format: uuid