feat(core): add TxValidator interface
#19950
Conversation
WalkthroughWalkthroughThe recent update involves a notable change in the naming convention from Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Review Status
Configuration used: .coderabbit.yml
Files selected for processing (2)
- core/appmodule/v2/module.go (1 hunks)
- core/appmodule/v2/tx_validator.go (1 hunks)
Additional Context Used
Path-based Instructions (2)
core/appmodule/v2/tx_validator.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.core/appmodule/v2/module.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (1)
core/appmodule/v2/module.go (1)
50-53: Ensure that the humorous comment within theTxValidatormethod documentation is appropriate for the project's documentation standards. While it adds personality, it may not align with the formal documentation style expected in some projects.
| // TxValidator represent the method that a TxValidator should implement. | ||
| // It was previously known as AnteHandler/Decorator.AnteHandle | ||
| type TxValidator[T transaction.Tx] interface { | ||
| ValidateTx(ctx context.Context, tx T) error | ||
| } |
There was a problem hiding this comment.
Consider adding more detailed documentation for the TxValidator interface and its ValidateTx method to explain the expected behavior and potential error cases.
// TxValidator represents the method that a TxValidator should implement.
// It was previously known as AnteHandler/Decorator.AnteHandle
+// The ValidateTx method should perform all necessary checks to validate a transaction.
+// It should return an error if the transaction fails any of these checks.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| // TxValidator represent the method that a TxValidator should implement. | |
| // It was previously known as AnteHandler/Decorator.AnteHandle | |
| type TxValidator[T transaction.Tx] interface { | |
| ValidateTx(ctx context.Context, tx T) error | |
| } | |
| // TxValidator represents the method that a TxValidator should implement. | |
| // It was previously known as AnteHandler/Decorator.AnteHandle | |
| // The ValidateTx method should perform all necessary checks to validate a transaction. | |
| // It should return an error if the transaction fails any of these checks. | |
| type TxValidator[T transaction.Tx] interface { | |
| ValidateTx(ctx context.Context, tx T) error | |
| } |
| // HasTxValidator is the extension interface that modules should implement to run | ||
| // custom logic for validating transactions. | ||
| // It was previously known as AnteHandler/Decorator. | ||
| type HasTxValidation[T transaction.Tx] interface { | ||
| type HasTxValidator[T transaction.Tx] interface { |
There was a problem hiding this comment.
Rename the method TxValidator to ValidateTx to match the method name in the TxValidator interface. This will maintain consistency and clarity in the interface method naming.
- TxValidator(ctx context.Context, tx T) error
+ ValidateTx(ctx context.Context, tx T) errorCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| // HasTxValidator is the extension interface that modules should implement to run | |
| // custom logic for validating transactions. | |
| // It was previously known as AnteHandler/Decorator. | |
| type HasTxValidation[T transaction.Tx] interface { | |
| type HasTxValidator[T transaction.Tx] interface { | |
| // HasTxValidator is the extension interface that modules should implement to run | |
| // custom logic for validating transactions. | |
| // It was previously known as AnteHandler/Decorator. | |
| type HasTxValidator[T transaction.Tx] interface { | |
| ValidateTx(ctx context.Context, tx T) error |
|
@julienrbrt your pull request is missing a changelog! |
* main: (45 commits) build(deps): Bump github.com/decred/dcrd/dcrec/secp256k1/v4 from 4.2.0 to 4.3.0 (cosmos#19913) build(deps): Bump google.golang.org/grpc from 1.62.1 to 1.63.0 (cosmos#19929) test(types/address): add additional unit tests for address.LengthPrefix and a… (cosmos#19964) refactor(x/bank)!: remove Address.String() (cosmos#19954) build(deps): Bump github.com/prometheus/common from 0.51.1 to 0.52.2 (cosmos#19930) fix(x/epochs): Fix init genesis (cosmos#19958) feat(core,runtime): transaction service (exec mode) (cosmos#19953) fix(x/authz): non utf-8 characters in logs (cosmos#19923) build(deps): Bump golang.org/x/crypto from 0.21.0 to 0.22.0 (cosmos#19960) chore: fix spelling errors (cosmos#19957) fix(x/tx): don't shadow Amino marshalling error messages (cosmos#19955) refactor(types): loosen module.AppModule interface (cosmos#19951) feat(core): add `TxValidator` interface (cosmos#19950) build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 in /x/epochs (cosmos#19947) feat(x/epochs): upstream osmosis epoch module (cosmos#19697) build(deps): Bump bufbuild/buf-setup-action from 1.30.0 to 1.30.1 (cosmos#19928) refactor(x/genutil)!: remove Address.String() (cosmos#19926) docs(x/mint): Fix inconsistency in mint docs (cosmos#19915) build(deps): Bump github.com/regen-network/gocuke from 1.1.0 to 1.1.1 in /orm (cosmos#19920) feat: Integrate grpc configuration into client.toml (cosmos#19905) ...
Description
ref: #19949
HasTxValidatorrepresents the interface modules needs to implementTxValidatoris the interface that TxValidator needs to implementAuthor 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.
I have...
Summary by CodeRabbit