feat: 🎸 get protocol fees

Author: sansan

src/common/utils/functions.ts

@@ -202,3 +202,24 @@ export function getNextYearISO(): string {
 
   return nextYear.toISOString();
 }
+
+/**
+ * Helper to convert a string to an array
+ *
+ * @param value - The value to convert to an array
+ * @returns The value as an array
+ */
+export function toArray(value: unknown): string[] | undefined {
+  if (Array.isArray(value)) {
+    return value;
+  }
+
+  if (typeof value === 'string') {
+    return value
+      .split(',')
+      .map(item => item.trim())
+      .filter(Boolean);
+  }
+
+  return undefined;
+}

src/network/dto/protocol-fees-query.dto.ts

@@ -0,0 +1,31 @@
+/* istanbul ignore file */
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { TxTag, TxTags } from '@polymeshassociation/polymesh-sdk/types';
+import { Transform } from 'class-transformer';
+import { ArrayNotEmpty, IsArray, IsOptional, IsString } from 'class-validator';
+
+import { IsTxTag } from '~/common/decorators/validation';
+import { getTxTags, toArray } from '~/common/utils';
+
+export class ProtocolFeesQueryDto {
+  @ApiProperty({
+    description: 'Transaction tags whose protocol fees should be returned',
+    isArray: true,
+    enum: getTxTags(),
+    example: [TxTags.asset.CreateAsset],
+  })
+  @Transform(({ value }) => toArray(value))
+  @IsArray()
+  @ArrayNotEmpty()
+  @IsTxTag({ each: true })
+  readonly tags: TxTag[];
+
+  @ApiPropertyOptional({
+    description: 'Optional block hash to query historic protocol fees',
+    type: 'string',
+    example: '0xc549227a184d7a16ffd7cd9ca923577c84f6e26946de092b30fcc2d9509789f7',
+  })
+  @IsOptional()
+  @IsString()
+  readonly blockHash?: string;
+}

src/network/models/protocol-fee.model.ts

@@ -0,0 +1,33 @@
+/* istanbul ignore file */
+import { ApiProperty } from '@nestjs/swagger';
+import { BigNumber } from '@polymeshassociation/polymesh-sdk';
+import { TxTag } from '@polymeshassociation/polymesh-sdk/types';
+
+import { FromBigNumber } from '~/common/decorators/transformation';
+import { getTxTags } from '~/common/utils';
+
+type ProtocolFeeModelParams = {
+  tag: TxTag;
+  fee: BigNumber;
+};
+
+export class ProtocolFeeModel {
+  @ApiProperty({
+    description: 'Transaction tag the fee applies to',
+    enum: getTxTags(),
+    example: 'asset.createAsset',
+  })
+  readonly tag: TxTag;
+
+  @ApiProperty({
+    description: 'Protocol fee amount in POLYX',
+    type: 'string',
+    example: '1',
+  })
+  @FromBigNumber()
+  readonly fee: BigNumber;
+
+  constructor(model: ProtocolFeeModelParams) {
+    Object.assign(this, model);
+  }
+}

src/network/network.controller.spec.ts

@@ -1,11 +1,13 @@
 import { DeepMocked } from '@golevelup/ts-jest';
 import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
+import { TxTags } from '@polymeshassociation/polymesh-sdk/types';
 
 import { MockMiddlewareMetadata } from '~/network/mocks/middleware-metadata.mock';
 import { MockNetworkProperties } from '~/network/mocks/network-properties.mock';
 import { MiddlewareMetadataModel } from '~/network/models/middleware-metadata.model';
 import { NetworkBlockModel } from '~/network/models/network-block.model';
+import { ProtocolFeeModel } from '~/network/models/protocol-fee.model';
 import { NetworkController } from '~/network/network.controller';
 import { NetworkService } from '~/network/network.service';
 import { mockNetworkServiceProvider } from '~/test-utils/service-mocks';
@@ -40,6 +42,19 @@ describe('NetworkController', () => {
     });
   });
 
+  describe('getProtocolFees', () => {
+    it('should return protocol fees as ProtocolFeeModel[]', async () => {
+      const tag = TxTags.asset.CreateAsset;
+      const mockServiceResult = [{ tag, fees: new BigNumber(1) }];
+
+      mockNetworkService.getProtocolFees.mockResolvedValue(mockServiceResult);
+
+      const result = await controller.getProtocolFees({ tags: [tag] });
+
+      expect(result).toEqual([new ProtocolFeeModel({ tag, fee: new BigNumber(1) })]);
+    });
+  });
+
   describe('getLatestBlock', () => {
     it('should return latest block number as NetworkBlockModel', async () => {
       const mockLatestBlock = new BigNumber(1);

src/network/network.controller.ts

@@ -1,9 +1,11 @@
-import { Controller, Get, NotFoundException } from '@nestjs/common';
+import { Controller, Get, NotFoundException, Query } from '@nestjs/common';
 import { ApiNotFoundResponse, ApiOkResponse, ApiOperation, ApiTags } from '@nestjs/swagger';
 
+import { ProtocolFeesQueryDto } from '~/network/dto/protocol-fees-query.dto';
 import { MiddlewareMetadataModel } from '~/network/models/middleware-metadata.model';
 import { NetworkBlockModel } from '~/network/models/network-block.model';
 import { NetworkPropertiesModel } from '~/network/models/network-properties.model';
+import { ProtocolFeeModel } from '~/network/models/protocol-fee.model';
 import { NetworkService } from '~/network/network.service';
 
 @ApiTags('network')
@@ -26,6 +28,25 @@ export class NetworkController {
     return new NetworkPropertiesModel(networkProperties);
   }
 
+  @ApiOperation({
+    summary: 'Get protocol fees for transactions',
+    description: 'Returns the protocol fees charged for the specified transaction tags',
+  })
+  @ApiOkResponse({
+    description: 'Protocol fees per transaction tag',
+    type: ProtocolFeeModel,
+    isArray: true,
+  })
+  @Get('protocol-fees')
+  public async getProtocolFees(@Query() query: ProtocolFeesQueryDto): Promise<ProtocolFeeModel[]> {
+    const { tags, blockHash } = query;
+    const fees = await this.networkService.getProtocolFees(tags, blockHash);
+
+    return fees.map(
+      protocolFee => new ProtocolFeeModel({ tag: protocolFee.tag, fee: protocolFee.fees })
+    );
+  }
+
   @ApiOperation({
     summary: 'Get the latest block',
     description: 'This endpoint will provide the latest block number',

src/network/network.service.spec.ts

@@ -3,6 +3,7 @@ const mockHexStripPrefix = jest.fn().mockImplementation(params => params);
 
 import { Test, TestingModule } from '@nestjs/testing';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
+import { TxTags } from '@polymeshassociation/polymesh-sdk/types';
 
 import { MockMiddlewareMetadata } from '~/network/mocks/middleware-metadata.mock';
 import { MockNetworkProperties } from '~/network/mocks/network-properties.mock';
@@ -96,6 +97,39 @@ describe('NetworkService', () => {
     });
   });
 
+  describe('getProtocolFees', () => {
+    it('should return protocol fees for the provided tags', async () => {
+      const tag = TxTags.asset.CreateAsset;
+      const protocolFees = [{ tag, fees: new BigNumber(1) }];
+
+      mockPolymeshApi.network.getProtocolFees.mockResolvedValue(protocolFees);
+
+      const result = await networkService.getProtocolFees([tag]);
+
+      expect(result).toBe(protocolFees);
+      expect(mockPolymeshApi.network.getProtocolFees).toHaveBeenCalledWith({
+        tags: [tag],
+        blockHash: undefined,
+      });
+    });
+
+    it('should forward block hash when provided', async () => {
+      const tag = TxTags.asset.CreateAsset;
+      const blockHash = '0x123';
+      const protocolFees = [{ tag, fees: new BigNumber(2) }];
+
+      mockPolymeshApi.network.getProtocolFees.mockResolvedValue(protocolFees);
+
+      const result = await networkService.getProtocolFees([tag], blockHash);
+
+      expect(result).toBe(protocolFees);
+      expect(mockPolymeshApi.network.getProtocolFees).toHaveBeenCalledWith({
+        tags: [tag],
+        blockHash,
+      });
+    });
+  });
+
   describe('getTransactionByHash', () => {
     it('should return the extrinsic details', async () => {
       mockPolymeshApi.network.getTransactionByHash.mockReturnValue(extrinsicWithFees);

src/network/network.service.ts

@@ -1,7 +1,8 @@
 import { Injectable } from '@nestjs/common';
 import { hexStripPrefix } from '@polkadot/util';
 import { BigNumber } from '@polymeshassociation/polymesh-sdk';
-import { Account, ExtrinsicDataWithFees } from '@polymeshassociation/polymesh-sdk/types';
+import { ProtocolFees } from '@polymeshassociation/polymesh-sdk/api/client/types';
+import { Account, ExtrinsicDataWithFees, TxTag } from '@polymeshassociation/polymesh-sdk/types';
 
 import { MiddlewareMetadataModel } from '~/network/models/middleware-metadata.model';
 import { NetworkPropertiesModel } from '~/network/models/network-properties.model';
@@ -29,6 +30,12 @@ export class NetworkService {
     return this.polymeshService.polymeshApi.network.getTreasuryBalance();
   }
 
+  public async getProtocolFees(tags: TxTag[], blockHash?: string): Promise<ProtocolFees[]> {
+    const args = blockHash ? { tags, blockHash } : { tags };
+
+    return this.polymeshService.polymeshApi.network.getProtocolFees(args);
+  }
+
   public getTransactionByHash(hash: string): Promise<ExtrinsicDataWithFees | null> {
     return this.polymeshService.polymeshApi.network.getTransactionByHash({
       txHash: hexStripPrefix(hash),

src/test-utils/mocks.ts

@@ -81,6 +81,7 @@ export class MockPolymesh {
     getNetworkProperties: jest.fn(),
     getTreasuryAccount: jest.fn(),
     getTreasuryBalance: jest.fn(),
+    getProtocolFees: jest.fn(),
     getTransactionByHash: jest.fn(),
     submitTransaction: jest.fn(),
     getMiddlewareMetadata: jest.fn(),