feat(backend): tenant support for wallet address (#3114)

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

@@ -15,6 +15,10 @@ if (!process.env.IDP_SECRET) {
   throw new Error('Environment variable IDP_SECRET is required')
 }
 
+if (!process.env.OPERATOR_TENANT_ID) {
+  throw new Error('Environment variable OPERATOR_TENANT_ID is required')
+}
+
 export const CONFIG: Config = {
   seed: parse(
     readFileSync(
@@ -26,5 +30,6 @@ export const CONFIG: Config = {
   testnetAutoPeerUrl: process.env.TESTNET_AUTOPEER_URL ?? '',
   authServerDomain: process.env.AUTH_SERVER_DOMAIN || 'http://localhost:3006',
   graphqlUrl: process.env.GRAPHQL_URL,
-  idpSecret: process.env.IDP_SECRET
+  idpSecret: process.env.IDP_SECRET,
+  operatorTenantId: process.env.OPERATOR_TENANT_ID
 }

packages/backend/migrations/20250117112902_add_tenant_to_wallet_address.js

@@ -0,0 +1,32 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema
+    .alterTable('walletAddresses', (table) => {
+      table.uuid('tenantId').references('tenants.id').index()
+    })
+    .then(() => {
+      return knex.raw(
+        `UPDATE "walletAddresses" SET "tenantId" = (SELECT id from "tenants" LIMIT 1)`
+      )
+    })
+    .then(() => {
+      return knex.schema.alterTable('walletAddresses', (table) => {
+        table.uuid('tenantId').notNullable().alter()
+      })
+    })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return Promise.all([
+    knex.schema.alterTable('walletAddresses', function (table) {
+      table.dropColumn('tenantId')
+    })
+  ])
+}

packages/backend/src/app.ts

@@ -70,7 +70,8 @@ import { applyMiddleware } from 'graphql-middleware'
 import { Redis } from 'ioredis'
 import {
   idempotencyGraphQLMiddleware,
-  lockGraphQLMutationMiddleware
+  lockGraphQLMutationMiddleware,
+  setForTenantIdGraphQLMutationMiddleware
 } from './graphql/middleware'
 import { createRedisDataStore } from './middleware/cache/data-stores/redis'
 import { createRedisLock } from './middleware/lock/redis'
@@ -226,6 +227,10 @@ export interface TenantedApolloContext extends ApolloContext {
   isOperator: boolean
 }
 
+export interface ForTenantIdContext extends TenantedApolloContext {
+  forTenantId?: string
+}
+
 export interface AppServices {
   logger: Promise<Logger>
   telemetry: Promise<TelemetryService>
@@ -338,7 +343,8 @@ export class App {
       ),
       idempotencyGraphQLMiddleware(
         createRedisDataStore(redis, this.config.graphQLIdempotencyKeyTtlMs)
-      )
+      ),
+      setForTenantIdGraphQLMutationMiddleware()
     )
 
     // Setup Armor

packages/backend/src/asset/service.test.ts

@@ -327,6 +327,7 @@ describe('Asset Service', (): void => {
       // make sure there is at least 1 wallet address using asset
       const walletAddress = walletAddressService.create({
         url: 'https://alice.me/.well-known/pay',
+        tenantId: Config.operatorTenantId,
         assetId: newAssetId
       })
       assert.ok(!isWalletAddressError(walletAddress))

packages/backend/src/graphql/middleware/index.ts

@@ -1,9 +1,14 @@
 import { GraphQLError } from 'graphql'
 import { IMiddleware } from 'graphql-middleware'
-import { ApolloContext } from '../../app'
+import {
+  ApolloContext,
+  ForTenantIdContext,
+  TenantedApolloContext
+} from '../../app'
 import { CacheDataStore } from '../../middleware/cache/data-stores'
 import { lockMiddleware, Lock } from '../../middleware/lock'
 import { cacheMiddleware } from '../../middleware/cache'
+import { validateTenantMiddleware } from '../../middleware/tenant'
 
 export function lockGraphQLMutationMiddleware(lock: Lock): {
   Mutation: IMiddleware
@@ -46,3 +51,17 @@ export function idempotencyGraphQLMiddleware(
     }
   }
 }
+
+export function setForTenantIdGraphQLMutationMiddleware(): {
+  Mutation: IMiddleware<TenantedApolloContext, ForTenantIdContext>
+} {
+  return {
+    Mutation: async (resolve, root, args, context, info) => {
+      return validateTenantMiddleware({
+        deps: { context },
+        next: () => resolve(root, args, context, info),
+        tenantIdInput: args?.input?.tenantId
+      })
+    }
+  }
+}

packages/backend/src/graphql/resolvers/combined_payments.test.ts

@@ -50,6 +50,7 @@ describe('Payment', (): void => {
 
   test('Can get payments', async (): Promise<void> => {
     const { id: outWalletAddressId } = await createWalletAddress(deps, {
+      tenantId: Config.operatorTenantId,
       assetId: asset.id
     })
 
@@ -68,6 +69,7 @@ describe('Payment', (): void => {
     })
 
     const { id: inWalletAddressId } = await createWalletAddress(deps, {
+      tenantId: Config.operatorTenantId,
       assetId: asset.id
     })
     const incomingPayment = await createIncomingPayment(deps, {
@@ -146,6 +148,7 @@ describe('Payment', (): void => {
 
   test('Can filter payments by type and wallet address', async (): Promise<void> => {
     const { id: outWalletAddressId } = await createWalletAddress(deps, {
+      tenantId: Config.operatorTenantId,
       assetId: asset.id
     })
 
@@ -168,6 +171,7 @@ describe('Payment', (): void => {
     })
 
     const { id: outWalletAddressId2 } = await createWalletAddress(deps, {
+      tenantId: Config.operatorTenantId,
       assetId: asset.id
     })
     await createOutgoingPayment(deps, {

packages/backend/src/graphql/resolvers/incoming_payment.test.ts

@@ -55,8 +55,12 @@ describe('Incoming Payment Resolver', (): void => {
 
   describe('Wallet address incoming payments', (): void => {
     beforeEach(async (): Promise<void> => {
-      walletAddressId = (await createWalletAddress(deps, { assetId: asset.id }))
-        .id
+      walletAddressId = (
+        await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
+          assetId: asset.id
+        })
+      ).id
     })
 
     getPageTests({
@@ -106,6 +110,7 @@ describe('Incoming Payment Resolver', (): void => {
       async ({ metadata, expiresAt, withAmount }): Promise<void> => {
         const incomingAmount = withAmount ? amount : undefined
         const { id: walletAddressId } = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
         const payment = await createIncomingPayment(deps, {
@@ -305,6 +310,7 @@ describe('Incoming Payment Resolver', (): void => {
       }
       beforeEach(async (): Promise<void> => {
         const { id: walletAddressId } = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
         payment = await createPayment({ walletAddressId, metadata })
@@ -462,6 +468,7 @@ describe('Incoming Payment Resolver', (): void => {
       async ({ metadata }): Promise<void> => {
         const incomingAmount = amount ? amount : undefined
         const { id: walletAddressId } = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
         const payment = await createIncomingPayment(deps, {

packages/backend/src/graphql/resolvers/liquidity.test.ts

@@ -1015,6 +1015,7 @@ describe('Liquidity Resolvers', (): void => {
 
     beforeEach(async (): Promise<void> => {
       walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         createLiquidityAccount: true
       })
 
@@ -1747,7 +1748,9 @@ describe('Liquidity Resolvers', (): void => {
     let payment: OutgoingPayment
 
     beforeEach(async (): Promise<void> => {
-      walletAddress = await createWalletAddress(deps)
+      walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
       const walletAddressId = walletAddress.id
       incomingPayment = await createIncomingPayment(deps, {
         walletAddressId,
@@ -2157,7 +2160,9 @@ describe('Liquidity Resolvers', (): void => {
     let outgoingPayment: OutgoingPayment
 
     beforeEach(async (): Promise<void> => {
-      walletAddress = await createWalletAddress(deps)
+      walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
       const walletAddressId = walletAddress.id
       incomingPayment = await createIncomingPayment(deps, {
         walletAddressId,