feat: 🎸 update code to accomodate sdk v27.0.2

Remove multiSig.joinCreator (by default MultiSigs are joined now). No
longer accept Ticker in claim scopes. Asset ID should be used instead

BREAKING CHANGE: 🧨 /multisigs/:multiSigAddress/join-creator is removed. Ticker is no longer
allowed for claim scope (use asset ID instead)

Author: polymath-eric

src/claims/decorators/validation.ts

@@ -54,8 +54,6 @@ export function IsValidScopeValue(property: string, validationOptions?: Validati
           switch (scopeType) {
             case ScopeType.Asset:
               return isString(value) && (isAssetId(value) || isTicker(value));
-            case ScopeType.Ticker:
-              return isString(value) && isTicker(value);
             case ScopeType.Identity:
               return (
                 isHexadecimal(value) &&
@@ -76,8 +74,6 @@ export function IsValidScopeValue(property: string, validationOptions?: Validati
           switch (scopeType) {
             case ScopeType.Asset:
               return 'value must be a valid Asset ID (either in hex or UUID format) or a valid ticker (all uppercase and no longer than 12 characters)';
-            case ScopeType.Ticker:
-              return `value must be all uppercase and no longer than 12 characters for type: ${scopeType}`;
             case ScopeType.Identity:
               return `value must be a hex string ${DID_LENGTH} characters long and prefixed with 0x`;
             case ScopeType.Custom:

src/claims/dto/claim.dto.spec.ts

@@ -153,7 +153,7 @@ describe('claimsDto', () => {
           type: ClaimType.Affiliate,
           scope: { type: 'Wrong', value: 123 },
         },
-        ['scope.type must be one of the following values: Identity, Ticker, Asset, Custom'],
+        ['scope.type must be one of the following values: Identity, Asset, Custom'],
       ],
       [
         'CustomerDueDiligence without `cddId`',
@@ -189,7 +189,7 @@ describe('claimsDto', () => {
           scope: {},
           customClaimTypeId: new BigNumber('1'),
         },
-        ['scope.type must be one of the following values: Identity, Ticker, Asset, Custom'],
+        ['scope.type must be one of the following values: Identity, Asset, Custom'],
       ],
     ];
     test.each(cases)('%s', async (_, input, expected) => {

src/identities/identities.controller.spec.ts

@@ -763,7 +763,6 @@ describe('IdentitiesController', () => {
     it('should return the Assets for which the Identity has permissions', async () => {
       const asset = createMock<Asset>({
         id: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
-        ticker: 'SOME_TICKER',
       });
       const assetGroups = [
         { asset, group: createMock<CustomPermissionGroup>({ id: new BigNumber(1), asset }) },

src/identities/identities.service.spec.ts

@@ -319,7 +319,6 @@ describe('IdentitiesService', () => {
     it('should return the list of AssetsGroups for which the Identity has permissions', async () => {
       const asset = createMock<Asset>({
         id: '3616b82e-8e10-80ae-dc95-2ea28b9db8b3',
-        ticker: 'SOME_TICKER',
       });
       const assetGroups = [
         { asset, group: createMock<CustomPermissionGroup>({ id: new BigNumber(1), asset }) },

src/multi-sigs/dto/join-creator.dto.ts

@@ -3,6 +3,7 @@ import { NotFoundException } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
 import {
+  HistoricalMultiSigProposal,
   Identity,
   MultiSig,
   MultiSigProposal,
@@ -56,18 +57,6 @@ describe('MultiSigsController', () => {
     });
   });
 
-  describe('joinCreator', () => {
-    it('should call the service and return the result', async () => {
-      const params = { asPrimary: true };
-
-      when(service.joinCreator).calledWith(multiSigAddress, params).mockResolvedValue(txResult);
-
-      const result = await controller.joinCreator({ multiSigAddress }, params);
-
-      expect(result).toEqual(processedTxResult);
-    });
-  });
-
   describe('modify', () => {
     it('should call the service and return the result', async () => {
       const params = {
@@ -190,11 +179,20 @@ describe('MultiSigsController', () => {
         details: jest.fn().mockResolvedValue(mockDetails),
         id: new BigNumber(2),
       });
-      const mockPaginatedResult = createMock<ResultSet<MultiSigProposal>>({
-        data: [mockProposal1, mockProposal2],
+
+      const historic1 = createMock<HistoricalMultiSigProposal>({
+        proposal: mockProposal1,
+      });
+      const historic2 = createMock<HistoricalMultiSigProposal>({
+        proposal: mockProposal2,
+      });
+
+      // Passing `HistoricalMultiSigProposal` would give an infinite type error
+      const mockPaginatedResult = createMock<ResultSet<unknown>>({
+        data: [historic1, historic2],
         next: new BigNumber(2),
         count: new BigNumber(2),
-      });
+      }) as ResultSet<HistoricalMultiSigProposal>;
 
       when(service.getHistoricalProposals)
         .calledWith(multiSigAddress)

src/multi-sigs/multi-sigs.controller.spec.ts

@@ -21,7 +21,6 @@ import { handleServiceResult, TransactionResolver, TransactionResponseModel } fr
 import { IdentityModel } from '~/identities/models/identity.model';
 import { IdentitySignerModel } from '~/identities/models/identity-signer.model';
 import { CreateMultiSigDto } from '~/multi-sigs/dto/create-multi-sig.dto';
-import { JoinCreatorDto } from '~/multi-sigs/dto/join-creator.dto';
 import { ModifyMultiSigDto } from '~/multi-sigs/dto/modify-multi-sig.dto';
 import { MultiSigParamsDto } from '~/multi-sigs/dto/multi-sig-params.dto';
 import { MultiSigProposalParamsDto } from '~/multi-sigs/dto/multisig-proposal-params.dto';
@@ -68,29 +67,6 @@ export class MultiSigsController {
     return handleServiceResult(serviceResult, resolver);
   }
 
-  @ApiOperation({
-    summary: "Join the creator's identity as a signing key",
-    description: `This endpoint joins a MultiSig to its creator's identity. For the multiSig to join a DID not belonging to the creator then a join identity auth needs to be made and accepted by the MultiSig. 
-      NOTE: This endpoint is only applicable for 6.x.x chains as from 7.x.x chain, the MultiSig is automatically attached to the creator's identity`,
-    deprecated: true,
-  })
-  @ApiTransactionResponse({
-    description: 'Details about the transaction',
-    type: TransactionQueueModel,
-  })
-  @ApiBadRequestResponse({
-    description: '<ul>' + '<li>The multiSig is already attached to an identity</li>' + '</ul>',
-  })
-  @Post(':multiSigAddress/join-creator')
-  async joinCreator(
-    @Param() { multiSigAddress }: MultiSigParamsDto,
-    @Body() params: JoinCreatorDto
-  ): Promise<TransactionResponseModel> {
-    const serviceResult = await this.multiSigService.joinCreator(multiSigAddress, params);
-
-    return handleServiceResult(serviceResult);
-  }
-
   @ApiOperation({
     summary: 'Modify a MultiSig',
     description: 'This endpoint allows for a multiSig to be modified by its creator',
@@ -361,12 +337,12 @@ export class MultiSigsController {
       multiSigAddress
     );
 
-    const detailsPromises = data.map(proposal => proposal.details());
+    const detailsPromises = data.map(({ proposal }) => proposal.details());
     const details = await Promise.all(detailsPromises);
 
     return new PaginatedResultsModel({
       results: data.map(
-        (proposal, i) =>
+        ({ proposal }, i) =>
           new MultiSigProposalModel({
             multiSigAddress,
             proposalId: proposal.id,

src/multi-sigs/multi-sigs.controller.ts

@@ -6,6 +6,7 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
 import {
   Account,
+  HistoricalMultiSigProposal,
   Identity,
   MultiSig,
   MultiSigProposal,
@@ -41,13 +42,15 @@ describe('MultiSigsService', () => {
 
   let multiSig: DeepMocked<MultiSig>;
   let proposal: DeepMocked<MultiSigProposal>;
+  let historicalProposal: DeepMocked<HistoricalMultiSigProposal>;
 
   beforeEach(async () => {
     mockAccountService = createMock<AccountsService>();
     mockTransactionsService = new MockTransactionsService();
 
     multiSig = createMock<MultiSig>({ address: multiSigAddress });
     proposal = createMock<MultiSigProposal>({ id: proposalId });
+    historicalProposal = createMock<HistoricalMultiSigProposal>({ proposal });
     mockPolymeshApi = new MockPolymesh();
 
     const module: TestingModule = await Test.createTestingModule({
@@ -150,14 +153,6 @@ describe('MultiSigsService', () => {
     });
   });
 
-  describe('joinCreator', () => {
-    it('should join the multiSig to the creator', async () => {
-      const result = await service.joinCreator(multiSigAddress, { options });
-
-      expect(result).toEqual(txResult);
-    });
-  });
-
   describe('approve', () => {
     it('should approve the proposal', async () => {
       const result = await service.approve(proposalParams, { options });
@@ -177,7 +172,7 @@ describe('MultiSigsService', () => {
   describe('getHistoricalProposals', () => {
     it('should return historical proposals', async () => {
       const mockResultSet = {
-        data: [proposal],
+        data: [historicalProposal],
         next: new BigNumber(2),
         count: new BigNumber(1),
       };

src/multi-sigs/multi-sigs.service.spec.ts

@@ -1,8 +1,8 @@
 import { Injectable } from '@nestjs/common';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
 import {
+  HistoricalMultiSigProposal,
   Identity,
-  JoinCreatorParams,
   MultiSig,
   MultiSigProposal,
   ResultSet,
@@ -14,7 +14,6 @@ import { TransactionBaseDto } from '~/common/dto/transaction-base-dto';
 import { AppValidationError } from '~/common/errors';
 import { extractTxOptions, ServiceReturn } from '~/common/utils';
 import { CreateMultiSigDto } from '~/multi-sigs/dto/create-multi-sig.dto';
-import { JoinCreatorDto } from '~/multi-sigs/dto/join-creator.dto';
 import { ModifyMultiSigDto } from '~/multi-sigs/dto/modify-multi-sig.dto';
 import { MultiSigProposalParamsDto } from '~/multi-sigs/dto/multisig-proposal-params.dto';
 import { SetMultiSigAdminDto } from '~/multi-sigs/dto/set-multi-sig-admin.dto';
@@ -88,14 +87,6 @@ export class MultiSigsService {
     return this.transactionsService.submit(multiSig.modify, { signers: signerAccounts }, options);
   }
 
-  public async joinCreator(multiSigAddress: string, params: JoinCreatorDto): ServiceReturn<void> {
-    const { options, args } = extractTxOptions(params);
-
-    const multi = await this.findOne(multiSigAddress);
-
-    return this.transactionsService.submit(multi.joinCreator, args as JoinCreatorParams, options);
-  }
-
   public async approve(
     proposalParams: MultiSigProposalParamsDto,
     txParams: TransactionBaseDto
@@ -179,7 +170,7 @@ export class MultiSigsService {
     multiSigAddress: string,
     size?: BigNumber,
     start?: BigNumber
-  ): Promise<ResultSet<MultiSigProposal>> {
+  ): Promise<ResultSet<HistoricalMultiSigProposal>> {
     const multiSig = await this.findOne(multiSigAddress);
 
     return multiSig.getHistoricalProposals({ size, start });

src/multi-sigs/multi-sigs.service.ts

@@ -502,7 +502,7 @@ export function createMockMetadataEntry(
   partial: PartialFuncReturn<MetadataEntry> = {
     id: new BigNumber(1),
     type: MetadataType.Local,
-    asset: { id: testValues.assetId, ticker: 'TICKER' },
+    asset: { id: testValues.assetId },
   }
 ): DeepMocked<MetadataEntry> {
   return createMock<MetadataEntry>(partial);