docs(readme): polish to truth post-sentrix-proto migration#25
Conversation
Three stale claims fixed after the sentrix-proto extraction landed (PR #23 merged): 1. **grpc surface row** said "Pre-generated proto types committed; no protoc needed by consumers". src/grpc/pb.rs is gone — the grpc feature now depends on sentrix-proto from crates.io. Updated to reflect the new dep + the protoc build-time requirement. 2. **Status section** claimed "EVM (alloy) and gRPC (tonic) modules are doors-only stubs". Both are functional — SentrixGrpcClient has connect / get_latest_block / get_balance / get_validator_set / get_supply / get_mempool / subscribe_events all live in src/grpc/mod.rs. Reframed to "all six doors compile + have working client paths". 3. **Roadmap "Published to crates.io once feature surface stabilises"** was already published — checkbox was lying. Replaced with a forward-looking "next: surface stabilisation toward 1.0" line.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis pull request updates README.md documentation for the SDK, clarifying the grpc module's proto type sourcing strategy and revising project status and roadmap statements. The Surface table row for grpc now explicitly states that proto types come from the published sentrix-proto crate and building from source requires protoc for client generation. The Status and Roadmap sections are rewritten to consolidate alpha/coverage messaging, align the grpc roadmap with sentrix-proto consumption, and outline planned stabilization with API naming and error handling improvements. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Comment |
4 of N in the all-READMEs polish sweep.
Truth gaps fixed
gRPC row claimed pre-generated proto types committed, no protoc needed. PR chore(grpc): depend on sentrix-proto crate, drop vendored proto #23 dropped `src/grpc/pb.rs` and migrated to the published `sentrix-proto` crate. Consumers DO now need `protoc` (sentrix-proto's build.rs invokes it). Reflected accurately.
Status said EVM + gRPC modules are "doors-only stubs". They aren't — `SentrixGrpcClient::connect / get_latest_block / get_balance / get_validator_set / get_supply / get_mempool / subscribe_events` all live in `src/grpc/mod.rs` (184 lines). EVM provider factory works against alloy. Reframed to "all six doors compile + have working client paths".
Roadmap had "Published to crates.io once stabilises" as an unchecked goal. Already published 2026-05-12 (`sentrix-chain v0.1.0-alpha.0`). Replaced with a forward-looking "next: surface stabilisation toward 1.0" line.
Summary by CodeRabbit