docs(local-store): specify namespace isolation as the contract, not the prefix scheme#525
Open
lgahdl wants to merge 1 commit into
Open
docs(local-store): specify namespace isolation as the contract, not the prefix scheme#525lgahdl wants to merge 1 commit into
lgahdl wants to merge 1 commit into
Conversation
…he prefix scheme The local_store_redb rustdoc and docs/diagrams/diagrams.md pinned the host-side keccak256(module_name) prefix (and its ENS-node-derivation rationale, ADR-0003) as if it were the specified guarantee. The contract is namespace isolation between modules - disjoint, non-forgeable key ranges - not the specific prefix mechanism, which remains free to change. Reworded rustdoc and the diagram tables to state the isolation guarantee first and demote the keccak256/ADR-0003 prefix scheme to an implementation note. Closes #425
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
1 participant
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.
Summary
local_store_redbmodule rustdoc anddocs/diagrams/diagrams.mdpinned the host-sidekeccak256(module_name)prefix mechanism (and its ENS-node-derivation rationale, ADR-0003) as if it were the specified contract.diagrams.mdtable rows (plus the WIT hierarchy diagram annotation) to state the isolation guarantee first, and demoted the keccak256/ADR-0003 prefix scheme to an implementation note.cargo check -p nexum-runtimepasses (doc-comment-only change to that crate).Closes #425