feat(wip): schema enforced wallet address prefixes

Author: njlie

bruno/collections/Rafiki/Rafiki Admin APIs/Create Tenant.bru

@@ -19,6 +19,7 @@ body:graphql {
         apiSecret
         idpConsentUrl
         idpSecret
+        walletAddressPrefix
       }
     }
   }
@@ -30,7 +31,8 @@ body:graphql:vars {
       "email": "[email protected]",
       "apiSecret": "test-secret",
       "idpConsentUrl": "https://example.com/consent",
-      "idpSecret": "test-idp-secret"
+      "idpSecret": "test-idp-secret",
+      "walletAddressPrefix": "https://google.com"
     }
   }
 }

localenv/mock-account-servicing-entity/generated/graphql.ts

@@ -1,7 +1,7 @@
-process.env.LOG_LEVEL = 'silent'
+process.env.LOG_LEVEL = 'info'
 process.env.INSTANCE_NAME = 'Rafiki'
 process.env.KEY_ID = 'myKey'
-process.env.OPEN_PAYMENTS_URL = 'http://127.0.0.1:3000'
+process.env.OPEN_PAYMENTS_URL = 'https://127.0.0.1:3000'
 process.env.ILP_CONNECTOR_URL = 'http://127.0.0.1:3002'
 process.env.ILP_ADDRESS = 'test.rafiki'
 process.env.AUTH_SERVER_GRANT_URL = 'http://127.0.0.1:3006'

packages/backend/jest.env.js

@@ -8,12 +8,20 @@ exports.up = function (knex) {
       table.string('walletAddressPrefix').unique()
     })
     .then(() => {
-      knex.raw(
+      return knex.raw(
         `UPDATE "tenants" SET "walletAddressPrefix" = (SELECT "value" from "tenantSettings" WHERE "tenantId" = "tenants"."id" AND "key" = 'WALLET_ADDRESS_URL')`
       )
     })
     .then(() => {
-      knex.raw(`DELETE "tenantSettings" WHERE "key" = 'WALLET_ADDRESS_URL'`)
+      return knex.raw(`DELETE FROM "tenantSettings" WHERE "key" = 'WALLET_ADDRESS_URL'`)
+    })
+    .then(() => {
+      return knex.raw(`UPDATE "tenants" SET "walletAddressPrefix" = '${process.env.OPEN_PAYMENTS_URL}/' || gen_random_uuid() WHERE "walletAddressPrefix" IS NULL`)
+    })
+    .then(() => {
+      return knex.schema.alterTable('tenants', (table) => {
+        table.dropNullable('walletAddressPrefix')
+      })
     })
 }
 

packages/backend/migrations/20250930210751_add_prefix_to_tenant.js

@@ -241,6 +241,7 @@ describe('Tenant Resolvers', (): void => {
                     idpConsentUrl
                     idpSecret
                     publicName
+                    walletAddressPrefix
                   }
                 }
               }
@@ -274,6 +275,7 @@ describe('Tenant Resolvers', (): void => {
                     idpConsentUrl
                     idpSecret
                     publicName
+                    walletAddressPrefix
                   }
                 }
               }
@@ -406,6 +408,7 @@ describe('Tenant Resolvers', (): void => {
                     idpConsentUrl
                     idpSecret
                     publicName
+                    walletAddressPrefix
                   }
                 }
               }
@@ -441,6 +444,7 @@ describe('Tenant Resolvers', (): void => {
                     idpConsentUrl
                     idpSecret
                     publicName
+                    walletAddressPrefix
                   }
                 }
               }

packages/backend/src/graphql/generated/graphql.schema.json

@@ -17,7 +17,7 @@ import { IocContract } from '@adonisjs/fold'
 import { AppServices } from '../../app'
 import { Asset } from '../../asset/model'
 import { initIocContainer } from '../..'
-import { Config } from '../../config/app'
+import { Config, IAppConfig } from '../../config/app'
 import { truncateTables } from '../../tests/tableManager'
 import {
   WalletAddressError,
@@ -49,6 +49,7 @@ import { faker } from '@faker-js/faker'
 import { Tenant } from '../../tenants/model'
 import { createTenant } from '../../tests/tenant'
 import { TenantService } from '../../tenants/service'
+import { isTenantError } from '../../tenants/errors'
 
 describe('Wallet Address Resolvers', (): void => {
   let deps: IocContract<AppServices>
@@ -57,6 +58,7 @@ describe('Wallet Address Resolvers', (): void => {
   let walletAddressService: WalletAddressService
   let assetService: AssetService
   let tenantService: TenantService
+  let prefix: string
 
   beforeAll(async (): Promise<void> => {
     deps = initIocContainer({
@@ -68,6 +70,13 @@ describe('Wallet Address Resolvers', (): void => {
     walletAddressService = await deps.use('walletAddressService')
     assetService = await deps.use('assetService')
     tenantService = await deps.use('tenantService')
+    const tenant = await tenantService.update({
+      id: Config.operatorTenantId,
+      walletAddressPrefix: 'https://alice.me'
+    })
+    assert.ok(!isTenantError(tenant))
+    assert.ok(tenant.walletAddressPrefix)
+    prefix = tenant.walletAddressPrefix
   })
 
   afterEach(async (): Promise<void> => {
@@ -80,10 +89,7 @@ describe('Wallet Address Resolvers', (): void => {
   })
 
   beforeEach(async () => {
-    await tenantService.update({
-      id: Config.operatorTenantId,
-      walletAddressPrefix: 'https://alice.me'
-    })
+    
   })
 
   describe('Create Wallet Address', (): void => {
@@ -95,7 +101,7 @@ describe('Wallet Address Resolvers', (): void => {
       input = {
         assetId: asset.id,
         tenantId: Config.operatorTenantId,
-        address: 'https://alice.me/.well-known/pay'
+        address: `${prefix}/.well-known/pay`
       }
     })
 

packages/backend/src/graphql/generated/graphql.ts

@@ -1644,7 +1644,7 @@ input CreateTenantInput {
   "Public name for the tenant."
   publicName: String
   "Prefix for all wallet addresses belonging to this tenant."
-  walletAddressPrefix: String
+  walletAddressPrefix: String!
   "Initial settings for tenant."
   settings: [TenantSettingInput!]
 }

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

@@ -4,8 +4,7 @@ export enum WalletAddressError {
   InvalidUrl = 'InvalidUrl',
   UnknownAsset = 'UnknownAsset',
   UnknownWalletAddress = 'UnknownWalletAddress',
-  DuplicateWalletAddress = 'DuplicateWalletAddress',
-  WalletAddressPrefixNotFound = 'WalletAddressPrefixNotFound'
+  DuplicateWalletAddress = 'DuplicateWalletAddress'
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
@@ -18,8 +17,7 @@ export const errorToCode: {
   [WalletAddressError.InvalidUrl]: GraphQLErrorCode.BadUserInput,
   [WalletAddressError.UnknownAsset]: GraphQLErrorCode.BadUserInput,
   [WalletAddressError.UnknownWalletAddress]: GraphQLErrorCode.NotFound,
-  [WalletAddressError.DuplicateWalletAddress]: GraphQLErrorCode.Duplicate,
-  [WalletAddressError.WalletAddressPrefixNotFound]: GraphQLErrorCode.NotFound
+  [WalletAddressError.DuplicateWalletAddress]: GraphQLErrorCode.Duplicate
 }
 
 export const errorToMessage: {
@@ -29,7 +27,5 @@ export const errorToMessage: {
   [WalletAddressError.UnknownAsset]: 'unknown asset',
   [WalletAddressError.UnknownWalletAddress]: 'unknown wallet address',
   [WalletAddressError.DuplicateWalletAddress]:
-    'Duplicate wallet address found with the same url',
-  [WalletAddressError.WalletAddressPrefixNotFound]:
-    'Prefix configuration for wallet address has not been found.'
+    'Duplicate wallet address found with the same url'
 }