feat: 🎸 get account details

Author: sansan

src/accounts/accounts.controller.spec.ts

@@ -4,19 +4,22 @@ import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
 import {
   ExtrinsicsOrderBy,
+  Identity,
   PermissionType,
   TxGroup,
   TxTags,
 } from '@polymeshassociation/polymesh-sdk/types';
 import { Response } from 'express';
 
 import { AccountsController } from '~/accounts/accounts.controller';
-import { AccountsService } from '~/accounts/accounts.service';
+import { AccountDetails, AccountsService } from '~/accounts/accounts.service';
 import { PermissionedAccountDto } from '~/accounts/dto/permissioned-account.dto';
 import { ExtrinsicModel } from '~/common/models/extrinsic.model';
 import { PaginatedResultsModel } from '~/common/models/paginated-results.model';
 import { PermissionsLikeDto } from '~/identities/dto/permissions-like.dto';
+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';
 import { NetworkService } from '~/network/network.service';
 import { SubsidyService } from '~/subsidy/subsidy.service';
@@ -291,4 +294,22 @@ describe('AccountsController', () => {
       expect(result).toEqual(new AccountModel({ address: testAccount.address }));
     });
   });
+
+  describe('getDetails', () => {
+    it('should call the service and return AccountDetailsModel', async () => {
+      const fakeIdentityModel = 'fakeIdentityModel' as unknown as IdentityModel;
+      jest.spyOn(identityUtil, 'createIdentityModel').mockResolvedValue(fakeIdentityModel);
+
+      const mockResponse: AccountDetails = {
+        identity: new MockIdentity() as unknown as Identity,
+        multiSigDetails: null,
+      };
+
+      mockAccountsService.getDetails.mockReturnValue(mockResponse);
+
+      const result = await controller.getAccountDetails({ account: '5xdd' });
+
+      expect(result).toEqual({ identity: fakeIdentityModel });
+    });
+  });
 });

src/accounts/accounts.controller.ts

@@ -28,6 +28,8 @@ import { ModifyPermissionsDto } from '~/accounts/dto/modify-permissions.dto';
 import { RevokePermissionsDto } from '~/accounts/dto/revoke-permissions.dto';
 import { TransactionHistoryFiltersDto } from '~/accounts/dto/transaction-history-filters.dto';
 import { TransferPolyxDto } from '~/accounts/dto/transfer-polyx.dto';
+import { AccountDetailsModel } from '~/accounts/models/account-details.model';
+import { MultiSigDetailsModel } from '~/accounts/models/multi-sig-details.model';
 import { PermissionsModel } from '~/accounts/models/permissions.model';
 import { BalanceModel } from '~/assets/models/balance.model';
 import { ApiArrayResponse, ApiTransactionResponse } from '~/common/decorators/swagger';
@@ -36,6 +38,7 @@ import { ExtrinsicModel } from '~/common/models/extrinsic.model';
 import { PaginatedResultsModel } from '~/common/models/paginated-results.model';
 import { TransactionQueueModel } from '~/common/models/transaction-queue.model';
 import { handleServiceResult, TransactionResponseModel } from '~/common/utils';
+import { createIdentityModel, createSignerModel } from '~/identities/identities.util';
 import { AccountModel } from '~/identities/models/account.model';
 import { IdentitySignerModel } from '~/identities/models/identity-signer.model';
 import { NetworkService } from '~/network/network.service';
@@ -301,4 +304,43 @@ export class AccountsController {
 
     return new AccountModel({ address });
   }
+
+  @ApiOperation({
+    summary: 'Get Account details',
+    description:
+      'This endpoint retrieves the Account details for the given Account address. This includes the  associated Identity DID, primary account for that Identity and Secondary Accounts with the Permissions and the Subsidy details',
+  })
+  @ApiParam({
+    name: 'account',
+    description: 'The Account address whose details is to be fetched',
+    type: 'string',
+    example: '5GwwYnwCYcJ1Rkop35y7SDHAzbxrCkNUDD4YuCUJRPPXbvyV',
+  })
+  @ApiOkResponse({
+    description: 'Account details',
+    type: AccountDetailsModel,
+  })
+  @ApiNotFoundResponse({
+    description: 'No Account found for the given address',
+  })
+  @Get(':account')
+  async getAccountDetails(@Param() { account }: AccountParamsDto): Promise<AccountDetailsModel> {
+    const { identity, multiSigDetails } = await this.accountsService.getDetails(account);
+
+    let identityModel;
+    let multiSigDetailsModel;
+
+    if (identity) {
+      identityModel = await createIdentityModel(identity);
+    }
+
+    if (multiSigDetails) {
+      multiSigDetailsModel = new MultiSigDetailsModel({
+        signers: multiSigDetails.signers.map(createSignerModel),
+        requiredSignatures: multiSigDetails.requiredSignatures,
+      });
+    }
+
+    return new AccountDetailsModel({ identity: identityModel, multiSig: multiSigDetailsModel });
+  }
 }

src/accounts/accounts.service.spec.ts

@@ -3,7 +3,7 @@ const mockIsPolymeshTransaction = jest.fn();
 import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
 import { ExtrinsicsOrderBy } from '@polymeshassociation/polymesh-sdk/middleware/types';
-import { PermissionType, TxGroup, TxTags } from '@polymeshassociation/polymesh-sdk/types';
+import { Account, PermissionType, TxGroup, TxTags } from '@polymeshassociation/polymesh-sdk/types';
 
 import { AccountsService } from '~/accounts/accounts.service';
 import { PermissionedAccountDto } from '~/accounts/dto/permissioned-account.dto';
@@ -17,6 +17,7 @@ import {
   MockAccount,
   MockAsset,
   MockIdentity,
+  MockMultiSig,
   MockPolymesh,
   MockTransaction,
 } from '~/test-utils/mocks';
@@ -357,4 +358,28 @@ describe('AccountsService', () => {
       );
     });
   });
+
+  describe('getDetails', () => {
+    it('should return the Account details', async () => {
+      const mockAccount = new MockAccount();
+      const mockIdentity = new MockIdentity();
+      const mockMultiSig = new MockMultiSig();
+
+      const findOneSpy = jest.spyOn(service, 'findOne');
+      findOneSpy.mockResolvedValue(mockAccount as unknown as Account);
+
+      mockMultiSig.details.mockResolvedValue({ signers: [], requiredSignatures: new BigNumber(2) });
+      mockAccount.getIdentity.mockResolvedValue(mockIdentity);
+      mockAccount.getMultiSig.mockResolvedValue(mockMultiSig);
+
+      const result = await service.getDetails('address');
+
+      const fakeResult = {
+        identity: mockIdentity,
+        multiSigDetails: { signers: [], requiredSignatures: new BigNumber(2) },
+      };
+
+      expect(result).toStrictEqual(fakeResult);
+    });
+  });
 });

src/accounts/accounts.service.ts

@@ -4,6 +4,8 @@ import {
   AccountBalance,
   ExtrinsicData,
   Identity,
+  MultiSig,
+  MultiSigDetails,
   Permissions,
   ResultSet,
 } from '@polymeshassociation/polymesh-sdk/types';
@@ -18,6 +20,11 @@ import { PolymeshService } from '~/polymesh/polymesh.service';
 import { TransactionsService } from '~/transactions/transactions.service';
 import { handleSdkError } from '~/transactions/transactions.util';
 
+export type AccountDetails = {
+  identity: Identity | null;
+  multiSigDetails: MultiSigDetails | null;
+};
+
 @Injectable()
 export class AccountsService {
   constructor(
@@ -114,4 +121,25 @@ export class AccountsService {
       options
     );
   }
+
+  private async getMultiSigDetails(multiSig: MultiSig | null): Promise<MultiSigDetails | null> {
+    if (!multiSig) {
+      return null;
+    }
+
+    return await multiSig.details();
+  }
+
+  public async getDetails(address: string): Promise<AccountDetails> {
+    const account = await this.findOne(address);
+
+    const [identity, multiSig] = await Promise.all([account.getIdentity(), account.getMultiSig()]);
+
+    const multiSigDetails = await this.getMultiSigDetails(multiSig);
+
+    return {
+      identity,
+      multiSigDetails,
+    };
+  }
 }

src/accounts/models/account-details.model.ts

@@ -0,0 +1,27 @@
+/* istanbul ignore file */
+
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Type } from 'class-transformer';
+
+import { MultiSigDetailsModel } from '~/accounts/models/multi-sig-details.model';
+import { IdentityModel } from '~/identities/models/identity.model';
+
+export class AccountDetailsModel {
+  @ApiPropertyOptional({
+    description: 'Static data (and identifiers) of the newly created Identity',
+    type: IdentityModel,
+  })
+  @Type(() => IdentityModel)
+  readonly identity?: IdentityModel;
+
+  @ApiPropertyOptional({
+    description: 'MultiSig Account details',
+    type: MultiSigDetailsModel,
+  })
+  @Type(() => MultiSigDetailsModel)
+  readonly multiSig?: MultiSigDetailsModel;
+
+  constructor(model: AccountDetailsModel) {
+    Object.assign(this, model);
+  }
+}

src/accounts/models/multi-sig-details.model.ts

@@ -0,0 +1,30 @@
+/* istanbul ignore file */
+
+import { ApiProperty } from '@nestjs/swagger';
+import { BigNumber } from '@polymeshassociation/polymesh-sdk';
+import { Type } from 'class-transformer';
+
+import { FromBigNumber } from '~/common/decorators/transformation';
+import { SignerModel } from '~/identities/models/signer.model';
+
+export class MultiSigDetailsModel {
+  @ApiProperty({
+    description: 'Secondary accounts with permissions',
+    isArray: true,
+    type: SignerModel,
+  })
+  @Type(() => SignerModel)
+  readonly signers: SignerModel[];
+
+  @ApiProperty({
+    description: 'Required signers',
+    type: 'string',
+    example: '2',
+  })
+  @FromBigNumber()
+  readonly requiredSignatures: BigNumber;
+
+  constructor(model: MultiSigDetailsModel) {
+    Object.assign(this, model);
+  }
+}

src/test-utils/mocks.ts

@@ -455,12 +455,17 @@ export class MockAccount {
   getPermissions = jest.fn();
   getIdentity = jest.fn();
   getSubsidy = jest.fn();
+  getMultiSig = jest.fn();
 
   constructor(address = 'address') {
     this.address = address;
   }
 }
 
+export class MockMultiSig {
+  details = jest.fn();
+}
+
 export function createMockMetadataEntry(
   partial: PartialFuncReturn<MetadataEntry> = {
     id: new BigNumber(1),

src/test-utils/service-mocks.ts

@@ -105,6 +105,7 @@ export class MockAccountsService {
   revokePermissions = jest.fn();
   getTreasuryAccount = jest.fn();
   getIdentity = jest.fn();
+  getDetails = jest.fn();
 }
 
 export class MockEventsService {