Skip to content

docs(readme): polish to truth post-sentrix-proto migration#25

Merged
satyakwok merged 1 commit into
mainfrom
chore/polish-readme-truth
May 13, 2026
Merged

docs(readme): polish to truth post-sentrix-proto migration#25
satyakwok merged 1 commit into
mainfrom
chore/polish-readme-truth

Conversation

@satyakwok
Copy link
Copy Markdown
Member

@satyakwok satyakwok commented May 13, 2026

4 of N in the all-READMEs polish sweep.

Truth gaps fixed

  1. 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.

  2. 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".

  3. 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

  • Documentation
    • Updated Surface table documentation for the grpc module to clarify proto type generation requirements.
    • Revised Status and Roadmap sections with updated alpha status, grpc roadmap adjustments, and stabilization plans.

Review Change Stack

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.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f631d78d-cdf0-4571-b26f-89c70a312925

📥 Commits

Reviewing files that changed from the base of the PR and between 7a7d0bc and 095031f.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This 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

  • Sentriscloud/sdk-rs#24: README documentation updates for grpc module status and roadmap alignment
  • Sentriscloud/sdk-rs#23: Switches grpc implementation to consume proto types from external sentrix-proto crate instead of vendored proto files
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description adequately explains what changed and why, covering the three truth gaps fixed. However, it does not follow the required template structure with sections like Scope, Checks, and Deploy impact. Follow the repository's PR description template by adding sections for Scope (docs only), Checks (N/A for docs), Linked issue, and Deploy impact (no on-chain change).
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating README documentation to reflect truth/accuracy post-sentrix-proto migration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/polish-readme-truth

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


Comment @coderabbitai help to get the list of available commands and usage tips.

@satyakwok satyakwok merged commit 9b12d98 into main May 13, 2026
8 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 17, 2026
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant