feat(vault): add getter functions and state documentation#396
Merged
Jayy4rl merged 1 commit intoApr 29, 2026
Merged
Conversation
- Add user_shares_at_epoch(user, epoch) to enable per-epoch UI mechanics - Add can_deposit(user, amount) as single-user wrapper for deposit checks - Add can_withdraw(user, assets) to validate withdrawal eligibility - Document Closed state semantics and migration requirements Refs #357 Refs #358 Refs #359 Refs #366
|
@rayvorden Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Implements four contract getter functions and documentation to enable UIs to perform non-mutating checks and epoch-based claim mechanics.
Changes
user_shares_at_epoch(user, epoch)getter for retrieving per-epoch share snapshotscan_deposit(user, amount)view to check single-user deposit eligibility without mutationcan_withdraw(user, assets)view to validate withdrawal conditions with explicit reason codesClosedvault state semantics, migration requirements, and TBD cleanup behaviorTesting
Closes #357
Closes #358
Closes #359
Closes #366