docs(client): Update setFeeGranter and setFeePayer comments #22526
Conversation
📝 WalkthroughWalkthroughThe pull request introduces two new methods to the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
ziscky
requested review from
julienrbrt,
JulianToledano and
a team
as code owners
|
@ziscky your pull request is missing a changelog! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
client/tx_config.go (1)
50-52: Documentation looks good, but could be even more explicitThe documentation clearly states the purpose and signing requirement. However, to fully address the confusion mentioned in issue #18886, consider adding a brief example use case.
Consider expanding the documentation like this:
// SetFeePayer sets the address of who will pay the fees for this transaction. -// Note: The fee payer must sign the transaction in addition to any other required signers. +// Note: The fee payer must sign the transaction in addition to any other required signers. +// Use this when you want an account to directly pay for transaction fees, rather than +// using the feegrant module for fee delegation.
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
📒 Files selected for processing (1)
client/tx_config.go(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
client/tx_config.go (1)
Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
🔇 Additional comments (2)
client/tx_config.go (2)
57-61: Excellent documentation that addresses the core issue
The documentation perfectly clarifies the fee granter's role and its relationship with the feegrant module. It explicitly addresses the distinction from the fee payer role and clearly states the signing requirements, which directly resolves the confusion raised in issue #18886.
50-61: Verify interface implementation consistency
Let's ensure all transaction builders implement these methods consistently.
✅ Verification successful
Based on the search results, I can now provide a final response:
Interface implementations are consistent across the codebase
The codebase shows consistent implementation of SetFeePayer and SetFeeGranter methods:
- Main implementation in
x/auth/tx/builder.goproperly sets the fee payer and granter addresses - Legacy implementation in
x/auth/migrations/legacytx/stdtx_builder.goexplicitly handles backward compatibility - Usage patterns in CLI commands and tests demonstrate consistent behavior
- All implementations follow the interface contract defined in
client/tx_config.go
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Find all implementations of TxBuilder interface to verify consistent implementation
# of SetFeePayer and SetFeeGranter methods
# Search for TxBuilder implementations
ast-grep --pattern 'type $_ struct {
$$$
}
func ($_ $_) SetFeePayer(feePayer sdk.AccAddress) {
$$$
}'
# Also search for any existing usage patterns
rg "SetFeePayer|SetFeeGranter" -A 3 -B 3
Length of output: 5136
julienrbrt
changed the title
julienrbrt
added
backport/v0.50.x
(cherry picked from commit 6351dc3)
…22526) (#22567) Co-authored-by: Eric Mokaya <[email protected]>
* main: build(deps): Bump cosmossdk.io/math from 1.3.0 to 1.4.0 (#22580) fix(server/v2/api/telemetry): enable global metrics (#22571) refactor(server/v2/cometbft): add `codec.Codec` and clean-up APIs (#22566) feat(core/coretesting): make memDB satisfy db.Db interface (#22570) Merge commit from fork fix(server(/v2)): fix fallback genesis path (#22564) fix: only overwrite context chainID when necessary (#22568) docs(client): Update setFeeGranter and setFeePayer comments (#22526) fix(baseapp): populate header info in `NewUncachedContext` (#22557) build(deps): Bump buf.build/gen/go/cometbft/cometbft/protocolbuffers/go from 1.35.1-20240701160653-fedbb9acfd2f.1 to 1.35.2-20240701160653-fedbb9acfd2f.1 in /api (#22551) build(deps): Bump github.com/creachadair/atomicfile from 0.3.5 to 0.3.6 in /tools/confix (#22552) docs: Update reference of Approximation (#22550) fix(server/v2/comebft): wire missing services + fix simulation (#21964) ci: fix permissions for GITHUB_TOKEN on dependabot workflows (#22547) ci: fix permissions for GITHUB_TOKEN in spell check workflow (#22545) build(deps): Bump google.golang.org/protobuf from 1.35.1 to 1.35.2 (#22537) fix(cosmovisor): premature upgrade on restart (#22528) fix(store/v2/pebble): handle version 0 in keys (#22524) refactor(server/v2/telemetry): swap redirects (#22520) docs: Update content in CODE_OF_CONDUCT.md (#22518)
Description
Closes: #18886
See: #22311
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit