feat: added sender wallet address to incoming payment (#3705)

* Added sender wallet address to incoming payment

Author: oana-lolea

localenv/mock-account-servicing-entity/generated/graphql.ts

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.alterTable('incomingPayments', function (table) {
+    table.string('senderWalletAddress').nullable()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.alterTable('incomingPayments', function (table) {
+    table.dropColumn('senderWalletAddress')
+  })
+}

packages/backend/migrations/20251003090838_add_sender_wallet_address_to_incoming_payment.js

@@ -35,6 +35,7 @@ import {
 import { Amount, serializeAmount } from '../../open_payments/amount'
 import { GraphQLErrorCode } from '../errors'
 import { createTenant } from '../../tests/tenant'
+import { faker } from '@faker-js/faker'
 
 describe('Incoming Payment Resolver', (): void => {
   let deps: IocContract<AppServices>
@@ -100,6 +101,7 @@ describe('Incoming Payment Resolver', (): void => {
 
   describe('Mutation.createIncomingPayment', (): void => {
     let amount: Amount
+    let senderWalletAddress: string
 
     beforeEach((): void => {
       amount = {
@@ -108,6 +110,7 @@ describe('Incoming Payment Resolver', (): void => {
         assetScale: asset.scale
       }
       client = 'incoming-payment-client-create'
+      senderWalletAddress = faker.internet.url()
     })
 
     test.each`
@@ -130,7 +133,8 @@ describe('Incoming Payment Resolver', (): void => {
           expiresAt,
           incomingAmount,
           tenantId,
-          initiationReason: IncomingPaymentInitiationReason.Admin
+          initiationReason: IncomingPaymentInitiationReason.Admin,
+          senderWalletAddress
         })
 
         const createSpy = jest
@@ -141,7 +145,8 @@ describe('Incoming Payment Resolver', (): void => {
           walletAddressId,
           incomingAmount,
           expiresAt,
-          metadata
+          metadata,
+          senderWalletAddress
         }
 
         const query = await appContainer.apolloClient
@@ -168,6 +173,7 @@ describe('Incoming Payment Resolver', (): void => {
                     }
                     metadata
                     createdAt
+                    senderWalletAddress
                   }
                 }
               }
@@ -205,7 +211,8 @@ describe('Incoming Payment Resolver', (): void => {
               ...serializeAmount(payment.receivedAmount)
             },
             metadata: metadata || null,
-            createdAt: payment.createdAt.toISOString()
+            createdAt: payment.createdAt.toISOString(),
+            senderWalletAddress
           }
         })
       }

packages/backend/src/graphql/generated/graphql.schema.json

@@ -119,7 +119,8 @@ export const createIncomingPayment: MutationResolvers<ForTenantIdContext>['creat
       initiationReason:
         ctx.isOperator && args.input.isCardPayment
           ? IncomingPaymentInitiationReason.Card
-          : IncomingPaymentInitiationReason.Admin
+          : IncomingPaymentInitiationReason.Admin,
+      senderWalletAddress: args.input.senderWalletAddress
     })
     const config = await ctx.container.use('config')
     if (isIncomingPaymentError(incomingPaymentOrError)) {
@@ -232,6 +233,7 @@ export function paymentToGraphql(
     incomingAmount: payment.incomingAmount,
     receivedAmount: payment.receivedAmount,
     metadata: payment.metadata,
-    createdAt: new Date(+payment.createdAt).toISOString()
+    createdAt: new Date(+payment.createdAt).toISOString(),
+    senderWalletAddress: payment.senderWalletAddress
   }
 }

packages/backend/src/graphql/generated/graphql.ts

@@ -959,6 +959,8 @@ type IncomingPayment implements BasePayment & Model {
   createdAt: String!
   "The tenant UUID associated with the incoming payment. If not provided, it will be obtained from the signature."
   tenantId: String
+  "The sender's wallet address URL. Applicable only to card payments."
+  senderWalletAddress: String
 }
 
 type Receiver {
@@ -1283,6 +1285,8 @@ input CreateIncomingPaymentInput {
   idempotencyKey: String
   "Whether or not the incoming payment is being created for a card payment."
   isCardPayment: Boolean
+  "The sender's wallet address URL. Applicable only to card payments."
+  senderWalletAddress: String
 }
 
 input CreateReceiverInput {

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

@@ -111,6 +111,7 @@ export class IncomingPayment
   private incomingAmountValue?: bigint | null
   private receivedAmountValue?: bigint
   public readonly tenantId!: string
+  public readonly senderWalletAddress?: string | null
 
   public get completed(): boolean {
     return this.state === IncomingPaymentState.Completed

packages/backend/src/graphql/resolvers/incoming_payment.ts

@@ -35,6 +35,7 @@ export interface CreateIncomingPaymentOptions {
   metadata?: Record<string, unknown>
   tenantId: string
   initiationReason: IncomingPaymentInitiationReason
+  senderWalletAddress?: string
 }
 
 export interface UpdateOptions {
@@ -146,7 +147,8 @@ async function createIncomingPayment(
     incomingAmount,
     metadata,
     tenantId,
-    initiationReason
+    initiationReason,
+    senderWalletAddress
   }: CreateIncomingPaymentOptions,
   trx?: Knex.Transaction
 ): Promise<IncomingPayment | IncomingPaymentError> {
@@ -192,7 +194,8 @@ async function createIncomingPayment(
     state: IncomingPaymentState.Pending,
     processAt: expiresAt,
     tenantId,
-    initiatedBy: initiationReason
+    initiatedBy: initiationReason,
+    senderWalletAddress
   })
 
   const asset = await deps.assetService.get(incomingPayment.assetId)