feat: grant spent amounts

bruno/collections/Rafiki/Examples/Vailidating Wallet Address Ownership with Open Payments/folder.bru

@@ -1,4 +1,4 @@
 meta {
-  name: Vailidating Wallet Address Ownership with Open Payments
+  name: Validating Wallet Address Ownership with Open Payments
   seq: 6
 }

bruno/collections/Rafiki/Open Payments APIs/Outgoing Payment Grant/Get Outgoing Payment Grant.bru

@@ -0,0 +1,33 @@
+meta {
+  name: Get Outgoing Payment Grant
+  type: http
+  seq: 1
+}
+
+get {
+  url: {{senderOpenPaymentsHost}}/outgoing-payment-grant
+  body: json
+  auth: none
+}
+
+headers {
+  Authorization: GNAP {{accessToken}}
+}
+
+script:pre-request {
+  const scripts = require('./scripts');
+
+  scripts.addHostHeader();
+
+  await scripts.addSignatureHeaders();
+}
+
+tests {
+  test("Status code is 201", function() {
+    expect(res.getStatus()).to.equal(200);
+  });
+}
+
+docs {
+  Uses GNAP access token to determine the grant.
+}

packages/auth/src/access/utils.test.ts

@@ -296,6 +296,27 @@ describe('Access utilities', (): void => {
     ).toBe(false)
   })
 
+  test('access comparison does not fail if no request identifier', async (): Promise<void> => {
+    const grantAccessItemSuperAction = await Access.query(trx).insertAndFetch({
+      grantId: grant.id,
+      type: AccessType.IncomingPayment,
+      actions: [AccessAction.ReadAll],
+      identifier
+    })
+
+    const requestAccessItem: AccessItem = {
+      type: 'incoming-payment',
+      actions: [AccessAction.ReadAll]
+    }
+
+    expect(
+      compareRequestAndGrantAccessItems(
+        requestAccessItem,
+        toOpenPaymentsAccess(grantAccessItemSuperAction)
+      )
+    ).toBe(true)
+  })
+
   test('access comparison fails if type mismatch', async (): Promise<void> => {
     const grantAccessItemSuperAction = await Access.query(trx).insertAndFetch({
       grantId: grant.id,

packages/auth/src/access/utils.ts

@@ -57,6 +57,7 @@ export function compareRequestAndGrantAccessItems(
 
   if (
     grantAccessIdentifier &&
+    requestAccessIdentifier &&
     requestAccessIdentifier !== grantAccessIdentifier
   ) {
     return false

packages/backend/migrations/20250409173617_add_outgoing_payment_grant_spent_amounts_table.js

@@ -0,0 +1,41 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema
+    .createTable('outgoingPaymentGrantSpentAmounts', function (table) {
+      table.uuid('id').notNullable().primary()
+      table.string('grantId').notNullable()
+      table.foreign('grantId').references('outgoingPaymentGrants.id')
+      table.uuid('outgoingPaymentId').notNullable()
+      table.foreign('outgoingPaymentId').references('outgoingPayments.id')
+      table.integer('receiveAmountScale').notNullable()
+      table.string('receiveAmountCode').notNullable()
+      table.bigInteger('paymentReceiveAmountValue').notNullable()
+      table.bigInteger('intervalReceiveAmountValue').nullable()
+      table.bigInteger('grantTotalReceiveAmountValue').notNullable()
+      table.integer('debitAmountScale').notNullable()
+      table.string('debitAmountCode').notNullable()
+      table.bigInteger('paymentDebitAmountValue').notNullable()
+      table.bigInteger('intervalDebitAmountValue').nullable()
+      table.bigInteger('grantTotalDebitAmountValue').notNullable()
+      table.string('paymentState').notNullable()
+      table.timestamp('intervalStart').nullable()
+      table.timestamp('intervalEnd').nullable()
+      table.timestamp('createdAt').defaultTo(knex.fn.now())
+    })
+    .then(() => {
+      return knex.raw(
+        'CREATE INDEX outgoingPaymentGrantSpentAmounts_grantId_createdAt_desc_idx ON "outgoingPaymentGrantSpentAmounts" ("grantId", "createdAt" DESC)'
+      )
+    })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.dropTableIfExists('outgoingPaymentGrantSpentAmounts')
+}

packages/backend/migrations/20250410162417_add_interval_op_grant_table.js

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

packages/backend/src/app.ts

@@ -30,7 +30,8 @@ import {
   httpsigMiddleware,
   Grant,
   RequestAction,
-  authenticatedStatusMiddleware
+  authenticatedStatusMiddleware,
+  createOutgoingPaymentGrantTokenIntrospectionMiddleware
 } from './open_payments/auth/middleware'
 import { RatesService } from './rates/service'
 import { createSpspMiddleware } from './payment-method/ilp/spsp/middleware'
@@ -134,13 +135,16 @@ export type AppRequest<ParamsT extends string = string> = Omit<
   params: Record<ParamsT, string>
 }
 
-export interface WalletAddressUrlContext extends AppContext {
-  walletAddressUrl: string
+export interface IntrospectionContext extends AppContext {
   grant?: Grant
   client?: string
   accessAction?: AccessAction
 }
 
+export interface WalletAddressUrlContext extends IntrospectionContext {
+  walletAddressUrl: string
+}
+
 export interface WalletAddressContext extends WalletAddressUrlContext {
   walletAddress: WalletAddress
 }
@@ -715,6 +719,16 @@ export class App {
       outgoingPaymentRoutes.get
     )
 
+    // GET /outgoing-payment-grant
+    // Get grant spent amounts (scoped to interval, if any) from grant
+    // with outgoing payment create access
+    router.get(
+      '/:tenantId/outgoing-payment-grant',
+      // Expects token used for outgoing payment payment creation
+      createOutgoingPaymentGrantTokenIntrospectionMiddleware(),
+      outgoingPaymentRoutes.getGrantSpentAmounts
+    )
+
     // GET /quotes/{id}
     // Read quote
     router.get<DefaultState, SignedSubresourceContext>(