8000 ADR 102: RPC Companion architecture · Issue #592 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ADR 102: RPC Companion architecture #592

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
Closed
Tracked by #707
thanethomson opened this issue Mar 27, 2023 · 2 comments · Fixed by #658
Closed
Tracked by #707

ADR 102: RPC Companion architecture #592

thanethomson opened this issue Mar 27, 2023 · 2 comments · Fixed by #658
Assignees
@andynog
Labels
P:integrator-experience Priority: Improve experience for integrators rpc
Milestone
2024-Q1

Comments

@thanethomson
Copy link
Contributor
thanethomson commented Mar 27, 2023 •
edited
Loading

As part of #574, we want to offer users a standalone proof-of-concept RPC service to serve as an example of a data companion. To this end, we want an ADR that captures:

  1. The overall architecture of our standalone RPC service (implemented as a data companion)
  2. Which of our RPC endpoints we'll be exposing as /v1
  3. The decision as to which database to use to facilitate (1). The best database here will depend on the data access patterns defined by (1).

Future efforts could possibly involve productionizing this to the point that it may be able to scale independently of a full node, possibly reducing the costs associated with providing an RPC as a service, but this work needs to be broken down in separate follow-up issues.
@thanethomson thanethomson mentioned this issue Mar 27, 2023
Closed
5 tasks
@thanethomson thanethomson added rpc P:integrator-experience Priority: Improve experience for integrators labels Mar 27, 2023
@thanethomson thanethomson changed the title ADR-101 RPC: Capture desired interface for /v1 of the standalone RPC server ADR-101: Standalone RPC architecture Mar 27, 2023
@andynog andynog moved this from Todo to In Progress in CometBFT 2023 Mar 27, 2023
andynog added a commit that referenced this issue Mar 27, 2023
@andynog
add document for proposed adr-102 standalone rpc (#592)
af36eb1
@andynog andynog changed the title ADR-101: Standalone RPC architecture ADR-102: Standalone RPC architecture Mar 29, 2023
andynog added a commit that referenced this issue Mar 30, 2023
@andynog
Added additional information to ADR-102 (WIP) #592
93a270a
@andynog andynog added this to the 2023-Q2 milestone Mar 31, 2023
andynog added a commit that referenced this issue Mar 31, 2023
@andynog
More information for the core parts (#592)
0ca73b2
andynog added a commit that referenced this issue Mar 31, 2023
@andynog
Fix image url (#592)
0b6ce24
andynog added a commit that referenced this issue Mar 31, 2023
@andynog
minor typo (#592)
6702138
andynog added a commit that referenced this issue Apr 5, 2023
@andynog
Re-organizing document structure (#592)
dd60139
andynog added a commit that referenced this issue Apr 5, 2023
@andynog
Renaming document (#592)
eee68a4
@andynog andynog mentioned this issue Apr 5, 2023
Merged
@andynog andynog changed the title ADR-102: Standalone RPC architecture ADR-102: RPC Companion architecture Apr 5, 2023
This was referenced Apr 6, 2023
Open
Open
@thanethomson thanethomson changed the title ADR-102: RPC Companion architecture ADR 102: RPC Companion architecture Apr 13, 2023
@jmalicevic
Copy link
Contributor

I am wondering whether the access patterns will depend on the endpoints exposed? If we have a preliminary list, I could make sure to gather the info on access patterns during the storage investigation.

andynog added a commit that referenced this issue Apr 28, 2023
@andynog
Adding details about database and schema (#592)
c121948
andynog added a commit that referenced this issue May 5, 2023
@andynog
adding information about RPC endpoints (wip) #592
d5bce4f
@andynog
Copy link
Contributor
andynog commented May 5, 2023 •
edited
Loading

I've started adding information about the RPC endpoints that will be implemented. I've used a table format because I believe it's easier to understand. There's a lot more information to be added so it's a WIP.

For each endpoint, I have to dig in into the code to understand it a bit better to assess the complexities on implement them on the Data Companion side. I also plan to add more sections outlining on how things will work, e.g. translating queries to sql statements or return a response mapping the database records to a struct (or protobuf).

andynog added a commit that referenced this issue May 8, 2023
@andynog
minor typos (#592)
877547a
andynog added a commit that referenced this issue May 8, 2023
@andynog
add more endpoints information (#592)
fa8ea2c
andynog added a commit that referenced this issue May 8, 2023
@andynog
fixing table formatting (#592)
91e8deb
andynog added a commit that referenced this issue May 9, 2023
@andynog
Added more endpoints information (#592)
1b5a09a
andynog added a commit that referenced this issue May 9, 2023
@andynog
Added more endpoints information (#592)
7b7508d
andynog added a commit that referenced this issue May 10, 2023
@andynog
added some more endpoints, list is complete (#592)
e43a141
andynog added a commit that referenced this issue May 10, 2023
@andynog
some minor typos and content fixes (#592)
2a2c283
andynog added a commit that referenced this issue May 11, 2023
@andynog
updating architecture image (#592)
0ced770
andynog added a commit that referenced this issue May 11, 2023
@andynog
reverting image to jpeg (#592)
38d00a6
andynog added a commit that referenced this issue Jun 6, 2023
@andynog
added additional information, fixed types and wording (#592)
a64bc4e
andynog added a commit that referenced this issue Jun 8, 2023
@andynog
removed wip section (#592)
73d384d
andynog added a commit that referenced this issue Jun 13, 2023
@andynog
better clarity on endpoint and methods (#592)
8a036c2
@andynog andynog modified the milestones: 2023-Q2, 2023-Q3 Jul 5, 2023
@thanethomson thanethomson modified the milestones: 2023-Q3, 2023-Q4 Jul 14, 2023
@adizere adizere modified the milestones: 2023-Q4, 2024-Q1 Jan 10, 2024
andynog added a commit that referenced this issue Mar 8, 2024
@andynog
refactoring doc (#592)
4b0f7df
@adizere adizere added this to CometBFT Mar 25, 2024
@github-project-automation github-project-automation bot moved this to Todo in CometBFT Mar 25, 2024
@andynog andynog moved this from Todo to Done in CometBFT Mar 25, 2024
github-merge-queue bot pushed a commit that referenced this issue Mar 25, 2024
@andynog @jmalicevic
@lasarojc @cason @sergio-mena
docs: ADR-102 - RPC Companion (#658)
c3304ee 
[Rendered](https://github.com/cometbft/cometbft/blob/andy/adr-102-standalone-rpc/docs/architecture/adr-102-rpc-companion.md)

closes: #592

This is a WIP document for the RPC Companion ADR

---------

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>
Co-authored-by: Lasaro <lasaro@informal.systems>
Co-authored-by: Daniel <daniel.cason@informal.systems>
Co-authored-by: Sergio Mena <sergio@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@andynog andynog

Labels
P:integrator-experience Priority: Improve experience for integrators rpc
Projects
No open projects
CometBFT
Status: Done
CometBFT 2023
Status: In Progress
Milestone
2024-Q1
Development

Successfully merging a pull request may close this issue.

docs: ADR-102 - RPC Companion cometbft/cometbft
4 participants
@thanethomson @adizere @jmalicevic @andynog
0