Add missing typing for axios calls

akash-network · Mar 19, 2024 · 4f25615 · 4f25615
1 parent e32695f
commit 4f25615
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 16 deletions.
diff --git a/api/src/routes/v1/nodes/mainnet.ts b/api/src/routes/v1/nodes/mainnet.ts
@@ -27,7 +27,9 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 2, cacheKeys.getMainnetNodes, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/mainnet-nodes.json"); //TODO: Add typing
+    const res = await axios.get<{ id: string; api: string; rpc: string }[]>(
+      "https://raw.githubusercontent.com/akash-network/cloudmos/main/config/mainnet-nodes.json"
+    );
     return res.data;
   });
   return c.json(response);

diff --git a/api/src/routes/v1/nodes/sandbox.ts b/api/src/routes/v1/nodes/sandbox.ts
@@ -27,7 +27,9 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 2, cacheKeys.getSandboxNodes, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/sandbox-nodes.json");
+    const res = await axios.get<{ id: string; api: string; rpc: string }[]>(
+      "https://raw.githubusercontent.com/akash-network/cloudmos/main/config/sandbox-nodes.json"
+    );
     return res.data;
   });
   return c.json(response);

diff --git a/api/src/routes/v1/nodes/testnet.ts b/api/src/routes/v1/nodes/testnet.ts
@@ -27,7 +27,9 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 2, cacheKeys.getTestnetNodes, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/testnet-nodes.json");
+    const res = await axios.get<{ id: string; api: string; rpc: string }[]>(
+      "https://raw.githubusercontent.com/akash-network/cloudmos/main/config/testnet-nodes.json"
+    );
     return res.data;
   });
   return c.json(response);

diff --git a/api/src/routes/v1/version/mainnet.ts b/api/src/routes/v1/version/mainnet.ts
@@ -18,7 +18,7 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 5, cacheKeys.getMainnetVersion, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/net/master/mainnet/version.txt");
+    const res = await axios.get<string>("https://raw.githubusercontent.com/akash-network/net/master/mainnet/version.txt");
     return res.data;
   });
   return c.text(response);

diff --git a/api/src/routes/v1/version/sandbox.ts b/api/src/routes/v1/version/sandbox.ts
@@ -18,7 +18,7 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 5, cacheKeys.getSandboxVersion, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/net/master/sandbox/version.txt");
+    const res = await axios.get<string>("https://raw.githubusercontent.com/akash-network/net/master/sandbox/version.txt");
     return res.data;
   });
   return c.text(response);

diff --git a/api/src/routes/v1/version/testnet.ts b/api/src/routes/v1/version/testnet.ts
@@ -18,7 +18,7 @@ const route = createRoute({
 
 export default new OpenAPIHono().openapi(route, async (c) => {
   const response = await cacheResponse(60 * 5, cacheKeys.getTestnetVersion, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/net/master/testnet-02/version.txt");
+    const res = await axios.get<string>("https://raw.githubusercontent.com/akash-network/net/master/testnet-02/version.txt");
     return res.data;
   });
   return c.text(response);

diff --git a/api/src/services/external/githubService.ts b/api/src/services/external/githubService.ts
@@ -1,6 +1,6 @@
 import { Octokit } from "@octokit/rest";
 import { cacheKeys, cacheResponse } from "@src/caching/helpers";
-import { ProviderAttributesSchema } from "@src/types/provider";
+import { Auditor, ProviderAttributesSchema } from "@src/types/provider";
 import { env } from "@src/utils/env";
 import axios from "axios";
 
@@ -23,17 +23,17 @@ export const getProviderAttributesSchema = async (): Promise<ProviderAttributesS
   const response = await cacheResponse(
     30,
     cacheKeys.getProviderAttributesSchema,
-    async () => await axios.get("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/provider-attributes.json")
+    async () => await axios.get<ProviderAttributesSchema>("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/provider-attributes.json")
   );
 
   return response.data;
 };
 
 export async function getAuditors() {
   const response = await cacheResponse(60 * 5, cacheKeys.getAuditors, async () => {
-    const res = await axios.get("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/auditors.json");
+    const res = await axios.get<Auditor[]>("https://raw.githubusercontent.com/akash-network/cloudmos/main/config/auditors.json");
     return res.data;
   });
 
   return response;
-}
+}
diff --git a/api/src/services/external/marketDataService.ts b/api/src/services/external/marketDataService.ts
@@ -1,3 +1,4 @@
+import { CoinGeckoCoinsResponse } from "@src/types/coingeckoCoinsResponse";
 import axios from "axios";
 
 interface AktMarketData {
@@ -13,14 +14,14 @@ export async function getMarketData(): Promise<AktMarketData> {
   const endpointUrl = "https://api.coingecko.com/api/v3/coins/akash-network";
   // TODO USDC https://api.coingecko.com/api/v3/coins/usd-coin
   console.log("Fetching latest market data from " + endpointUrl);
-  const response = await axios.get(endpointUrl);
+  const response = await axios.get<CoinGeckoCoinsResponse>(endpointUrl);
 
   return {
-    price: parseFloat(response.data.market_data.current_price.usd),
-    volume: parseInt(response.data.market_data.total_volume.usd),
-    marketCap: parseInt(response.data.market_data.market_cap.usd),
+    price: response.data.market_data.current_price.usd,
+    volume: response.data.market_data.total_volume.usd,
+    marketCap: response.data.market_data.market_cap.usd,
     marketCapRank: response.data.market_cap_rank,
-    priceChange24h: parseFloat(response.data.market_data.price_change_24h),
-    priceChangePercentage24: parseFloat(response.data.market_data.price_change_percentage_24h)
+    priceChange24h: response.data.market_data.price_change_24h,
+    priceChangePercentage24: response.data.market_data.price_change_percentage_24h
   };
 }
diff --git a/api/src/types/coingeckoCoinsResponse.ts b/api/src/types/coingeckoCoinsResponse.ts
@@ -0,0 +1,13 @@
+export type CoinGeckoCoinsResponse = {
+  id: string;
+  symbol: string;
+  name: string;
+  market_cap_rank: number;
+  market_data: {
+    current_price: { usd: number };
+    total_volume: { usd: number };
+    market_cap: { usd: number };
+    price_change_24h: number;
+    price_change_percentage_24h: number;
+  };
+};