Skip to content

Commit cdef8ef

Browse files
fabianbormannfabianbormann
authored
Merge pull request #51 from cardano-foundation/feat/network_config
feat: introduce network config
2 parents 99ec3d0 + 832d58c commit cdef8ef

32 files changed

+426
-206
lines changed

‎calculation/.flattened-pom.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
<modelVersion>4.0.0</modelVersion>
55
<groupId>org.cardanofoundation</groupId>
66
<artifactId>cf-rewards-calculation</artifactId>
7-
<version>0.11.0</version>
7+
<version>0.11.1</version>
88
<name>cardano-reward-calculation</name>
99
<description>This project aims to be a cardano reward calculation, java formula implementation and edge case
1010
documentation</description>
11+
<url>https://github.com/cardano-foundation/cf-java-rewards-calculation.git</url>
1112
<organization>
1213
<name>Cardano Foundation</name>
1314
<url>https://cardanofoundation.org</url>

‎calculation/src/main/java/org/cardanofoundation/rewards/calculation/DepositsCalculation.java‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
package org.cardanofoundation.rewards.calculation;
22

3+
import org.cardanofoundation.rewards.calculation.config.NetworkConfig;
4+
35
import java.math.BigInteger;
4-
import static org.cardanofoundation.rewards.calculation.constants.RewardConstants.POOL_DEPOSIT_IN_LOVELACE;
56
import static org.cardanofoundation.rewards.calculation.util.BigNumberUtils.multiply;
67

78
public class DepositsCalculation {
89

910
public static BigInteger calculateDepositsInEpoch(BigInteger depositsInPreviousEpoch,
1011
BigInteger transactionDepositsInEpoch,
11-
int retiredPoolsInEpoch) {
12+
int retiredPoolsInEpoch,
13+
NetworkConfig networkConfig) {
1214
BigInteger deposits = BigInteger.ZERO;
1315
deposits = deposits.add(transactionDepositsInEpoch);
1416
deposits = deposits.subtract(
15-
multiply(retiredPoolsInEpoch, POOL_DEPOSIT_IN_LOVELACE));
17+
multiply(retiredPoolsInEpoch, networkConfig.getPoolDepositInLovelace()));
1618
return depositsInPreviousEpoch.add(deposits);
1719
}
1820
}

‎calculation/src/main/java/org/cardanofoundation/rewards/calculation/EpochCalculation.java‎

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.cardanofoundation.rewards.calculation;
22

3+
import org.cardanofoundation.rewards.calculation.config.NetworkConfig;
34
import org.cardanofoundation.rewards.calculation.domain.*;
45
import org.cardanofoundation.rewards.calculation.enums.MirPot;
56

@@ -11,7 +12,6 @@
1112
import java.util.stream.Collectors;
1213

1314
import static org.cardanofoundation.rewards.calculation.PoolRewardsCalculation.calculatePoolRewardInEpoch;
14-
import static org.cardanofoundation.rewards.calculation.constants.RewardConstants.*;
1515
import static org.cardanofoundation.rewards.calculation.util.BigNumberUtils.*;
1616
import lombok.extern.slf4j.Slf4j;
1717

@@ -31,10 +31,11 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
3131
final HashSet<String> registeredAccountsSinceLastEpoch,
3232
final HashSet<String> registeredAccountsUntilNow,
3333
final HashSet<String> sharedPoolRewardAddressesWithoutReward,
34-
final HashSet<String> deregisteredAccountsOnEpochBoundary) {
34+
final HashSet<String> deregisteredAccountsOnEpochBoundary,
35+
final NetworkConfig networkConfig) {
3536
final EpochCalculationResult epochCalculationResult = EpochCalculationResult.builder().epoch(epoch).build();
3637

37-
if (epoch < MAINNET_SHELLEY_START_EPOCH) {
38+
if (epoch < networkConfig.getShelleyStartEpoch()) {
3839
log.warn("Epoch " + epoch + " is before the start of the Shelley era. No rewards were calculated in this epoch.");
3940
epochCalculationResult.setReserves(BigInteger.ZERO);
4041
epochCalculationResult.setTreasury(BigInteger.ZERO);
@@ -43,13 +44,13 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
4344
epochCalculationResult.setTotalPoolRewardsPot(BigInteger.ZERO);
4445
epochCalculationResult.setTotalAdaInCirculation(BigInteger.ZERO);
4546
return epochCalculationResult;
46-
} else if (epoch == MAINNET_SHELLEY_START_EPOCH) {
47-
epochCalculationResult.setReserves(MAINNET_SHELLEY_INITIAL_RESERVES);
48-
epochCalculationResult.setTreasury(MAINNET_SHELLEY_INITIAL_TREASURY);
47+
} else if (epoch == networkConfig.getShelleyStartEpoch()) {
48+
epochCalculationResult.setReserves(networkConfig.getShelleyInitialReserves());
49+
epochCalculationResult.setTreasury(networkConfig.getShelleyInitialTreasury());
4950
epochCalculationResult.setTotalDistributedRewards(BigInteger.ZERO);
5051
epochCalculationResult.setTotalRewardsPot(BigInteger.ZERO);
5152
epochCalculationResult.setTotalPoolRewardsPot(BigInteger.ZERO);
52-
epochCalculationResult.setTotalAdaInCirculation(MAINNET_SHELLEY_INITIAL_UTXO);
53+
epochCalculationResult.setTotalAdaInCirculation(networkConfig.getShelleyInitialUtxo());
5354
return epochCalculationResult;
5455
}
5556

@@ -72,7 +73,7 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
7273

7374
final int blocksInEpoch = totalBlocksInEpoch;
7475
final BigInteger rewardPot = TreasuryCalculation.calculateTotalRewardPotWithEta(
75-
monetaryExpandRate, totalBlocksInEpoch, decentralizationParameter, reserveInPreviousEpoch, totalFeesForCurrentEpoch);
76+
monetaryExpandRate, totalBlocksInEpoch, decentralizationParameter, reserveInPreviousEpoch, totalFeesForCurrentEpoch, networkConfig);
7677

7778
final BigInteger treasuryCut = multiplyAndFloor(rewardPot, treasuryGrowthRate);
7879
BigInteger treasuryForCurrentEpoch = treasuryInPreviousEpoch.add(treasuryCut);
@@ -95,8 +96,8 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
9596
!ownerAccountsRegisteredInThePast.contains(rewardAddress)) {
9697
// If the reward address has been unregistered, the deposit can not be returned
9798
// and will be added to the treasury instead (Pool Reap see: shelley-ledger.pdf p.53)
98-
treasuryForCurrentEpoch = treasuryForCurrentEpoch.add(POOL_DEPOSIT_IN_LOVELACE);
99-
unclaimedRefunds = unclaimedRefunds.add(POOL_DEPOSIT_IN_LOVELACE);
99+
treasuryForCurrentEpoch = treasuryForCurrentEpoch.add(networkConfig.getPoolDepositInLovelace());
100+
unclaimedRefunds = unclaimedRefunds.add(networkConfig.getPoolDepositInLovelace());
100101
}
101102
}
102103
}
@@ -114,7 +115,7 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
114115

115116
treasuryForCurrentEpoch = treasuryForCurrentEpoch.subtract(treasuryWithdrawals);
116117
BigInteger totalDistributedRewards = BigInteger.ZERO;
117-
final BigInteger adaInCirculation = TOTAL_LOVELACE.subtract(reserveInPreviousEpoch);
118+
final BigInteger adaInCirculation = networkConfig.getTotalLovelace().subtract(reserveInPreviousEpoch);
118119
final List<PoolRewardCalculationResult> poolRewardCalculationResults = new ArrayList<>();
119120
BigInteger unspendableEarnedRewards = BigInteger.ZERO;
120121

@@ -146,15 +147,15 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
146147
// This is not the case anymore and the stake account receives the reward for all pools
147148
// Until the Allegra hard fork, this method will be used to emulate the old behavior
148149
boolean ignoreLeaderReward = false;
149-
if (epoch - 2 < MAINNET_ALLEGRA_HARDFORK_EPOCH) {
150+
if (epoch - 2 < networkConfig.getAllegraHardforkEpoch()) {
150151
ignoreLeaderReward = sharedPoolRewardAddressesWithoutReward.contains(poolId);
151152
}
152153

153154
poolRewardCalculationResult = calculatePoolRewardInEpoch(poolId, poolState,
154155
blocksInEpoch, protocolParameters,
155156
adaInCirculation, activeStakeInEpoch, stakePoolRewardsPot,
156157
poolState.getOwnerActiveStake(), poolState.getOwners(),
157-
delegatorAccountDeregistrations, ignoreLeaderReward, lateDeregisteredDelegators, registeredAccountsSinceLastEpoch);
158+
delegatorAccountDeregistrations, ignoreLeaderReward, lateDeregisteredDelegators, registeredAccountsSinceLastEpoch, networkConfig);
158159
}
159160

160161
totalDistributedRewards = add(totalDistributedRewards, poolRewardCalculationResult.getDistributedPoolReward());
@@ -167,15 +168,15 @@ public static EpochCalculationResult calculateEpochRewardPots(final int epoch,
167168
calculatedReserve = add(calculatedReserve, undistributedRewards);
168169
calculatedReserve = subtract(calculatedReserve, unspendableEarnedRewards);
169170

170-
if (epoch == MAINNET_ALLEGRA_HARDFORK_EPOCH) {
171+
if (epoch == networkConfig.getAllegraHardforkEpoch()) {
171172
/*
172173
"The bootstrap addresses from Figure 6 were not intended to include the Byron era redeem
173174
addresses (those with addrtype 2, see the Byron CDDL spec). These addresses were, however,
174175
not spendable in the Shelley era. At the Allegra hard fork they were removed from the UTxO
175176
and the Ada contained in them was returned to the reserves."
176177
- shelley-spec-ledger.pdf 17.5 p.115
177178
*/
178-
calculatedReserve = calculatedReserve.add(MAINNET_BOOTSTRAP_ADDRESS_AMOUNT);
179+
calculatedReserve = calculatedReserve.add(networkConfig.getBootstrapAddressAmount());
179180
}
180181

181182
log.debug("Unspendable earned rewards: " + unspendableEarnedRewards.longValue() + " Lovelace");

‎calculation/src/main/java/org/cardanofoundation/rewards/calculation/PoolRewardsCalculation.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
package org.cardanofoundation.rewards.calculation;
22

3+
import org.cardanofoundation.rewards.calculation.config.NetworkConfig;
34
import org.cardanofoundation.rewards.calculation.domain.*;
45

56
import java.math.BigDecimal;
67
import java.math.BigInteger;
78
import java.util.*;
89

9-
import static org.cardanofoundation.rewards.calculation.constants.RewardConstants.MAINNET_ALLEGRA_HARDFORK_EPOCH;
10-
import static org.cardanofoundation.rewards.calculation.constants.RewardConstants.MAINNET_VASIL_HARDFORK_EPOCH;
1110
import static org.cardanofoundation.rewards.calculation.util.BigNumberUtils.*;
1211
import static org.cardanofoundation.rewards.calculation.util.BigNumberUtils.divide;
1312

@@ -132,7 +131,8 @@ public static PoolRewardCalculationResult calculatePoolRewardInEpoch(final Strin
132131
final BigInteger totalActiveStakeOfOwners, final HashSet<String> poolOwnerStakeAddresses,
133132
final HashSet<String> deregisteredAccounts, final boolean ignoreLeaderReward,
134133
final HashSet<String> lateDeregisteredAccounts,
135-
final HashSet<String> accountsRegisteredInThePast) {
134+
final HashSet<String> accountsRegisteredInThePast,
135+
final NetworkConfig networkConfig) {
136136
final int earnedEpoch = poolStateCurrentEpoch.getEpoch();
137137
final PoolRewardCalculationResult poolRewardCalculationResult = PoolRewardCalculationResult.builder()
138138
.epoch(earnedEpoch)
@@ -149,7 +149,7 @@ public static PoolRewardCalculationResult calculatePoolRewardInEpoch(final Strin
149149
a reward update. As in the Shelley era, though, they are still filtered on the epoch boundary
150150
when the reward update is applied
151151
*/
152-
if (earnedEpoch >= MAINNET_VASIL_HARDFORK_EPOCH) {
152+
if (earnedEpoch >= networkConfig.getVasilHardforkEpoch()) {
153153
lateDeregisteredAccounts.addAll(deregisteredAccounts);
154154
deregisteredAccounts.clear();
155155
}
@@ -212,7 +212,7 @@ public static PoolRewardCalculationResult calculatePoolRewardInEpoch(final Strin
212212

213213
if (!accountsRegisteredInThePast.contains(rewardAddress)) {
214214
log.info(poolRewardCalculationResult.getRewardAddress() + " has never been registered. Operator would have received " + poolOperatorReward + " but will not receive any rewards.");
215-
if (earnedEpoch >= MAINNET_VASIL_HARDFORK_EPOCH) {
215+
if (earnedEpoch >= networkConfig.getVasilHardforkEpoch()) {
216216
unspendableEarnedRewards = poolOperatorReward;
217217
}
218218
poolOperatorReward = BigInteger.ZERO;
@@ -244,7 +244,7 @@ public static PoolRewardCalculationResult calculatePoolRewardInEpoch(final Strin
244244
shelley-ledger.pdf | 17.4 Reward aggregation | p. 114
245245
*/
246246
if (stakeAddress.equals(poolStateCurrentEpoch.getRewardAddress())
247-
&& earnedEpoch < MAINNET_ALLEGRA_HARDFORK_EPOCH) {
247+
&& earnedEpoch < networkConfig.getAllegraHardforkEpoch()) {
248248
continue;
249249
}
250250

‎calculation/src/main/java/org/cardanofoundation/rewards/calculation/TreasuryCalculation.java‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package org.cardanofoundation.rewards.calculation;
22

3+
import org.cardanofoundation.rewards.calculation.config.NetworkConfig;
34
import org.cardanofoundation.rewards.calculation.domain.*;
45
import org.cardanofoundation.rewards.calculation.enums.MirPot;
56

@@ -10,7 +11,6 @@
1011
import java.util.List;
1112
import java.util.stream.Collectors;
1213

13-
import static org.cardanofoundation.rewards.calculation.constants.RewardConstants.*;
1414
import static org.cardanofoundation.rewards.calculation.util.BigNumberUtils.*;
1515

1616
public class TreasuryCalculation {
@@ -21,10 +21,11 @@ public static TreasuryCalculationResult calculateTreasuryInEpoch(int epoch, Prot
2121
List<MirCertificate> mirCertificates,
2222
final HashSet<String> deregisteredAccounts,
2323
final HashSet<String> registeredAccountsUntilNow,
24-
BigInteger unspendableEarnedRewards) {
24+
BigInteger unspendableEarnedRewards,
25+
NetworkConfig networkConfig) {
2526
// The Shelley era and the ada pot system started on mainnet in epoch 208.
2627
// Fee and treasury values are 0 for epoch 208.
27-
if (epoch <= MAINNET_SHELLEY_START_EPOCH) {
28+
if (epoch <= networkConfig.getShelleyStartEpoch()) {
2829
return TreasuryCalculationResult.builder()
2930
.treasury(BigInteger.ZERO)
3031
.epoch(epoch)
@@ -54,7 +55,7 @@ public static TreasuryCalculationResult calculateTreasuryInEpoch(int epoch, Prot
5455
final BigInteger treasuryInPreviousEpoch = adaPotsForPreviousEpoch.getTreasury();
5556

5657
final BigInteger totalRewardPot = calculateTotalRewardPotWithEta(
57-
monetaryExpandRate, totalBlocksInEpoch, decentralizationParameter, reserveInPreviousEpoch, totalFeesForCurrentEpoch);
58+
monetaryExpandRate, totalBlocksInEpoch, decentralizationParameter, reserveInPreviousEpoch, totalFeesForCurrentEpoch, networkConfig);
5859

5960
final BigInteger treasuryCut = multiplyAndFloor(totalRewardPot, treasuryGrowthRate);
6061
BigInteger treasuryForCurrentEpoch = treasuryInPreviousEpoch.add(treasuryCut);
@@ -66,7 +67,7 @@ public static TreasuryCalculationResult calculateTreasuryInEpoch(int epoch, Prot
6667
List<String> ownerAccountsRegisteredInThePast = registeredAccountsUntilNow.stream()
6768
.filter(rewardAddressesOfRetiredPools::contains).toList();
6869

69-
unclaimedRefunds = calculateUnclaimedRefundsForRetiredPools(rewardAddressesOfRetiredPools, deregisteredRewardAccounts, ownerAccountsRegisteredInThePast);
70+
unclaimedRefunds = calculateUnclaimedRefundsForRetiredPools(rewardAddressesOfRetiredPools, deregisteredRewardAccounts, ownerAccountsRegisteredInThePast, networkConfig);
7071
treasuryForCurrentEpoch = treasuryForCurrentEpoch.add(unclaimedRefunds);
7172
}
7273

@@ -97,8 +98,8 @@ public static TreasuryCalculationResult calculateTreasuryInEpoch(int epoch, Prot
9798
* rewards(e) = 0, if e < 209
9899
*/
99100
public static BigInteger calculateTotalRewardPotWithEta(BigDecimal monetaryExpandRate, int totalBlocksInEpochByPools,
100-
BigDecimal decentralizationParameter, BigInteger reserve, BigInteger fee) {
101-
BigDecimal eta = calculateEta(totalBlocksInEpochByPools, decentralizationParameter);
101+
BigDecimal decentralizationParameter, BigInteger reserve, BigInteger fee, NetworkConfig networkConfig) {
102+
BigDecimal eta = calculateEta(totalBlocksInEpochByPools, decentralizationParameter, networkConfig);
102103
return multiplyAndFloor(reserve, monetaryExpandRate, eta).add(fee);
103104
}
104105

@@ -111,7 +112,7 @@ public static BigInteger calculateTotalRewardPotWithEta(BigDecimal monetaryExpan
111112
*
112113
* See: https://github.com/input-output-hk/cardano-ledger/commit/c4f10d286faadcec9e4437411bce9c6c3b6e51c2
113114
*/
114-
private static BigDecimal calculateEta(int totalBlocksInEpochByPools, BigDecimal decentralizationParameter) {
115+
private static BigDecimal calculateEta(int totalBlocksInEpochByPools, BigDecimal decentralizationParameter, NetworkConfig networkConfig) {
115116
// shelley-delegation.pdf 5.4.3
116117

117118
BigDecimal decentralisationThreshold = new BigDecimal("0.8");
@@ -120,12 +121,12 @@ private static BigDecimal calculateEta(int totalBlocksInEpochByPools, BigDecimal
120121
}
121122

122123
// The number of expected blocks will be the number of slots per epoch times the active slots coefficient
123-
BigDecimal activeSlotsCoeff = new BigDecimal(ACTIVE_SLOT_COEFFICIENT); // See: Non-Updatable Parameters: https://cips.cardano.org/cips/cip9/
124+
BigDecimal activeSlotsCoeff = BigDecimal.valueOf(networkConfig.getActiveSlotCoefficient()); // See: Non-Updatable Parameters: https://cips.cardano.org/cips/cip9/
124125

125126
// decentralizationParameter is the proportion of blocks that are expected to be produced by stake pools
126127
// instead of the OBFT (Ouroboros Byzantine Fault Tolerance) nodes. It was introduced close before the Shelley era:
127128
// https://github.com/input-output-hk/cardano-ledger/commit/c4f10d286faadcec9e4437411bce9c6c3b6e51c2
128-
BigDecimal expectedBlocksInNonOBFTSlots = new BigDecimal(EXPECTED_SLOTS_PER_EPOCH)
129+
BigDecimal expectedBlocksInNonOBFTSlots = new BigDecimal(networkConfig.getExpectedSlotsPerEpoch())
129130
.multiply(activeSlotsCoeff).multiply(BigDecimal.ONE.subtract(decentralizationParameter));
130131

131132
// eta is the ratio between the number of blocks that have been produced during the epoch, and
@@ -142,7 +143,8 @@ private static BigDecimal calculateEta(int totalBlocksInEpochByPools, BigDecimal
142143
*/
143144
public static BigInteger calculateUnclaimedRefundsForRetiredPools(HashSet<String> rewardAddressesOfRetiredPools,
144145
HashSet<String> deregisteredRewardAccounts,
145-
List<String> ownerAccountsRegisteredInThePast) {
146+
List<String> ownerAccountsRegisteredInThePast,
147+
NetworkConfig networkConfig) {
146148
BigInteger unclaimedRefunds = BigInteger.ZERO;
147149
if (rewardAddressesOfRetiredPools.size() > 0) {
148150
/* Check if the reward address of the retired pool has been unregistered before
@@ -153,7 +155,7 @@ public static BigInteger calculateUnclaimedRefundsForRetiredPools(HashSet<String
153155
!ownerAccountsRegisteredInThePast.contains(rewardAddress)) {
154156
// If the reward address has been unregistered, the deposit can not be returned
155157
// and will be added to the treasury instead (Pool Reap see: shelley-ledger.pdf p.53)
156-
unclaimedRefunds = unclaimedRefunds.add(POOL_DEPOSIT_IN_LOVELACE);
158+
unclaimedRefunds = unclaimedRefunds.add(networkConfig.getPoolDepositInLovelace());
157159
}
158160
}
159161
}

0 commit comments

Comments
 (0)