This project is aims to target multiple goals. First of all, it tries to re-implement the cardano ledger rules for calculating the ADA pots (Treasury, Reserves, Rewards, Deposits, Utxo, Fees), as well as the rewards for stake pool operators and delegators. The second goal is to use this implementation to validate the rewards calculation of the Cardano blockchain by providing a different implementation of the ledger specification. The third goal is to provide a library that can be used in other project (such as yaci-store) to serve the rewards data independently of DB Sync. Last but not least, this project could also be used to understand the influence of protocol parameters and the flow of ADA through an interactive report.
To ensure the stability and reliability of this project, unit tests have been implemented. By clicking on the link below, you can access the detailed test report. We also generate for each version of this project calculation reports. These reports are generated by the unit tests and contain the calculation results compared to the actual values.
📈 Treasury Calculation Report 📊 Coverage Report
flowchart
A[Total Transaction Fees <br />at Epoch n] --> B[Total Reward Pot <br />at Epoch n]
B --> | treasuryGrowthRate | C[Treasury]
B --> | 1 - treasuryGrowthRate | D[Stake Pool Rewards Pot <br />at Epoch n]
subgraph ADA_POTS[" "]
D --> | Unclaimed Rewards | E["ADA Reserves<br /> (monetary expansion) <br /> Started at ~14B ADA"]
E --> | monetaryExpandRate * Performance of all Stake Pools | B
C --> F[Payouts e.g. for <br />Project Catalyst]
D --> | Rewards Equation<br /> for Pool 1 | G[Stake Pool 1]
D --> | ewards Equation<br /> for Pool 2 | H[Stake Pool 2]
D --> I[...]
D --> | Rewards Equation<br /> for Pool n | J[Stake Pool n]
J --> | margin & minPoolCost | K[Operators]
J --> | rewards | L[Delegators]
D --> | Rewards going to<br /> de-registered<br /> stake addresses | C
L <--> | Stake Key Registrations + <br /> Deregistrations | M[Deposits]
K <--> | Stake Pool Registrations + <br /> Deregistrations | M
M --> | Unclaimed Refunds for Retired Pools | C
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
While the flowchart above shows the calculation of the Ada pots in general, there are some more aspects that need to be considered:
- The point in time 🕑. The reward calculation starts at slot
(4 * 2160) / 0.05) = 172800(48h) each epoch. Before the Babbage era, accounts that were de-registered before this point in time were not considered for the rewards calculation.
This means that the rewards for the de-registered stake addresses are not considered in the rewards calculation. Those rewards were not distributed and went therefore back to the reserves. Accounts that deregistered after this point in time, but before the end of the epoch, were considered for the rewards calculation. But as it is not possible to send rewards to a de-registered stake address, the rewards went back to the treasury. - At the Allegra hard fork, the (pre-Shelley) bootstrap addresses were removed from the UTxO and the Ada contained in them was returned to the reserves.
- There was a different behavior (pre-Allegra): If a pool reward address had been used for multiple pools, the stake account only received the reward for one of those pools and did also not get any member rewards. This behavior has changed in mainnet epoch 236 with the Allegra hard fork. Now, the stake account receives the rewards for all pools (including member rewards).
- Transaction fees and a part of the reserve is used to build the total reward pot. It is often mentioned that
the monetary expansion rate (protocol parameter) is used to calculate the part coming from the reserves.
While this is true, the actual calculation is a multiplication of the monetary expansion rate and the performance of all stake pools
eta.Etais the ratio of the blocks produced by pools in an epoch and the expected blocks(432000 slots per epoch / 20 sec per block = 21600). With beginning of Shelly the blocks were produced by OBFT nodes and not by pools. Therefore, the performance of all stake pools would be 0. The decentralization parameterdhas been introduced to slightly increase the amount of expected blocks produced by pools. In the time whendwas above 0.8etawas set to 1.0.ddecreased over time from 1.0 to 0.0 and disappeared completely with the Vasil hard fork. - The pool deposit is currently 500 Ada. This deposit will be returned (on the next epoch boundary) to the pool reward address when the pool is retired. However, if the deposit could not be returned (e.g. because the pool reward address is de-registered), the deposit will be added to the treasury instead.
- Pool updates override pool deregistrations. This means that if a pool is updated before the end of the epoch, the pool will not be retired and the deposit will not be returned.
You can use this project as a library in your own project. The library is available through maven central, or you can clone the repository and run the tests or build the library yourself.
<dependency>
<groupId>org.cardanofoundation</groupId>
<artifactId>cf-rewards-calculation</artifactId>
<version>0.14.0</version>
</dependency>Make sure to have Java 17 installed and run the following commands:
git clone https://github.com/cardano-foundation/cf-java-rewards-calculation.git
cd cf-java-rewards-calculation
./mvnw clean test
In the near future you can use the calculation part of this repository as a library in your own project as it will be accessible through maven central.
For now the structure of the repository is divided in two parts:
-
calculation package
-
validation package
While the calculation package is used as a pure re-implementation of the ledger specification, the validation package is used to get the needed data (e.g. registration/deregistration certificates, epoch stakes, etc.) from the data provider and execute the calculation. Furthermore, the validation package is used to compare the calculated values with the actual values using DB Sync as ground truth.
The pool rewards calculation and also the treasury calculation requires a data provider to perform the calculation. This repository offers different data providers and also an interface if you want to add your own provider. The following data providers are available:
The data fetcher is used to fetch the data from the data provider and put it into local json files. These files can be used to perform the calculation using the JSON Data Provider. The following data fetchers are available:
To make the application fetching the data, create an .env file with the following content in the validation resources folder:
SPRING_PROFILES_ACTIVE=db-sync
RUN_MODE=fetch
OVERWRITE_EXISTING_DATA=false
DATA_FETCHER_START_EPOCH=<start-epoch>
DATA_FETCHER_END_EPOCH=<end-epoch>
DATA_FETCHER_SKIP_VALIDATION_DATA=<true|false>
POSTGRES_USER=<username>
POSTGRES_PASSWORD=<password>
POSTGRES_DB=cexplorer
JSON_DATA_SOURCE_FOLDER=/path/to/your/rewards-calculation-test-data
Note
️ The actual rewards data will also be fetched when setting DATA_FETCHER_SKIP_VALIDATION_DATA=false, but it is only used from the validator and not within the calculation itself.`
The data plotter is used to generate the report. The following data plotters are available:
To use the application to make the report, create an .env file with the following content in the validation resources folder:
SPRING_PROFILES_ACTIVE=json
RUN_MODE=plot
JSON_DATA_SOURCE_FOLDER=/path/to/your/rewards-calculation-test-data
- Enhance reporting and add values for the other pots as well. Display the flow of Ada within an epoch
- Add a
/docsfolder containing parsable Markdown files to explain MIR certificates and edge cases - Provide a library through maven central to use the calculation in other projects
- Find out the root cause of the difference between the actual rewards and the calculated rewards beginning with epoch 350
- Include MIR certificates
- Calculate member and operator rewards
- Add deposits and utxo pot
- Calculate unclaimed rewards that need to go back to the reserves
- Put rewards to unregistered stake addresses into the treasury