Repository navigation
docs(confidential): align compliance and protocol docs with the code - #956
Closed
ninglinLiu wants to merge 1 commit into
Closed
ninglinLiu wants to merge 1 commit into
ninglinLiu wants to merge 1 commit into
Conversation
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
Contributor
|
Warning Review limit reachedYou'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. View limit details
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 |
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.
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.mdNotConfigured: withcompliance: None, onlyfreezeandunfreezerevert withNotConfigured(src/compliance/storage.rs).clawbackandforce_revoke_spenderrevert withAccountNotFrozen, since no account can be frozen.set_compliance_confighas no guard because it is the single setter for both the first write and later rotations. The Interface Summary comment onset_compliance_configis updated to say the same.on_deposit: it gatesfromandtowith the freeze, policy and SAC checks. It does not requirefromto be registered, becausestorage::depositchecks registration only forto. 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_registersample:payload: Val→payload: &RegisterPayload, matchingHooks::on_registerinsrc/lib.rs.docs/protocol/proof-system.mdsoroban-sdk28 andultrahonk_soroban_verifier0.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.md1.0.0-beta.11withbb 0.87.0, while the verifier crate's README listsbeta.9.PR Checklist
AI disclosure: I used an AI coding assistant to help prepare this PR. I checked each statement against the code at
mainand against theultrahonk_soroban_verifier0.1.0 README.