cardano-foundation / cf-java-rewards-calculation Goto Github PK

🚀 The feature and your motivation

Currently it is not possible to use this repository within other java-based projects like yaci-store or ledger-sync.

To overcome this situation, the rewards calculation part should be put on maven central allowing other java-based projects to reuse the calculation methods. We need to make sure not to include all the codebase, as this could bring unnecessary overhead to those projects.

Alternatives

Providing an API would also allow other projects to make use of the rewards calculation, but they would need to run the project somewhere aside to their application, which is maybe not wanted. We should anyways wrap this service in an api.

Additional context

No response

🚀 The feature and your motivation

The reserves pot calculation is currently still missing and needs to be implemented for all epochs, to implement eventually all ada pots calculations.

Alternatives

No response

Additional context

No response

Is there an existing issue for this?

• I have searched the existing issues

Current (incorrect 🙈) Behavior

For some epochs the UTXO pot calculation is 4 or -4 Lovelace off.

For the other epochs the formula utxoPot = utxoFromPreviousEpochPot - deposits - fees + withdrawals; seems to work pretty well.

With the other pot calculations we already prove that deposits and fee are aligned with their adapots table. So the issue must most probably come from the withdrawals table or some rule from the protocol that hasn't been implemented yet.

Expected Behavior (what you should have seen 🎉)

No response

Steps To Reproduce

1. Run the UTXO test in the tests folder

Environment

- OS:all
- Java JDK: all

Anything else?

No response

Is there an existing issue for this?

• I have searched the existing issues

Task description 🔨🔧

Currently we only provide a report for the treasury calculation, but with finishing the utxo, deposits and fees pot calculation, we should also provide a report for them as well.

Anything else?

No response

Is there an existing issue for this?

• I have searched the existing issues

Task description 🔨🔧

Even if the data used by the JSON data provider is aggregated and less than the data in DB Sync, it is growing and growing over time. It makes sense to remove this test data from the repository.

• Move the test data to an S3 bucket
• Provide a how to fetch the data
• Include the data folder in the .gitignore
• Remove those folders from the git history as well to reduce the disk size of this project
• Change the report generation and test pipeline to fetch the data on-the-fly from the bucket

Anything else?

No response

🚀 The feature and your motivation

With the current report, we provide the information about the calculated and the actual treasury value. Another interesting measure would be including the actual treasury cut 0.2 * totalRewardsPot and the amount of Lovelace being added on top of this value due to ledger rules such as PoolReap etc.

Alternatives

No response

Additional context

No response

Is there an existing issue for this?

• I have searched the existing issues

Task description 🔨🔧

The calculations of the pool, member and owner rewards are done but the rewards pot calculation is an open task that needs to be done, to finally implement all calculations for the ada pots.

Anything else?

No response

Is there an existing issue for this?

• I have searched the existing issues

Current (incorrect 🙈) Behavior

With the beginning of epoch 215, it seems that more ADA has been added to the treasury than calculated by the current treasury calculation. It probably comes from the fact, that (from the spec) remainders from the rewards pot should go into the treasury as well as member rewards going to unregistered stake accounts.

Expected Behavior (what you should have seen 🎉)

0 Lovelace difference between calculation and the actual treasury value provided by the ada_pots table from dbsync.

Steps To Reproduce

1. Run the TreasuryCalculationTest in the test folder with a range from 208-460 (epochs)

Environment

- OS: any
- Java JDK: any

Anything else?

No response