Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New Draw State Terminology #41

Merged
merged 2 commits into from
Jun 30, 2023
Merged

New Draw State Terminology #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d883710
Update function naming and descriptions using new language around the…
Jun 30, 2023
fc8e114
Code comments.
Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion script/generateConstants.s.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ contract GenerateConstants is Script {
);
console.log("\n");

console.log("/// @notice The estiamted number of prizes given X tiers.");
console.log("/// @notice The estimated number of prizes given X tiers.");
uint8 MIN_TIERS = 2;
uint8 MAX_TIERS = 14;
// Precompute the prizes per draw
Expand Down
188 changes: 95 additions & 93 deletions src/PrizePool.sol
View file
Open in desktop

Large diffs are not rendered by default.

48 changes: 20 additions & 28 deletions src/abstract/TieredLiquidityDistributor.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ contract TieredLiquidityDistributor {
/// @notice The number of draws that should statistically occur between grand prizes.
uint16 internal constant GRAND_PRIZE_PERIOD_DRAWS = 365;

/// @notice The estiamted number of prizes given X tiers.
/// @notice The estimated number of prizes given X tiers.
uint32 internal constant ESTIMATED_PRIZES_PER_DRAW_FOR_2_TIERS = 4;
uint32 internal constant ESTIMATED_PRIZES_PER_DRAW_FOR_3_TIERS = 16;
uint32 internal constant ESTIMATED_PRIZES_PER_DRAW_FOR_4_TIERS = 66;
Expand Down Expand Up @@ -218,11 +218,11 @@ contract TieredLiquidityDistributor {
/// @notice The current number of prize tokens per share.
UD34x4 public prizeTokenPerShare;

/// @notice The number of tiers for the last completed draw. The last tier is the canary tier.
/// @notice The number of tiers for the last closed draw. The last tier is the canary tier.
uint8 public numberOfTiers;

/// @notice The draw id of the last completed draw.
uint16 internal lastCompletedDrawId;
/// @notice The draw id of the last closed draw.
uint16 internal lastClosedDrawId;

/// @notice The amount of available reserve.
uint104 internal _reserve;
Expand Down Expand Up @@ -335,7 +335,7 @@ contract TieredLiquidityDistributor {
uint8 numTiers = numberOfTiers;
UD60x18 _prizeTokenPerShare = fromUD34x4toUD60x18(prizeTokenPerShare);
(
uint16 completedDrawId,
uint16 closedDrawId,
uint104 newReserve,
UD60x18 newPrizeTokenPerShare
) = _computeNewDistributions(
Expand All @@ -359,7 +359,7 @@ contract TieredLiquidityDistributor {
}
for (uint8 i = start; i < end; i++) {
_tiers[i] = Tier({
drawId: completedDrawId,
drawId: closedDrawId,
prizeTokenPerShare: prizeTokenPerShare,
prizeSize: uint96(
_computePrizeSize(i, _nextNumberOfTiers, _prizeTokenPerShare, newPrizeTokenPerShare)
Expand All @@ -369,26 +369,22 @@ contract TieredLiquidityDistributor {

prizeTokenPerShare = fromUD60x18toUD34x4(newPrizeTokenPerShare);
numberOfTiers = _nextNumberOfTiers;
lastCompletedDrawId = completedDrawId;
lastClosedDrawId = closedDrawId;
_reserve += newReserve;
}

/// @notice Computes the liquidity that will be distributed for the next draw given the next number of tiers and prize liquidity.
/// @param _numberOfTiers The current number of tiers
/// @param _nextNumberOfTiers The next number of tiers to use to compute distribution
/// @param _prizeTokenLiquidity The amount of fresh liquidity to distribute across the tiers and reserve
/// @return completedDrawId The drawId that this is for
/// @return closedDrawId The drawId that this is for
/// @return newReserve The amount of liquidity that will be added to the reserve
/// @return newPrizeTokenPerShare The new prize token per share
function _computeNewDistributions(
uint8 _numberOfTiers,
uint8 _nextNumberOfTiers,
uint256 _prizeTokenLiquidity
)
internal
view
returns (uint16 completedDrawId, uint104 newReserve, UD60x18 newPrizeTokenPerShare)
{
) internal view returns (uint16 closedDrawId, uint104 newReserve, UD60x18 newPrizeTokenPerShare) {
return
_computeNewDistributions(
_numberOfTiers,
Expand All @@ -403,20 +399,16 @@ contract TieredLiquidityDistributor {
/// @param _nextNumberOfTiers The next number of tiers to use to compute distribution
/// @param _currentPrizeTokenPerShare The current prize token per share
/// @param _prizeTokenLiquidity The amount of fresh liquidity to distribute across the tiers and reserve
/// @return completedDrawId The drawId that this is for
/// @return closedDrawId The drawId that this is for
/// @return newReserve The amount of liquidity that will be added to the reserve
/// @return newPrizeTokenPerShare The new prize token per share
function _computeNewDistributions(
uint8 _numberOfTiers,
uint8 _nextNumberOfTiers,
UD60x18 _currentPrizeTokenPerShare,
uint _prizeTokenLiquidity
)
internal
view
returns (uint16 completedDrawId, uint104 newReserve, UD60x18 newPrizeTokenPerShare)
{
completedDrawId = lastCompletedDrawId + 1;
) internal view returns (uint16 closedDrawId, uint104 newReserve, UD60x18 newPrizeTokenPerShare) {
closedDrawId = lastClosedDrawId + 1;
uint256 totalShares = _getTotalShares(_nextNumberOfTiers);
UD60x18 deltaPrizeTokensPerShare = (toUD60x18(_prizeTokenLiquidity).div(toUD60x18(totalShares)))
.floor();
Expand Down Expand Up @@ -477,9 +469,9 @@ contract TieredLiquidityDistributor {
/// @return An up-to-date Tier struct; if the prize is outdated then it is recomputed based on available liquidity and the draw id updated.
function _getTier(uint8 _tier, uint8 _numberOfTiers) internal view returns (Tier memory) {
Tier memory tier = _tiers[_tier];
uint16 _lastCompletedDrawId = lastCompletedDrawId;
if (tier.drawId != _lastCompletedDrawId) {
tier.drawId = _lastCompletedDrawId;
uint16 _lastClosedDrawId = lastClosedDrawId;
if (tier.drawId != _lastClosedDrawId) {
tier.drawId = _lastClosedDrawId;
tier.prizeSize = uint96(
_computePrizeSize(
_tier,
Expand Down Expand Up @@ -679,10 +671,10 @@ contract TieredLiquidityDistributor {
return delta.mul(toUD60x18(_shares));
}

/// @notice Retrieves the id of the next draw to be completed.
/// @notice Retrieves the id of the next draw to be closed.
/// @return The next draw id
function getNextDrawId() external view returns (uint16) {
return lastCompletedDrawId + 1;
function getOpenDrawId() external view returns (uint16) {
return lastClosedDrawId + 1;
}

/// @notice Estimates the number of prizes that will be awarded.
Expand All @@ -705,13 +697,13 @@ contract TieredLiquidityDistributor {
return _canaryPrizeCountFractional(numTiers);
}

/// @notice Computes the number of canary prizes for the last completed draw.
/// @notice Computes the number of canary prizes for the last closed draw.
/// @return The number of canary prizes
function canaryPrizeCount() external view returns (uint32) {
return _canaryPrizeCount(numberOfTiers);
}

/// @notice Computes the number of canary prizes for the last completed draw
/// @notice Computes the number of canary prizes for the last closed draw
/// @param _numberOfTiers The number of tiers
/// @return The number of canary prizes
function _canaryPrizeCount(uint8 _numberOfTiers) internal view returns (uint32) {
Expand Down
8 changes: 4 additions & 4 deletions src/libraries/DrawAccumulatorLib.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ library DrawAccumulatorLib {
/// @param _oldestIndex The oldest index in the ring buffer
/// @param _newestIndex The newest index in the ring buffer
/// @param _cardinality The number of items in the ring buffer
/// @param _targetLastCompletedDrawId The target draw id to search for
/// @param _targetLastClosedDrawId The target draw id to search for
/// @return beforeOrAtIndex The index of the observation occurring at or before the target draw id
/// @return beforeOrAtDrawId The draw id of the observation occurring at or before the target draw id
/// @return afterOrAtIndex The index of the observation occurring at or after the target draw id
Expand All @@ -422,7 +422,7 @@ library DrawAccumulatorLib {
uint16 _oldestIndex,
uint16 _newestIndex,
uint16 _cardinality,
uint16 _targetLastCompletedDrawId
uint16 _targetLastClosedDrawId
)
internal
view
Expand All @@ -448,10 +448,10 @@ library DrawAccumulatorLib {
afterOrAtIndex = uint16(RingBufferLib.nextIndex(currentIndex, _cardinality));
afterOrAtDrawId = _drawRingBuffer[afterOrAtIndex];

bool targetAtOrAfter = beforeOrAtDrawId <= _targetLastCompletedDrawId;
bool targetAtOrAfter = beforeOrAtDrawId <= _targetLastClosedDrawId;

// Check if we've found the corresponding Observation.
if (targetAtOrAfter && _targetLastCompletedDrawId <= afterOrAtDrawId) {
if (targetAtOrAfter && _targetLastClosedDrawId <= afterOrAtDrawId) {
break;
}

Expand Down
Loading
Loading