Add developer docs: overview, architecture, and demo guide#8
Add developer docs: overview, architecture, and demo guide#8cargopete wants to merge 2 commits intographprotocol:juanmardefago/mvp-scopefrom
Conversation
maoueh
left a comment
maoueh
left a comment
There was a problem hiding this comment.
Also a general comment. The README.md should be updated also to point more to the docs now otherwise we will have two places where to maintain development instructions as there is lot of crossing between README and some guide here.
| Runs alongside a Substreams client. Exposes a gRPC interface the client uses to manage sessions and report usage. | ||
|
|
||
| **Key RPCs:** | ||
|
|
||
| | RPC | What it does | | ||
| |-----|-------------| | ||
| | `InitSession` | Creates a session, resolves payer/signer, validates the collector | | ||
| | `ReportUsage` | Aggregates usage, creates RAVs, sends to provider; detects `NeedMoreFunds` | | ||
| | `EndSession` | Terminates the session and cleans up | | ||
|
|
||
| `payment_session_manager.go` manages the bidirectional stream to the Provider Gateway. | ||
|
|
||
| > **MVP note:** The consumer-facing Substreams-compatible proxy endpoint (MVP-007, MVP-017) is not yet implemented. Clients currently integrate via the `sds_sink` wrapper. |
There was a problem hiding this comment.
I think this is outdated, @juanmardefago can confirm
|
|
||
| ### Consumer Sidecar (`consumer/sidecar/`) | ||
|
|
||
| Runs alongside a Substreams client. Exposes a gRPC interface the client uses to manage sessions and report usage. |
There was a problem hiding this comment.
We should document here the expected relation with each sink, e.g. a single globally available consumer-sidecar, or 1:1 relation with each sink.
|
|
||
| ### Provider Plugin Gateway (`provider/plugin/`) | ||
|
|
||
| Registers auth, session, and usage-metering plugins with Firehose Core via the `BorrowWorkerRequest` / `Event` interfaces. Always runs colocated with the Provider Gateway — they communicate via local in-process notification, not gRPC. |
There was a problem hiding this comment.
A bit more meat could be added here with maybe some pointers to code. Also, who is the audience of this? Integrators, operators, etc?
| cd substreams-data-service | ||
|
|
||
| # Check out the MVP scope branch | ||
| git checkout juanmardefago/mvp-scope |
There was a problem hiding this comment.
To be updated to latest branch.
2 participants
Summary
docs/overview.md— what SSDS is, where it fits in The Graph ecosystem, payment flow summary, and current MVP statedocs/architecture.md— component reference, network topology diagram, ports table, key design decisions, and repo layoutdocs/demo-guide.md— step-by-step guide for running the full local stack and streaming data through the payment loop (both reflex and manual modes)docs/SUMMARY.md— GitBook-compatible navigation index linking all docsTest plan
SUMMARY.mdresolve correctly