docs: add map and state variable docs (backport #22824)#22880
Merged
nventuro merged 1 commit intobackport-to-v4-next-stagingfrom May 4, 2026
Merged
docs: add map and state variable docs (backport #22824)#22880nventuro merged 1 commit intobackport-to-v4-next-stagingfrom
nventuro merged 1 commit intobackport-to-v4-next-stagingfrom
Conversation
These contain a basic explainer on some state variable concepts, add some missing bits there (like a table with different kinds of statevars and their usecases), and greatly expands on (completes) `Map` documentation.
AztecBot
added
ci-draft
AztecBot
added a commit
that referenced
this pull request
May 5, 2026
BEGIN_COMMIT_OVERRIDE docs: add map and state variable docs (#22824) fix: e2e compat should not fail for contracts added after legacy stables (#22900) chore: fix kv-store browser tests hangs (#22721) feat: kv-store sqlite backend with page level encryption (#22759) fix: install node 22 for aztec-cli acceptance test (#22917) feat: backport kv-store sqlite encryption (#22759) to v4-next (#22927) fix(docs): correct llms.txt links for versioned developer docs (#22819) feat(docs): improve discoverability of Aztec.nr API reference docs (#22861) feat(docs): backport improve discoverability of Aztec.nr API reference docs (#22861) to v4-next (#22931) feat(aztec-nr): add call_self stubs for utility functions (#22885) docs: add map and state variable docs (backport #22824) (#22880) refactor: `getPackageVersion` fn cleanup (#22941) fix(ci): skip acceptance test for canary -commit. tags (#22951) fix: closing db, correct stub side effects (#22939) END_COMMIT_OVERRIDE
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
2 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.
Summary
Backport of #22824 to
v4-next.The PR is purely a docs update to
aztec-nr/aztec/src/state_vars/:Mapdocumentationstate_vars/mod.nr(intro, public/private state variable comparison tables, storage slots,Contextparameter)public_mutable.nrandstate_variable.nrConflict resolution
Three test files conflicted:
propagated_note_hashes_tests.nr,propagated_nullifiers_tests.nr,propagated_private_logs_tests.nr.The conflicts were incidental adjacent-line drift (a
use super::rebuild_bounded_vec;import and a couple of reformattedBoundedVec.pop()rebuild call sites) that belong to a separateBoundedVec.pop()change which has not yet been backported tov4-next. I kept thev4-next(HEAD) state in those three files so this PR contains only the docs changes that PR #22824 was actually about.Full analysis: https://gist.github.com/AztecBot/36b70c2ad5fdfe6a9e4101ec56230cc1
ClaudeBox log: https://claudebox.work/s/126c3faff0c2af32?run=4