Skip to content

docs: describe running against zebrad instead of the deprecated zcashd - #594

Merged
pacu merged 1 commit into
masterfrom
docs/zebrad-first-readme
Aug 24, 2026
Merged

docs: describe running against zebrad instead of the deprecated zcashd#594
pacu merged 1 commit into
masterfrom
docs/zebrad-first-readme

Conversation

@nuttycom

Copy link
Copy Markdown
Contributor

zcashd is deprecated, but the README's setup instructions still directed readers to configure a zcashd instance. This rewrites the setup documentation to be zebrad-first:

  • Replace the Zcashd section with a Zebrad section covering the [rpc] configuration (listen_addr, enable_cookie_auth = false) that lightwalletd requires.
  • Point the example invocations' --zcash-conf-path at a zebrad.toml, and document that the file extension selects the config format (zebrad .toml vs. zcashd-style .conf), along with the --rpchost/--rpcport/--rpcuser/--rpcpassword alternative.
  • Add a health-check section showing how to call GetLightdInfo with grpcurl. The server answers this RPC by querying the backend node, so a successful reply verifies both the gRPC frontend and the backend connection. gRPC reflection is enabled at the default log level, so grpcurl needs no .proto files.
  • Update the remaining zcashd references in the production and block-cache sections.

🤖 Generated with Claude Code

The README's setup instructions predate zebrad support: they direct the
reader to configure a zcashd instance, although zcashd is deprecated and
lightwalletd already accepts a zebrad.toml via --zcash-conf-path and
detects the zebrad backend at startup. Rewrite the local and production
setup instructions zebrad-first, and add a grpcurl health-check section
so operators can verify both the gRPC frontend and the backend
connection after starting the server.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@nuttycom
nuttycom marked this pull request as ready for review August 24, 2026 20:31

@pacu pacu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK

@pacu
pacu merged commit 6e9fb8b into master Aug 24, 2026
5 checks passed
@pacu
pacu deleted the docs/zebrad-first-readme branch August 24, 2026 22:29
@LarryRuane

Copy link
Copy Markdown
Collaborator

post-merge ACK
Tested specifying zebrad.toml on the lightwalletd command line, and the grpcurl command

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.

3 participants