-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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.
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
Update docs for eager rent collection #10348
Update docs for eager rent collection #10348
Conversation
@ryoqun , it will be great to get the design docs updated. I also created a stub page here for a developer-focused doc on rent and accounts: https://docs.solana.com/apps/rent |
Okay, I'll take the initial crack. :) |
2ef4cdb
to
e9eea03
Compare
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.
Just a couple of comments / questions on the write-up. Thanks!
@ericlwilliams Thanks for reviewing! I've addressed your comments and clarified the text a bit. :) |
Thank you so much! Co-authored-by: Tyera Eulberg <[email protected]>
@CriesofCarrots I think I've addressed all your comments. :) |
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.
No need to block on my review. I haven't had a chance to review in depth, but looks quite detailed! Thanks for writing this up.
Co-authored-by: Tyera Eulberg <[email protected]>
@garious I see! From @CriesofCarrots:
@danpaul000 Hi! Do you mind having a look at this pr? If there is no objections, I want to merge this because I think it's getting mature to merge. :) |
Looks good to me @ryoqun , thanks for the write-up! |
* Update docs for eager rent collection * Add rent doc and clarify account doc for app devs * Clarify some and pass the grammarly * Fix units notation * Fix link * Fix link really * Fix link really really * More grammarly * Apply suggestions from code review Thank you so much! Co-authored-by: Tyera Eulberg <[email protected]> * Add explanation of 19.055441478439427 * Fix unit... * Fix unit... * Clarify rent duration reasoning * Tweak a text for more clarification * Tweak more.. * Apply suggestions from code review Co-authored-by: Tyera Eulberg <[email protected]> * Revert too detailed out-of-context explanations Co-authored-by: Tyera Eulberg <[email protected]> (cherry picked from commit 40ffc56)
* Update docs for eager rent collection * Add rent doc and clarify account doc for app devs * Clarify some and pass the grammarly * Fix units notation * Fix link * Fix link really * Fix link really really * More grammarly * Apply suggestions from code review Thank you so much! Co-authored-by: Tyera Eulberg <[email protected]> * Add explanation of 19.055441478439427 * Fix unit... * Fix unit... * Clarify rent duration reasoning * Tweak a text for more clarification * Tweak more.. * Apply suggestions from code review Co-authored-by: Tyera Eulberg <[email protected]> * Revert too detailed out-of-context explanations Co-authored-by: Tyera Eulberg <[email protected]>
Problem
Docs for rent is a bit outdated regarding its timings with the debut of eager rent collection #9527 on mainnet-beta in 1.5 day (epoch 34~).
Ideally, I think the docs update should go first, but the eager rent collection is pursued due to rather urgent security concern and performance degradation due to unbounded live account data growth (#8931).
Summary of Changes
Update the doc for eager rent collection with some bonus clarifications.
Also, note that I intentionally didn't introduce eager-/lazy- rent collection terminology because these are implementation details and named from the historical background. From user's perspective, the eager rent collection looks lazy now, exactly opposite to the naming!
CCs
Any comments are appreciated!
@sakridge: as a reviewer of the actual implementation pr, does this represents the behind intention of the PR well?
@ericlwilliams, @aeyakovenko: regarding recent discussion on economic design for rent, I believe this is exactly what this is implemented in code. Is there any unclear parts the docs still is missing?
@CriesofCarrots: partly related to #10133, originating from #10054, I've added some clarification along with the new mention of eager rent collection. Is there any other omission?
Fixes #10133