setup test on ci, fix roi calculator (#21)

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  pull_request:
+    branches: ["master"]
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  SUBSCAN_KEY: ${{ secrets.SUBSCAN_KEY }}
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: "Install: NodeJS 20.x"
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - name: "Install: pkg dependencies"
+        run: yarn install
+
+      - name: "Run server"
+        env:
+          SUBSCAN_KEY: ${{ secrets.SUBSCAN_KEY }}
+          NETWORK_ADDRESSES: "wss://rpc.vara.network"
+        run: nohup yarn start &
+
+      - name: "Run tests"
+        run: yarn test

package.json

@@ -6,19 +6,20 @@
   "type": "module",
   "scripts": {
     "start": "node src/main.js",
-    "watch": "node --watch src/main.js"
+    "watch": "node --watch src/main.js",
+    "test": "node test.js"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@polkadot/api": "^10.9.1",
+    "@polkadot/api": "^15.0.1",
     "cors": "^2.8.5",
     "dotenv": "^16.3.1",
     "express": "^4.18.2"
   },
   "devDependencies": {
-    "@polkadot/types": "^10.9.1",
+    "@polkadot/types": "^15.0.1",
     "@types/express": "^4.17.17"
   }
 }

src/calculators/staking-roi.js

@@ -6,13 +6,16 @@ import { DECIMALS } from '../consts.js';
 // era_payout = total_issuance * inflation_per_era
 
 export async function stakingRoi() {
-    const lastEra = (await api.query.staking.currentEra()).toHuman();
+  const lastEra = (await api.query.staking.currentEra()).unwrap().toNumber();
 
-    const inflationPerEra = (await api.query.staking.erasValidatorReward(lastEra - 2)).toJSON();
-    const totalStaked = await api.query.staking.erasTotalStake(lastEra - 2);
-    const totalIssuance = await totalSupply();
+  const inflationPerEra = (await api.query.staking.erasValidatorReward(lastEra - 2)).unwrap().toBigInt();
 
-    const roi = (totalIssuance * (inflationPerEra / 10 ** DECIMALS)) / (totalStaked / 10 ** DECIMALS) * 730;
+  const totalStaked = (await api.query.staking.erasTotalStake(lastEra - 2)).toBigInt();
 
-    return (roi / 10 ** 8)
+  const totalIssuance = BigInt(await totalSupply());
+
+  const roi =
+    ((totalIssuance * (inflationPerEra / BigInt(10 ** DECIMALS))) / (totalStaked / BigInt(10 ** DECIMALS))) * 730n;
+
+  return Number(roi / BigInt(10 ** 8));
 }

src/calculators/subscan.js

@@ -1,7 +1,7 @@
-import config from "../config.js";
-import {api} from "../node.js";
+import config from '../config.js';
+import { api } from '../node.js';
 
-const SUBSCAN_URL = 'https://vara.api.subscan.io'
+const SUBSCAN_URL = 'https://vara.api.subscan.io';
 const ONE_HOUR = 60 * 60 * 1000;
 const PAGE_ROWS = 100;
 
@@ -26,36 +26,35 @@ const exchangeAddresses = [
   'kGgvxgM2sJF7fWUze3fNWBWzy5momsyna7XF8MFzAWPhj2WpU',
   'kGiVY7G1mJkqaAjKzLnRmwCy5GcvuGQvG5mUtojhVHdLfBd1P',
   'kGga7DgxzLLTqn9WjtEZW5pkxYVnBPS4Rt6xK3Adqs1iKN42z',
-]
+];
 
 function getVestExtrinsicPaginated(page, lastBlockNumber, type) {
   return fetch(`${SUBSCAN_URL}/api/v2/scan/extrinsics`, {
     method: 'POST',
     headers: HEADERS,
     body: JSON.stringify({
-      "module": "vesting",
-      "call": type,
-      "block_range": `${minBlock}-${lastBlockNumber}`,
-      "row": PAGE_ROWS,
-      "page": page,
-    })
-  })
-    .then(response => {
-      if (!response.ok) {
-        return response.json().then(err => {
-          throw err;
-        });
-      }
-      return response.json();
-    });
+      module: 'vesting',
+      call: type,
+      block_range: `${minBlock}-${lastBlockNumber}`,
+      row: PAGE_ROWS,
+      page: page,
+    }),
+  }).then((response) => {
+    if (!response.ok) {
+      return response.json().then((err) => {
+        throw err;
+      });
+    }
+    return response.json();
+  });
 }
 
 async function getVestExtrinsic(type, lastBlockNumber) {
   let page = 0;
   let extrinsics = [];
   let res = await getVestExtrinsicPaginated(page, lastBlockNumber, type);
   while (res.data?.extrinsics?.length > 0) {
-    extrinsics.push(...res.data.extrinsics.map(s => s.extrinsic_index));
+    extrinsics.push(...res.data.extrinsics.map((s) => s.extrinsic_index));
     page++;
     res = await getVestExtrinsicPaginated(page, lastBlockNumber, type);
   }
@@ -69,19 +68,17 @@ async function getExchangeAddresses(lastBlockNumber) {
       method: 'POST',
       headers: HEADERS,
       body: JSON.stringify({
-        "address": address,
-        "direction": "all",
-        "order": "asc",
-        "include_total": true,
-        "page": 0,
-        "row": 1,
-        "block_range": `${minBlock}-${lastBlockNumber}`,
-        "success": true,
-        "token_category": [
-          "native"
-        ]
-      })
-    }).then(response => response.json());
+        address: address,
+        direction: 'all',
+        order: 'asc',
+        include_total: true,
+        page: 0,
+        row: 1,
+        block_range: `${minBlock}-${lastBlockNumber}`,
+        success: true,
+        token_category: ['native'],
+      }),
+    }).then((response) => response.json());
     sum += BigInt(res?.data?.total?.VARA?.sent ?? 0n);
   }
   return sum;
@@ -95,13 +92,12 @@ export async function getUnvested() {
 }
 
 async function updateUnvested() {
-  const lastBlockResult = await api.rpc.chain.getBlock()
+  const lastBlockResult = await api.rpc.chain.getBlock();
   const lastBlockNumber = lastBlockResult.block.header.number.toBigInt();
-  const extrinsics = await Promise.all(
-    [
-      getVestExtrinsic("vest", lastBlockNumber),
-      getVestExtrinsic("vest_other", lastBlockNumber),
-    ]).then(res => res.flat());
+  const extrinsics = await Promise.all([
+    getVestExtrinsic('vest', lastBlockNumber),
+    getVestExtrinsic('vest_other', lastBlockNumber),
+  ]).then((res) => res.flat());
   let unvested = cachedValue;
   console.log('found extrinsics: ', extrinsics.length);
   for (const extrinsicIndex of extrinsics) {
@@ -110,18 +106,19 @@ async function updateUnvested() {
         method: 'POST',
         headers: HEADERS,
         body: JSON.stringify({
-          "extrinsic_index": extrinsicIndex,
+          extrinsic_index: extrinsicIndex,
         }),
-      }).then(response => response.json());
-      const vestingEvents = extrinsicRes.data?.event?.filter(e => {
-        return e.module_id?.toLowerCase() === 'balances' && e.event_id?.toLowerCase() === 'unlocked';
-      }) ?? [];
+      }).then((response) => response.json());
+      const vestingEvents =
+        extrinsicRes.data?.event?.filter((e) => {
+          return e.module_id?.toLowerCase() === 'balances' && e.event_id?.toLowerCase() === 'unlocked';
+        }) ?? [];
       for (let e of vestingEvents) {
         try {
           const params = JSON.parse(e.params) ?? [];
-          const unvestedParams = params.filter(p => p.name === "amount");
+          const unvestedParams = params.filter((p) => p.name === 'amount');
           for (let un of unvestedParams) {
-            unvested += BigInt(un.value)
+            unvested += BigInt(un.value);
           }
         } catch (e) {
           console.error(`failed to calculate unvested because of`, e);

src/config.js

@@ -19,6 +19,6 @@ export default {
     port: Number(getEnv('PORT', '3000')),
   },
   subscan: {
-    apiKey: getEnv('SUBSCSCAN_KEY'),
+    apiKey: getEnv('SUBSCAN_KEY'),
   },
 };

src/server.js

@@ -7,7 +7,7 @@ import {
   tokensSentFromInflationPool,
   totalSupply,
   totalVesting,
-  stakingRoi
+  stakingRoi,
 } from './calculators/index.js';
 
 const app = express();
@@ -32,14 +32,14 @@ app.get('/api/total', async (req, res) => {
     });
 });
 
-app.get('/api/total-staking', async (req, res) => {
-  totalStaking()
-    .then((result) => res.json(result))
-    .catch((err) => {
-      console.error(err);
-      res.sendStatus(500);
-    });
-});
+// app.get('/api/total-staking', async (req, res) => {
+//   totalStaking()
+//     .then((result) => res.json(result))
+//     .catch((err) => {
+//       console.error(err);
+//       res.sendStatus(500);
+//     });
+// });
 
 app.get('/api/total-vesting', async (req, res) => {
   totalVesting()

test.js

@@ -0,0 +1,26 @@
+const endpoints = ['/api/burned', '/api/total', '/api/total-vesting', '/api/circulating-supply', '/api/roi'];
+
+const test = async () => {
+  for (const endpoint of endpoints) {
+    const res = await fetch(new URL(endpoint, 'http://127.0.0.1:3000'));
+
+    if (!res.ok) {
+      throw new Error(`Failed to fetch ${endpoint}`);
+    }
+
+    const data = await res.text();
+
+    if (Number(data) === NaN) {
+      throw new Error(`Failed to parse ${endpoint}. ${data}`);
+    }
+
+    console.log(endpoint, '- ok');
+  }
+};
+
+test()
+  .catch((e) => {
+    console.error(e);
+    process.exit(1);
+  })
+  .then(() => process.exit(0));