Clarifications (and additions) for private buckets#298
Open
eskimor wants to merge 8 commits into
Open
Conversation
Mermaid treats a semicolon in note/message text as a statement separator, so the challenge_checkpoint and respond_to_challenge diagrams broke mid-note and failed to render. Replace the two offending semicolons with commas.
Fold each field-by-field "Note over X:" block into a single note using <br/>, matching the register_provider style, so structs render as one box instead of a stack of separate note boxes. Also add blank lines before three lists. Purely cosmetic.
- Pad each ASCII box so every right border sits at the same column; they were jagged across columns 74-76. - Drop the unused Balances participant from the create_drive diagram. - Collapse the create_drive DriveInfo note into a single <br/> note (missed in the earlier reformat pass).
ilchu
approved these changes
Jul 20, 2026
ilchu
left a comment
ilchu
left a comment
Collaborator
There was a problem hiding this comment.
Just some small doc and diagram related comments.
| **Per-bucket MMR**: The bucket has ONE canonical MMR state. Multiple providers may store the bucket, and they should all converge to this state. The MMR is not per-provider. | ||
|
|
||
| **Roles**: | ||
| **Roles** (Admin implies Writer implies Reader—each can do everything the next can): |
Collaborator
There was a problem hiding this comment.
Suggested change
| **Roles** (Admin implies Writer implies Reader—each can do everything the next can): | |
| **Roles** (Admin subsumes Writer subsumes Reader - each can do at least everything the next can): |
Comment on lines
+1094
to
+1096
| /// - `visibility`: `Public` or `Private` (see `Visibility`). Wrappers that | ||
| /// omit the choice must default to `Private` (fail-safe: an unset choice | ||
| /// should protect data, not expose it). |
Collaborator
There was a problem hiding this comment.
Maybe then we could mark the private variant as #[default] above?
Comment on lines
+480
to
+482
| Note over C: (authorized = member or agreement owner; stored in the | ||
| Note over C: challenge so later membership changes don't alter the fee | ||
| Note over C: split on a valid response — see respond_to_challenge) |
Collaborator
There was a problem hiding this comment.
I've noticed that this kind of note splits into separate boxes when rendered, which is very inconvenient to read, and having a single note with <br/> markdown is much more manageable. And as a second point, ";" seems to be a reserved character so it breaks the render completely. As I've already tested it out locally, I'll push these changes to the branch if you don't mind.
# Conflicts: # docs/design/EXECUTION_FLOWS.md
bkontur
self-requested a review
July 21, 2026 09:53
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
3 participants
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.
The Reader role suggested that there should be private buckets - and it does seem they are genuinely useful, thus this PR adds the missing bits and clarifications to make them actually work