Sip 185 debt shares #1601
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,11 +16,10 @@ import "./interfaces/IERC20.sol"; | |
| import "./interfaces/ISynth.sol"; | ||
| import "./interfaces/ISystemStatus.sol"; | ||
| import "./interfaces/ISynthetix.sol"; | ||
| import "./interfaces/ISynthetixDebtShare.sol"; | ||
| import "./FeePoolEternalStorage.sol"; | ||
| import "./interfaces/IExchanger.sol"; | ||
| import "./interfaces/IIssuer.sol"; | ||
| import "./interfaces/IRewardEscrowV2.sol"; | ||
| import "./interfaces/IDelegateApprovals.sol"; | ||
| import "./interfaces/IRewardsDistribution.sol"; | ||
|
|
@@ -44,7 +43,6 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| // This struct represents the issuance activity that's happened in a fee period. | ||
| struct FeePeriod { | ||
| uint64 feePeriodId; | ||
| uint64 startTime; | ||
| uint feesToDistribute; | ||
| uint feesClaimed; | ||
|
|
@@ -66,11 +64,10 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
|
|
||
| bytes32 private constant CONTRACT_SYSTEMSTATUS = "SystemStatus"; | ||
| bytes32 private constant CONTRACT_SYNTHETIX = "Synthetix"; | ||
| bytes32 private constant CONTRACT_SYNTHETIXDEBTSHARE = "SynthetixDebtShare"; | ||
| bytes32 private constant CONTRACT_FEEPOOLETERNALSTORAGE = "FeePoolEternalStorage"; | ||
| bytes32 private constant CONTRACT_EXCHANGER = "Exchanger"; | ||
| bytes32 private constant CONTRACT_ISSUER = "Issuer"; | ||
| bytes32 private constant CONTRACT_REWARDESCROW_V2 = "RewardEscrowV2"; | ||
| bytes32 private constant CONTRACT_DELEGATEAPPROVALS = "DelegateApprovals"; | ||
| bytes32 private constant CONTRACT_COLLATERALMANAGER = "CollateralManager"; | ||
|
|
@@ -95,20 +92,19 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| /* ========== VIEWS ========== */ | ||
| function resolverAddressesRequired() public view returns (bytes32[] memory addresses) { | ||
| bytes32[] memory existingAddresses = MixinSystemSettings.resolverAddressesRequired(); | ||
| bytes32[] memory newAddresses = new bytes32[](12); | ||
| newAddresses[0] = CONTRACT_SYSTEMSTATUS; | ||
| newAddresses[1] = CONTRACT_SYNTHETIX; | ||
| newAddresses[2] = CONTRACT_SYNTHETIXDEBTSHARE; | ||
| newAddresses[3] = CONTRACT_FEEPOOLETERNALSTORAGE; | ||
| newAddresses[4] = CONTRACT_EXCHANGER; | ||
| newAddresses[5] = CONTRACT_ISSUER; | ||
| newAddresses[6] = CONTRACT_REWARDESCROW_V2; | ||
| newAddresses[7] = CONTRACT_DELEGATEAPPROVALS; | ||
| newAddresses[8] = CONTRACT_REWARDSDISTRIBUTION; | ||
| newAddresses[9] = CONTRACT_COLLATERALMANAGER; | ||
| newAddresses[10] = CONTRACT_WRAPPER_FACTORY; | ||
| newAddresses[11] = CONTRACT_ETHER_WRAPPER; | ||
| addresses = combineArrays(existingAddresses, newAddresses); | ||
| } | ||
|
|
||
|
|
@@ -120,8 +116,8 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| return ISynthetix(requireAndGetAddress(CONTRACT_SYNTHETIX)); | ||
| } | ||
|
|
||
| function synthetixDebtShare() internal view returns (ISynthetixDebtShare) { | ||
| return ISynthetixDebtShare(requireAndGetAddress(CONTRACT_SYNTHETIXDEBTSHARE)); | ||
| } | ||
|
|
||
| function feePoolEternalStorage() internal view returns (FeePoolEternalStorage) { | ||
|
|
@@ -140,10 +136,6 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| return IIssuer(requireAndGetAddress(CONTRACT_ISSUER)); | ||
| } | ||
|
|
||
| function rewardEscrowV2() internal view returns (IRewardEscrowV2) { | ||
| return IRewardEscrowV2(requireAndGetAddress(CONTRACT_REWARDESCROW_V2)); | ||
| } | ||
|
|
@@ -181,7 +173,6 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| view | ||
| returns ( | ||
| uint64 feePeriodId, | ||
| uint64 startTime, | ||
| uint feesToDistribute, | ||
| uint feesClaimed, | ||
|
|
@@ -192,7 +183,6 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| FeePeriod memory feePeriod = _recentFeePeriodsStorage(index); | ||
| return ( | ||
| feePeriod.feePeriodId, | ||
| feePeriod.startTime, | ||
| feePeriod.feesToDistribute, | ||
| feePeriod.feesClaimed, | ||
|
|
@@ -205,31 +195,6 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| return _recentFeePeriods[(_currentFeePeriod + index) % FEE_PERIOD_LENGTH]; | ||
| } | ||
|
|
||
| /** | ||
| * @notice The Exchanger contract informs us when fees are paid. | ||
| * @param amount susd amount in fees being paid. | ||
|
|
@@ -286,9 +251,11 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| // Open up the new fee period. | ||
| // Increment periodId from the recent closed period feePeriodId | ||
| _recentFeePeriodsStorage(0).feePeriodId = uint64(uint256(_recentFeePeriodsStorage(1).feePeriodId).add(1)); | ||
| _recentFeePeriodsStorage(0).startTime = uint64(now); | ||
|
|
||
| // Inform Issuer to start recording for the new fee period | ||
| issuer().setCurrentPeriodId(now); | ||
|
|
||
| emitFeePeriodClosed(_recentFeePeriodsStorage(1).feePeriodId); | ||
| } | ||
|
|
||
|
|
@@ -363,18 +330,14 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| function importFeePeriod( | ||
| uint feePeriodIndex, | ||
| uint feePeriodId, | ||
| uint startTime, | ||
| uint feesToDistribute, | ||
| uint feesClaimed, | ||
| uint rewardsToDistribute, | ||
| uint rewardsClaimed | ||
| ) public optionalProxy_onlyOwner onlyDuringSetup { | ||
barrasso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| _recentFeePeriods[_currentFeePeriod.add(feePeriodIndex).mod(FEE_PERIOD_LENGTH)] = FeePeriod({ | ||
| feePeriodId: uint64(feePeriodId), | ||
| startTime: uint64(startTime), | ||
| feesToDistribute: feesToDistribute, | ||
| feesClaimed: feesClaimed, | ||
|
|
@@ -580,15 +543,14 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| function feesByPeriod(address account) public view returns (uint[2][FEE_PERIOD_LENGTH] memory results) { | ||
| // What's the user's debt entry index and the debt they owe to the system at current feePeriod | ||
| uint userOwnershipPercentage; | ||
| ISynthetixDebtShare _debtShare = synthetixDebtShare(); | ||
|
|
||
| userOwnershipPercentage = _debtShare.sharePercent(account); | ||
|
|
||
| // If they don't have any debt ownership and they never minted, they don't have any fees. | ||
| // User ownership can reduce to 0 if user burns all synths, | ||
| // however they could have fees applicable for periods they had minted in before so we check debtEntryIndex. | ||
| if (userOwnershipPercentage == 0) { | ||
|
There was a problem hiding this comment. @dbeal-eth Have to be careful here that they can still claim previous fee periods even if they now have burned all their debt / no current debt shares %. This is why it checked that their There was a problem hiding this comment. is there a unit test, or an easy way to write one? There was a problem hiding this comment. I think best way to test is
|
||
| uint[2][FEE_PERIOD_LENGTH] memory nullResults; | ||
| return nullResults; | ||
| } | ||
|
|
@@ -597,7 +559,7 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| // fees owing for, so we need to report on it anyway. | ||
| uint feesFromPeriod; | ||
| uint rewardsFromPeriod; | ||
| (feesFromPeriod, rewardsFromPeriod) = _feesAndRewardsFromPeriod(0, userOwnershipPercentage); | ||
|
|
||
| results[0][0] = feesFromPeriod; | ||
| results[0][1] = rewardsFromPeriod; | ||
|
|
@@ -608,22 +570,16 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| // Go through our fee periods from the oldest feePeriod[FEE_PERIOD_LENGTH - 1] and figure out what we owe them. | ||
| // Condition checks for periods > 0 | ||
| for (uint i = FEE_PERIOD_LENGTH - 1; i > 0; i--) { | ||
|
|
||
| // We can skip the period, as no debt minted during period (next period's startingDebtIndex is still 0) | ||
dbeal-eth marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (lastFeeWithdrawal < _recentFeePeriodsStorage(i).feePeriodId) { | ||
|
|
||
| // Gas optimisation - to reuse debtEntryIndex if found new applicable one | ||
dbeal-eth marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // if applicable is 0,0 (none found) we keep most recent one from issuanceData[0] | ||
| // return if userOwnershipPercentage = 0) | ||
| userOwnershipPercentage = _debtShare.sharePercentOnPeriod(account, uint(_recentFeePeriodsStorage(i).startTime)); | ||
|
|
||
| (feesFromPeriod, rewardsFromPeriod) = _feesAndRewardsFromPeriod(i, userOwnershipPercentage); | ||
|
|
||
| results[i][0] = feesFromPeriod; | ||
| results[i][1] = rewardsFromPeriod; | ||
|
|
@@ -641,62 +597,29 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| */ | ||
| function _feesAndRewardsFromPeriod( | ||
| uint period, | ||
| uint ownershipPercentage | ||
| ) internal view returns (uint, uint) { | ||
| // If it's zero, they haven't issued, and they have no fees OR rewards. | ||
| if (ownershipPercentage == 0) return (0, 0); | ||
|
|
||
| // Calculate their percentage of the fees / rewards in this period | ||
| // This is a high precision integer. | ||
| uint feesFromPeriod = _recentFeePeriodsStorage(period).feesToDistribute.multiplyDecimal(ownershipPercentage); | ||
|
|
||
| uint rewardsFromPeriod = | ||
| _recentFeePeriodsStorage(period).rewardsToDistribute.multiplyDecimal(ownershipPercentage); | ||
|
|
||
| return (feesFromPeriod, rewardsFromPeriod); | ||
| } | ||
|
|
||
| function effectiveDebtRatioForPeriod(address account, uint period) external view returns (uint) { | ||
| require(period != 0, "Current period is not closed yet"); | ||
| require(period < FEE_PERIOD_LENGTH, "Exceeds the FEE_PERIOD_LENGTH"); | ||
|
|
||
| // If the period being checked is uninitialised then return 0. This is only at the start of the system. | ||
| if (_recentFeePeriodsStorage(period - 1).startTime == 0) return 0; | ||
|
|
||
| return synthetixDebtShare().sharePercentOnPeriod(account, uint(_recentFeePeriods[period].startTime)); | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -739,10 +662,9 @@ contract FeePool is Owned, Proxyable, LimitedSetup, MixinSystemSettings, IFeePoo | |
| _; | ||
| } | ||
|
|
||
| modifier onlyIssuer { | ||
| bool isIssuer = msg.sender == address(issuer()); | ||
| require(isIssuer, "Issuer only"); | ||
| _; | ||
| } | ||
|
|
||
dbeal-eth marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not check whether the account has any debt shares balance (directly from the SDS contract) and if 0, you could save more gas and skip this check for transferring ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I just wanted to reuse the
issuerdependency. You are right, checking the debt shares contract directly would make more sense.