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.

Sign up for GitHub

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

Jump to bottom

add(scan): Adds gRPC reflection and documents how to use the zebra-scan gRPC server #8288

Merged
merged 6 commits into from
Feb 22, 2024
Merged

add(scan): Adds gRPC reflection and documents how to use the zebra-scan gRPC server #8288

merged 6 commits into from
Feb 22, 2024

Conversation

arya2
Copy link
Contributor

@arya2 arya2 commented Feb 20, 2024 •
edited
Loading

Motivation

We want to provide a guide for getting started using the shielded scanner's gRPC server.

We also want to add gRPC server reflection so that users don't need the protocol definitions to call the server.

Closes #8284.

PR Author Checklist

Check before marking the PR as ready for review:

  • Will the PR name make sense to users?
  • Does the PR have a priority label?
  • Have you added or updated tests?
  • Is the documentation up to date?
For significant changes:
  • Is there a summary in the CHANGELOG?
  • Can these changes be split into multiple PRs?

If a checkbox isn't relevant to the PR, mark it as done.

Solution

  • Adds tonic-reflection to provide a gRPC reflection service
  • Adds a page to the Zebra book for getting started with the zebra-scan gRPC server

Review

Anyone can review.

Reviewer Checklist

Check before approving the PR:

  • Does the PR scope match the ticket?
  • Are there enough tests to make sure it works? Do the tests cover the PR motivation?
  • Are all the PR blockers dealt with?
    PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

@arya2 arya2 self-assigned this Feb 20, 2024
@arya2 arya2 requested a review from a team as a code owner February 20, 2024 01:38
@arya2 arya2 requested review from oxarbitrage and removed request for a team February 20, 2024 01:38
@arya2 arya2 added A-docs Area: Documentation I-usability Zebra is hard to understand or use A-blockchain-scanner Area: Blockchain scanner of shielded transactions P-Medium ⚡ A-rpc Area: Remote Procedure Call interfaces labels Feb 20, 2024
@arya2 arya2 changed the title add(scan): Adds gRPC reflection and document how to use the zebra-scan gRPC server add(scan): Adds gRPC reflection and documents how to use the zebra-scan gRPC server Feb 21, 2024
oxarbitrage
oxarbitrage reviewed Feb 21, 2024
View reviewed changes
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

Looks good, i added some comments.

book/src/user/shielded-scan-grpc-server.md Outdated Show resolved Hide resolved
book/src/user/shielded-scan-grpc-server.md Outdated Show resolved Hide resolved
book/src/user/shielded-scan-grpc-server.md Show resolved Hide resolved
book/src/user/shielded-scan-grpc-server.md Outdated Show resolved Hide resolved
book/src/user/shielded-scan-grpc-server.md Outdated Show resolved Hide resolved
@arya2 arya2 force-pushed the add-scan-server-docs branch from c36a10d to 6a1057a Compare February 22, 2024 00:07
@arya2 arya2 requested a review from oxarbitrage February 22, 2024 00:10
@oxarbitrage @upbqdn
update link
b9cfd02 
Co-authored-by: Marek <[email protected]>
oxarbitrage
oxarbitrage approved these changes Feb 22, 2024
View reviewed changes
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

I think there are some problems with the error responses in the grpc methods that are not related to this PR. Rest looks good.

@oxarbitrage oxarbitrage mentioned this pull request Feb 22, 2024
Closed
mergify bot added a commit that referenced this pull request Feb 22, 2024
@mergify
Merge of #8288
c7fc2ef
@mergify mergify bot mentioned this pull request Feb 22, 2024
Closed
@mergify mergify bot merged commit 4ebd7a8 into main Feb 22, 2024
184 checks passed
@mergify mergify bot deleted the add-scan-server-docs branch February 22, 2024 18:51
idky137 pushed a commit to idky137/zebra that referenced this pull request Feb 28, 2024
@arya2 @oxarbitrage
@upbqdn @idky137
add(scan): Adds gRPC reflection and documents how to use the zebra-sc…
59aecf6 
…an gRPC server (ZcashFoundation#8288)

* adds tonic-reflection

* adds listen_addr to log

* Adds user guide for scan server to zebra book

* fixes typo

* Applies suggestions from code review

* update link

Co-authored-by: Marek <[email protected]>

---------

Co-authored-by: Alfredo Garcia <[email protected]>
Co-authored-by: Marek <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oxarbitrage oxarbitrage oxarbitrage approved these changes

@upbqdn upbqdn upbqdn left review comments

Assignees

@arya2 arya2

Labels
A-blockchain-scanner Area: Blockchain scanner of shielded transactions A-docs Area: Documentation A-rpc Area: Remote Procedure Call interfaces I-usability Zebra is hard to understand or use P-Medium ⚡
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document how to run and use the zebra-scan gRPC server
3 participants
@arya2 @upbqdn @oxarbitrage