Merge branch 'main' into release

Author: DarianM

api/package.json

@@ -3,7 +3,7 @@
   "version": "1.0.0",
   "scripts": {
     "predev": "node -e \"require('fs').copyFileSync('../.dev.vars', '.dev.vars');\"",
-    "dev": "wrangler dev",
+    "dev": "wrangler dev --persist-to ../.wrangler",
     "build": "wrangler deploy --dry-run --outdir dist",
     "preview": "wrangler dev",
     "typecheck": "tsc --noEmit",
@@ -28,8 +28,9 @@
   },
   "types": "./src/types.ts",
   "devDependencies": {
-    "@shared/types": "workspace:^",
+    "@cloudflare/workers-types": "^4.20251011.0",
     "@shared/defines": "workspace:^",
+    "@shared/types": "workspace:^",
     "typescript": "5.9.2",
     "wrangler": "^4.40.0"
   }

api/src/app.ts

@@ -3,6 +3,7 @@ import { cors } from 'hono/cors'
 import { HTTPException } from 'hono/http-exception'
 import { ZodError } from 'zod'
 import { serializeError } from './utils/utils.js'
+import type { KVNamespace } from '@cloudflare/workers-types'
 
 export type Env = {
   AWS_ACCESS_KEY_ID: string
@@ -11,6 +12,7 @@ export type Env = {
   OP_WALLET_ADDRESS: string
   OP_PRIVATE_KEY: string
   OP_KEY_ID: string
+  PUBLISHER_TOOLS_KV: KVNamespace
 }
 
 export const app = new Hono<{ Bindings: Env }>()

api/src/routes/payment.ts

@@ -1,14 +1,15 @@
 import { zValidator } from '@hono/zod-validator'
-
 import { APP_URL } from '@shared/defines'
-import { createHTTPException } from '../utils/utils'
+import { createHTTPException, waitWithAbort } from '../utils/utils'
 import { OpenPaymentsService } from '../utils/open-payments.js'
 import {
   PaymentQuoteSchema,
   PaymentGrantSchema,
-  PaymentFinalizeSchema
+  PaymentFinalizeSchema,
+  PaymentStatusParamSchema
 } from '../schemas/payment.js'
-
+import { KV_PAYMENTS_PREFIX } from '@shared/types'
+import type { PaymentStatus } from '../types'
 import { app } from '../app.js'
 
 app.post(
@@ -91,6 +92,44 @@ app.post(
   }
 )
 
+app.get(
+  '/payment/status/:paymentId',
+  zValidator('param', PaymentStatusParamSchema),
+  async ({ req, json, env }) => {
+    const { paymentId } = req.param()
+
+    const POLLING_MAX_DURATION = 25000
+    const POLLING_INTERVAL = 1500
+    const signal = AbortSignal.timeout(POLLING_MAX_DURATION)
+
+    try {
+      while (!signal.aborted) {
+        await waitWithAbort(POLLING_INTERVAL, signal)
+
+        const status = await env.PUBLISHER_TOOLS_KV.get<PaymentStatus>(
+          KV_PAYMENTS_PREFIX + paymentId,
+          'json'
+        )
+
+        if (status) {
+          return json({
+            type: 'GRANT_INTERACTION',
+            ...status
+          })
+        }
+      }
+
+      throw new Error('AbortError')
+    } catch (error) {
+      if (error instanceof Error && error.message === 'TimeoutError') {
+        throw createHTTPException(408, 'Payment status polling timeout', {})
+      }
+
+      throw createHTTPException(404, 'Failed to retrieve data', error)
+    }
+  }
+)
+
 function isAllowedRedirectUrl(redirectUrl: string) {
   const redirectUrlOrigin = new URL(redirectUrl).origin
   const ALLOWED_ORIGINS = Object.values(APP_URL)

api/src/schemas/payment.ts

@@ -81,6 +81,13 @@ export const PaymentFinalizeSchema = z.object({
   note: z.string().optional().default('Tools payment')
 })
 
+export const PaymentStatusParamSchema = z.object({
+  paymentId: z
+    .string()
+    .min(1, 'Payment ID is required')
+    .max(100, 'Payment ID invalid')
+})
+
 export const WalletAddressParamSchema = z.object({
   wa: z.string().min(1, 'Wallet address is required'),
   version: z.string().optional().default('default')

api/src/types.ts

@@ -6,6 +6,19 @@ import type {
 } from './schemas/payment.js'
 import type { z } from 'zod/v4'
 
+export type PaymentStatusSuccess = {
+  paymentId: string
+  hash: string
+  interact_ref: string
+}
+
+export type PaymentStatusRejected = {
+  paymentId: string
+  result: 'grant_rejected'
+}
+
+export type PaymentStatus = PaymentStatusSuccess | PaymentStatusRejected
+
 export type PaymentQuoteInput = z.infer<typeof PaymentQuoteSchema>
 export type PaymentGrantInput = z.infer<typeof PaymentGrantSchema>
 export type PaymentFinalizeInput = z.infer<typeof PaymentFinalizeSchema>

api/src/utils/open-payments.ts

@@ -2,6 +2,7 @@ import {
   type PendingGrant,
   type WalletAddress,
   type AuthenticatedClient,
+  type OutgoingPayment,
   type Quote,
   type Grant,
   isFinalizedGrant,
@@ -11,7 +12,7 @@ import {
 import { getWalletAddress } from '@shared/utils'
 import {
   createHeaders,
-  timeout,
+  sleep,
   createHTTPException,
   urlWithParams
 } from './utils.js'
@@ -193,7 +194,7 @@ export class OpenPaymentsService {
     debitAmount: Amount
     receiveAmount: Amount
     redirectUrl: string
-  }): Promise<PendingGrant> {
+  }): Promise<{ grant: PendingGrant; paymentId: string }> {
     const clientNonce = crypto.randomUUID()
     const paymentId = createId()
 
@@ -206,7 +207,7 @@ export class OpenPaymentsService {
       redirectUrl: args.redirectUrl
     })
 
-    return outgoingPaymentGrant
+    return { grant: outgoingPaymentGrant, paymentId }
   }
 
   async finishPaymentProcess(
@@ -419,22 +420,20 @@ export class OpenPaymentsService {
   }
 
   private async checkOutgoingPayment(
-    finishPaymentUrl: string,
+    outgoingPaymentId: OutgoingPayment['id'],
     continuationAccessToken: string,
     incomingPaymentGrant: Grant,
     incomingPaymentId: string
   ): Promise<CheckPaymentResult> {
-    await timeout(3000)
+    await sleep(3000)
 
-    // get outgoing payment, to check if there was enough balance
-    const checkOutgoingPaymentResponse = await this.client!.outgoingPayment.get(
-      {
-        url: finishPaymentUrl,
-        accessToken: continuationAccessToken
-      }
-    )
+    const outgoingPayment = await this.client!.outgoingPayment.get({
+      url: outgoingPaymentId,
+      accessToken: continuationAccessToken
+    })
 
-    if (!(Number(checkOutgoingPaymentResponse.sentAmount.value) > 0)) {
+    // get outgoing payment, to check if there was enough balance
+    if (!(Number(outgoingPayment.sentAmount.value) > 0)) {
       return {
         success: false,
         error: {

api/src/utils/utils.ts

@@ -28,8 +28,26 @@ interface SignOptions {
   keyId: string
 }
 
-export function timeout(delay: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, delay))
+export function sleep(delay: number): Promise<void> {
+  return new Promise((r) => setTimeout(r, delay))
+}
+
+export function waitWithAbort(ms: number, signal: AbortSignal): Promise<void> {
+  return new Promise((resolve, reject) => {
+    if (signal.aborted) {
+      reject(new Error('TimeoutError'))
+      return
+    }
+
+    const timer = setTimeout(resolve, ms)
+
+    const onAbort = () => {
+      clearTimeout(timer)
+      reject(new Error('TimeoutError'))
+    }
+
+    signal.addEventListener('abort', onAbort, { once: true })
+  })
 }
 
 export async function createHeaders({

api/wrangler.toml

@@ -3,5 +3,9 @@ main = "src/index.ts"
 compatibility_date = "2024-09-23"
 compatibility_flags = ["nodejs_compat"]
 
+kv_namespaces = [
+  { binding = "PUBLISHER_TOOLS_KV", id = "b00031e45d5945c78e1eb3df6336e54a", preview_id = "preview_publisher_tools_kv" }
+]
+
 [dev]
 port = 8787

components/src/widget/controller.ts

@@ -15,6 +15,7 @@ export interface WidgetState {
   incomingPaymentGrant: Grant
   quote: Quote
   outgoingPaymentGrant: PendingGrant
+  paymentId: string
   debitAmount: string
   receiveAmount: string
   receiverPublicName?: string

components/src/widget/views/confirmation/confirmation.ts

@@ -220,14 +220,15 @@ export class PaymentConfirmation extends LitElement {
   private async handlePaymentConfirmed() {
     try {
       const { walletAddress, quote } = this.configController.state
-      const outgoingPaymentGrant = await this.requestOutgoingGrant({
+      const { grant, paymentId } = await this.requestOutgoingGrant({
         walletAddress,
         debitAmount: quote.debitAmount,
         receiveAmount: quote.receiveAmount
       })
 
       this.configController.updateState({
-        outgoingPaymentGrant,
+        outgoingPaymentGrant: grant,
+        paymentId,
         note: this.note
       })
 
@@ -255,7 +256,7 @@ export class PaymentConfirmation extends LitElement {
     walletAddress: WalletAddress
     debitAmount: Amount
     receiveAmount: Amount
-  }): Promise<PendingGrant> {
+  }): Promise<{ grant: PendingGrant; paymentId: string }> {
     const { apiUrl, frontendUrl } = this.configController.config
     const url = new URL('/payment/grant', apiUrl).href
     const redirectUrl = new URL('payment-confirmation', frontendUrl).href