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

Document Hermes' gRPC endpoint requirements #3529

Merged
merged 24 commits into from
Sep 27, 2023
Merged

Document Hermes' gRPC endpoint requirements #3529

merged 24 commits into from
Sep 27, 2023

Conversation

seanchen1991
Copy link
Contributor

@seanchen1991 seanchen1991 commented Aug 10, 2023 •
edited
Loading

Closes: #3545

Description

PR author checklist:

  • Added changelog entry, using unclog.
  • Added tests: integration (for Hermes) or unit/mock tests (for modules).
  • Linked to GitHub issue.
  • Updated code comments and documentation (e.g., docs/).
  • Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

  • Reviewed Files changed in the GitHub PR explorer.
  • Manually tested (in case integration/unit/mock tests are absent).

@seanchen1991
Update Data-Requirements.md
61a348f 
Signed-off-by: Sean Chen <seanchen11235@gmail.com>
@romac
Copy link
Member

romac commented Aug 11, 2023

While we are at it, we should also document all the gRPC queries Hermes makes. Or should we do it in another PR?

@seanchen1991
Copy link
Contributor Author

Yea, we can document the gRPC queries as well as part of this PR.

@seanchen1991 seanchen1991 changed the title Update Data-Requirements.md Document Hermes' gRPC endpoint requirements Aug 17, 2023
@seanchen1991 seanchen1991 requested a review from romac August 31, 2023 14:55
romac
romac reviewed Sep 13, 2023
View reviewed changes
docs/spec/relayer/Data-Requirements.md Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Outdated Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Outdated Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Outdated Show resolved Hide resolved
docs/spec/relayer/Data-Requirements.md Outdated Show resolved Hide resolved
seanchen1991 and others added 8 commits September 13, 2023 16:02
@seanchen1991 @romac
Specify the names of the RPC methods instead of the request parameter…
e5b5852 
… types

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Signed-off-by: Sean Chen <seanchen11235@gmail.com>
@seanchen1991 @romac
Update docs/spec/relayer/Data-Requirements.md
721fdaf 
Co-authored-by: Romain Ruetschi <romain@informal.systems>
Signed-off-by: Sean Chen <seanchen11235@gmail.com>
@seanchen1991 @romac
Update docs/spec/relayer/Data-Requirements.md
197259f 
Co-authored-by: Romain Ruetschi <romain@informal.systems>
Signed-off-by: Sean Chen <seanchen11235@gmail.com>
@seanchen1991 @romac
Update docs/spec/relayer/Data-Requirements.md
2177af7 
Co-authored-by: Romain Ruetschi <romain@informal.systems>
Signed-off-by: Sean Chen <seanchen11235@gmail.com>
@seanchen1991
Clean up data-requirements
3994b5b
@seanchen1991
List the RPC queries for each endpoint
dfe0c6c
@seanchen1991
Merge branch 'master' into sean/data-requirements-links
f1cf380
@romac
Merge branch 'master' into sean/data-requirements-links
dabf671
@romac romac merged commit 2731e5f into master Sep 27, 2023
33 of 36 checks passed
@romac romac deleted the sean/data-requirements-links branch September 27, 2023 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@romac romac romac left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update Data-Requirements.md with gRPC endpoints
2 participants
@seanchen1991 @romac