Skip to content

docs(reference): sync DAPI endpoint and query reference to v4.0 testnet#155

Merged
thephez merged 4 commits into
dashpay:developfrom
thephez:v4.0/audit-fixes
Jul 1, 2026
Merged

docs(reference): sync DAPI endpoint and query reference to v4.0 testnet#155
thephez merged 4 commits into
dashpay:developfrom
thephez:v4.0/audit-fixes

Conversation

@thephez

@thephez thephez commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

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 entry
  • getDocumentHistory — with parameter table and a real testnet gRPCurl request/response

Corrected a set of parameter and behavior errors:

  • getIdentityKeys: identity_tdidentity_id, type String → Bytes, and limit/offset made optional and reworded from "revisions" to "keys"
  • getIdentitiesContractKeys: contract_id type String → Bytes
  • getDataContractHistory: start_at_ms/limit/offset marked optional
  • getProtocolVersionUpgradeVoteStatus: start_pro_tx_hash type String → Bytes
  • Protocol-version-upgrade endpoints: prove descriptions no longer reference "identity"
  • getGroupActions: added the burn_from_id field and the update_price token event
  • getTokenContractInfo: added tokenContractPosition to the response example
  • getTokenPerpetualDistributionLastClaim: noted the last_claim oneof variants
  • getEpochsInfo: removed a stray "id must be base64" comment
  • getCurrentQuorumsInfo: removed the nonexistent version parameter and the proof claim
  • subscribeToTransactionsWithProofs: fixed the orphaned asterisk / empty description on send_transaction_hashes

Shielded 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 orderBy rule to describe sorting by a consecutive trailing run of an index's properties (the prior "last indexed property" wording wrongly denied valid multi-field orderBy). Added the required orderBy to the Range and in examples so they execute, reframed the "range only after ==/in" tip as an index-position rule that permits a standalone range, and noted that in is treated as a range.

Preview build: https://dash-docs-platform--155.org.readthedocs.build/en/155/

thephez and others added 3 commits June 29, 2026 15:41
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>
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 85e6f5ea-188d-41a9-89ee-c3e246a1a523

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

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

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>
@thephez thephez marked this pull request as ready for review July 1, 2026 16:46
@thephez thephez merged commit 7b004e1 into dashpay:develop Jul 1, 2026
1 check passed
@thephez thephez deleted the v4.0/audit-fixes branch July 1, 2026 19:43
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