fix(api/payment): store additional temporary details in KV (#722)

Author: sidvishnoi

api/src/routes/payment/initiate.ts

@@ -41,7 +41,7 @@ app.post(
       ).href
 
       const openPayments = await OpenPaymentsService.getInstance(env)
-      const { grantContinuation, nonce, ...result } =
+      const { grantContinuation, nonce, amount, ...result } =
         await openPayments.paymentInitiate(params)
 
       // The `/payment/complete` endpoint will find details from the KV based on
@@ -53,9 +53,12 @@ app.post(
         {
           status: 'PENDING',
           quoteId: result.quoteId,
+          incomingPaymentId: result.incomingPaymentId,
           redirectUrl: originalRedirectUrl,
           grantContinuation: grantContinuation,
           sender: params.sender,
+          receiver: params.receiver,
+          amount,
           metadata: { description: params.note },
           nonce,
         },

api/src/routes/payment/redirect.ts

@@ -85,7 +85,10 @@ app.get(
             status: 'CREATED',
             redirectUrl: data.redirectUrl,
             outgoingPaymentId,
+            incomingPaymentId: data.incomingPaymentId,
             sender: data.sender,
+            receiver: data.receiver,
+            amount: data.amount,
             outgoingPaymentGrantAccessToken: accessToken,
           },
           { expirationTtl: 5 * 60 /* 5 minutes */ },

api/src/routes/payment/status.ts

@@ -56,7 +56,11 @@ async function handleStatus(
       paymentId,
       {
         status: 'COMPLETE',
+        incomingPaymentId: data.incomingPaymentId,
         outgoingPaymentId: data.outgoingPaymentId,
+        sender: data.sender,
+        receiver: data.receiver,
+        amount: data.amount,
         result: result.success ? 'success' : 'failure',
         error: result.success ? undefined : result.error,
       },

api/src/utils/open-payments.ts

@@ -173,6 +173,7 @@ export class OpenPaymentsService {
       grantRedirectUrl: grant.interact.redirect,
       grantContinuation: grant.continue,
       nonce,
+      amount: debitAmount || receiveAmount!,
     }
   }
 

api/src/utils/payments-kv.ts

@@ -5,19 +5,23 @@ import type {
 import type {
   GrantWithAccessToken,
   PendingGrant,
-  WalletAddress,
 } from '@interledger/open-payments'
+import type { Amount } from '@shared/types'
+import type { WalletAddressInfo } from '../types'
 
 export const KV_PAYMENTS_PREFIX = 'payments/'
 
 export type PaymentKvData =
   | {
       status: 'PENDING'
       quoteId: string
+      incomingPaymentId: string
       redirectUrl: string
       grantContinuation: PendingGrant['continue']
       nonce: string
-      sender: WalletAddress
+      sender: WalletAddressInfo
+      receiver: WalletAddressInfo
+      amount: Amount
       metadata: Record<string, unknown>
     }
   | {
@@ -27,14 +31,21 @@ export type PaymentKvData =
       status: 'CREATED'
       // For polling of outgoing payment completion
       outgoingPaymentId: string
+      incomingPaymentId: string
+      sender: WalletAddressInfo
+      receiver: WalletAddressInfo
+      amount: Amount
       redirectUrl: string
       // For expiring resources/grants when done
       outgoingPaymentGrantAccessToken: GrantWithAccessToken['access_token']['value']
-      sender: WalletAddress
     }
   | {
       status: 'COMPLETE'
       outgoingPaymentId: string
+      incomingPaymentId: string
+      sender: WalletAddressInfo
+      receiver: WalletAddressInfo
+      amount: Amount
       result: 'success' | 'failure'
       error?: {
         code: string