feat(server/v2/cometbft,stf): Listener integration in server/v2 #21917
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -7,6 +7,7 @@ import ( | |||||||||||||||||||||||||||||||||||||
| "cosmossdk.io/core/server" | ||||||||||||||||||||||||||||||||||||||
| "cosmossdk.io/core/store" | ||||||||||||||||||||||||||||||||||||||
| errorsmod "cosmossdk.io/errors/v2" | ||||||||||||||||||||||||||||||||||||||
| "cosmossdk.io/schema/appdata" | ||||||||||||||||||||||||||||||||||||||
| "cosmossdk.io/server/v2/streaming" | ||||||||||||||||||||||||||||||||||||||
| ) | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
@@ -57,6 +58,55 @@ func (c *Consensus[T]) streamDeliverBlockChanges( | |||||||||||||||||||||||||||||||||||||
| c.logger.Error("ListenStateChanges listening hook failed", "height", height, "err", err) | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| if c.listener == nil { | ||||||||||||||||||||||||||||||||||||||
| return nil | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| // stream the StartBlockData to the listener. | ||||||||||||||||||||||||||||||||||||||
| if c.listener.StartBlock != nil { | ||||||||||||||||||||||||||||||||||||||
| if err := c.listener.StartBlock(appdata.StartBlockData{ | ||||||||||||||||||||||||||||||||||||||
| Height: uint64(height), | ||||||||||||||||||||||||||||||||||||||
| HeaderBytes: nil, // TODO: https://github.com/cosmos/cosmos-sdk/issues/22009 | ||||||||||||||||||||||||||||||||||||||
| HeaderJSON: nil, // TODO: https://github.com/cosmos/cosmos-sdk/issues/22009 | ||||||||||||||||||||||||||||||||||||||
| }); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| // stream the TxData to the listener. | ||||||||||||||||||||||||||||||||||||||
| if c.listener.OnTx != nil { | ||||||||||||||||||||||||||||||||||||||
| for i, tx := range txs { | ||||||||||||||||||||||||||||||||||||||
| if err := c.listener.OnTx(appdata.TxData{ | ||||||||||||||||||||||||||||||||||||||
| TxIndex: int32(i), | ||||||||||||||||||||||||||||||||||||||
| Bytes: func() ([]byte, error) { return tx, nil }, | ||||||||||||||||||||||||||||||||||||||
| JSON: nil, // TODO: https://github.com/cosmos/cosmos-sdk/issues/22009 | ||||||||||||||||||||||||||||||||||||||
| }); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| // stream the EventData to the listener. | ||||||||||||||||||||||||||||||||||||||
| if c.listener.OnEvent != nil { | ||||||||||||||||||||||||||||||||||||||
| if err := c.listener.OnEvent(appdata.EventData{Events: events}); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| // stream the KVPairData to the listener. | ||||||||||||||||||||||||||||||||||||||
| if c.listener.OnKVPair != nil { | ||||||||||||||||||||||||||||||||||||||
| if err := c.listener.OnKVPair(appdata.KVPairData{Updates: stateChanges}); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| // stream the CommitData to the listener. | ||||||||||||||||||||||||||||||||||||||
| if c.listener.Commit != nil { | ||||||||||||||||||||||||||||||||||||||
| if completionCallback, err := c.listener.Commit(appdata.CommitData{}); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } else if completionCallback != nil { | ||||||||||||||||||||||||||||||||||||||
| if err := completionCallback(); err != nil { | ||||||||||||||||||||||||||||||||||||||
| return err | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+101
to
+108
There was a problem hiding this comment. 🛠️ Refactor suggestion Refactor to simplify control flow and enhance readability The Apply this diff to refactor the code: - if completionCallback, err := c.listener.Commit(appdata.CommitData{}); err != nil {
- return err
- } else if completionCallback != nil {
- if err := completionCallback(); err != nil {
- return err
- }
- }
+ completionCallback, err := c.listener.Commit(appdata.CommitData{})
+ if err != nil {
+ return err
+ }
+ if completionCallback != nil {
+ if err := completionCallback(); err != nil {
+ return err
+ }
+ }This refactoring removes the unnecessary 📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
| return nil | ||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
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.
I don't like to add setters tbh, I feel like it pollutes the server instantiation in root.go
Additionally, Consensus is wired from the cometbft server and not manually.
Let's instead add it to the Consensus contructor if possible and have the CometBFT ServerOptions take a listener.
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.
The idea of the separated setters is to make the listener a nil default since all nodes are not open to an off-chain indexer.
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.
That makes sense, the option can be nil by default then. But a user won't have to call NewConsensus manually, so putting it in a setter isn't useful
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.
When init the consensus from the config, if the indexer is set as on, then call the setter API.
I think it is more flexible.
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.
works too, could you wire that in cometbft server.go?
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.
can I do it in the next PR after baseapp integration? it seems not trivial, and have no idea of the indexer config, not exist???
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.
Can you add a TODO in cometbft/server.go after NewConsensus then?