Skip to content

docs(confidential): align compliance and protocol docs with the code - #956

Closed
ninglinLiu wants to merge 1 commit into
OpenZeppelin:mainfrom
ninglinLiu:docs/confidential-spec-drift
Closed

ninglinLiu wants to merge 1 commit into
OpenZeppelin:mainfrom
ninglinLiu:docs/confidential-spec-drift

Conversation

@ninglinLiu

Copy link
Copy Markdown

Fixes #949

This updates the confidential token docs to match the code for every item in #949. Each change follows the code, which looks intended in all five cases. No code changes.

docs/compliance.md

  • NotConfigured: with compliance: None, only freeze and unfreeze revert with NotConfigured (src/compliance/storage.rs). clawback and force_revoke_spender revert with AccountNotFrozen, since no account can be frozen. set_compliance_config has no guard because it is the single setter for both the first write and later rotations. The Interface Summary comment on set_compliance_config is updated to say the same.
  • Default on_deposit: it gates from and to with the freeze, policy and SAC checks. It does not require from to be registered, because storage::deposit checks registration only for to. The "Permit Unregistered Deposits" example is unchanged; it still differs from the default because it skips the freeze and policy gates for unregistered senders.
  • on_register sample: payload: Val → payload: &RegisterPayload, matching Hooks::on_register in src/lib.rs.

docs/protocol/proof-system.md

  • The doc now says protocol 28 is the effective minimum for deployment. That comes from soroban-sdk 28 and ultrahonk_soroban_verifier 0.1.0, whose README says contracts built with it require protocol 28 or newer. The doc still records 25 and 26 as the protocols where the CAP-80 host functions landed.

circuits/vks/README.md

  • A new note says the repo uses and tests nargo 1.0.0-beta.11 with bb 0.87.0, while the verifier crate's README lists beta.9.

PR Checklist

  • Tests (docs only)
  • Documentation

AI disclosure: I used an AI coding assistant to help prepare this PR. I checked each statement against the code at main and against the ultrahonk_soroban_verifier 0.1.0 README.

The confidential token docs had drifted from the code in a few places
(found in OpenZeppelin#949):

- compliance.md: with compliance None, only freeze/unfreeze revert with
  NotConfigured; clawback and force_revoke_spender revert with
  AccountNotFrozen, and set_compliance_config has no guard.
- compliance.md: the default on_deposit does not require the depositor to
  be registered; the core only checks `to`.
- compliance.md: the on_register sample takes `&RegisterPayload`, not `Val`.
- proof-system.md: protocol 28 is the effective minimum for deployment
  (soroban-sdk 28 and ultrahonk_soroban_verifier 0.1.0).
- circuits/vks/README.md: note that nargo 1.0.0-beta.11 is used and tested
  even though the verifier crate lists beta.9.

Fixes OpenZeppelin#949
@coderabbitai

coderabbitai Bot commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3988839c-7f95-4541-b48d-a8421f4a1d7f
Commits

Reviewing files that changed from the base of the PR and between ddc327e and 7e86a0d.

Files selected for processing: 3
  • packages/confidential/circuits/vks/README.md
  • packages/confidential/docs/compliance.md
  • packages/confidential/docs/protocol/proof-system.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@son-oz son-oz closed this Oct 29, 2026
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.

Confidential Token: specs disagree with the code in a few places

2 participants