natspec(TabLib): add complete contract natspec #157
Merged
Conversation
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
POOL-1673 TwabLib: natspec doc should be more descriptive
Twab Lib is doing more than just track user's historic balance. |
asselstine
requested changes
Oct 5, 2021
contracts/libraries/TwabLib.sol
Outdated
| ring buffer parameters. Every token.transfer() creates a new TWAB checkpoint. The new TWAB | ||
| checkpoint is stored in the circular ring buffer, as either a new checkpoint or rewriting | ||
| a previous checkpoint with new parameters. The TwabLib (using existing blocktimes 1block/15sec) | ||
| guarantees on average 6 months of search history. |
There was a problem hiding this comment.
The MAX_CARDINALITY in fact guarantees at least 7.4 years of records:
If 14 = block time in seconds
(2**24) * 14 = 234881024 seconds of history
234881024 / (365 * 24 * 60 * 60) ~= 7.44 years
There was a problem hiding this comment.
Where did the "6 months" come from yesterday? I obviously didn't do the math and was just running with that figure.
Was that calculated differently?
There was a problem hiding this comment.
It was the minimum target I had in my head. Nothing too concrete.
asselstine
force-pushed
the
pool-1673-twablib-natspec-doc-should-be-more
branch
from
24a65b6
to
7422feb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
docs. docs..... docs!