Skip to content

docs: update Aztec.nr contract structure and state variables #19726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
ciaranightingale wants to merge 36 commits into
base: next
Choose a base branch
from
Open

docs: update Aztec.nr contract structure and state variables #19726

ciaranightingale wants to merge 36 commits into from
+1,640 −1,180

Conversation

@ciaranightingale
Copy link
Contributor

@ciaranightingale ciaranightingale commented Jan 19, 2026 •
edited
Loading

Add Nico's detailed Aztec.nr content

@ciaranightingale ciaranightingale mentioned this pull request Jan 19, 2026
Closed
@ciaranightingale ciaranightingale marked this pull request as ready for review January 20, 2026 14:13
critesjosh
critesjosh requested changes Jan 20, 2026
View reviewed changes
critesjosh
critesjosh requested changes Jan 20, 2026
View reviewed changes
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions. I think having Claude do a pass on your PR would helpful as well to catch grammatical errors. I suggest telling it to use the guidelines defined in docs/CLAUDE.md

@nchamo nchamo requested review from nventuro and removed request for nchamo January 20, 2026 17:52
critesjosh
critesjosh requested changes Jan 22, 2026
View reviewed changes
@critesjosh
Copy link
Contributor

critesjosh commented Jan 22, 2026

Also have Claude do a pass, following the guidelines in docs/CLAUDE.md for grammar and style consistency

nventuro
nventuro reviewed Jan 23, 2026
View reviewed changes
ciaranightingale and others added 12 commits January 28, 2026 12:46
@ciaranightingale @critesjosh
Update noir-projects/noir-contracts/contracts/test/test_contract/src/…
f2495c3 
…main.nr

Co-authored-by: josh crites <[email protected]>
@ciaranightingale @critesjosh
Update docs/docs-developers/docs/aztec-nr/framework-description/contr…
80cc7d9 
…act_structure.md

Co-authored-by: josh crites <[email protected]>
@ciaranightingale @critesjosh
Update docs/docs-developers/docs/aztec-nr/framework-description/contr…
d779e34 
…act_structure.md

Co-authored-by: josh crites <[email protected]>
@ciaranightingale @critesjosh
Update docs/docs-developers/docs/aztec-nr/framework-description/contr…
ae2c484 
…act_structure.md

Co-authored-by: josh crites <[email protected]>
@ciaranightingale @nventuro
Update docs/docs-developers/docs/aztec-nr/index.md
c2d5cde 
Co-authored-by: Nicolás Venturo <[email protected]>
@ciaranightingale @nventuro
Update docs/docs-developers/docs/aztec-nr/index.md
bda37a9 
Co-authored-by: Nicolás Venturo <[email protected]>
@ciaranightingale @critesjosh
Update docs/docs-developers/docs/aztec-nr/framework-description/contr…
5738ee4 
…act_structure.md

Co-authored-by: josh crites <[email protected]>
@ciaranightingale
modify redirect
3ec8e7e
@ciaranightingale @critesjosh
Update docs/docs-developers/docs/aztec-nr/framework-description/contr…
8b4f821 
…act_structure.md

Co-authored-by: josh crites <[email protected]>
@ciaranightingale
Merge branch 'docs/nico-changes' of https://github.com/AztecProtocol/…
242c219 
…aztec-packages into docs/nico-changes
@ciaranightingale
requested changes
ee4df0d
@ciaranightingale
add api refs
b8e25ac
@ciaranightingale ciaranightingale force-pushed the docs/nico-changes branch 3 times, most recently from c7b1de3 to 8d575aa Compare January 30, 2026 14:26
critesjosh
critesjosh reviewed Jan 30, 2026
View reviewed changes
docs/docs-developers/docs/aztec-nr/framework-description/contract_structure.md
// A private numeric value which can change over time. This value will be hidden, and only those with the secret can know its current value.
my_private_state_variable: Owned<PrivateMutable<NoteType, Context>>,
// A public numeric value which can change over time. This value will be known to everyone and is equivalent to the Solidity example above.
my_public_state_variable: Owned<PublicMutable<NoteType, Context>>,
Copy link
Contributor

@critesjosh critesjosh Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

public mutables arent owned. also it may be confusing to call the type a NoteType since public state doesnt actually use notes

docs/docs-developers/docs/aztec-nr/framework-description/state_variables.md
#### Delivery Methods

Private notes need to be communicated to their recipients so they know the note exists and can use it. The [`NoteMessage`](https://docs.aztec.network/aztec-nr-api/nightly/noir_aztec/note/struct.notemessage) wrapper forces you to make an explicit choice about how this happens:
[
Copy link
Contributor

@critesjosh critesjosh Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[

docs/docs-developers/docs/aztec-nr/framework-description/state_variables.md
}
```

In Aztec.nr, we define a [`struct`](https://noir-lang.org/docs/noir/concepts/data_types/structs) that holds _all_ state variables. This struct is called **the storage struct**, and it is identified by having the [`#[storage]` macro](https://docs.aztec.network/aztec-nr-api/nightly/noir_aztec/macros/storage/fn.storage) applied to it.
Copy link
Contributor

@critesjosh critesjosh Jan 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be a relative link to the appropriate version. wdyt about adding a preprocessing macro, something like (to include_version.js?

  // New macro for API ref paths                                                                             
  const apiRefVersion = releaseType === "nightly" ? "nightly"                                                
                      : releaseType === "devnet" ? "devnet"                                                  
                      : "next";                                                                              
  markdownContent = markdownContent.replaceAll(`#api_ref_version`, apiRefVersion);

Then links could be:
"[#[storage] macro] (/aztec-nr-api/#api_ref_version/noir_aztec/macros/storage/fn.storage)"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@critesjosh critesjosh critesjosh requested changes

@nventuro nventuro Awaiting requested review from nventuro

@benesjan benesjan Awaiting requested review from benesjan

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ciaranightingale @critesjosh @nventuro