docs(explanations): correct protocol behavior and fill gaps from audit - #160
Merged
Conversation
Apply the pre-existing findings (v4.1.0 and earlier) from the explanations section audit against the platform source. Corrections: - Groups are append-only rather than frozen at contract registration: existing groups are immutable, but a contract update can add groups at new positions. - The daily credit withdrawal limit is a fixed protocol constant, not a proportion of total credits on Platform that scales with the network. - Attribute state transition validation to the platform state machine rather than Tenderdash, and describe Drive storage as current state rather than a record of state transitions. - Scope the contract update index allowance to newly added document types, and widen the restriction to cover all index definitions rather than only unique ones. - Data triggers can bind to any document transition action, not just create, replace, and delete. - The fee multiplier is recorded and reported per epoch but is not applied when distributing collected fees. - Token cost minimum and maximum bounds are attached by the submitting client, not declared by the contract. - Perpetual distribution schedules can be epoch-based in addition to block- and time-based. - Spell the document create field as $prefundedVotingBalance. - Describe the platform chain as secured by evonode quorums anchored to the core chain, reserving Proof of Service for its glossary meaning. - Split the DAPI endpoint overview into per-transport bullets so the layer coverage of each is accurate. Additions: - $creatorId base field, and a document transition base section covering the identity contract nonce and token payment info. - On-chain transfer, purchase, and pricing history for NFT document types. - Adding a token to an already registered contract. - Vote extensions and their use for quorum-signing withdrawals. - Storage refund front-loading and the minimum refundable size; storage refunds netting to a credit. - Shielded pool protocol version availability, plus change notes and the creation-failure fallback address. - Contract-level description field. - System data contract versioning notes on DPNS and DashPay. - Cross-references to the proofs explanation and to the token, NFT, and document tutorials. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Caution CodeRabbit couldn't post its review summary. Error details |
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.
Apply the pre-existing findings (v4.1.0 and earlier) from the explanations section audit against the platform source.
Corrections:
Additions:
Preview build: https://dash-docs-platform--160.org.readthedocs.build/en/160/