fix: validation service isBeneficiary

Signed-off-by: Axel Loupias <[email protected]>

Author: Axel-IoBuilders

packages/ats/sdk/src/app/service/validation/ValidationService.ts

@@ -269,6 +269,8 @@ import { IsExternallyGrantedQuery } from '@query/security/externalKycLists/isExt
 import { GetTokenBySaltQuery } from '@query/factory/trex/getTokenBySalt/GetTokenBySaltQuery';
 import { InvalidTrexTokenSalt } from '@domain/context/factory/error/InvalidTrexTokenSalt';
 import { IsBeneficiaryQuery } from '@query/security/beneficiary/isBeneficiary/IsBeneficiaryQuery';
+import { AccountIsNotBeneficiary } from '@domain/context/security/error/operations/AccountIsNotBeneficiary';
+import { AccountIsBeneficiary } from '@domain/context/security/error/operations/AccountIsBeneficiary';
 
 @singleton()
 export default class ValidationService extends Service {
@@ -766,15 +768,36 @@ export default class ValidationService extends Service {
     return kycResult.payload === kycStatus;
   }
 
-  async isBeneficiary(
+  async checkIsBeneficiary(
     securityId: string,
     beneficiary: string,
   ): Promise<boolean> {
     this.queryBus = Injectable.resolve<QueryBus>(QueryBus);
-    return (
+    const res = (
+      await this.queryBus.execute(
+        new IsBeneficiaryQuery(securityId, beneficiary),
+      )
+    ).payload;
+    if (!res) {
+      throw new AccountIsNotBeneficiary(securityId, beneficiary);
+    }
+
+    return res;
+  }
+  async checkIsNotBeneficiary(
+    securityId: string,
+    beneficiary: string,
+  ): Promise<boolean> {
+    this.queryBus = Injectable.resolve<QueryBus>(QueryBus);
+    const res = (
       await this.queryBus.execute(
         new IsBeneficiaryQuery(securityId, beneficiary),
       )
     ).payload;
+    if (res) {
+      throw new AccountIsBeneficiary(securityId, beneficiary);
+    }
+
+    return !res;
   }
 }

packages/ats/sdk/src/app/service/validation/ValidationService.unit.test.ts

@@ -273,6 +273,9 @@ import { OperationNotAllowed } from '@domain/context/security/error/operations/O
 import { KycStatus } from '@domain/context/kyc/Kyc';
 import { IsInternalKycActivatedQuery } from '@query/security/kyc/isInternalKycActivated/IsInternalKycActivatedQuery';
 import { IsExternallyGrantedQuery } from '@query/security/externalKycLists/isExternallyGranted/IsExternallyGrantedQuery';
+import { IsBeneficiaryQuery } from '@query/security/beneficiary/isBeneficiary/IsBeneficiaryQuery';
+import { AccountIsNotBeneficiary } from '@domain/context/security/error/operations/AccountIsNotBeneficiary';
+import { AccountIsBeneficiary } from '@domain/context/security/error/operations/AccountIsBeneficiary';
 
 describe('ValidationService', () => {
   let service: ValidationService;
@@ -1313,4 +1316,48 @@ describe('ValidationService', () => {
       ).rejects.toThrow(OperationNotAllowed);
     });
   });
+
+  describe('checkIsBeneficiary', () => {
+    it('should resolve successfully when address is a beneficiary', async () => {
+      queryBusMock.execute.mockResolvedValueOnce({ payload: true });
+      const res = await service.checkIsBeneficiary(
+        securityId.value,
+        targetId.value,
+      );
+
+      expect(res).toBe(true);
+      expect(queryBusMock.execute).toHaveBeenCalledWith(
+        new IsBeneficiaryQuery(securityId.value, targetId.value),
+      );
+    });
+
+    it('should throw AccountIsNotBeneficiary when security is not issuable', async () => {
+      queryBusMock.execute.mockResolvedValueOnce({ payload: false });
+      await expect(
+        service.checkIsBeneficiary(securityId.value, targetId.value),
+      ).rejects.toThrow(AccountIsNotBeneficiary);
+    });
+  });
+
+  describe('checkIsNotBeneficiary', () => {
+    it('should resolve successfully when address is not a beneficiary', async () => {
+      queryBusMock.execute.mockResolvedValueOnce({ payload: false });
+      const res = await service.checkIsNotBeneficiary(
+        securityId.value,
+        targetId.value,
+      );
+
+      expect(res).toBe(true);
+      expect(queryBusMock.execute).toHaveBeenCalledWith(
+        new IsBeneficiaryQuery(securityId.value, targetId.value),
+      );
+    });
+
+    it('should throw AccountIsBeneficiary when security is not issuable', async () => {
+      queryBusMock.execute.mockResolvedValueOnce({ payload: true });
+      await expect(
+        service.checkIsNotBeneficiary(securityId.value, targetId.value),
+      ).rejects.toThrow(AccountIsBeneficiary);
+    });
+  });
 });

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/addBeneficiary/AddBeneficiaryCommandHandler.ts

@@ -222,9 +222,10 @@ export class AddBeneficiaryCommandHandler
         securityId,
       );
 
-      if (await this.validationService.isBeneficiary(securityId, beneficiary)) {
-        throw new Error('The address is already a beneficiary');
-      }
+      await this.validationService.checkIsNotBeneficiary(
+        securityId,
+        beneficiary,
+      );
 
       const res = await handler.addBeneficiary(
         securityEvmAddress,

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/addBeneficiary/AddBeneficiaryCommandHandler.unit.test.ts

@@ -254,7 +254,7 @@ describe('AddBeneficiaryCommandHandler', () => {
       accountServiceMock.getCurrentAccount.mockReturnValue(account);
       validationServiceMock.checkPause.mockResolvedValue(undefined);
       validationServiceMock.checkRole.mockResolvedValue(undefined);
-      validationServiceMock.isBeneficiary.mockResolvedValue(false);
+      validationServiceMock.checkIsNotBeneficiary.mockResolvedValue(true);
       transactionServiceMock.getHandler().addBeneficiary.mockResolvedValue({
         id: transactionId,
       });

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/removeBeneficiary/RemoveBeneficiaryCommandHandler.ts

@@ -222,11 +222,8 @@ export class RemoveBeneficiaryCommandHandler
         securityId,
       );
 
-      if (
-        !(await this.validationService.isBeneficiary(securityId, beneficiary))
-      ) {
-        throw new Error('The address is not a beneficiary');
-      }
+      await this.validationService.checkIsBeneficiary(securityId, beneficiary);
+
       const res = await handler.removeBeneficiary(
         securityEvmAddress,
         beneficiaryEvmAddress,

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/removeBeneficiary/RemoveBeneficiaryCommandHandler.unit.test.ts

@@ -254,7 +254,7 @@ describe('RemoveBeneficiaryCommandHandler', () => {
       accountServiceMock.getCurrentAccount.mockReturnValue(account);
       validationServiceMock.checkPause.mockResolvedValue(undefined);
       validationServiceMock.checkRole.mockResolvedValue(undefined);
-      validationServiceMock.isBeneficiary.mockResolvedValue(true);
+      validationServiceMock.checkIsBeneficiary.mockResolvedValue(true);
       transactionServiceMock.getHandler().removeBeneficiary.mockResolvedValue({
         id: transactionId,
       });

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/updateBeneficiaryData/UpdateBeneficiaryDataCommandHandler.ts

@@ -222,11 +222,8 @@ export class UpdateBeneficiaryDataCommandHandler
         securityId,
       );
 
-      if (
-        !(await this.validationService.isBeneficiary(securityId, beneficiary))
-      ) {
-        throw new Error('The address is not a beneficiary');
-      }
+      await this.validationService.checkIsBeneficiary(securityId, beneficiary);
+
       const res = await handler.updateBeneficiaryData(
         securityEvmAddress,
         beneficiaryEvmAddress,

packages/ats/sdk/src/app/usecase/command/security/beneficiaries/updateBeneficiaryData/UpdateBeneficiaryDataCommandHandler.unit.test.ts

@@ -254,7 +254,7 @@ describe('UpdateBeneficiaryDataCommandHandler', () => {
       accountServiceMock.getCurrentAccount.mockReturnValue(account);
       validationServiceMock.checkPause.mockResolvedValue(undefined);
       validationServiceMock.checkRole.mockResolvedValue(undefined);
-      validationServiceMock.isBeneficiary.mockResolvedValue(true);
+      validationServiceMock.checkIsBeneficiary.mockResolvedValue(true);
       transactionServiceMock
         .getHandler()
         .updateBeneficiaryData.mockResolvedValue({

packages/ats/sdk/src/core/error/BaseError.ts

@@ -279,6 +279,8 @@ export enum ErrorCode {
   InvalidKycStatus = '20041',
   WalletRecovered = '20042',
   AddressNotVerified = '20043',
+  AccountIsBeneficiary = '20044',
+  AccountIsNotBeneficiary = '20045',
 
   // Error codes for System Errors (Prefix: 3XXXX)
   ContractNotFound = '30002',