@tangle-network/agent-gateway 0.7.1 → 0.8.1

package/src/payment-operations.ts

@@ -0,0 +1,485 @@
+import type {
+  PaymentSettlementBasis,
+  SandboxUsageReceipt,
+} from './payment-types'
+
+/** Version negotiated by gateways that use durable payment operations. */
+export const PAYMENT_PROTOCOL_VERSION = 2 as const
+
+export type PaymentOperationState =
+  | 'claiming'
+  | 'claimed'
+  | 'executing'
+  | 'retained'
+  | 'settling'
+  | 'settled'
+  | 'releasing'
+  | 'released'
+  | 'reclaimable'
+  | 'reclaimed'
+
+/** Fenced result for a recovery lookup that found no provider operation. */
+export interface PaymentOperationNotFound {
+  protocolVersion: typeof PAYMENT_PROTOCOL_VERSION
+  operationId: string
+  state: 'not-found'
+}
+
+export type PaymentOperationRecoveryResult = PaymentOperation | PaymentOperationNotFound
+
+/** Durable ownership of one signed payment authorization. */
+export interface PaymentOperation {
+  protocolVersion: typeof PAYMENT_PROTOCOL_VERSION
+  operationId: string
+  /** Request that atomically created this operation. Idempotent reads retain the original value. */
+  acquiredByRequestId: string
+  executionStartedAt?: number
+  retentionReason?: string
+  nonceKey: string
+  authorizationId: string
+  reservedAmount: bigint
+  settledAmount: bigint
+  refundAmount: bigint
+  expiresAt: number
+  state: PaymentOperationState
+}
+
+export interface PaymentAuthorizationContext {
+  requestId: string
+  agentId: string
+  requiredAmount: bigint
+  maxOutputTokens: number
+  executionBudget: {
+    maxInputTokens: number
+    maxOutputTokens: number
+    maxReasoningTokens: number
+    maxToolTokens: number
+    maxToolCalls: number
+    maxProviderCostUsd: number
+  }
+}
+
+export interface PaymentSettlementInput {
+  amount: bigint
+  totalCostUsd: number
+  usage: SandboxUsageReceipt
+  /** Distinguishes a provider receipt from the bounded missing-receipt fallback. */
+  basis: PaymentSettlementBasis
+}
+
+/**
+ * One payment lifecycle shared by every payment-backed gateway surface.
+ * Implementations must persist the operation before external side effects.
+ */
+export interface PaymentOperations {
+  readonly protocolVersion: typeof PAYMENT_PROTOCOL_VERSION
+  claimPayment(
+    payload: Record<string, unknown>,
+    context: PaymentAuthorizationContext,
+  ): Promise<PaymentOperation>
+  /** Prevent expiry reclaim while the sandbox can consume provider resources. */
+  beginPaymentExecution(operation: PaymentOperation): Promise<PaymentOperation>
+  /** Preserve funds after work when the final usage receipt is still missing. */
+  retainPayment(operation: PaymentOperation, reason: string): Promise<PaymentOperation>
+  settlePayment(
+    operation: PaymentOperation,
+    input: PaymentSettlementInput,
+  ): Promise<PaymentOperation>
+  /**
+   * Read the authoritative durable operation without changing its state.
+   * Recovery uses this to avoid repeating a provider settlement after the
+   * provider committed but the task finalization write lost its acknowledgement.
+   */
+  getPaymentOperation(operationId: string): Promise<PaymentOperationRecoveryResult>
+  /**
+   * Release an unused authorization.
+   * Repeated calls must recover an ambiguous acknowledgement by operationId.
+   */
+  releasePayment(operation: PaymentOperation, reason: string): Promise<PaymentOperation>
+  reclaimPayment(operationId: string): Promise<PaymentOperationRecoveryResult>
+}
+
+export interface MemoryPaymentOperationsOptions {
+  now?: () => number
+  onClaim?: (operation: PaymentOperation) => Promise<void>
+  onSettle?: (operation: PaymentOperation, input: PaymentSettlementInput) => Promise<void>
+  onRelease?: (operation: PaymentOperation, reason: string) => Promise<void>
+  onReclaim?: (operation: PaymentOperation) => Promise<void>
+}
+
+/** Small atomic implementation used by single-process deployments and tests. */
+export class MemoryPaymentOperations implements PaymentOperations {
+  readonly protocolVersion = PAYMENT_PROTOCOL_VERSION
+  private readonly operations = new Map<string, PaymentOperation>()
+  private readonly claimFlights = new Map<string, Promise<PaymentOperation>>()
+  private readonly claimTokens = new Map<string, string>()
+  private readonly settleFlights = new Map<string, Promise<PaymentOperation>>()
+  private readonly releaseFlights = new Map<string, Promise<PaymentOperation>>()
+  private readonly reclaimFlights = new Map<string, Promise<PaymentOperation>>()
+  private readonly now: () => number
+
+  constructor(private readonly options: MemoryPaymentOperationsOptions = {}) {
+    if ((options.onClaim || options.onSettle || options.onRelease) && !options.onReclaim) {
+      throw new Error('onReclaim is required when payment callbacks can lose acknowledgement')
+    }
+    this.now = options.now ?? (() => Math.floor(Date.now() / 1000))
+  }
+
+  async claimPayment(
+    payload: Record<string, unknown>,
+    context: PaymentAuthorizationContext,
+  ): Promise<PaymentOperation> {
+    const nonceKey = paymentNonceKey(payload)
+    const operationId = `x402:${nonceKey}`
+    const existing = this.operations.get(operationId)
+    if (existing) {
+      if (existing.state === 'claiming') throw new Error('payment operation is being recovered')
+      throw new Error('payment operation was already claimed')
+    }
+
+    const reservedAmount = unsignedAmount(payload.amount)
+    if (reservedAmount < context.requiredAmount) {
+      throw new Error('payment authorization is below the request ceiling')
+    }
+    const expiresAt = unsignedAmount(payload.expiry, 'expiry')
+    if (expiresAt > BigInt(Number.MAX_SAFE_INTEGER)) throw new Error('payment expiry is too large')
+    if (Number(expiresAt) <= this.now()) throw new Error('payment authorization has expired')
+
+    const operation: PaymentOperation = {
+      protocolVersion: PAYMENT_PROTOCOL_VERSION,
+      operationId,
+      acquiredByRequestId: context.requestId,
+      nonceKey,
+      authorizationId: typeof payload.authHash === 'string' ? payload.authHash : operationId,
+      reservedAmount,
+      settledAmount: 0n,
+      refundAmount: reservedAmount,
+      expiresAt: Number(expiresAt),
+      state: 'claiming',
+    }
+    // The map write is synchronous. No second caller can observe a free nonce
+    // between the uniqueness check and ownership write.
+    this.operations.set(operationId, operation)
+    const claimToken = globalThis.crypto.randomUUID()
+    this.claimTokens.set(operationId, claimToken)
+    const claim = (async () => {
+      try {
+        await this.options.onClaim?.(operation)
+        if (this.claimTokens.get(operationId) !== claimToken) {
+          throw new Error('payment claim ownership was reclaimed')
+        }
+        const current = this.operations.get(operationId)
+        if (!current || current.state !== 'claiming') {
+          throw new Error('payment claim ownership was lost')
+        }
+        const claimed = { ...current, state: 'claimed' as const }
+        this.operations.set(operationId, claimed)
+        return claimed
+      } catch (error) {
+        // Keep the durable `claiming` row. The external authorization may have
+        // committed before its acknowledgement was lost, so expiry recovery
+        // must own the decision to reclaim it.
+        throw error
+      } finally {
+        if (this.claimTokens.get(operationId) === claimToken) {
+          this.claimTokens.delete(operationId)
+        }
+      }
+    })()
+    this.claimFlights.set(operationId, claim)
+    try {
+      return await claim
+    } finally {
+      if (this.claimFlights.get(operationId) === claim) {
+        this.claimFlights.delete(operationId)
+      }
+    }
+  }
+
+  async settlePayment(
+    operation: PaymentOperation,
+    input: PaymentSettlementInput,
+  ): Promise<PaymentOperation> {
+    const current = this.requireCurrent(operation)
+    if (current.state === 'settled') {
+      if (current.settledAmount !== input.amount) throw new Error('payment operation was settled twice')
+      return current
+    }
+    if (current.state === 'settling') {
+      if (current.settledAmount !== input.amount) throw new Error('payment operation has a different pending settlement')
+      const flight = this.settleFlights.get(current.operationId)
+      if (flight) return flight
+      const reclaimFlight = this.reclaimFlights.get(current.operationId)
+      if (reclaimFlight) return reclaimFlight
+      const recovery = this.recoverSettlement(current, input)
+      this.settleFlights.set(current.operationId, recovery)
+      try {
+        return await recovery
+      } finally {
+        if (this.settleFlights.get(current.operationId) === recovery) {
+          this.settleFlights.delete(current.operationId)
+        }
+      }
+    } else if (current.state !== 'claimed' && current.state !== 'executing' && current.state !== 'retained') {
+      throw new Error(`cannot settle payment in state ${current.state}`)
+    }
+    validateSettlement(current, input)
+    const settling = {
+      ...current,
+      state: 'settling' as const,
+      settledAmount: input.amount,
+      refundAmount: current.reservedAmount - input.amount,
+    }
+    this.operations.set(current.operationId, settling)
+    const flight = this.runSettlement(settling, input)
+    this.settleFlights.set(current.operationId, flight)
+    try {
+      return await flight
+    } finally {
+      if (this.settleFlights.get(current.operationId) === flight) {
+        this.settleFlights.delete(current.operationId)
+      }
+    }
+  }
+
+  async beginPaymentExecution(operation: PaymentOperation): Promise<PaymentOperation> {
+    const current = this.requireCurrent(operation)
+    if (current.state === 'executing') return current
+    if (current.state !== 'claimed') {
+      throw new Error(`cannot begin payment execution in state ${current.state}`)
+    }
+    const executing = {
+      ...current,
+      state: 'executing' as const,
+      executionStartedAt: this.now(),
+    }
+    this.operations.set(current.operationId, executing)
+    return executing
+  }
+
+  async retainPayment(operation: PaymentOperation, reason: string): Promise<PaymentOperation> {
+    const current = this.requireCurrent(operation)
+    if (current.state === 'retained' || current.state === 'settling' || current.state === 'settled') {
+      return current
+    }
+    if (current.state !== 'claimed' && current.state !== 'executing') {
+      throw new Error(`cannot retain payment in state ${current.state}`)
+    }
+    const retained = {
+      ...current,
+      state: 'retained' as const,
+      retentionReason: reason,
+    }
+    this.operations.set(current.operationId, retained)
+    return retained
+  }
+
+  async releasePayment(operation: PaymentOperation, reason: string): Promise<PaymentOperation> {
+    const current = this.requireCurrent(operation)
+    if (current.state === 'released') return current
+    if (current.state === 'releasing') {
+      const flight = this.releaseFlights.get(current.operationId)
+      if (flight) return flight
+      const recovered = await this.reclaimPayment(current.operationId)
+      if (recovered.state === 'not-found') {
+        throw new Error('payment operation disappeared during release recovery')
+      }
+      return recovered
+    }
+    if (current.state !== 'claimed' && current.state !== 'executing') {
+      throw new Error(`cannot release payment in state ${current.state}`)
+    }
+    const releasing = { ...current, state: 'releasing' as const }
+    this.operations.set(current.operationId, releasing)
+    return this.runRelease(releasing, reason)
+  }
+
+  async reclaimPayment(operationId: string): Promise<PaymentOperationRecoveryResult> {
+    const current = this.operations.get(operationId)
+    if (!current) {
+      return {
+        protocolVersion: PAYMENT_PROTOCOL_VERSION,
+        operationId,
+        state: 'not-found',
+      }
+    }
+    if (current.state === 'reclaimed') return current
+    if (current.state === 'executing' || current.state === 'retained') {
+      throw new Error(`cannot reclaim payment in state ${current.state} without a usage receipt`)
+    }
+    if (current.state === 'settling') {
+      const flight = this.settleFlights.get(operationId)
+      if (flight) return flight
+      const recoveryFlight = this.reclaimFlights.get(operationId)
+      if (recoveryFlight) return recoveryFlight
+      const recovery = this.recoverSettlement(current, {
+        amount: current.settledAmount,
+        totalCostUsd: 0,
+        basis: 'usage-receipt',
+        usage: {
+          inputTokens: 0,
+          outputTokens: 0,
+          reasoningTokens: 0,
+          toolTokens: 0,
+          toolCallCount: 0,
+          providerCostUsd: 0,
+          budgetEnforced: true,
+        },
+      })
+      this.reclaimFlights.set(operationId, recovery)
+      try {
+        return await recovery
+      } finally {
+        if (this.reclaimFlights.get(operationId) === recovery) this.reclaimFlights.delete(operationId)
+      }
+    }
+    if (current.state === 'releasing') {
+      if (!this.options.onReclaim) throw new Error('payment release recovery is not configured')
+      const releaseFlight = this.releaseFlights.get(operationId)
+      if (releaseFlight) return releaseFlight
+      const flight = this.reclaimFlights.get(operationId)
+      if (flight) return flight
+      const recovery = this.runReclaim(current, 'released')
+      this.reclaimFlights.set(operationId, recovery)
+      try {
+        return await recovery
+      } finally {
+        if (this.reclaimFlights.get(operationId) === recovery) this.reclaimFlights.delete(operationId)
+      }
+    }
+    if (current.state !== 'claiming' && current.state !== 'claimed' && current.state !== 'reclaimable') {
+      throw new Error(`cannot reclaim payment in state ${current.state}`)
+    }
+    const flight = this.reclaimFlights.get(operationId)
+    if (flight) return flight
+    if (current.expiresAt > this.now()) throw new Error('payment operation has not expired')
+    if (current.state === 'claiming') {
+      // Invalidate the live claim before starting recovery. Its callback may
+      // still finish, but it can no longer promote the operation to claimed.
+      this.claimTokens.delete(operationId)
+    }
+    const reclaimable = { ...current, state: 'reclaimable' as const }
+    this.operations.set(operationId, reclaimable)
+    const recovery = this.runReclaim(reclaimable, 'reclaimed')
+    this.reclaimFlights.set(operationId, recovery)
+    try {
+      return await recovery
+    } finally {
+      if (this.reclaimFlights.get(operationId) === recovery) this.reclaimFlights.delete(operationId)
+    }
+  }
+
+  private async runSettlement(
+    settling: PaymentOperation,
+    input: PaymentSettlementInput,
+  ): Promise<PaymentOperation> {
+    await this.options.onSettle?.(settling, input)
+    const settled = {
+      ...settling,
+      state: 'settled' as const,
+      settledAmount: input.amount,
+      refundAmount: settling.reservedAmount - input.amount,
+    }
+    this.operations.set(settling.operationId, settled)
+    return settled
+  }
+
+  private async recoverSettlement(
+    settling: PaymentOperation,
+    input: PaymentSettlementInput,
+  ): Promise<PaymentOperation> {
+    if (!this.options.onReclaim) throw new Error('payment settlement recovery is not configured')
+    await this.options.onReclaim(settling)
+    const settled = {
+      ...settling,
+      state: 'settled' as const,
+      settledAmount: input.amount,
+      refundAmount: settling.reservedAmount - input.amount,
+    }
+    this.operations.set(settling.operationId, settled)
+    return settled
+  }
+
+  private async runReclaim(
+    operation: PaymentOperation,
+    finalState: 'released' | 'reclaimed',
+  ): Promise<PaymentOperation> {
+    await this.options.onReclaim?.(operation)
+    const recovered = { ...operation, state: finalState as PaymentOperationState }
+    this.operations.set(operation.operationId, recovered)
+    return recovered
+  }
+
+  private async runRelease(
+    releasing: PaymentOperation,
+    reason: string,
+  ): Promise<PaymentOperation> {
+    const flight = (async () => {
+      await this.options.onRelease?.(releasing, reason)
+      const released = { ...releasing, state: 'released' as const }
+      this.operations.set(releasing.operationId, released)
+      return released
+    })()
+    this.releaseFlights.set(releasing.operationId, flight)
+    try {
+      return await flight
+    } finally {
+      if (this.releaseFlights.get(releasing.operationId) === flight) {
+        this.releaseFlights.delete(releasing.operationId)
+      }
+    }
+  }
+
+  get(operationId: string): PaymentOperation | undefined {
+    const operation = this.operations.get(operationId)
+    return operation ? { ...operation } : undefined
+  }
+
+  async getPaymentOperation(operationId: string): Promise<PaymentOperationRecoveryResult> {
+    const operation = this.get(operationId)
+    return operation ?? {
+      protocolVersion: PAYMENT_PROTOCOL_VERSION,
+      operationId,
+      state: 'not-found',
+    }
+  }
+
+  private requireCurrent(operation: PaymentOperation): PaymentOperation {
+    const current = this.operations.get(operation.operationId)
+    if (!current) throw new Error('payment operation was not found')
+    if (current.protocolVersion !== operation.protocolVersion) {
+      throw new Error('payment operation protocol version mismatch')
+    }
+    return current
+  }
+}
+
+export function paymentNonceKey(payload: Record<string, unknown>): string {
+  const commitment = String(payload.commitment ?? '').toLowerCase()
+  const nonce = unsignedAmount(payload.nonce, 'nonce').toString()
+  if (!commitment) throw new Error('payment commitment is required')
+  return `${commitment}:${nonce}`
+}
+
+function unsignedAmount(value: unknown, name = 'amount'): bigint {
+  const raw = typeof value === 'string'
+    ? value
+    : typeof value === 'number' && Number.isSafeInteger(value)
+      ? String(value)
+      : ''
+  if (!/^\d+$/.test(raw)) throw new Error(`${name} is not an unsigned integer`)
+  return BigInt(raw)
+}
+
+function validateSettlement(operation: PaymentOperation, input: PaymentSettlementInput): void {
+  if (input.amount < 0n || input.amount > operation.reservedAmount) {
+    throw new Error('settled amount must be between zero and the reserved amount')
+  }
+  if (!Number.isFinite(input.totalCostUsd) || input.totalCostUsd < 0) {
+    throw new Error('settlement cost must be finite and non-negative')
+  }
+  if (!input.usage.budgetEnforced) throw new Error('sandbox usage receipt is not budget-enforced')
+  if (input.basis !== 'usage-receipt' && input.basis !== 'quoted-ceiling') {
+    throw new Error('payment settlement basis is invalid')
+  }
+}

package/src/payment-recovery-sql.ts

@@ -0,0 +1,108 @@
+import type { SqlAdapter } from './a2a/task-store-sql'
+import type {
+  PaymentRecoveryRecord,
+  PaymentRecoveryStore,
+} from './payment-recovery'
+
+const TABLE_DDL = (table: string) => `
+  CREATE TABLE IF NOT EXISTS ${table} (
+    id TEXT PRIMARY KEY,
+    state TEXT NOT NULL,
+    next_attempt_at INTEGER NOT NULL,
+    revision INTEGER NOT NULL,
+    payload TEXT NOT NULL,
+    updated_at INTEGER NOT NULL
+  )
+`
+
+const DUE_INDEX_DDL = (table: string) => `
+  CREATE INDEX IF NOT EXISTS idx_${table}_due
+  ON ${table} (state, next_attempt_at)
+`
+
+/** Durable recovery outbox for D1, sqlite, libSQL, or an adapted SQL driver. */
+export class SqlPaymentRecoveryStore implements PaymentRecoveryStore {
+  private readonly table: string
+
+  constructor(
+    private readonly db: SqlAdapter,
+    options: { table?: string } = {},
+  ) {
+    this.table = options.table ?? 'payment_recovery'
+    if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(this.table)) {
+      throw new Error('payment recovery table name is invalid')
+    }
+  }
+
+  /** Idempotent. Run this before the gateway starts accepting traffic. */
+  async migrate(): Promise<void> {
+    await this.db.exec(TABLE_DDL(this.table))
+    await this.db.exec(DUE_INDEX_DDL(this.table))
+  }
+
+  async createIfAbsent(record: PaymentRecoveryRecord): Promise<boolean> {
+    try {
+      const result = await this.db.exec(
+        `INSERT INTO ${this.table} (id, state, next_attempt_at, revision, payload, updated_at) VALUES (?, ?, ?, ?, ?, ?)`,
+        [
+          record.id,
+          record.state,
+          record.nextAttemptAt,
+          record.revision,
+          JSON.stringify(record),
+          record.updatedAt,
+        ],
+      )
+      return result.rowsAffected === 1
+    } catch (error) {
+      if (await this.get(record.id)) return false
+      throw error
+    }
+  }
+
+  async get(id: string): Promise<PaymentRecoveryRecord | undefined> {
+    const rows = await this.db.query<{ payload: string }>(
+      `SELECT payload FROM ${this.table} WHERE id = ?`,
+      [id],
+    )
+    return rows[0] ? parseRecord(rows[0].payload) : undefined
+  }
+
+  async compareAndSet(
+    expected: PaymentRecoveryRecord,
+    next: PaymentRecoveryRecord,
+  ): Promise<boolean> {
+    const result = await this.db.exec(
+      `UPDATE ${this.table} SET state = ?, next_attempt_at = ?, revision = ?, payload = ?, updated_at = ? WHERE id = ? AND revision = ?`,
+      [
+        next.state,
+        next.nextAttemptAt,
+        next.revision,
+        JSON.stringify(next),
+        next.updatedAt,
+        expected.id,
+        expected.revision,
+      ],
+    )
+    return result.rowsAffected === 1
+  }
+
+  async listDue(now: number, limit: number): Promise<PaymentRecoveryRecord[]> {
+    if (!Number.isSafeInteger(limit) || limit <= 0) {
+      throw new Error('payment recovery scan limit must be a positive safe integer')
+    }
+    const rows = await this.db.query<{ payload: string }>(
+      `SELECT payload FROM ${this.table} WHERE state <> ? AND next_attempt_at <= ? ORDER BY next_attempt_at ASC LIMIT ?`,
+      ['reconciled', now, limit],
+    )
+    return rows.map((row) => parseRecord(row.payload))
+  }
+}
+
+function parseRecord(payload: string): PaymentRecoveryRecord {
+  const value = JSON.parse(payload) as PaymentRecoveryRecord
+  if (value.version !== 1 || !value.id || !Number.isSafeInteger(value.revision)) {
+    throw new Error('stored payment recovery record is invalid')
+  }
+  return value
+}