dev-rel icon indicating copy to clipboard operation
dev-rel copied to clipboard

Reference doc of all Aztec macros

Open jzaki opened this issue 1 year ago • 2 comments

User Story - As a developer new to Aztec, I would like an understanding of what goes on in macros (eg "private"), so that I can have confidence in writing privacy preserving applications.

There are some references to different macros around the docs, but a search doesn't yield a doc that readily lists them all, defining what they do.

Task - Create a reference doc that generally explains Aztec macros, and defines each one.

jzaki avatar Mar 12 '24 15:03 jzaki

Summary of function level macros can be seen in VSCode via Ctrl+K then Ctrl+2 (fold to depth 2), then Ctrl+K then Ctrl+J (to unfold)

Related https://github.com/AztecProtocol/aztec-packages/issues/5162

jzaki avatar Mar 12 '24 16:03 jzaki

Related: https://github.com/AztecProtocol/dev-rel/issues/200 <- this one is an explainer vs a reference

critesjosh avatar Apr 15 '24 18:04 critesjosh