Merge pull request #4 from cardano-foundation/release-please--branches--main

chore(main): release 0.0.2-SNAPSHOT

Author: fabianbormann

.github/workflows/publish.yaml

@@ -0,0 +1,73 @@
+name: Run Plot Action and Upload Results
+
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+
+jobs:
+  plot-and-publish:
+    runs-on: ubuntu-latest
+    if: |
+      "contains(github.event.head_commit.message, 'release-please--branches--main')" ||
+      ${{ github.event_name == 'pull_request' }}
+    steps:
+      - name: ⬇️ Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Setup JDK 18
+        uses: actions/setup-java@v3
+        with:
+          java-version: '18'
+          distribution: 'temurin'
+          cache: maven
+
+      - name: Setup dependencies
+        run: |
+          pip install yq
+
+      - 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
+
+      - name: JSON result to js file
+        run: |
+          echo -e "const treasuryCalculationResult = $(cat ./report/treasury_calculation_result.json)" > ./report/treasury_calculation_result.js
+        
+      - name: 👀 Lookup metadata for report
+        run: |
+          echo "VERSION=$(xq -r .project.version pom.xml)" >> $GITHUB_ENV
+          echo "LATEST_COMMIT_HASH=$(git rev-parse "$GITHUB_SHA")" >> $GITHUB_ENV
+          echo "LATEST_COMMIT_HASH_SHORT=$(git rev-parse --short "$GITHUB_SHA")" >> $GITHUB_ENV
+          echo "UTC_DATE=$(date -uR|sed 's/.....$//')" >> $GITHUB_ENV
+
+      - name: 📂 Create report directory
+        run: |
+          mkdir -p report-v${{ env.VERSION }}
+
+      - name: 📄 Copy report files
+        run: |
+          cp -r report/* report-v${{ env.VERSION }}
+
+      - name: 📝 Add metadata to the report
+        run: |
+          sed -i 's|<footer></footer>|<footer><p>Created on ${{ env.UTC_DATE }} UTC as a result of modifications triggered by <a href="https://github.com/cardano-foundation/cf-java-rewards-calculation/commit/${{ env.LATEST_COMMIT_HASH }}">${{ env.LATEST_COMMIT_HASH_SHORT }}</a></p></footer>|' report-v${{ env.VERSION }}/treasury_calculation.html
+
+      - name: 📅 Publish report to gh-pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          BRANCH: gh-pages
+          folder: report-v${{ env.VERSION }}
+          target-folder: report-latest/
+
+      - name: 📅 Publish report to gh-pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          BRANCH: gh-pages
+          folder: report-v${{ env.VERSION }}
+          target-folder: report-v${{ env.VERSION }}/

.gitignore

@@ -1,5 +1,4 @@
-HELP.md
-*
+
 !/**/
 !*.*
 target/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Cardano Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -10,6 +10,38 @@
 
 This java project is used to calculate the rewards of the Cardano network. It aims to be both an edge case documentation and formula implementation.
 
+📈 [Treasury Calculation Report](https://cardano-foundation.github.io/cf-java-rewards-calculation/report-latest/treasury_calculation.html)
+
+```mermaid
+flowchart
+    A[Total Transaction Fees <br />at Epoch n] --> B[<a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/main/java/org/cardanofoundation/rewards/calculation/TreasuryCalculation.java#L42'>Total Reward Pot <br />at Epoch n</a/>]
+    B --> | <a href='https://cips.cardano.org/cips/cip9/#updatableprotocolparameters'>treasuryGrowthRate</a> | C[<a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/main/java/org/cardanofoundation/rewards/calculation/TreasuryCalculation.java#L17'>Treasury</a/>]
+    B --> | 1 - <a href='https://cips.cardano.org/cips/cip9/#updatableprotocolparameters'>treasuryGrowthRate</a> | D[<a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/test/java/org/cardanofoundation/rewards/calculation/PoolRewardCalculationTest.java#L63'>Stake Pool Rewards Pot <br />at Epoch n</a/>]
+    subgraph ADA_POTS[" "]
+    D --> | Unclaimed Rewards | E["ADA Reserves<br /> (monetary expansion) <br /> Started at ~14B ADA"]
+    E --> | <a href='https://cips.cardano.org/cips/cip9/#updatableprotocolparameters'>monetaryExpandRate</a> * <a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/main/src/main/java/org/cardanofoundation/rewards/calculation/PoolRewardCalculation.java#L19'>apparent performance of all stake pools</a> | B
+    C --> F[Payouts e.g. for <br /><a href='https://projectcatalyst.io/'>Project Catalyst</a>]
+    D --> | <a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/main/java/org/cardanofoundation/rewards/calculation/PoolRewardCalculation.java#L87'>Rewards Equation<br /> for Pool 1</a> | G[Stake Pool 1]
+    D --> | <a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/main/java/org/cardanofoundation/rewards/calculation/PoolRewardCalculation.java#L87'>Rewards Equation<br /> for Pool 2</a> | H[Stake Pool 2]
+    D --> I[...]
+    D --> | <a href='https://github.com/cardano-foundation/cf-java-rewards-calculation/blob/a794130dc0e320426725a58b8b15f1fbe726b2de/src/main/java/org/cardanofoundation/rewards/calculation/PoolRewardCalculation.java#L87'>Rewards Equation<br /> for Pool n</a> | J[Stake Pool n]
+    end
+
+    style A fill:#5C8DFF,stroke:#5C8DFF
+    style B fill:#5C8DFF,stroke:#5C8DFF
+    style C fill:#1EC198,stroke:#1EC198
+    style D fill:#5C8DFF,stroke:#5C8DFF
+    style E fill:#1EC198,stroke:#1EC198
+
+    style F fill:#F6C667,stroke:#F6C667
+    style G fill:#F6C667,stroke:#F6C667
+    style H fill:#F6C667,stroke:#F6C667
+    style I fill:#F6C667,stroke:#F6C667
+    style J fill:#F6C667,stroke:#F6C667
+
+    style ADA_POTS fill:#f6f9ff,stroke:#f6f9ff
+```
+
 ## 🚀 Getting Started
 
 #### Prerequisites
@@ -30,3 +62,7 @@ To ensure the stability and reliability of this project, unit tests have been im
 
 📊 [Coverage Report](https://cardano-foundation.github.io/cf-java-rewards-calculation/coverage-report/)
 
+## 📖 Sources
+
+ - Beavr Cardano Stake Pool: [How is the Rewards Pot (R) Calculated](https://archive.ph/HQfoV/fb8166e31d2bf61d3d6ca769e7785f2a96530f8e.webp)
+ - Protocol Parameters: https://beta.explorer.cardano.org/en/protocol-parameters/