Soloseng/celo-minting-schedule #10995
Conversation
| uint256 _communityRewardFraction, | ||
| address _carbonOffsettingPartner, | ||
| uint256 _carbonOffsettingFraction, | ||
| address registryAddress |
There was a problem hiding this comment.
isn't registry address a well known constant?
There was a problem hiding this comment.
Yes, however it has been common practice to include the registry address as an initialze variable rather that hardcode it.
removed, since in this case initialize() no longer takes args.
| areDependenciesSet = true; | ||
| l2StartTime = _l2StartTime; | ||
| setRegistry(registryAddress); | ||
| communityRewardFund = address(getGovernance()); |
There was a problem hiding this comment.
same as above, this is to ensure that the community reward fund address is the correct one for L2
| setRegistry(registryAddress); | ||
| communityRewardFund = address(getGovernance()); | ||
| totalSupplyAtL2Start = getGoldToken().totalSupply(); | ||
| setCommunityRewardFraction(_communityRewardFraction); |
There was a problem hiding this comment.
we could get this from the epoch rewards contract to make it clear that we're not using a new value?
There was a problem hiding this comment.
This will. To avoid importing the EpochRewards contract (not included in registry) into this one just to read the fraction variable, the fractions are passed in as a parameter. There should be minimal confusion, as the function parameters will be defined in the governance proposal that executes this function.
Also opted not to hard code the values, as these values could be changed at anytime before deployment by governance proposal, such as this one.
So it is best to let the governance proposal set the fraction in case it is later decided that it should change back to 25%
| communityRewardFund = address(getGovernance()); | ||
| totalSupplyAtL2Start = getGoldToken().totalSupply(); | ||
| setCommunityRewardFraction(_communityRewardFraction); | ||
| setCarbonOffsettingFund(_carbonOffsettingPartner, _carbonOffsettingFraction); |
| * @param _carbonOffsettingFraction The percentage of rewards going to carbon offsetting partner. | ||
| * @param registryAddress Address of the deployed contracts registry. | ||
| */ | ||
| function setDependecies( |
There was a problem hiding this comment.
maybe called activate and just set the l2StartTime and totalSupplyAtCall
There was a problem hiding this comment.
changed the name as suggested, but left the other setters to avoid misconfigs during L2 transition.
| * @return communityTargetRewards The community reward that can be minted according to the target schedule. | ||
| * @return carbonFundTargetRewards The carbon offsetting reward that can be minted according to the target schedule. | ||
| */ | ||
| function getTargetGoldTotalSupply() |
There was a problem hiding this comment.
how should i review this? same logic is in epoch rewards?
There was a problem hiding this comment.
For the most part, same logic.
The only difference, is that it's not minting the fraction that would go to validators. This results in less CELO being minted in the first 15 year period than originally planned for.
This should be fine since it's only being used by MintGoldSchedule
Description
Created a contract
MintGoldSchedule.solthat calculates the amount of CELO to mint and distribute to the community fund and carbon offsetting fund address. This contract can be deployed on L1, but will only be activated on L2 by callingMintGoldSchedule.setDependencies().This schedule is based on the existing schedule previously defined by
EpochRewardscontract. In this new schedule, only the percentage of CELO allocated to community rewards and carbon offsetting fund is minted.As with the L1 minting schedule, the L2 minting schedule in only defined for the first 15 years after L1 genesis block. Future modification to the
MintGoldSchedulecontract will be required to define a schedule beyond the first 15 years. Additionally, setting the distribution fraction for any fund is prohibited once the first 15 years have elapsed.GoldToken.solwas updated to only allow minting by the owner or theMintGoldSchedulecontract.Other changes
IGoldToken.solinterface was added to allowMintGoldScheduleto callGoldToken.mint().MockGovernancecontract, using pragma 0.8, was added to allow testing of theMintGoldSchedule. UsingdeployCodeTo("Governance.sol", abi.encode(false), governanceAddress);does not work, as the Governance contract bytecode has a placeholder for the libraries that it is using and Foundry does not provide a way to link the library during the compilation step of the tests.Tested
Related issues