Repository navigation
docs: name Zakura as a supported validator and cite the RPC spec - #6
Merged
Merged
Conversation
Zingod reads a validator through the Zcash JSON-RPC interface, and Zakura (https://github.com/zakura-core/zakura), a Zebra fork, serves that interface. The docs named Zebra alone. They now name Zakura beside Zebra in the README, the running guide, the contributing guide, the example config, the zingod-source guide and the 1.0.0 change file. The Requirements section of docs/running.md cites the specification by its full URL, https://zcash.github.io/rpc/, and lists the ten methods Zingod calls, each with the URL of its page. It also links the two OpenRPC documents of Zakura 1.8.4, which list all ten methods for the authenticated listener and for the restricted one. The support covers validator_client = "legacy_rpc". Zakura 1.8.4's indexer GetBlockRange streams BlockAndHeight, and Zingod's grpc client reads BlockAndHash. The Validator client section tells a Zakura operator to use legacy_rpc for that reason. The architecture guide adds zakurad to the validators that answer -32601 to checkadmission. No test ran Zingod against zakurad for this change. The live suite still tests against zebrad 6.2.3 only, and the running guide says so. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes: no issue. Issues are disabled on this repository.
What this PR changes
The docs named Zebra as the only validator. Zingod also works with Zakura, a Zebra fork. This PR names Zakura beside Zebra in seven files.
README.mdnames Zakura in the introduction and in the quick start.docs/running.mdlists Zebra and Zakura in the Requirements section, with the URLs of the Zakura repository, website and image.CONTRIBUTING.md,docs/example_configs/zingod.toml,packages/zingod-source/usage.mdand.changeset/1-zingod-1.0.0.mdname Zakura where they named Zebra alone.docs/architecture.mdadds zakurad to the validators that answer-32601tocheckadmission.The RPC specification
Zingod reads a validator through the Zcash JSON-RPC interface. The Requirements section now cites the specification by its full URL: https://zcash.github.io/rpc/.
The section lists the ten methods that Zingod calls. Each method has the URL of its page in the specification. The method names come from
packages/zingod-source/src/legacy_rpc.rs.Zakura 1.8.4 lists all ten methods in two OpenRPC documents:
One limit:
validator_client = "grpc"The support covers
validator_client = "legacy_rpc", which is the default.Zakura 1.8.4 serves
GetBlockRangeon its indexer gRPC. Its stream carriesBlockAndHeightmessages. Zingod readsBlockAndHashmessages. Field 1 has a different wire type in the two messages. The Validator client section tells a Zakura operator to uselegacy_rpc, and it links the Zakura proto file.A maintainer must confirm this statement. The comparison used the two proto files only. No run of the gRPC client against zakurad supports it.
Verification
🤖 Generated with Claude Code