docs: platform v4.2 updates - #162
Merged
Merged
Conversation
Document the protocol v14 getDocuments query surface. Correct two claims that no longer hold. OFFSET is consumed in ranked mode rather than always rejected, and HAVING is served in having-range mode. Retarget data-contracts to the v3 document meta-schema and add the keywords it introduces. Fix the index example, and drop a required-field count that disagreed with the list beneath it. Document error codes and response semantics for getBlock, getTransaction, getBlockchainStatus, and getMasternodeStatus; correct the sendRawTransaction parameters to positional and note that allowHighFees and bypassLimits are parsed but not forwarded to Core; add the params member to the JSON-RPC request table. Add glossary entries. Apply the release annotation pass: mark getDocuments as updated in 4.2.0, demote the 4.0.0 annotations to italics, and point the previous-version link at 4.1.0. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…havior Add a Minimum and Fixed Fees section to fees.md covering the minimum-balance pre-check and the fixed fee schedule for shielded pool transitions. Clarify NFT deletion rules, including the legacy correction for history-keeping document types and the restriction on consensus-validated references to deletable NFTs. Simplify the Batch payload row in the state transition table and move the action list to a new Batch transitions subsection. Document the DashPay v2 profile payment address fields, DAPI gateway TLS termination and gRPC-Web support, DPNS testnet voting windows and tie resolution, validator set rotation targets, and asset-lock surplus handling for shield transitions. Correct the Drive block finalization description, the Tenderdash maintenance note, the two-thirds validator threshold wording, and add token localization, decimal, and group threshold constraints. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…behavior Add index-only document types across the document, data contract, and query explanations, covering their storage model, the indexOnlyDelete action, and the restrictions they trade for compactness. Document the $contractVersion base field and the related change that lets a contract update add a required property without invalidating older documents. Expand the query and proofs pages with ranked aggregates, having-range filters, time-range selection, and chained and composite queries, and add a contract design section covering the declarations those capabilities require. Note gap-free index matching and multi-property set membership. Add an identity Keys section, document credit transfers to identities and Platform addresses, and correct the withdrawal limit and masternode reward sharing descriptions. Attribute data triggers to Drive rather than DPP, add the DashPay profile payment address trigger, and point the binding list link at v2. Correct the token base supply default, mark the main control group as immutable, note the per-claim distribution interval bound, and drop the contract-side price bounds that do not exist. Reference the DashPay v2 schema and trim a trailing space. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…havior Document the protocol v14 additions: the v3 document meta-schema and its new contract keywords, index-only document types and their delete transition, the $contractVersion base field, and the new constants and error codes. Correct stale behavior across the section, including address system fees and witnesses, identity key signature requirements, the token base transition group fields, token purchase payment, and the common state transition field table. Co-Authored-By: Claude Opus 5 (1M context) <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: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
…anges Add the Shield from Identity (type 21) and Identity Top Up From Shielded Pool (type 22) state transitions, along with their signing model and the identity transition type table. Document the timeRange `ttl` index option and its ephemeral fee rate, the FAILED withdrawal status for dust-threshold withdrawals, the portable math used for token distribution functions, and the reduced contested vote resolution fund. Add the new protocol constants and correct stale v4.2-dev line anchors. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Split the index field bullet list into required and optional field tables, and move the longer options into their own subsections: time-range indices, index-only options, and contested indices. Relocate the DPNS example to follow the JSON template instead of trailing the constraints table. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Fix stale or imprecise descriptions of DPNS pre-orders, credit conversion, read-only contracts, asset lock proofs, and token configuration defaults. Document the shielded pool identity transitions, index-only document delete, and the $price base field added in protocol version 14. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Repoint source links from v4.1.0 to v4.2-dev across the protocol reference, recomputing line anchors where structs, enums and constant blocks moved. Rename the serialized format version field from $version to $formatVersion on the state transition, data contract and identity tables, and in the identity JSON response examples. Correct the identity create fee formula and example to include the asset lock cost, and state the minimum identity top-up fee. Document behavior added in protocol version 14: the contested index checks on document create transitions, the conditional refersTo requirements, and the shielded denomination set. Add the group validation rules, the contract version stamp size constant, default values for the token supply and control properties, and note that the EvonodesByParticipation pairing is unchecked at registration. Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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
Initial update of the Platform docs for Dash Platform 4.2 / protocol version 14, across the protocol reference, explanations, and reference sections.
$contractVersionand$pricebase fields, the two shielded pool identity transitions (types 21 and 22), thetimeRangettlindex option, ranked aggregates and having-range/chained/composite queries, and the DashPay v2 profile payment address fields.OFFSETandHAVINGare handled in the new query modes rather than rejected;sendRawTransactiontakes positional params, withallowHighFeesandbypassLimitsparsed but not forwarded to Core. Also data trigger attribution, NFT deletion rules, token defaults, and the validator threshold wording. Dropped contract-side price bounds that don't exist in code.$versionto$formatVersionon the transition and identity tables and JSON examples, following platform commit 5953d17bce.v4.1.0tov4.2-dev, recomputing line anchors where code moved.RELEASE.md:getDocumentsmarked updated in 4.2.0, 4.0.0 annotations demoted to italics, previous-version link moved to 4.1.0.Most findings were verified against
dashpay/platform@51189ad5(v4.2-dev) before being applied. All 313v4.2-devlinks were resolved against the code repo, with changed anchors read individually to confirm they land on the declaration cited.Preview build: https://dash-docs-platform--162.org.readthedocs.build/en/162/