-
Notifications
You must be signed in to change notification settings - Fork 4
chore: improved error logs + docs and naming #69
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
Merged
Merged
Conversation
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
- this increased the executable size from 290Kb to 295Kb
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.
37 file(s) reviewed, 16 comment(s)
Edit PR Review Bot Settings | Greptile
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
GabrielePicco
approved these changes
Mar 7, 2025
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.
LGTM! Thanks
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.
Summary
Improving error logs, documenting each instruction in more detail and normalizing the protocol
fees vault related instruction name.
Details
Error Logs
When an error occurred we would end up with just an error code and it was hard to understand
what went wrong. We now log error messages to include more information about the error
and the context in which it occurred, mainly a label and pubkey of the account in violation.
Documentation
Each instruction now has the following sections in the documentation:
writable/signers
mainly relating to how the input accounts were setup previously
and were added to all remaining ones)
Greptile Summary
This PR enhances documentation and error logging across the delegation program, focusing on improved clarity and maintainability.
InitFeesVault
toInitProtocolFeesVault
and related functions for better clarityUndelegatable
toNotUndelegatable
for clearer error messagingThe changes are well-structured and improve code maintainability without introducing functional changes. However, the TODO comments should be addressed before merging.