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

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

@@ -26,5 +26,7 @@ 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 || '438fa74a-fa7d-4317-9ced-dde32ece1787'
 }

packages/backend/migrations/20241203112902_add_tenant_to_wallet_address.js

@@ -0,0 +1,25 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return Promise.all([
+    knex.schema.alterTable('walletAddresses', function (table) {
+      table.uuid('tenantId').index().notNullable()
+      //table.foreign(['tenantId']).references('tenants.id')
+    })
+  ])
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return Promise.all([
+    knex.schema.alterTable('walletAddresses', function (table) {
+      table.dropIndex('tenantId')
+      table.dropColumn('tenantId')
+    })
+  ])
+}

packages/backend/src/app.ts

@@ -105,6 +105,7 @@ import {
   getTenantFromApiSignature,
   TenantApiSignatureResult
 } from './shared/utils'
+import { faker } from '@faker-js/faker'
 export interface AppContextData {
   logger: Logger
   container: AppContainer
@@ -393,7 +394,21 @@ export class App {
     )
 
     let tenantApiSignatureResult: TenantApiSignatureResult
-    if (this.config.env !== 'test') {
+    if (this.config.env === 'test') {
+      const tenantService = await this.container.use('tenantService')
+      let tenant = await tenantService.get(this.config.operatorTenantId)
+      if (!tenant) {
+        tenant = await Tenant.query().insertAndFetch({
+          id: this.config.operatorTenantId,
+          email: faker.internet.email(),
+          publicName: faker.company.name(),
+          apiSecret: 'test-api-secret',
+          idpConsentUrl: faker.internet.url(),
+          idpSecret: 'test-idp-secret'
+        })
+      }
+      tenantApiSignatureResult = { tenant, isOperator: true }
+    } else {
       koa.use(async (ctx, next: Koa.Next): Promise<void> => {
         const result = await getTenantFromApiSignature(ctx, this.config)
         if (!result) {

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

@@ -275,6 +275,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/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,

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

@@ -99,6 +99,7 @@ describe('OutgoingPayment Resolvers', (): void => {
     beforeEach(async (): Promise<void> => {
       walletAddressId = (
         await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
       ).id
@@ -135,13 +136,16 @@ describe('OutgoingPayment Resolvers', (): void => {
 
       beforeEach(async (): Promise<void> => {
         const firstReceiverWalletAddress = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
         const secondWalletAddress = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
 
         const secondReceiverWalletAddress = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
 
@@ -326,6 +330,7 @@ describe('OutgoingPayment Resolvers', (): void => {
         const grantId = uuid()
 
         const { id: walletAddressId } = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
 
@@ -365,6 +370,7 @@ describe('OutgoingPayment Resolvers', (): void => {
 
       beforeEach(async (): Promise<void> => {
         const { id: walletAddressId } = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
         payment = await createPayment({ walletAddressId, metadata })
@@ -553,6 +559,7 @@ describe('OutgoingPayment Resolvers', (): void => {
 
     test('success (metadata)', async (): Promise<void> => {
       const { id: walletAddressId } = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         assetId: asset.id
       })
       const payment = await createPayment({ walletAddressId, metadata })
@@ -689,6 +696,7 @@ describe('OutgoingPayment Resolvers', (): void => {
 
     test('create', async (): Promise<void> => {
       const walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         assetId: asset.id
       })
       const payment = await createPayment({ walletAddressId: walletAddress.id })
@@ -840,6 +848,7 @@ describe('OutgoingPayment Resolvers', (): void => {
     let payment: OutgoingPaymentModel
     beforeEach(async () => {
       const walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         assetId: asset.id
       })
 
@@ -956,6 +965,7 @@ describe('OutgoingPayment Resolvers', (): void => {
     beforeEach(async (): Promise<void> => {
       walletAddressId = (
         await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
       ).id

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

@@ -71,6 +71,7 @@ describe('Quote Resolvers', (): void => {
   describe('Query.quote', (): void => {
     test('success', async (): Promise<void> => {
       const { id: walletAddressId } = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         assetId: asset.id
       })
       const quote = await createWalletAddressQuote(walletAddressId)
@@ -189,6 +190,7 @@ describe('Quote Resolvers', (): void => {
     `('$type', async ({ withAmount, receiveAmount }): Promise<void> => {
       const amount = withAmount ? debitAmount : undefined
       const { id: walletAddressId } = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId,
         assetId: asset.id
       })
       const input = {
@@ -300,6 +302,7 @@ describe('Quote Resolvers', (): void => {
     beforeEach(async (): Promise<void> => {
       walletAddressId = (
         await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           assetId: asset.id
         })
       ).id

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

@@ -45,7 +45,9 @@ describe('Wallet Address Key Resolvers', (): void => {
 
   describe('Create Wallet Address Keys', (): void => {
     test('Can create wallet address key', async (): Promise<void> => {
-      const walletAddress = await createWalletAddress(deps)
+      const walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
 
       const input: CreateWalletAddressKeyInput = {
         walletAddressId: walletAddress.id,
@@ -106,7 +108,9 @@ describe('Wallet Address Key Resolvers', (): void => {
           throw new Error('unexpected')
         })
 
-      const walletAddress = await createWalletAddress(deps)
+      const walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
 
       const input = {
         walletAddressId: walletAddress.id,
@@ -164,7 +168,9 @@ describe('Wallet Address Key Resolvers', (): void => {
 
   describe('Revoke key', (): void => {
     test('Can revoke a key', async (): Promise<void> => {
-      const walletAddress = await createWalletAddress(deps)
+      const walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
 
       const key = await walletAddressKeyService.create({
         walletAddressId: walletAddress.id,
@@ -267,7 +273,9 @@ describe('Wallet Address Key Resolvers', (): void => {
   describe('List Wallet Address Keys', (): void => {
     let walletAddressId: string
     beforeEach(async (): Promise<void> => {
-      walletAddressId = (await createWalletAddress(deps)).id
+      walletAddressId = (
+        await createWalletAddress(deps, { tenantId: Config.operatorTenantId })
+      ).id
     })
     getPageTests({
       getClient: () => appContainer.apolloClient,

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

@@ -43,7 +43,7 @@ describe('Wallet Address Resolvers', (): void => {
   let walletAddressService: WalletAddressService
 
   beforeAll(async (): Promise<void> => {
-    deps = await initIocContainer({
+    deps = initIocContainer({
       ...Config,
       localCacheDuration: 0
     })
@@ -312,7 +312,9 @@ describe('Wallet Address Resolvers', (): void => {
     let walletAddress: WalletAddressModel
 
     beforeEach(async (): Promise<void> => {
-      walletAddress = await createWalletAddress(deps)
+      walletAddress = await createWalletAddress(deps, {
+        tenantId: Config.operatorTenantId
+      })
     })
 
     test('Can update a wallet address', async (): Promise<void> => {
@@ -426,6 +428,7 @@ describe('Wallet Address Resolvers', (): void => {
       })
       test('New additional properties override previous additional properties', async (): Promise<void> => {
         const createOptions = {
+          tenantId: Config.operatorTenantId,
           additionalProperties: [
             {
               fieldKey: 'existingKey',
@@ -492,6 +495,7 @@ describe('Wallet Address Resolvers', (): void => {
       })
       test('Updating with empty additional properties deletes existing', async (): Promise<void> => {
         const createOptions = {
+          tenantId: Config.operatorTenantId,
           additionalProperties: [
             {
               fieldKey: 'existingKey',
@@ -655,6 +659,7 @@ describe('Wallet Address Resolvers', (): void => {
         const additionalProperties = [walletProp01, walletProp02]
 
         const walletAddress = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           publicName,
           createLiquidityAccount: true,
           additionalProperties
@@ -729,6 +734,7 @@ describe('Wallet Address Resolvers', (): void => {
       'Can get a wallet address by its url (publicName: $publicName)',
       async ({ publicName }): Promise<void> => {
         const walletAddress = await createWalletAddress(deps, {
+          tenantId: Config.operatorTenantId,
           publicName,
           createLiquidityAccount: true
         })
@@ -818,14 +824,17 @@ describe('Wallet Address Resolvers', (): void => {
 
     getPageTests({
       getClient: () => appContainer.apolloClient,
-      createModel: () => createWalletAddress(deps),
+      createModel: () =>
+        createWalletAddress(deps, { tenantId: Config.operatorTenantId }),
       pagedQuery: 'walletAddresses'
     })
 
     test('Can get page of wallet addresses', async (): Promise<void> => {
       const walletAddresses: WalletAddressModel[] = []
       for (let i = 0; i < 2; i++) {
-        walletAddresses.push(await createWalletAddress(deps))
+        walletAddresses.push(
+          await createWalletAddress(deps, { tenantId: Config.operatorTenantId })
+        )
       }
       walletAddresses.reverse() // Calling the default getPage will result in descending order
       const query = await appContainer.apolloClient
@@ -889,6 +898,7 @@ describe('Wallet Address Resolvers', (): void => {
         const withdrawalAmount = BigInt(10)
         for (let i = 0; i < 3; i++) {
           const walletAddress = await createWalletAddress(deps, {
+            tenantId: Config.operatorTenantId,
             createLiquidityAccount: true
           })
           if (i) {