Skip to content
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

feat: gRPC server for TxStatus endpoint #3754

Merged
merged 3 commits into from
Aug 3, 2024
Merged

feat: gRPC server for TxStatus endpoint #3754

merged 3 commits into from
Aug 3, 2024

Conversation

cmwaters
Copy link
Contributor

@cmwaters cmwaters commented Aug 2, 2024

Closes: #3753

This in some ways ties into #3421

@cmwaters cmwaters changed the title gRPC server for TxStatus endpoint feat: gRPC server for TxStatus endpoint Aug 2, 2024
@cmwaters cmwaters marked this pull request as ready for review August 2, 2024 15:11
@cmwaters cmwaters requested a review from a team as a code owner August 2, 2024 15:11
@cmwaters cmwaters requested review from staheri14 and evan-forbes and removed request for a team August 2, 2024 15:11
Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

Walkthrough

The recent changes introduce a gRPC service for transaction handling in the Celestia application. This includes the implementation of the TxStatus endpoint, allowing clients to query the real-time status of transactions. Enhancements to the API routes, transaction service registration, and the addition of comprehensive tests ensure better functionality and reliability within the Cosmos SDK framework.

Changes

Files Change Summary
app/app.go, app/grpc/tx/server.go Added support for gRPC transaction handling, including API route registration and service implementation.
app/test/std_sdk_test.go Introduced tests for various gRPC queries including transaction status and network parameters.
buf.yaml Removed ignore section from lint configuration to enforce stricter linting on specified packages.
proto/celestia/core/v1/tx/tx.proto Defined a new gRPC service for transaction status management, including methods and message structures.
test/util/testnode/testnode_test.go Created unit tests for the testnode package, validating default and custom network initializations.

Assessment against linked issues

Objective Addressed Explanation
Implement gRPC TxStatus endpoint (Issue #3753)
Create a gRPC service that proxies to the RPC server
Ensure the new service integrates with existing clients

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Collaborator

@rootulp rootulp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we backport this to v1.x and/or v2.x?

Comment on lines +60 to +73
node, err := s.clientCtx.GetNode()
if err != nil {
return nil, err
}

txID, err := hex.DecodeString(req.TxId)
if err != nil {
return nil, status.Errorf(codes.InvalidArgument, "invalid tx id: %s", err)
}

resTx, err := node.TxStatus(ctx, txID)
if err != nil {
return nil, err
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after we move node initialization to the app and have access to the dbs, it would soooo nice if we would just move the logic here and not wrap the existing rpc

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, although I don't think proxying through the local RPC has much overhead

@cmwaters cmwaters added backport:v1.x PR will be backported automatically to the v1.x branch upon merging backport:v2.x PR will be backported automatically to the v2.x branch upon merging labels Aug 3, 2024
@cmwaters
Copy link
Contributor Author

cmwaters commented Aug 3, 2024

Should we backport this to v1.x and/or v2.x?

Yes I think we should

@cmwaters cmwaters merged commit bb4f712 into main Aug 3, 2024
33 of 34 checks passed
@cmwaters cmwaters deleted the cal/tx-status-grpc branch August 3, 2024 08:44
mergify bot pushed a commit that referenced this pull request Aug 3, 2024
Closes: #3753

This in some ways ties into
#3421

(cherry picked from commit bb4f712)

# Conflicts:
#	app/app.go
#	app/test/std_sdk_test.go
#	app/test/testnode_test.go
mergify bot pushed a commit that referenced this pull request Aug 3, 2024
Closes: #3753

This in some ways ties into
#3421

(cherry picked from commit bb4f712)

# Conflicts:
#	app/app.go
#	app/test/std_sdk_test.go
#	app/test/testnode_test.go
cmwaters added a commit that referenced this pull request Aug 5, 2024
Closes: #3753

This in some ways ties into
https://github.com/celestiaorg/celestia-app/issues/3421<hr>This is an
automatic backport of pull request #3754 done by
[Mergify](https://mergify.com).

---------

Co-authored-by: Callum Waters <cmwaters19@gmail.com>
cmwaters added a commit that referenced this pull request Aug 5, 2024
Closes: #3753

This in some ways ties into
https://github.com/celestiaorg/celestia-app/issues/3421<hr>This is an
automatic backport of pull request #3754 done by
[Mergify](https://mergify.com).

---------

Co-authored-by: Callum Waters <cmwaters19@gmail.com>
ninabarbakadze pushed a commit that referenced this pull request Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:v1.x PR will be backported automatically to the v1.x branch upon merging backport:v2.x PR will be backported automatically to the v2.x branch upon merging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

gRPC TxStatus endpoint
3 participants