Integrates shared cache, lib errors

.env.dist

@@ -9,4 +9,11 @@ TESTNET_DELEGATION_API_ROOT_URI=https://api-delegation.qa.community.taraxa.io
 COINGECKO_API_TARAXA_URI=https://api.coingecko.com/api/v3/simple/price?ids=taraxa&vs_currencies=usd
 TESTNET_EXPLORER_API_ROOT_URI=https://explorer.testnet.taraxa.io
 EXPLORER_API_ROOT_URI=https://explorer.mainnet.taraxa.io
-GITHUB_ACCESS_TOKEN=<your_GH_token>
+GITHUB_ACCESS_TOKEN=<your_GH_token>
+
+PORT=3001
+
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6739
+REDIS_NAME=info-cache
+REDIS_PASSWORD=pass

.eslintrc.js

@@ -19,5 +19,6 @@ module.exports = {
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/explicit-module-boundary-types': 'off',
     '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unused-vars': 'off',
   },
 };

.gitignore

@@ -396,4 +396,4 @@ Temporary Items
 # Local
 .env
 dist
-/charts/taraxa-info-api/prod.secret.values.yaml
+/charts/taraxa-info-api/prod.secret.values.yaml

charts/taraxa-info-api/prod.values.yaml

@@ -9,6 +9,10 @@ app:
   coingeckoUri: https://api.coingecko.com/api/v3/simple/price?ids=taraxa&vs_currencies=usd
   testnetExplorerUri: https://explorer.testnet.taraxa.io
   mainnetExplorerUri: https://explorer.mainnet.taraxa.io
+  redisHost: 10.39.114.21
+  redisPort: 6379
+  redisPassword: pass
+  redisName: infocache
 
 image:
   tag: "latest"

charts/taraxa-info-api/templates/configmap.yaml

@@ -14,3 +14,6 @@ data:
   COINGECKO_API_TARAXA_URI: {{ .Values.app.coingeckoUri | quote }}
   TESTNET_EXPLORER_API_ROOT_URI: {{ .Values.app.testnetExplorerUri | quote }}
   EXPLORER_API_ROOT_URI: {{ .Values.app.mainnetExplorerUri | quote }}
+  REDIS_HOST: {{ .Values.app.redisHost | quote }}
+  REDIS_PORT: {{ .Values.app.redisPort | quote }}
+  REDIS_NAME: {{ .Values.app.redisName | quote }}

charts/taraxa-info-api/templates/secrets.yaml

@@ -0,0 +1,16 @@
+{{- $secret := (lookup "v1" "Secret" .Release.Namespace .Release.Name) -}}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ .Release.Name }}
+  labels:
+    {{- include "taraxa-info-api.labels" . | nindent 4 }}
+type: Opaque
+data:
+{{ if $secret }}
+  {{- range $key, $value := $secret.data }}
+  {{ $key }}: {{ $value }}
+  {{- end }}
+{{ else }}
+  auth: {{ .Values.app.redisPassword | quote }}
+{{- end }}

charts/taraxa-info-api/values.yaml

@@ -14,7 +14,11 @@ app:
   coingeckoUri: https://api.coingecko.com/api/v3/simple/price?ids=taraxa&vs_currencies=usd
   testnetExplorerUri: https://explorer.testnet.taraxa.io
   mainnetExplorerUri: https://explorer.mainnet.taraxa.io
+  redisHost: 10.39.114.11
+  redisPort: 6379
   serverPort: 3000
+  redisPassword: pass
+  redisName: infocache
 
 nodeSelector:
   cloud.google.com/gke-nodepool: taraxa-community-default

package.json

@@ -21,8 +21,10 @@
     "@nestjs/config": "^2.2.0",
     "@nestjs/core": "^9.2.1",
     "@nestjs/platform-express": "^9.2.1",
+    "@nestjs/schedule": "^2.1.0",
     "@nestjs/swagger": "^6.1.4",
-    "cache-manager": "^3.4.4",
+    "cache-manager": "^5.1.4",
+    "cache-manager-redis-store": "^3.0.1",
     "ethers": "^5.3.1",
     "reflect-metadata": "^0.1.13",
     "rimraf": "^3.0.2",
@@ -31,9 +33,12 @@
   "devDependencies": {
     "@nestjs/cli": "^7.6.0",
     "@nestjs/schematics": "^7.3.1",
-    "@types/cache-manager": "^3.4.0",
+    "@types/cache-manager": "^4.0.2",
+    "@types/cache-manager-redis-store": "^2.0.1",
+    "@types/cron": "^2.0.0",
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.36",
+    "@types/redis": "^4.0.11",
     "@typescript-eslint/eslint-plugin": "^4.19.0",
     "@typescript-eslint/parser": "^4.19.0",
     "eslint": "^7.22.0",

src/app.module.ts

@@ -1,6 +1,7 @@
-import { Module } from '@nestjs/common';
-import { ConfigModule } from '@nestjs/config';
+import { CacheModule, CacheStore, Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
 import { SwaggerModule } from '@nestjs/swagger';
+import { redisStore } from 'cache-manager-redis-store';
 import general from './config/general';
 import { GitHubModule } from './github/github.module';
 import { NodeModule } from './node/node.module';
@@ -13,6 +14,23 @@ import { TokenModule } from './token/token.module';
       isGlobal: true,
       load: [general],
     }),
+    CacheModule.registerAsync({
+      isGlobal: true,
+      imports: [ConfigModule],
+      inject: [ConfigService],
+      useFactory: async (configService: ConfigService) => {
+        return {
+          store: await redisStore({
+            socket: {
+              host: configService.get<string>('redisHost'),
+              port: configService.get<number>('redisPort'),
+            },
+            name: `${configService.get<string>('redisName')}`,
+            password: configService.get<string>('redisPassword'),
+          }),
+        } as unknown as CacheStore;
+      },
+    }),
     SwaggerModule,
     TokenModule,
     StakingModule,

src/config/general.ts

@@ -11,4 +11,8 @@ export default () => ({
   coinGeckoTaraxaApi: process.env.COINGECKO_API_TARAXA_URI,
   githubAccessToken: process.env.GITHUB_ACCESS_TOKEN,
   graphQLGitHubURI: 'https://api.github.com/graphql',
+  redisHost: process.env.REDIS_HOST,
+  redisPort: process.env.REDIS_PORT,
+  redisPassword: process.env.REDIS_PASSWORD,
+  redisName: process.env.REDIS_NAME,
 });

src/github/github.controller.ts

@@ -14,6 +14,15 @@ import { GitHubService } from './github.service';
 export class GitHubController {
   constructor(private readonly ghService: GitHubService) {}
 
+  @Get()
+  @CacheTTL(36000)
+  async contributionData() {
+    const commitsThisMonth = (await this.ghService.commitsOfThisMonth())
+      .totalCommits;
+    return {
+      commitsThisMonth,
+    };
+  }
   /**
    * Returns the number of commits from the current month from the Taraxa-project organization
    * @returns number of commits of current month

src/main.ts

@@ -11,7 +11,9 @@ async function bootstrap() {
     .setVersion('1.0')
     .build();
   const document = SwaggerModule.createDocument(app, config);
+
   SwaggerModule.setup('apidocs', app, document);
-  await app.listen(3000);
+
+  await app.listen(process.env.PORT || 3000);
 }
 bootstrap();

src/node/node.controller.ts

@@ -14,6 +14,20 @@ import { NodeService } from './node.service';
 export class NodeController {
   constructor(private readonly nodeService: NodeService) {}
 
+  @Get()
+  async validatorData() {
+    const activeMainnet = (await this.nodeService.noActiveValidators())
+      .totalActive;
+    const activeTestnet = (await this.nodeService.noActiveValidators(true))
+      .totalActive;
+    const cumulativeCommission = await this.nodeService.cumulativeCommisson();
+    return {
+      activeMainnet,
+      activeTestnet,
+      cumulativeCommission,
+    };
+  }
+
   /**
    * Returns the active validators in the past week for the Taraxa Mainnet
    * @returns active validator amount

src/staking/staking.controller.ts

@@ -18,13 +18,29 @@ export class StakingController {
     private readonly delegationService: DelegationService,
   ) {}
 
+  @Get()
+  async stakingData() {
+    const totalStaked = await this.tokenService.totalStaked();
+    const totalDelegated = (await this.delegationService.totalDelegated())
+      .totalDelegated;
+    const avgValidatorCommission = (
+      await this.delegationService.averageWeightedCommission()
+    ).averageWeightedCommission;
+    const avgStakingYield = 20 - (await this.avgValidatorCommission());
+    return {
+      totalStaked,
+      totalDelegated,
+      avgValidatorCommission,
+      avgStakingYield,
+    };
+  }
   /**
    * Returns the current TARA staked in the ecosystem
    * @returns staked supply in ETH
    */
   @Get('totalStake')
   @CacheTTL(36000)
-  async totalSupply() {
+  async totalStaked() {
     return await this.tokenService.totalStaked();
   }
 
@@ -42,7 +58,7 @@ export class StakingController {
    * Returns the current avegare weighted validator commission in the ecosystem
    * @returns avegrage weighted validator commission
    */
-  @Get('AVC')
+  @Get('avc')
   @CacheTTL(36000)
   async avgValidatorCommission() {
     return (await this.delegationService.averageWeightedCommission())
@@ -53,7 +69,7 @@ export class StakingController {
    * Returns the current avegare staking validator yield in the ecosystem
    * @returns avegare staking validator yield
    */
-  @Get('ASY')
+  @Get('asy')
   @CacheTTL(36000)
   async avgStakingYeild() {
     return 20 - (await this.avgValidatorCommission());

src/staking/staking.module.ts

@@ -1,5 +1,5 @@
 import { HttpModule } from '@nestjs/axios';
-import { Module, CacheModule } from '@nestjs/common';
+import { CacheModule, Module } from '@nestjs/common';
 import { ConfigModule } from '@nestjs/config';
 import { TokenModule } from 'src/token/token.module';
 import { DelegationService } from './delegation.service';

src/token/token.controller.ts

@@ -13,6 +13,12 @@ import { TokenService } from './token.service';
 @UseInterceptors(CacheInterceptor)
 export class TokenController {
   constructor(private readonly tokenService: TokenService) {}
+
+  @Get()
+  async getTokenData() {
+    return await this.tokenService.tokenData();
+  }
+
   @Get('name')
   @CacheTTL(36000)
   async getName() {
@@ -28,9 +34,8 @@ export class TokenController {
    * @returns price as float
    */
   @Get('price')
-  @CacheTTL(30)
   async getPrice() {
-    return await this.tokenService.getPrice();
+    return (await this.tokenService.marketDetails()).price;
   }
   @Get('decimals')
   @CacheTTL(36000)
@@ -62,9 +67,8 @@ export class TokenController {
    * @returns circulating supply in ETH
    */
   @Get('totalCirculating')
-  @CacheTTL(30)
   async totalInCirculation() {
-    return await this.tokenService.totalCirculation();
+    return (await this.tokenService.marketDetails()).circulatingSupply;
   }
   /**
    * Returns the current TARA stakign ratio
@@ -80,8 +84,7 @@ export class TokenController {
    * @returns market cap in 8-precision decimals as float
    */
   @Get('mktCap')
-  @CacheTTL(30)
   async mktCap() {
-    return await this.tokenService.mktCap();
+    return (await this.tokenService.marketDetails()).marketCap;
   }
 }

src/token/token.service.ts

@@ -1,5 +1,7 @@
 import {
+  CACHE_MANAGER,
   ForbiddenException,
+  Inject,
   Injectable,
   InternalServerErrorException,
   Logger,
@@ -10,6 +12,8 @@ import { BigNumber } from '@ethersproject/bignumber';
 import * as Tara from './contracts/Tara.json';
 import { HttpService } from '@nestjs/axios';
 import { firstValueFrom, catchError, map } from 'rxjs';
+import { Cache } from 'cache-manager';
+import { MarketDetails } from '../utils/types';
 
 @Injectable()
 export class TokenService {
@@ -20,6 +24,7 @@ export class TokenService {
   constructor(
     private configService: ConfigService,
     private readonly httpService: HttpService,
+    @Inject(CACHE_MANAGER) private cacheManager: Cache,
   ) {
     this.ethersProvider = new ethers.providers.JsonRpcProvider(
       this.configService.get<string>('provider'),
@@ -104,7 +109,47 @@ export class TokenService {
       100
     );
   }
-  async mktCap() {
-    return Number(await this.totalCirculation()) * (await this.getPrice());
+  async marketDetails() {
+    const details = (await this.cacheManager.get('marketCap')) as MarketDetails;
+    if (details) {
+      return details;
+    } else {
+      try {
+        const price = await this.getPrice();
+        const circulatingSupply = await this.totalCirculation();
+        const marketCap = price * circulatingSupply;
+        const marketDetails = {
+          price,
+          circulatingSupply,
+          marketCap,
+        };
+        await this.cacheManager.set('marketCap', marketDetails as any, 30);
+        return marketDetails;
+      } catch (error) {
+        throw new InternalServerErrorException(
+          'Fetching market details failed. Reason: ',
+          error,
+        );
+      }
+    }
+  }
+
+  async tokenData() {
+    const marketDetails = await this.marketDetails();
+    const name = await this.getName();
+    const symbol = await this.getSymbol();
+    const decimals = await this.getDecimals();
+    const totalSupply = await this.totalSupply();
+    const totalLocked = await this.totalLocked();
+    const stakingRatio = await this.stakingRatio();
+    return {
+      name,
+      symbol,
+      decimals,
+      totalSupply,
+      totalLocked,
+      stakingRatio,
+      ...marketDetails,
+    };
   }
 }

src/utils/types.ts

@@ -19,3 +19,9 @@ export interface ValidatorData {
   account: string;
   info: ValidatorBasicInfo;
 }
+
+export interface MarketDetails {
+  price: number;
+  circulatingSupply: number;
+  marketCap: number;
+}

tsconfig.json

@@ -11,6 +11,7 @@
     "sourceMap": true,
     "outDir": "./dist",
     "baseUrl": "./",
-    "incremental": true
+    "incremental": true,
+    "skipLibCheck": true
   }
 }