feat(backend, mock-ase): encrypted data exchange

localenv/cloud-nine-wallet/docker-compose.yml

@@ -115,6 +115,7 @@ services:
       OPERATOR_TENANT_ID: 438fa74a-fa7d-4317-9ced-dde32ece1787
       CARD_SERVICE_URL: 'http://cloud-nine-wallet-card-service:3007'
       CARD_WEBHOOK_SERVICE_URL: 'http://cloud-nine-wallet-card-service:3007/webhook'
+      DB_ENCRYPTION_SECRET: 'zO9KogehJECHReHgQr+ZWGkmgOD4AYa4ksUxALSwgM8='
     depends_on:
       shared-database:
         condition: service_healthy

localenv/docs/encrypted-data-exchange.md

@@ -0,0 +1,24 @@
+# Run with Encrypted Data Exchange
+
+Start the env with the feature flag enabled on the receiver:
+
+```bash
+pnpm localenv:compose:partial-payment up
+```
+
+# Manually Test the Encrypted Data Exchange Flow (Happy Path)
+
+## Steps
+
+- Run the **Examples > Admin API > Open Payments** or the **Examples > Open Payments > Peer-to-Peer Payment** requests in Bruno.
+
+## Verification
+
+In the `happy-life-bank-mock-ase` logs:
+
+- `incoming_payment.partial_payment_received` webhook was received, with `partialIncomingPaymentId` and the `dataToTransmit` defined in the payload
+- `confirmPartialIncomingPayment` was called
+
+In Bruno:
+
+- Confirm the Outgoing Payment is completed by calling the `Get Outgoing Payment` request, and verifying a positive `sentAmount`.

localenv/happy-life-bank/docker-compose.yml

@@ -52,6 +52,7 @@ services:
       SIGNATURE_VERSION: 1
       SIGNATURE_SECRET: iyIgCprjb9uL8wFckR+pLEkJWMB7FJhgkvqhTQR/964=
       IDP_SECRET: 2pEcn2kkCclbOHQiGNEwhJ0rucATZhrA807HTm2rNXE=
+      DB_ENCRYPTION_SECRET: 'zO9KogehJECHReHgQr+ZWGkmgOD4AYa4ksUxALSwgM8='
       DISPLAY_NAME: Happy Life Bank
       DISPLAY_ICON: bank-icon.svg
       OPERATOR_TENANT_ID: cf5fd7d3-1eb1-4041-8e43-ba45747e9e5d
@@ -114,6 +115,7 @@ services:
       OPERATOR_TENANT_ID: cf5fd7d3-1eb1-4041-8e43-ba45747e9e5d
       CARD_SERVICE_URL: 'http://happy-life-bank-card-service:4007'
       POS_WEBHOOK_SERVICE_URL: 'http://happy-life-bank-point-of-sale:4008/webhook'
+      DB_ENCRYPTION_SECRET: 'zO9KogehJECHReHgQr+ZWGkmgOD4AYa4ksUxALSwgM8='
       WALLET_ADDRESS_NOT_FOUND_POLLING_ENABLED: true
     depends_on:
       - cloud-nine-backend

localenv/mock-account-servicing-entity/app/lib/webhooks.server.ts

@@ -118,7 +118,8 @@ export async function handleOutgoingPaymentCreated(
       variables: {
         input: {
           outgoingPaymentId: payment.id,
-          idempotencyKey: uuid()
+          idempotencyKey: uuid(),
+          dataToTransmit: 'sample kyc data'
         }
       }
     })
@@ -186,6 +187,62 @@ export async function handleIncomingPaymentCompletedExpired(
   return
 }
 
+export async function handleIncomingPartialPaymentReceived(
+  wh: Webhook,
+  options?: TenantOptions
+) {
+  if (wh.type !== WebhookEventType.IncomingPaymentPartialPaymentReceived) {
+    throw new Error(
+      'Invalid event type when handling incoming partial payment webhook'
+    )
+  }
+
+  const incomingPaymentId = wh.data['id'] as string | undefined
+  if (!incomingPaymentId) {
+    throw new Error('No incomingPaymentId found on webhook data')
+  }
+
+  const partialIncomingPaymentId = wh.data['partialIncomingPaymentId'] as
+    | string
+    | undefined
+  if (!partialIncomingPaymentId) {
+    throw new Error('No partialIncomingPaymentId found on webhook data')
+  }
+
+  const dataFromSender = wh.data['dataFromSender'] as string | undefined
+  if (!dataFromSender) {
+    throw new Error('No dataFromSender found on webhook data')
+  }
+
+  await generateApolloClient(options)
+    .mutate({
+      mutation: gql`
+        mutation ConfirmPartialIncomingPayment(
+          $input: ConfirmPartialIncomingPaymentInput!
+        ) {
+          confirmPartialIncomingPayment(input: $input) {
+            success
+          }
+        }
+      `,
+      variables: {
+        input: {
+          incomingPaymentId,
+          partialIncomingPaymentId
+        }
+      }
+    })
+    .then((query): LiquidityMutationResponse => {
+      if (query.data) {
+        return query.data.confirmPartialIncomingPayment
+      } else {
+        throw new Error('Data was empty')
+      }
+    })
+
+  return
+}
+
 export async function handleWalletAddressWebMonetization(
   wh: Webhook,
   options?: TenantOptions

localenv/mock-account-servicing-entity/app/routes/webhooks.ts

@@ -3,12 +3,11 @@ import { json } from '@remix-run/node'
 import {
   handleLowLiquidity,
   handleWalletAddressNotFound,
-  handleWalletAddressWebMonetization
-} from '~/lib/webhooks.server'
-import {
+  handleWalletAddressWebMonetization,
   handleOutgoingPaymentCreated,
   handleOutgoingPaymentCompletedFailed,
-  handleIncomingPaymentCompletedExpired
+  handleIncomingPaymentCompletedExpired,
+  handleIncomingPartialPaymentReceived
 } from '~/lib/webhooks.server'
 import { WebhookEventType, Webhook } from 'mock-account-service-lib'
 import { getTenantCredentials } from '~/lib/utils'
@@ -36,6 +35,9 @@ export async function action({ request }: ActionFunctionArgs) {
         break
       case WebhookEventType.IncomingPaymentCreated:
         break
+      case WebhookEventType.IncomingPaymentPartialPaymentReceived:
+        await handleIncomingPartialPaymentReceived(wh, tenantOptions)
+        break
       case WebhookEventType.IncomingPaymentCompleted:
       case WebhookEventType.IncomingPaymentExpired:
         await handleIncomingPaymentCompletedExpired(wh, tenantOptions)

localenv/partial-payment/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  happy-life-backend:
+    environment:
+      ENABLE_PARTIAL_PAYMENT_DECISION: 'true'
+      PARTIAL_PAYMENT_DECISION_MAX_WAIT_MS: '30000'

package.json

@@ -21,6 +21,7 @@
     "build": "tsc --build",
     "localenv:compose:psql": "docker compose -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/global-bank/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/merged/docker-compose.yml",
     "localenv:compose": "docker compose -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/merged/docker-compose.yml -f ./localenv/tigerbeetle/docker-compose.yml --env-file ./localenv/tigerbeetle/.env.tigerbeetle",
+    "localenv:compose:partial-payment": "docker compose -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/merged/docker-compose.yml -f ./localenv/tigerbeetle/docker-compose.yml -f ./localenv/partial-payment/docker-compose.yml --env-file ./localenv/tigerbeetle/.env.tigerbeetle",
     "localenv:compose:multihop": "docker compose -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/global-bank/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/multihop/docker-compose.yml -f ./localenv/merged/docker-compose.yml -f ./localenv/tigerbeetle/docker-compose.yml --env-file ./localenv/tigerbeetle/.env.tigerbeetle",
     "localenv:compose:multitenancy": "docker compose -f ./localenv/cloud-ten-wallet/docker-compose.yml -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/merged/docker-compose.yml -f ./localenv/tigerbeetle/docker-compose.yml --env-file ./localenv/tigerbeetle/.env.tigerbeetle",
     "localenv:compose:psql:telemetry": "docker compose -f ./localenv/cloud-nine-wallet/docker-compose.yml -f ./localenv/global-bank/docker-compose.yml -f ./localenv/happy-life-bank/docker-compose.yml -f ./localenv/merged/docker-compose.yml -f ./localenv/telemetry/docker-compose.yml",

packages/backend/migrations/20251126191852_add_sender_data_to_outgoing_payment.js

@@ -0,0 +1,31 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = async function (knex) {
+  const hasColumn = await knex.schema.hasColumn(
+    'outgoingPayments',
+    'dataToTransmit'
+  )
+  if (!hasColumn) {
+    await knex.schema.alterTable('outgoingPayments', function (table) {
+      table.string('dataToTransmit').nullable()
+    })
+  }
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = async function (knex) {
+  const hasColumn = await knex.schema.hasColumn(
+    'outgoingPayments',
+    'dataToTransmit'
+  )
+  if (hasColumn) {
+    await knex.schema.alterTable('outgoingPayments', function (table) {
+      table.dropColumn('dataToTransmit')
+    })
+  }
+}