Merge pull request #107 from PolymathNetwork/chore/DA-364

chore: 🤖 Bump SDK version to 15.0.0-alpha.10

Author: monitz87

package.json

@@ -33,7 +33,7 @@
     "@nestjs/swagger": "^5.2.1",
     "@polymathnetwork/hashicorp-vault-signing-manager": "^1.1.0",
     "@polymathnetwork/local-signing-manager": "^1.0.5",
-    "@polymathnetwork/polymesh-sdk": "15.0.0-alpha.6",
+    "@polymathnetwork/polymesh-sdk": "15.0.0-alpha.10",
     "@polymathnetwork/signing-manager-types": "^1.0.3",
     "class-transformer": "0.5.1",
     "class-validator": "^0.13.2",

src/accounts/accounts.util.ts

@@ -14,7 +14,7 @@ export function createPermissionsModel(permissions: Permissions): PermissionsMod
   let assetPermissions: AssetPermissionsModel | null;
   if (assets) {
     const { type, values } = assets;
-    assetPermissions = new AssetPermissionsModel({ type, values: values.map(v => v.toJson()) });
+    assetPermissions = new AssetPermissionsModel({ type, values: values.map(v => v.toHuman()) });
   } else {
     assetPermissions = null;
   }

src/common/decorators/transformation.ts

@@ -20,7 +20,7 @@ export function ToBigNumber() {
  * Entity -> POJO
  */
 export function FromEntity() {
-  return applyDecorators(Transform(({ value }: { value: Entity<unknown> }) => value?.toJson()));
+  return applyDecorators(Transform(({ value }: { value: Entity<unknown> }) => value?.toHuman()));
 }
 
 /**
@@ -31,7 +31,7 @@ export function FromMaybeEntityArray() {
     Transform(({ value }: { value: unknown[] }) =>
       value.map(val => {
         if (isEntity(val)) {
-          return val.toJson();
+          return val.toHuman();
         }
 
         return val;
@@ -44,16 +44,16 @@ export function FromMaybeEntityArray() {
  *   or serialize the value if it is an SDK Entity in
  */
 export function FromEntityObject() {
-  return applyDecorators(Transform(({ value }: { value: unknown }) => toJsonObject(value)));
+  return applyDecorators(Transform(({ value }: { value: unknown }) => toHumanObject(value)));
 }
 
-function toJsonObject(obj: unknown): unknown {
+function toHumanObject(obj: unknown): unknown {
   if (isEntity(obj)) {
-    return obj.toJson();
+    return obj.toHuman();
   }
 
   if (Array.isArray(obj)) {
-    return obj.map(toJsonObject);
+    return obj.map(toHumanObject);
   }
 
   if (obj instanceof BigNumber && !obj.isNaN()) {
@@ -62,7 +62,7 @@ function toJsonObject(obj: unknown): unknown {
 
   if (obj && typeof obj === 'object') {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    return mapValues(obj as any, val => toJsonObject(val));
+    return mapValues(obj as any, val => toHumanObject(val));
   }
   return obj;
 }

src/common/types.ts

@@ -3,7 +3,7 @@
 export interface Entity<Serialized> {
   uuid: string;
 
-  toJson(): Serialized;
+  toHuman(): Serialized;
 }
 
 // eslint-disable-next-line @typescript-eslint/ban-types, @typescript-eslint/no-explicit-any

src/portfolios/portfolios.util.ts

@@ -60,7 +60,7 @@ export async function createPortfolioModel(
 export function createPortfolioIdentifierModel(
   portfolio: DefaultPortfolio | NumberedPortfolio
 ): PortfolioIdentifierModel {
-  return new PortfolioIdentifierModel(portfolio.toJson());
+  return new PortfolioIdentifierModel(portfolio.toHuman());
 }
 
 export function toPortfolioId(id: BigNumber): BigNumber | undefined {

src/test-utils/mocks.ts

@@ -140,7 +140,7 @@ export class MockAsset {
     issue: jest.fn(),
   };
 
-  public toJson = jest.fn().mockImplementation(() => this.ticker);
+  public toHuman = jest.fn().mockImplementation(() => this.ticker);
 }
 
 export class MockInstruction {
@@ -193,7 +193,7 @@ export class MockPortfolio {
   public isCustodiedBy = jest.fn();
   public getCustodian = jest.fn();
   public moveFunds = jest.fn();
-  public toJson = jest.fn().mockImplementation(() => {
+  public toHuman = jest.fn().mockImplementation(() => {
     return {
       id: '1',
       did: '0x06'.padEnd(66, '0'),

src/ticker-reservations/ticker-reservations.controller.spec.ts

@@ -43,6 +43,25 @@ describe('TickerReservationsController', () => {
     });
   });
 
+  describe('getDetails', () => {
+    it('should call the service and return the details', async () => {
+      const mockDetails = {
+        owner: '0x6000',
+        expiryDate: null,
+        status: TickerReservationStatus.AssetCreated,
+      };
+      const mockTickerReservation = new MockTickerReservation();
+      mockTickerReservation.details.mockResolvedValue(mockDetails);
+      mockTickerReservationsService.findOne.mockResolvedValue(mockTickerReservation);
+
+      const ticker = 'SOME_TICKER';
+      const result = await controller.getDetails({ ticker });
+
+      expect(result).toEqual(mockDetails);
+      expect(mockTickerReservationsService.findOne).toHaveBeenCalledWith(ticker);
+    });
+  });
+
   describe('transferOwnership', () => {
     it('should call the service and return the results', async () => {
       const mockAuthorization = new MockAuthorizationRequest();

src/ticker-reservations/ticker-reservations.controller.ts

@@ -1,8 +1,6 @@
 import { Body, Controller, Get, Param, Post } from '@nestjs/common';
 import {
   ApiCreatedResponse,
-  ApiGoneResponse,
-  ApiNotFoundResponse,
   ApiOkResponse,
   ApiOperation,
   ApiParam,
@@ -60,12 +58,6 @@ export class TickerReservationsController {
     description: 'Details of the ticker reservation',
     type: TickerReservationModel,
   })
-  @ApiNotFoundResponse({
-    description: 'The ticker has not been reserved',
-  })
-  @ApiGoneResponse({
-    description: 'Asset has already been created',
-  })
   @Get(':ticker')
   public async getDetails(@Param() { ticker }: TickerParamsDto): Promise<TickerReservationModel> {
     const tickerReservation = await this.tickerReservationsService.findOne(ticker);

src/ticker-reservations/ticker-reservations.service.spec.ts

@@ -2,10 +2,9 @@
 const mockIsPolymeshError = jest.fn();
 const mockIsPolymeshTransaction = jest.fn();
 
-import { GoneException, NotFoundException } from '@nestjs/common';
 import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymathnetwork/polymesh-sdk';
-import { ErrorCode, TxTags } from '@polymathnetwork/polymesh-sdk/types';
+import { TxTags } from '@polymathnetwork/polymesh-sdk/types';
 
 import { TransactionType } from '~/common/types';
 import { POLYMESH_API } from '~/polymesh/polymesh.consts';
@@ -64,74 +63,12 @@ describe('TickerReservationsService', () => {
   });
 
   describe('findOne', () => {
-    describe('if the reservation does not exist', () => {
-      it('should throw a NotFoundException', async () => {
-        const mockError = {
-          message: 'There is no reservation for',
-          code: ErrorCode.UnmetPrerequisite,
-        };
-        mockPolymeshApi.assets.getTickerReservation.mockImplementation(() => {
-          throw mockError;
-        });
-
-        mockIsPolymeshError.mockReturnValue(true);
-
-        let error;
-        try {
-          await service.findOne('TICKER');
-        } catch (err) {
-          error = err;
-        }
-
-        expect(error).toBeInstanceOf(NotFoundException);
-      });
-    });
-    describe('if the asset has already been created', () => {
-      it('should throw a GoneException', async () => {
-        const mockError = {
-          code: ErrorCode.UnmetPrerequisite,
-          message: 'TICKER Asset has been created',
-        };
-        mockPolymeshApi.assets.getTickerReservation.mockImplementation(() => {
-          throw mockError;
-        });
-
-        mockIsPolymeshError.mockReturnValue(true);
-
-        let error;
-        try {
-          await service.findOne('TICKER');
-        } catch (err) {
-          error = err;
-        }
-
-        expect(error).toBeInstanceOf(GoneException);
-      });
-    });
-    describe('if there is a different error', () => {
-      it('should pass the error along the chain', async () => {
-        const expectedError = new Error('Something else');
-        mockPolymeshApi.assets.getTickerReservation.mockImplementation(() => {
-          throw expectedError;
-        });
-        mockIsPolymeshError.mockReturnValue(true);
-        let error;
-        try {
-          await service.findOne('TICKER');
-        } catch (err) {
-          error = err;
-        }
-        expect(error).toBe(expectedError);
-      });
-    });
-    describe('otherwise', () => {
-      it('should return the reservation', async () => {
-        const mockTickerReservation = new MockTickerReservation();
-        mockPolymeshApi.assets.getTickerReservation.mockResolvedValue(mockTickerReservation);
+    it('should return the reservation', async () => {
+      const mockTickerReservation = new MockTickerReservation();
+      mockPolymeshApi.assets.getTickerReservation.mockResolvedValue(mockTickerReservation);
 
-        const result = await service.findOne('TICKER');
-        expect(result).toEqual(mockTickerReservation);
-      });
+      const result = await service.findOne('TICKER');
+      expect(result).toEqual(mockTickerReservation);
     });
   });
 

src/ticker-reservations/ticker-reservations.service.ts

@@ -1,10 +1,5 @@
-import { GoneException, Injectable, NotFoundException } from '@nestjs/common';
-import {
-  AuthorizationRequest,
-  ErrorCode,
-  TickerReservation,
-} from '@polymathnetwork/polymesh-sdk/types';
-import { isPolymeshError } from '@polymathnetwork/polymesh-sdk/utils';
+import { Injectable } from '@nestjs/common';
+import { AuthorizationRequest, TickerReservation } from '@polymathnetwork/polymesh-sdk/types';
 
 import { TransferOwnershipDto } from '~/common/dto/transfer-ownership.dto';
 import { processQueue, QueueResult } from '~/common/utils';
@@ -19,28 +14,9 @@ export class TickerReservationsService {
   ) {}
 
   public async findOne(ticker: string): Promise<TickerReservation> {
-    try {
-      return await this.polymeshService.polymeshApi.assets.getTickerReservation({
-        ticker,
-      });
-    } catch (err: unknown) {
-      if (isPolymeshError(err)) {
-        const { code, message } = err;
-        if (
-          code === ErrorCode.UnmetPrerequisite &&
-          message.startsWith('There is no reservation for')
-        ) {
-          throw new NotFoundException(`There is no reservation for "${ticker}"`);
-        } else if (
-          code === ErrorCode.UnmetPrerequisite &&
-          message.endsWith('Asset has been created')
-        ) {
-          throw new GoneException(`Asset "${ticker}" has already been created`);
-        }
-      }
-
-      throw err;
-    }
+    return this.polymeshService.polymeshApi.assets.getTickerReservation({
+      ticker,
+    });
   }
 
   public async reserve(ticker: string, signer: string): Promise<QueueResult<TickerReservation>> {

yarn.lock

@@ -1457,10 +1457,10 @@
   dependencies:
     "@polymathnetwork/signing-manager-types" "^1.0.3"
 
-"@polymathnetwork/[email protected].6":
-  version "15.0.0-alpha.6"
-  resolved "https://registry.yarnpkg.com/@polymathnetwork/polymesh-sdk/-/polymesh-sdk-15.0.0-alpha.6.tgz#9f2747f3222f4ffc10708a67fadc8f9aadcd6720"
-  integrity sha512-MV8MjtGGcXBP1ykVRRvxZvZXqW7D9Fq0VOnJBSo1yopFajdOxW91m5Wae00XD0facUzArkfXvl+UuZpV0KtV+w==
+"@polymathnetwork/[email protected].10":
+  version "15.0.0-alpha.10"
+  resolved "https://registry.yarnpkg.com/@polymathnetwork/polymesh-sdk/-/polymesh-sdk-15.0.0-alpha.10.tgz#d5f9998945fcc1015b66395e9a860cdf8a16be52"
+  integrity sha512-XzYH6r9aWvyhoCSQbbCEETK/OPrp5cadDNiDzOsYCJ/ie4pV7u6K/RiVWpzAw3+QS4sMTMUjzyNshYenFVh5Rg==
   dependencies:
     "@polkadot/api" "8.1.1"
     "@polkadot/util" "9.0.1"