README and some fixes

README.md

@@ -0,0 +1,29 @@
+# Vara Network Economic Parameters
+
+Welcome to the Vara Network Economic Parameters repository. Here, you will find methods for retrieving crucial economic data related to the Vara Network, including:
+
+- Total Token Supply
+- Total Amount of Tokens Burned from the Inflation Pool
+- Total Circulating Supply
+
+## Overview
+
+Vara Network is a decentralized blockchain network with a unique economic model. To understand the details of this economic model, please refer to our [Tokenomics Documentation](https://wiki.vara-network.io/docs/tokenomics/).
+
+**API Endpoints**
+To obtain these parameters programmatically, you can use the following API endpoints:
+
+1. Total Tokens Burned
+Use this endpoint to retrieve information about tokens burned from the inflation pool.
+
+Endpoint: `/api/burned`
+
+2. Total Token Supply
+This endpoint provides data on the total token supply of Vara Network.
+
+Endpoint: `/api/total`
+
+3. Total Circulating Supply
+Get the current circulating supply of tokens on Vara Network using this endpoint.
+
+Endpoint: `/api/circulation`

src/calculators/circulation-supply.js

@@ -20,6 +20,7 @@ async function getKeys(prefix) {
   return result;
 }
 
+// Get all vested tokens from the chain
 async function vestingTotal() {
   const prefix = api.query.vesting.vesting.keyPrefix();
   const keys = await getKeys(prefix);
@@ -40,10 +41,13 @@ async function vestingTotal() {
   return Number(totalVesting);
 }
 
+// Get all pool addresses
+// Each pool additionally has 10 derived accounts (indexes from 1 to 10)
 function getPoolAddresses(poolAddr) {
   return [poolAddr, ...deriveAddr(poolAddr)];
 }
 
+// Circulation Supply = Total Supply - (Vesting + Pools);
 export async function circulationSupply() {
   const addresses = [
     ...getPoolAddresses(MARKETING_POOL),

src/server.js

@@ -8,7 +8,7 @@ const app = express();
 
 app.use(cors());
 
-app.get('/burnt', async (req, res) => {
+app.get('/burned', async (req, res) => {
   tokensSentFromInflationPool()
     .then((result) => res.json(result))
     .catch((err) => {