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

Added comments and natspec #102

Merged
merged 4 commits into from Mar 22, 2024
Merged

Added comments and natspec #102

merged 4 commits into from Mar 22, 2024

Conversation

asselstine
Copy link
Contributor

No description provided.

@linear Linear
Copy link

linear bot commented Mar 21, 2024

GEN-1116 rename newReserve to deltaReserve in computeNewDistribution

@github-actions GitHub Actions
Copy link

LCOV of commit 25abf52 during Tests with 100% Coverage #469

Summary coverage rate:
  lines......: 100.0% (419 of 419 lines)
  functions..: 100.0% (67 of 67 functions)
  branches...: no data found

Files changed coverage rate:
                                             |Lines       |Functions  |Branches    
  Filename                                   |Rate     Num|Rate    Num|Rate     Num
  =================================================================================
  src/PrizePool.sol                          | 100%    187| 100%    36|    -      0
  src/abstract/TieredLiquidityDistributor.sol| 100%    156| 100%    19|    -      0

trmid
trmid requested changes Mar 22, 2024
View reviewed changes
src/PrizePool.sol Outdated Show resolved Hide resolved
src/PrizePool.sol Outdated Show resolved Hide resolved
src/abstract/TieredLiquidityDistributor.sol Outdated Show resolved Hide resolved
src/abstract/TieredLiquidityDistributor.sol
Comment on lines +116 to +119
/// @notice The number of prize tokens that have accrued per share for all time.
/// @dev This is an ever-increasing exchange rate that is used to calculate the prize liquidity for each tier.
/// @dev Each tier holds a separate tierPrizeTokenPerShare; the delta between the tierPrizeTokenPerShare and
/// the prizeTokenPerShare * tierShares is the available liquidity they have.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! This is simple and makes sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! I'm glad it's clear. Kind of an odd concept

asselstine and others added 3 commits March 22, 2024 16:44
@asselstine @trmid
Update src/PrizePool.sol
24adc8e 
Co-authored-by: Trevor Richard <40277611+trmid@users.noreply.github.com>
@asselstine @trmid
Update src/PrizePool.sol
42b1454 
Co-authored-by: Trevor Richard <40277611+trmid@users.noreply.github.com>
@asselstine @trmid
Update src/abstract/TieredLiquidityDistributor.sol
068e2ad 
Co-authored-by: Trevor Richard <40277611+trmid@users.noreply.github.com>
@asselstine asselstine merged commit dd959b7 into main Mar 22, 2024
2 checks passed
@asselstine asselstine deleted the gen-1116-rename-newreserve-to-deltareserve-in-computenewdistribution branch March 22, 2024 23:45
@github-actions GitHub Actions
Copy link

LCOV of commit 24adc8e during Tests with 100% Coverage #471

Summary coverage rate:
  lines......: 100.0% (419 of 419 lines)
  functions..: 100.0% (67 of 67 functions)
  branches...: no data found

Files changed coverage rate:
                                             |Lines       |Functions  |Branches    
  Filename                                   |Rate     Num|Rate    Num|Rate     Num
  =================================================================================
  src/PrizePool.sol                          | 100%    187| 100%    36|    -      0
  src/abstract/TieredLiquidityDistributor.sol| 100%    156| 100%    19|    -      0

@github-actions GitHub Actions
Copy link

LCOV of commit 42b1454 during Tests with 100% Coverage #473

Summary coverage rate:
  lines......: 100.0% (419 of 419 lines)
  functions..: 100.0% (67 of 67 functions)
  branches...: no data found

Files changed coverage rate:
                                             |Lines       |Functions  |Branches    
  Filename                                   |Rate     Num|Rate    Num|Rate     Num
  =================================================================================
  src/PrizePool.sol                          | 100%    187| 100%    36|    -      0
  src/abstract/TieredLiquidityDistributor.sol| 100%    156| 100%    19|    -      0

@github-actions GitHub Actions
Copy link

LCOV of commit 068e2ad during Tests with 100% Coverage #475

Summary coverage rate:
  lines......: 100.0% (419 of 419 lines)
  functions..: 100.0% (67 of 67 functions)
  branches...: no data found

Files changed coverage rate:
                                             |Lines       |Functions  |Branches    
  Filename                                   |Rate     Num|Rate    Num|Rate     Num
  =================================================================================
  src/PrizePool.sol                          | 100%    187| 100%    36|    -      0
  src/abstract/TieredLiquidityDistributor.sol| 100%    156| 100%    19|    -      0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trmid trmid trmid requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@asselstine @trmid