feat: add more information to the treasury report

Author: fabianbormann

.github/workflows/publish.yaml

@@ -40,14 +40,15 @@ jobs:
       - name: 🍀 Generate .env file
         run: |
           echo "SPRING_PROFILES_ACTIVE=ci" >> src/test/resources/.env
+          echo "RUN_MODE=plot" >> src/test/resources/.env
           echo "JSON_DATA_SOURCE_FOLDER=./rewards-calculation-test-data" >> src/test/resources/.env
 
       - name: Build
         run: |
           mvn --batch-mode --update-snapshots clean package -DskipTests && mv target/rewards-*.jar target/rewards-calculation.jar
 
       - name: 📊 Generate plots
-        run: java -jar target/rewards-calculation.jar --action=plot
+        run: java -jar target/rewards-calculation.jar
 
       - name: JSON result to js file
         run: |

pom.xml

@@ -44,8 +44,9 @@
   <properties>
     <version.java>17</version.java>
     <version.lombok>1.18.26</version.lombok>
-    <version.koios-java-client>1.17.2</version.koios-java-client>
+    <version.koios-java-client>1.18.1</version.koios-java-client>
     <version.spring-boot>3.1.3</version.spring-boot>
+    <version.spring-dotenv>4.0.0</version.spring-dotenv>
     <version.flyway>9.16.0</version.flyway>
     <version.h2>2.2.220</version.h2>
     <version.jacoco-maven-plugin>0.8.8</version.jacoco-maven-plugin>
@@ -96,7 +97,7 @@
     <dependency>
       <groupId>me.paulschwarz</groupId>
       <artifactId>spring-dotenv</artifactId>
-      <version>4.0.0</version>
+      <version>${version.spring-dotenv}</version>
     </dependency>
 
     <dependency>

report/index.js

@@ -18,7 +18,7 @@ window.onload = () => {
         connectgaps: true,
         line: {
             color: '#5C8DFF'
-        } 
+        }
     }
 
     const difference = {
@@ -29,7 +29,7 @@ window.onload = () => {
         connectgaps: true,
         line: {
             color: '#1EC198'
-        } 
+        }
     }
 
     const relativeDifference = {
@@ -40,13 +40,18 @@ window.onload = () => {
         connectgaps: true,
         line: {
             color: '#1EC198'
-        } 
+        }
     }
 
     const lovelaceToAda = (lovelace) => {
         return Math.round(lovelace / 1000000);
     }
 
+    const formatAda = (ada) => {
+        const amount = ada.toLocaleString();
+        return `${amount === '-0' ? '0' : amount}₳`;
+    }
+
     const treasuryCalculationTable = document.getElementById('treasury-calculation-table');
 
     for (const epoch of Object.keys(treasuryCalculationResult)) {
@@ -61,7 +66,7 @@ window.onload = () => {
 
         relativeDifference.x.push(epoch);
         relativeDifference.y.push(
-            Math.round(
+            epoch === "208" ? 0 : Math.round(
                 (Math.abs(treasuryCalculationResult[epoch].actualTreasury - treasuryCalculationResult[epoch].calculatedTreasury) /
                 Math.abs((treasuryCalculationResult[epoch].actualTreasury + treasuryCalculationResult[epoch].calculatedTreasury) / 2) * 100) * 1000) / 1000
         );
@@ -70,10 +75,10 @@ window.onload = () => {
         const row = document.createElement('tr');
         row.innerHTML = `
             <td>${epoch}</td>
-            <td>${lovelaceToAda(treasuryCalculationResult[epoch].actualTreasury)}₳</td>
-            <td>${lovelaceToAda(treasuryCalculationResult[epoch].calculatedTreasury)}₳</td>
-            <td>${differenceAbsolut}₳</td>
-            <td>${Math.round(
+            <td>${formatAda(lovelaceToAda(treasuryCalculationResult[epoch].actualTreasury))}</td>
+            <td>${formatAda(lovelaceToAda(treasuryCalculationResult[epoch].calculatedTreasury))}</td>
+            <td>${formatAda(differenceAbsolut)}</td>
+            <td>${epoch === "208" ? 0 : Math.round(
                 (Math.abs(treasuryCalculationResult[epoch].actualTreasury - treasuryCalculationResult[epoch].calculatedTreasury) /
                 Math.abs((treasuryCalculationResult[epoch].actualTreasury + treasuryCalculationResult[epoch].calculatedTreasury) / 2) * 100) * 1000) / 1000
             }%</td>
@@ -87,6 +92,45 @@ window.onload = () => {
         treasuryCalculationTable.appendChild(row);
     }
 
+    const treasuryDevelopmentTable = document.getElementById('treasury-development-table');
+
+    let totalAdaAddedToTreasury = 0.0;
+    let totalAdaWithdrawledFromTreasury = 0.0;
+    let totalAdaAddedOnTopOfTreasuryCut = 0.0;
+
+    for (const epoch of Object.keys(treasuryCalculationResult)) {
+        const currentEpochTreasury = treasuryCalculationResult[epoch].actualTreasury;
+        const previousEpochTreasury = treasuryCalculationResult[epoch - 1]?.actualTreasury;
+
+        if (previousEpochTreasury === undefined) {
+            continue;
+        }
+
+        const totalRewardPot = treasuryCalculationResult[epoch].totalRewardPot;
+        const treasuryWithdrawals = treasuryCalculationResult[epoch].treasuryWithdrawals;
+        totalAdaWithdrawledFromTreasury += treasuryWithdrawals;
+        const adaAddedToTreasury = (currentEpochTreasury + treasuryWithdrawals) - previousEpochTreasury;
+        totalAdaAddedToTreasury += adaAddedToTreasury;
+        const percentageAddedToTreasury = Math.round(adaAddedToTreasury / totalRewardPot * 100 * 1000) / 1000;
+        
+        const tauParameter = 0.2;
+        const treasuryCut = tauParameter * totalRewardPot;
+        const adaAddedOnTopOfTreasuryCut = adaAddedToTreasury - treasuryCut;
+        totalAdaAddedOnTopOfTreasuryCut += adaAddedOnTopOfTreasuryCut;
+
+        const row = document.createElement('tr');
+        row.innerHTML = `
+            <td>${epoch}</td>
+            <td>${formatAda(lovelaceToAda(adaAddedToTreasury))}</td>
+            <td>${formatAda(lovelaceToAda(totalRewardPot))}</td>
+            <td>${percentageAddedToTreasury}%</td>
+            <td>${formatAda(lovelaceToAda(adaAddedOnTopOfTreasuryCut))}</td>
+            <td>${formatAda(lovelaceToAda(treasuryWithdrawals))}</td>
+        `;
+
+        treasuryDevelopmentTable.appendChild(row);
+    }
+
     const layoutAda = {
         title: 'Treasury Calculation & Actual Values',
         showlegend: false,
@@ -100,7 +144,7 @@ window.onload = () => {
             showline: false
         }
     };
-    
+
     const layoutAdaDifference = {
         title: 'Treasury Calculation - Difference in ADA',
         showlegend: false,
@@ -134,7 +178,7 @@ window.onload = () => {
     Plotly.newPlot('difference-percentage-plot', [relativeDifference], layoutPercentage);
 
     const epochInfo = document.getElementById('epoch-info');
-    const epochs = Object.keys(treasuryCalculationResult).map((epoch) => Number(epoch)); 
+    const epochs = Object.keys(treasuryCalculationResult).map((epoch) => Number(epoch));
     const epochStart = Math.min(...epochs);
     const epochEnd = Math.max(...epochs);
     epochInfo.innerHTML = `Epoch ${epochStart} - ${epochEnd}`;
@@ -156,13 +200,13 @@ window.onload = () => {
 
     const highestAbsolutDifference = Math.max(...difference.y);
     const highestAbsolutDifferenceEpoch = difference.x[difference.y.indexOf(highestAbsolutDifference)];
-    fillCard('highest-absolut-difference', 'Highest absolut difference', `${highestAbsolutDifference}₳`, `Epoch ${highestAbsolutDifferenceEpoch}`);
+    fillCard('highest-absolut-difference', 'Highest absolut difference', `${highestAbsolutDifference.toLocaleString()}₳`, `Epoch ${highestAbsolutDifferenceEpoch}`);
 
     const averageDifferenceMedian = relativeDifference.y.sort((a, b) => a - b)[Math.round(relativeDifference.y.length / 2)];
     fillCard('average-difference-percentage', 'Average relative difference', `${averageDifferenceMedian}%`, 'Median');
 
     const averageAbsolutDifferenceMedian = difference.y.sort((a, b) => a - b)[Math.round(difference.y.length / 2)]
-    fillCard('average-absolut-difference', 'Average absolut difference', `${averageAbsolutDifferenceMedian}₳`, 'Median');
+    fillCard('average-absolut-difference', 'Average absolut difference', `${averageAbsolutDifferenceMedian.toLocaleString()}₳`, 'Median');
 
     const absolutDifferences = difference.y.map((difference) => Math.abs(difference));
 
@@ -175,4 +219,8 @@ window.onload = () => {
     fillCard('difference-5k-10k-ADA', 'Difference between 5k₳ and 10k₳', `${absolutDifferences.filter((difference) => difference >= 5000 && difference < 10000).length}`, '');
     fillCard('difference-10k-50k-ADA', 'Difference between 10k₳ and 50k₳', `${absolutDifferences.filter((difference) => difference >= 10000 && difference < 50000).length}`, '');
     fillCard('difference-above-50k-ADA', 'Difference above 50k₳', `${absolutDifferences.filter((difference) => difference >= 50000).length}`, '');
+
+    fillCard('ada-added-to-treasury', 'Total ADA added to treasury', `${formatAda(lovelaceToAda(totalAdaAddedToTreasury))}`, '');
+    fillCard('ada-withdrawled-from-treasury', 'Total ADA withdrawled from treasury', `${formatAda(lovelaceToAda(totalAdaWithdrawledFromTreasury))}`, '');
+    fillCard('total-ada-added-on-top-of-treasury-cut', 'Total ADA added on top of treasury cut', `${formatAda(lovelaceToAda(totalAdaAddedOnTopOfTreasuryCut))}`, '');
 };

report/treasury_calculation.html

@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
+
 <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1" />
@@ -77,6 +78,7 @@
         table {
             border-collapse: collapse;
             width: 100%;
+            overflow: scroll;
             text-align: center;
             vertical-align: middle;
         }
@@ -89,13 +91,13 @@
             background-color: #F6C667 !important;
         }
 
-        td, th {
+        td,
+        th {
             padding: 8px;
         }
 
         .table-container {
             width: 100%;
-            overflow: scroll;
             background-color: #fff;
             padding: 16px;
             border-radius: 12px;
@@ -106,11 +108,12 @@
         }
     </style>
 </head>
+
 <body>
     <div id="content">
         <h2>Treasury Calculation Report</h2>
         <h4 id="epoch-info"></h4>
-        <div class="cards" >
+        <div class="cards">
             <div class="card" id="highest-difference-percentage"></div>
             <div class="card" id="average-difference-percentage"></div>
             <div class="card" id="highest-absolut-difference"></div>
@@ -147,7 +150,32 @@ <h4 id="epoch-info"></h4>
             </table>
         </div>
 
-        <footer></footer>
-    </div>
+        <h3>Treasury Development</h3>
+
+        <div class="table-container">
+            <table>
+                <thead>
+                    <tr>
+                        <th>Epoch</th>
+                        <th>ADA Added to Treasury</th>
+                        <th>Total Rewards Pot Size</th>
+                        <th>% Added to Treasury from Total Rewards Pot</th>
+                        <th>ADA Added on Top of Treasury Cut (PoolReap, etc.)</th>
+                        <th>ADA Removed from Treasury (MIR Cert)</th>
+                    </tr>
+                </thead>
+                <tbody id="treasury-development-table">
+                </tbody>
+            </table>
+
+            <footer></footer>
+        </div>
+
+        <div class="cards">
+            <div class="card" id="ada-added-to-treasury"></div>
+            <div class="card" id="ada-withdrawled-from-treasury"></div>
+            <div class="card" id="total-ada-added-on-top-of-treasury-cut"></div>
+        </div>
 </body>
+
 </html>

report/treasury_calculation_result.js

@@ -1,9 +1,9 @@
 package org.cardanofoundation.rewards;
 
-import org.cardanofoundation.rewards.data.fetcher.DataFetcher;
 import org.cardanofoundation.rewards.data.fetcher.DbSyncDataFetcher;
 import org.cardanofoundation.rewards.data.fetcher.KoiosDataFetcher;
 import org.cardanofoundation.rewards.data.plotter.JsonDataPlotter;
+import org.checkerframework.checker.units.qual.A;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -25,50 +25,73 @@
 public class RewardsApplication implements ApplicationRunner {
   private static final Logger logger = LoggerFactory.getLogger(RewardsApplication.class);
 
+  @Value("${application.run.mode}")
+  private String runMode;
+
+  @Value("${application.fetch.override}")
+  private boolean overrideFetchedData;
+
+  @Value("${spring.profiles.active:Unknown}")
+  private String activeProfiles;
+
+  @Value("${json.data-provider.source}")
+  private String sourceFolder;
+
   @Autowired
   private ApplicationContext context;
 
+  @Autowired
+  private JsonDataPlotter jsonDataPlotter;
+
+  @Autowired
+  private KoiosDataFetcher koiosDataFetcher;
+
+  @Autowired
+  private DbSyncDataFetcher dbSyncDataFetcher;
+
   public static void main(String[] args) {
     SpringApplication.run(RewardsApplication.class, args);
   }
 
   @Override
   public void run(ApplicationArguments args) throws Exception {
-    for (String name : args.getOptionNames()) {
-      if (name.equals("action")) {
-        List<String> action = args.getOptionValues("action");
-        if (action == null || action.isEmpty()) {
-          logger.warn("No action specified. Example usage: --action=fetch --override");
-          int exitCode = SpringApplication.exit(context, (ExitCodeGenerator) () -> 0);
-          System.exit(exitCode);
-        }
-
-        if (action.get(0).equals("fetch")) {
-          boolean override = args.containsOption("override");
-          KoiosDataFetcher dataFetcher = new KoiosDataFetcher();
-          DbSyncDataFetcher dbSyncDataFetcher = new DbSyncDataFetcher();
-          for (int epoch = 208; epoch < 460; epoch++) {
-            logger.info("Fetching data for epoch " + epoch);
-            dataFetcher.fetch(epoch, override);
-            dbSyncDataFetcher.fetch(epoch, override);
+
+      if (runMode == null) {
+        logger.warn("No run mode specified. Set the environment variable RUN_MODE in your .env file to 'fetch' or 'plot' or 'test'");
+        int exitCode = SpringApplication.exit(context, (ExitCodeGenerator) () -> 0);
+        System.exit(exitCode);
+      }
+
+      int startEpoch = 208;
+      int endEpoch = 464;
+
+      if (runMode.equals("fetch")) {
+          boolean override = overrideFetchedData;
+          logger.info("Override fetched data: " + override);
+
+          if (activeProfiles.contains("db-sync")) {
+            logger.info("DB Sync data provider is active. Fetching data from DB Sync...");
+
+            for (int epoch = startEpoch; epoch < endEpoch; epoch++) {
+              logger.info("Fetching data for epoch with the DB sync data provider " + epoch);
+              dbSyncDataFetcher.fetch(epoch, override);
+            }
+          }
+
+          for (int epoch = startEpoch; epoch < endEpoch; epoch++) {
+            logger.info("Fetching data for epoch with the Koios data provider " + epoch);
+            koiosDataFetcher.fetch(epoch, override);
           }
-        } else if (action.get(0).equals("plot")) {
-          int epochStart = 210;
-          int epochEnd = 460;
-          JsonDataPlotter dataPlotter = new JsonDataPlotter();
-            dataPlotter.plot(epochStart, epochEnd);
-        } else {
-          logger.warn("Unknown action: " + action.get(0));
-        }
-      } else {
-        logger.warn("Unknown option: " + name);
+      } else if (runMode.equals("plot")) {
+        jsonDataPlotter.plot(startEpoch, endEpoch);
+      } else if (!runMode.equals("test")) {
+          logger.warn("Unknown run mode: " + runMode);
       }
-    }
 
-    if (!args.getOptionNames().isEmpty()) {
-      logger.warn("Finished actions. Exiting...");
-      int exitCode = SpringApplication.exit(context, () -> 0);
-      System.exit(exitCode);
-    }
+      if (!runMode.equals("test")) {
+          logger.info("Done. Exiting...");
+          int exitCode = SpringApplication.exit(context, () -> 0);
+          System.exit(exitCode);
+      }
   }
 }