feat: 🎸 remove POST /mock-cdd use /create-test-accounts instead

Remove an endpoint that has been marked for 2 years since the
`testUtils` pallet is expected to be removed from the chain soon

BREAKING CHANGE: 🧨 POST /mock-cdd has been removed

Author: polymath-eric

package.json

@@ -49,7 +49,7 @@
     "@polymeshassociation/fireblocks-signing-manager": "^2.5.0",
     "@polymeshassociation/hashicorp-vault-signing-manager": "^3.4.0",
     "@polymeshassociation/local-signing-manager": "^3.3.0",
-    "@polymeshassociation/polymesh-sdk": "^26.2.0-alpha.4",
+    "@polymeshassociation/polymesh-sdk": "27.0.0-alpha.4",
     "@polymeshassociation/signing-manager-types": "^3.2.0",
     "class-transformer": "0.5.1",
     "class-validator": "^0.14.0",

src/developer-testing/developer-testing.service.spec.ts

@@ -143,23 +143,4 @@ describe('DeveloperTestingService', () => {
       );
     });
   });
-
-  describe('createMockCdd', () => {
-    it('should return the created Identity', async () => {
-      const params = {
-        address,
-        initialPolyx: new BigNumber(10),
-      };
-      mockPolymeshApi.network.getSs58Format.mockReturnValue(new BigNumber(42));
-
-      when(mockAccountsService.findOne)
-        .calledWith(address)
-        .mockResolvedValue({
-          getIdentity: jest.fn().mockResolvedValue('fakeId'),
-        });
-
-      const result = await service.createMockCdd(params);
-      expect(result).toEqual('fakeId');
-    });
-  });
 });

src/developer-testing/developer-testing.service.ts

@@ -5,7 +5,7 @@ import { KeyringPair } from '@polkadot/keyring/types';
 import { Account, Identity } from '@polymeshassociation/polymesh-sdk/types';
 
 import { AccountsService } from '~/accounts/accounts.service';
-import { AppInternalError, AppValidationError } from '~/common/errors';
+import { AppInternalError } from '~/common/errors';
 import { isNotNull } from '~/common/utils';
 import { CreateMockIdentityDto } from '~/developer-testing/dto/create-mock-identity.dto';
 import { CreateTestAccountsDto } from '~/developer-testing/dto/create-test-accounts.dto';
@@ -133,40 +133,4 @@ export class DeveloperTestingService {
 
     return identities;
   }
-
-  /**
-   * @deprecated Use @link{DeveloperTestingService.createAccount} (the batched version) instead
-   * @note intended for development chains only (i.e. Alice exists and can call `testUtils.createMockCddClaim`)
-   */
-  public async createMockCdd({ address, initialPolyx }: CreateMockIdentityDto): Promise<Identity> {
-    const {
-      _polkadotApi: {
-        tx: { testUtils, balances, sudo },
-      },
-    } = this.polymeshService.polymeshApi;
-
-    if (!testUtils) {
-      throw new AppValidationError(
-        'The chain does not have the `testUtils` pallet enabled. This endpoint is intended for development use only'
-      );
-    }
-
-    const targetAccount = await this.accountsService.findOne(address);
-
-    await this.polymeshService.execTransaction(
-      this.sudoPair,
-      testUtils.mockCddRegisterDid,
-      address
-    );
-    const setBalance = balances.setBalance(address, initialPolyx.shiftedBy(6).toNumber(), 0);
-    await this.polymeshService.execTransaction(this.sudoPair, sudo.sudo, setBalance);
-
-    const id = await targetAccount.getIdentity();
-
-    if (!id) {
-      throw new AppInternalError('The Identity was not created');
-    }
-
-    return id;
-  }
 }

src/identities/identities.controller.spec.ts

@@ -26,7 +26,6 @@ import { MockDistributionWithDetails } from '~/corporate-actions/mocks/distribut
 import { RegisterIdentityDto } from '~/identities/dto/register-identity.dto';
 import { IdentitiesController } from '~/identities/identities.controller';
 import { IdentitiesService } from '~/identities/identities.service';
-import * as identityUtil from '~/identities/identities.util';
 import { AccountModel } from '~/identities/models/account.model';
 import { IdentityModel } from '~/identities/models/identity.model';
 import { IdentitySignerModel } from '~/identities/models/identity-signer.model';
@@ -67,8 +66,6 @@ describe('IdentitiesController', () => {
 
   const mockTickerReservationsService = new MockTickerReservationsService();
 
-  const mockDeveloperTestingService = mockDeveloperServiceProvider.useValue;
-
   beforeEach(async () => {
     const module = await Test.createTestingModule({
       controllers: [IdentitiesController],
@@ -521,23 +518,6 @@ describe('IdentitiesController', () => {
     });
   });
 
-  describe('mockCdd', () => {
-    it('should call the service and return the Identity', async () => {
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      const fakeIdentityModel = 'fakeIdentityModel' as any;
-      jest.spyOn(identityUtil, 'createIdentityModel').mockResolvedValue(fakeIdentityModel);
-
-      const params = {
-        address: '5abc',
-        initialPolyx: new BigNumber(10),
-      };
-
-      const result = await controller.createMockCdd(params);
-      expect(result).toEqual(fakeIdentityModel);
-      expect(mockDeveloperTestingService.createMockCdd).toHaveBeenCalledWith(params);
-    });
-  });
-
   describe('getClaimScopes', () => {
     it('should call the service and return the list of claim scopes', async () => {
       const params = {

src/identities/identities.controller.ts

@@ -51,7 +51,6 @@ import { handleServiceResult, TransactionResponseModel } from '~/common/utils';
 import { createDividendDistributionDetailsModel } from '~/corporate-actions/corporate-actions.util';
 import { DividendDistributionDetailsModel } from '~/corporate-actions/models/dividend-distribution-details.model';
 import { DeveloperTestingService } from '~/developer-testing/developer-testing.service';
-import { CreateMockIdentityDto } from '~/developer-testing/dto/create-mock-identity.dto';
 import { AddSecondaryAccountParamsDto } from '~/identities/dto/add-secondary-account-params.dto';
 import { RegisterIdentityDto } from '~/identities/dto/register-identity.dto';
 import { RotatePrimaryKeyParamsDto } from '~/identities/dto/rotate-primary-key-params.dto';
@@ -529,27 +528,6 @@ export class IdentitiesController {
     return new ResultsModel({ results });
   }
 
-  @ApiTags('developer-testing')
-  @ApiOperation({
-    summary:
-      'Creates a fake Identity for an Account and sets its POLYX balance (DEPRECATED: Use `/developer-testing/create-test-account` instead)',
-    description:
-      'This endpoint creates a Identity for an Account and sets its POLYX balance. A sudo account must be configured.',
-  })
-  @ApiOkResponse({ description: 'The details of the newly created Identity' })
-  @ApiBadRequestResponse({
-    description:
-      'This instance of the REST API is pointing to a chain that lacks development features. A proper CDD provider must be used instead',
-  })
-  @ApiInternalServerErrorResponse({
-    description: 'Failed to execute an extrinsic, or something unexpected',
-  })
-  @Post('/mock-cdd')
-  public async createMockCdd(@Body() params: CreateMockIdentityDto): Promise<IdentityModel> {
-    const identity = await this.developerTestingService.createMockCdd(params);
-    return createIdentityModel(identity);
-  }
-
   @ApiTags('claims')
   @ApiOperation({
     summary: 'Fetch all CDD claims for an Identity',