docs(reference): sync DAPI endpoint and query reference to v4.0 testnet#155
Merged
Conversation
Reword the orderBy modifier to describe sorting by a consecutive trailing run of an index's properties instead of "the last indexed property", which denied valid multi-field orderBy. Add the required orderBy to the Range and in examples so they execute (a terminal range-classified clause requires a matching orderBy), and note that in is treated as a range. Reframe the "range only after == and in" tip as an index-position rule that permits a standalone range. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove the four orphaned nullifier-changes endpoints (getNullifiersTrunkState, getNullifiersBranchState, getRecentNullifierChanges, getRecentCompactedNullifierChanges) from the detail and overview pages, matching their removal from the proto. Document getShieldedNotesCount and getDocumentHistory, the latter with a real testnet gRPCurl example and response. Correct getIdentityKeys (identity_id name/type, key-based limit/offset), getIdentitiesContractKeys contract_id, getDataContractHistory optional fields, getProtocolVersionUpgradeVoteStatus start_pro_tx_hash, and the protocol-version-upgrade prove descriptions. Add the burn_from_id field and update_price token event to getGroupActions, the tokenContractPosition field to getTokenContractInfo, and the last_claim oneof note to getTokenPerpetualDistributionLastClaim. Drop the stray base64 comment from the getEpochsInfo example, the nonexistent version parameter and proof claim from getCurrentQuorumsInfo, and the orphaned asterisk on send_transaction_hashes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add gRPCurl request and response examples to the six Shielded Transaction endpoints (getShieldedEncryptedNotes, getShieldedAnchors, getMostRecentShieldedAnchor, getShieldedPoolState, getShieldedNotesCount, getShieldedNullifiers), captured from a live testnet seed node. Remove the admonition stating these endpoints are not yet available on public nodes, since v4 now serves them on testnet. Note that getShieldedNullifiers omits is_spent for unspent nullifiers. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Remove the four removed nullifier-changes endpoints from the shielded query list, which produced broken myst.xref links, and add getShieldedNotesCount. Reword the intro from "sync incremental nullifier updates" to "track shielded sync progress". Co-Authored-By: Claude Opus 4.8 <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.
Summary
Brings the DAPI endpoint reference and query-syntax docs in line with the v4.0 proto, now live on testnet. Covers an audit-driven cleanup of stale/incorrect endpoint entries, two newly documented endpoints, real testnet examples for the shielded endpoints, and corrections to the query
orderBy/range rules.DAPI endpoint reference
Removed the four orphaned nullifier-changes endpoints (
getNullifiersTrunkState,getNullifiersBranchState,getRecentNullifierChanges,getRecentCompactedNullifierChanges) from the detail and overview pages, matching their removal from the proto.Documented two endpoints that existed in the proto but were missing from the docs:
getShieldedNotesCount— with overview row and detail entrygetDocumentHistory— with parameter table and a real testnet gRPCurl request/responseCorrected a set of parameter and behavior errors:
getIdentityKeys:identity_td→identity_id, type String → Bytes, andlimit/offsetmade optional and reworded from "revisions" to "keys"getIdentitiesContractKeys:contract_idtype String → BytesgetDataContractHistory:start_at_ms/limit/offsetmarked optionalgetProtocolVersionUpgradeVoteStatus:start_pro_tx_hashtype String → Bytesprovedescriptions no longer reference "identity"getGroupActions: added theburn_from_idfield and theupdate_pricetoken eventgetTokenContractInfo: addedtokenContractPositionto the response examplegetTokenPerpetualDistributionLastClaim: noted thelast_claimoneof variantsgetEpochsInfo: removed a stray "id must be base64" commentgetCurrentQuorumsInfo: removed the nonexistentversionparameter and the proof claimsubscribeToTransactionsWithProofs: fixed the orphaned asterisk / empty description onsend_transaction_hashesShielded endpoints
Added gRPCurl request/response examples to all six shielded endpoints, captured from a live testnet seed node, and removed the admonition stating they were not yet available on public nodes (v4 now serves them on testnet).
Query syntax
Reworded the
orderByrule to describe sorting by a consecutive trailing run of an index's properties (the prior "last indexed property" wording wrongly denied valid multi-fieldorderBy). Added the requiredorderByto the Range andinexamples so they execute, reframed the "range only after==/in" tip as an index-position rule that permits a standalone range, and noted thatinis treated as a range.Preview build: https://dash-docs-platform--155.org.readthedocs.build/en/155/