Skip to content

docs: v3.1 minor cleanup (Proofs page, address encoding, constants)#148

Merged
thephez merged 5 commits into
dashpay:developfrom
thephez:v3.1/minor-cleanup
May 21, 2026
Merged

docs: v3.1 minor cleanup (Proofs page, address encoding, constants)#148
thephez merged 5 commits into
dashpay:developfrom
thephez:v3.1/minor-cleanup

Conversation

@thephez
Copy link
Copy Markdown
Collaborator

@thephez thephez commented May 21, 2026

Summary

Batch of v3.1 doc updates — low-risk additions and cleanups against the v3.1-dev surface:

  • Proofs explanation page (new) — covers the two-layer proof model (GroveDB Merkle + Tenderdash consensus), what can be proven, the new aggregate proof primitives (count / sum / average, #3661), and asset-lock proofs. Wired into the docs/index.md toctree.
  • PlatformAddress encoding (#3059 BREAKING) — docs/protocol-ref/address-system.md clarified for the new HRPs (dash / tdash) and bech32m payload structure, with a note on the two distinct byte encodings (user-facing bech32m vs. internal GroveDB storage keys). Refreshed source-line anchors against current rs-dpp line numbers.
  • max_asset_lock_transaction_inputs (#3491) — added to the Identity Create Fees table in docs/protocol-ref/protocol-constants.md. New protocol-v3 limit (100) to prevent stuck funds.
  • feature-flags system contract removed (#3522) — dropped the row from docs/explanations/platform-protocol-data-trigger.md and the sample dashmate setup output in the masternode tutorial.
  • Sidebar regenerated for the new Proofs page.

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

Summary by CodeRabbit

  • New Features

    • Added comprehensive documentation on Dash Platform cryptographic proofs, covering proof models, verification flows, and asset lock proofs.
  • Documentation

    • Updated navigation to include new Proofs section.
    • Clarified Platform Address bech32m encoding specifications.
    • Updated protocol constants documentation.
    • Refreshed masternode setup tutorial examples.
    • Added navigation links for example applications.

Review Change Stack

thephez and others added 4 commits May 21, 2026 11:13
…ve feature-flags contract

PR #3059 renamed the PlatformAddress HRPs (evo/tevo → dash/tdash) and
introduced two distinct byte encodings (user-facing bech32m vs. internal
GroveDB storage). PR #3522 removed the feature-flags system contract.
Refresh source-line anchors against current rs-dpp line numbers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cover the two-layer proof model (GroveDB Merkle proofs + Tenderdash
consensus signatures), what can be proven, the v3.1 aggregate proof
primitives (count/sum/average), and asset lock proofs. Wire it into
the explanations toctree.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Introduced in protocol v3 (#3491) to prevent stuck funds; v1 and v2
had no effective limit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 21, 2026

Warning

Rate limit exceeded

@thephez has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 33 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a120dfe9-b834-41dd-9621-52f7e92dbb4d

📥 Commits

Reviewing files that changed from the base of the PR and between 1da2e10 and 428e6dc.

📒 Files selected for processing (1)
  • docs/protocol-ref/protocol-constants.md
📝 Walkthrough

Walkthrough

This PR updates Dash Platform documentation to introduce comprehensive cryptographic proofs documentation, clarify Platform Address bech32m encoding specifications, remove deprecated Feature Flags system contracts, and extend sidebar navigation with new example applications and Proofs links.

Changes

Platform Documentation Updates

Layer / File(s) Summary
Proofs documentation and navigation registration
docs/explanations/proofs.md, docs/index.md, _templates/sidebar-main.html
New comprehensive Proofs page explains two-layer architecture combining GroveDB Merkle proofs with Tenderdash BLS signatures, client verification flow via DAPI, supported proof types across identities/contracts/documents/tokens/state, aggregate proof primitives, asset lock proofs, and related topics. Page is registered in toctree and sidebar.
Platform address and protocol constant specifications
docs/protocol-ref/address-system.md, docs/protocol-ref/protocol-constants.md
Updated Platform Address documentation to clarify bech32m HRP (dash/tdash) encoding, distinguish user-facing type bytes from internal GroveDB bincode variants, and added inline variant/type-byte table. Added protocol v3 Identity Create Fees row for maximum Core transaction inputs in asset-lock transactions. Updated Address Constants to explicitly label bech32m variants.
Feature flags system contract deprecation
docs/explanations/platform-protocol-data-trigger.md, docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md
Removed Feature flags system-contract data trigger from platform-protocol-data-trigger.md table and corresponding example wizard registration output from masternode setup tutorial, reflecting contract deprecation.
Example applications sidebar navigation
_templates/sidebar-main.html
Extended sidebar Example apps section with four new nested links: Dashnote, DashMint Lite, Dashnote Lite, and DashProof Lite.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A rabbit hops through docs with glee, 🐰
Adding proofs for all to see!
With bech32m and assets locked tight,
The platform shines even more bright. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main documentation updates: adding a Proofs explanation page, clarifying address encoding details, and updating protocol constants.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/protocol-ref/protocol-constants.md`:
- Line 258: The table row currently labeled "Platform HRP (testnet)" and showing
the value "tdash" is misleading because "tdash" is used for all non-mainnet
networks (testnet, devnet, regtest), not just testnet; update that row's
label/description to say something like "Platform HRP (non‑mainnet:
testnet/devnet/regtest)" or similar, and ensure the value "tdash" remains and
the rs-dpp link is preserved so readers understand the broader non-mainnet
scope.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 34d23a1f-4f4e-4ab9-b1c1-f7573e59ce1e

📥 Commits

Reviewing files that changed from the base of the PR and between 4cb4104 and 1da2e10.

📒 Files selected for processing (7)
  • _templates/sidebar-main.html
  • docs/explanations/platform-protocol-data-trigger.md
  • docs/explanations/proofs.md
  • docs/index.md
  • docs/protocol-ref/address-system.md
  • docs/protocol-ref/protocol-constants.md
  • docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md
💤 Files with no reviewable changes (2)
  • docs/explanations/platform-protocol-data-trigger.md
  • docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md

Comment thread docs/protocol-ref/protocol-constants.md Outdated
@thephez thephez changed the base branch from 3.1.0 to develop May 21, 2026 16:29
@thephez thephez merged commit a07df37 into dashpay:develop May 21, 2026
2 checks passed
@thephez thephez deleted the v3.1/minor-cleanup branch May 21, 2026 18:29
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