chore(sequencer): add fee docs #1666
Closed
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
noot
reviewed
Oct 23, 2024
Comment on lines
+64
to
+70
| // This module contains the fee handling logic for all actions. All actions must implement the | ||
| // [`FeeHandler`] trait. In addition to this, new actions should provide new, unique read/write | ||
| // methods in [`fees::StateReadExt`] and [`fees::StateWriteExt`] for the fees associated with the | ||
| // action, which take/return a domain type [`<action_name>FeeComponents`]. If there are no fees | ||
| // stored to the state for the given action, it is assumed to be disabled, and the transaction | ||
| // execution should fail. If the action is free, the fees should be explicitly set to zero in the | ||
| // state. See action implementations for examples of how to implement this trait for new actions. |
There was a problem hiding this comment.
if this is intended to be a doc comment, it should be at the top of this file, and start with //!
There was a problem hiding this comment.
Do you think this should be a doc comment? I had intentionally left it more as a means of guiding people who are adding actions/fees in the future, since it deals more with the implementation details and figured that probably wouldn't be best for public-facing docs. Happy to make it a doc comment if you think it warrants it, though
|
Closing as these comments will no longer be accurate as of #1811. |
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
Added more comments/docs to the fees module.
Background
Fees module was lacking in comments because it was done so quickly. This is meant to make the process of implementing new fees and the
FeeHandlertrait clearer to anyone who is adding a new action.Changes
Testing
None needed - no code in doc comments.
Related Issues
closes #1663