Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Token total supply endpoint #103

Merged
merged 2 commits into from
Aug 29, 2023
Merged

Token total supply endpoint #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b5a5e9
Token total supply endpoint
bobo-k2 Aug 28, 2023
a2f6bf3
fix test that require one parameter of NetworType
gluneau Aug 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions public/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,34 @@
}
}
},
"/api/{network}/token/circulation": {
"get": {
"tags": [
"Token"
],
"description": "Retrieves a token circulation supply for a given network.",
"parameters": [
{
"name": "network",
"in": "path",
"required": true,
"type": "string",
"description": "The network name. Supported networks: astar, shiden, shibuya, rocstar",
"enum": [
"astar",
"shiden",
"shibuya",
"rocstar"
]
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/{network}/token/circulation": {
"get": {
"tags": [
Expand Down Expand Up @@ -104,6 +132,34 @@
}
}
},
"/api/v1/{network}/token/supply": {
"get": {
"tags": [
"Token"
],
"description": "Retrieves a token total supply for a given network.",
"parameters": [
{
"name": "network",
"in": "path",
"required": true,
"type": "string",
"description": "The network name. Supported networks: astar, shiden, shibuya, rocstar",
"enum": [
"astar",
"shiden",
"shibuya",
"rocstar"
]
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/{network}/token/price/{period}": {
"get": {
"tags": [
Expand Down
34 changes: 31 additions & 3 deletions src/controllers/TokenStatsController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class TokenStatsController extends ControllerBase implements IControllerB
#swagger.description = 'Test endpoint, returns token stats for Astar Network'
*/
try {
res.json(await this._statsService.getTokenStats());
res.json(await this._statsService.getTokenStats('astar'));
} catch (err) {
this.handleError(res, err as Error);
}
Expand Down Expand Up @@ -98,7 +98,7 @@ export class TokenStatsController extends ControllerBase implements IControllerB
#swagger.ignore = true
*/
try {
res.json(await (await this._statsService.getTokenStats()).circulatingSupply);
res.json(await (await this._statsService.getTokenStats('astar')).circulatingSupply);
} catch (err) {
this.handleError(res, err as Error);
}
Expand All @@ -109,7 +109,14 @@ export class TokenStatsController extends ControllerBase implements IControllerB
*/
app.route('/api/:network/token/circulation').get(async (req: Request, res: Response) => {
/*
#swagger.ignore = true
#swagger.description = 'Retrieves a token circulation supply for a given network.'
#swagger.tags = ['Token']
#swagger.parameters['network'] = {
in: 'path',
description: 'The network name. Supported networks: astar, shiden, shibuya, rocstar',
required: true,
enum: ['astar', 'shiden', 'shibuya', 'rocstar']
}
*/
try {
res.json(
Expand Down Expand Up @@ -147,6 +154,27 @@ export class TokenStatsController extends ControllerBase implements IControllerB
}
});

/**
* @description Token total supply.
*/
app.route('/api/v1/:network/token/supply').get(async (req: Request, res: Response) => {
/*
#swagger.description = 'Retrieves a token total supply for a given network.'
#swagger.tags = ['Token']
#swagger.parameters['network'] = {
in: 'path',
description: 'The network name. Supported networks: astar, shiden, shibuya, rocstar',
required: true,
enum: ['astar', 'shiden', 'shibuya', 'rocstar']
}
*/
try {
res.json(await this._statsService.getTotalSupply(req.params.network as NetworkType));
} catch (err) {
this.handleError(res, err as Error);
}
});

/**
* @description Token price route v1.
*/
Expand Down
33 changes: 30 additions & 3 deletions src/services/StatsService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ import { TokenStats } from '../models/TokenStats';
import { NetworkType } from '../networks';
import { addressesToExclude } from './AddressesToExclude';
import { AccountData } from '../models/AccountData';
import { Guard } from '../guard';

export interface IStatsService {
getTokenStats(network?: NetworkType): Promise<TokenStats>;
getTokenStats(network: NetworkType): Promise<TokenStats>;
getTotalSupply(network: NetworkType): Promise<number>;
}

@injectable()
Expand All @@ -22,10 +24,13 @@ export class StatsService implements IStatsService {
/**
* Calculates token circulation supply by substracting sum of all token holder accounts
* not in circulation from total token supply.
* @param network Network (astar or shiden) to calculate token supply for.
* @param network NetworkType (astar or shiden) to calculate token supply for.
* @returns Token statistics including total supply and circulating supply.
*/
public async getTokenStats(network = 'astar'): Promise<TokenStats> {
public async getTokenStats(network: NetworkType): Promise<TokenStats> {
Guard.ThrowIfUndefined(network, 'network');
this.throwIfNetworkIsNotSupported(network);

try {
const api = this._apiFactory.getApiInstance(network);
const chainDecimals = await api.getChainDecimals();
Expand All @@ -46,6 +51,22 @@ export class StatsService implements IStatsService {
}
}

public async getTotalSupply(network: NetworkType): Promise<number> {
Guard.ThrowIfUndefined(network, 'network');
this.throwIfNetworkIsNotSupported(network);

try {
const api = this._apiFactory.getApiInstance(network);
const chainDecimals = await api.getChainDecimals();
const totalSupply = await api.getTotalSupply();

return this.formatBalance(totalSupply, chainDecimals);
} catch (e) {
console.error(e);
throw new Error('Unable to fetch token total supply from a node.');
}
}

private getTotalBalanceToExclude(balances: AccountData[]): BN {
const sum = balances
.map((balance) => {
Expand All @@ -61,4 +82,10 @@ export class StatsService implements IStatsService {

return parseInt(result.replaceAll(',', ''));
}

private throwIfNetworkIsNotSupported(network: NetworkType): void {
if (network !== 'astar' && network !== 'shiden' && network !== 'shibuya' && network !== 'rocstar') {
throw new Error(`Network ${network} is not supported.`);
}
}
}
6 changes: 3 additions & 3 deletions tests/services/StatsService.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { AstarApiMock } from './AstarApiMock';
/**
* Tests are writen adhering to AAA (Arange, Act, Assert) pattern.
*/
describe('getTokeStats', () => {
describe('getTokenStats', () => {
let apiFactory: IApiFactory;

beforeEach(() => {
Expand All @@ -16,15 +16,15 @@ describe('getTokeStats', () => {
it('calculates circulating supply', async () => {
const service = new StatsService(apiFactory);

const result = await service.getTokenStats('');
const result = await service.getTokenStats('astar');

expect(result.circulatingSupply).toBe(83);
});

it('returns valid total supply', async () => {
const service = new StatsService(apiFactory);

const result = await service.getTokenStats('');
const result = await service.getTokenStats('astar');

expect(result.totalSupply).toBe(100);
});
Expand Down
Loading