Skip to content
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

docs: storage and state variables #1725

Merged
merged 9 commits into from
Sep 1, 2023
Merged

docs: storage and state variables #1725

merged 9 commits into from
Sep 1, 2023

Conversation

LeilaWang
Copy link
Contributor

@LeilaWang LeilaWang commented Aug 22, 2023 •
edited by iAmMichaelConnor
Loading

Fixes #1610
Fixes #1509

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

iAmMichaelConnor
iAmMichaelConnor reviewed Aug 22, 2023
View reviewed changes
docs/docs/dev_docs/contracts/storage.md

#include_code storage-declaration /yarn-project/noir-contracts/src/contracts/private_token_contract/src/storage.nr rust
#include_code storage-declaration /yarn-project/noir-contracts/src/contracts/docs_example_contract/src/storage.nr rust
Copy link
Contributor

Choose a reason for hiding this comment

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

I'll start reviewing this now (in between other meetings). It's looking lovely!

My first comment: If the example contract is going to be used throughout the syntax explanations (which is a very nice idea), should we have a page or paragraph which introduces the purpose of this contract? What is the game? What is the objective of the game? What are the rules? What do players do?

It feels like this explanation could be both a README within the contract's directory, but also as a dedicated page or paragraph of these docs?

iAmMichaelConnor
iAmMichaelConnor requested changes Aug 22, 2023
View reviewed changes
Copy link
Contributor

@iAmMichaelConnor iAmMichaelConnor left a comment

Choose a reason for hiding this comment

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

Hi Leila! Thanks so much for doing this! I can see it must have taken ages. The code snippets are meticulously planned, and comprehensive!
I've added a few comments and suggestions. Some of my documentation reviews have been quite detailed - sorry about that!
We might want to open issues for some of my comments, so as not to delay this PR for too long, though.

yarn-project/noir-contracts/src/contracts/docs_example_contract/src/storage/locked.nr Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Outdated Show resolved Hide resolved
docs/docs/dev_docs/contracts/state_variables.md Show resolved Hide resolved
LeilaWang and others added 3 commits August 25, 2023 18:14
@LeilaWang @iAmMichaelConnor
Updated docs.
12fb070 
Co-authored-by: Michael Connor <mike@aztecprotocol.com>
@LeilaWang
More examples.
80c51e2
@LeilaWang
Update docs.
6e5c2d6
This was referenced Aug 29, 2023
Closed
Closed
Closed
@iAmMichaelConnor iAmMichaelConnor merged commit fc72f84 into master Sep 1, 2023
2 checks passed
@iAmMichaelConnor iAmMichaelConnor deleted the lw/docs_noir_contract branch September 1, 2023 15:36
@github-actions github-actions bot mentioned this pull request Sep 1, 2023
Merged
PhilWindle pushed a commit that referenced this pull request Sep 5, 2023
@github-actions
chore(master): release 0.1.0-alpha50 (#1900)
8135fee 
🤖 I have created a new Aztec Packages release
---


##
[0.1.0-alpha50](v0.1.0-alpha49...v0.1.0-alpha50)
(2023-09-05)


### ⚠ BREAKING CHANGES

* update to acvm 0.24.0
([#1925](#1925))

### Features

* **892:** add hints for matching transient read requests with
correspondi…
([#1995](#1995))
([0955bb7](0955bb7))
* Add support for assert messages & runtime call stacks
([#1997](#1997))
([ac68837](ac68837))
* **Aztec.nr:** Kernel return types abstraction
([#1924](#1924))
([3a8e702](3a8e702))
* **ci:** use content hash in build system, restrict docs build to *.ts
or *.cpp
([#1953](#1953))
([0036e07](0036e07))
* do not allow slot 0 in `noir-libs`
([#1884](#1884))
([54094b4](54094b4)),
closes
[#1692](#1692)
* throwing when submitting a duplicate tx of a settled one
([#1880](#1880))
([9ad768f](9ad768f)),
closes
[#1810](#1810)
* typos, using Tx.clone functionality, better naming
([#1976](#1976))
([00bca67](00bca67))


### Bug Fixes

* add retry_10 around ensure_repo
([#1963](#1963))
([0afde39](0afde39))
* Adds Mac cross compile flags into barretenberg
([#1954](#1954))
([3aaf91e](3aaf91e))
* bb meta-data
([#1960](#1960))
([712e0a0](712e0a0))
* **bb.js:** (breaking change) bundles bb.js properly so that it works
in the browser and in node
([#1855](#1855))
([1aa6f59](1aa6f59))
* Benchmark preset uses clang16
([#1902](#1902))
([4f7eeea](4f7eeea))
* build
([#1906](#1906))
([8223be1](8223be1))
* **ci:** Incorrect content hash in some build targets
([#1973](#1973))
([0a2a515](0a2a515))
* circuits should not link openmp with -DMULTITHREADING
([#1929](#1929))
([cd1a685](cd1a685))
* compilation on homebrew clang 16.06
([#1937](#1937))
([c611582](c611582))
* docs preprocessor line numbers and errors
([#1883](#1883))
([4e7e290](4e7e290))
* ensure CLI command doesn't fail due to missing client version
([#1895](#1895))
([88086e4](88086e4))
* error handling in acir simulator
([#1907](#1907))
([165008e](165008e))
* Fix off by one in circuits.js when fetching points from transcript
([#1993](#1993))
([cec901f](cec901f))
* format.sh issues
([#1946](#1946))
([f24814b](f24814b))
* master
([#1981](#1981))
([6bfb053](6bfb053))
* More accurate c++ build pattern
([#1962](#1962))
([21c2f8e](21c2f8e))
* polyfill by bundling fileURLToPath
([#1949](#1949))
([1b2de01](1b2de01))
* Set correct version of RPC & Sandbox when deploying tagged commit
([#1914](#1914))
([898c50d](898c50d))
* typescript lookup of aztec.js types
([#1948](#1948))
([22901ae](22901ae))
* unify base64 interface between mac and linux (cherry-picked)
([#1968](#1968))
([ee24b52](ee24b52))
* Update docs search config
([#1920](#1920))
([c8764e6](c8764e6))
* update docs search keys
([#1931](#1931))
([03b200c](03b200c))


### Miscellaneous

* **1407:** remove forwarding witnesses
([#1930](#1930))
([cc8bc8f](cc8bc8f)),
closes
[#1407](#1407)
* **1879:** add use of PrivateKernelPublicInputs in TS whenever relevant
([#1911](#1911))
([8d5f548](8d5f548))
* acir tests are no longer base64 encoded
([#1854](#1854))
([7fffd16](7fffd16))
* Add back double verify proof to test suite
([#1986](#1986))
([f8688d7](f8688d7))
* add CLI test to canary flow
([#1918](#1918))
([cc68958](cc68958)),
closes
[#1903](#1903)
* Add safemath noir testing
([#1967](#1967))
([cb1f1ec](cb1f1ec))
* **Aztec.nr:** remove implicit imports
([#1901](#1901))
([c7d5190](c7d5190))
* **Aztec.nr:** Remove the open keyword from public functions
([#1917](#1917))
([4db8603](4db8603))
* **ci:** build docs on every pr
([#1955](#1955))
([c200bc5](c200bc5))
* Enable project-specific releases for dockerhub too
([#1721](#1721))
([5d2c082](5d2c082))
* reduce max circuit size in bb binary
([#1942](#1942))
([c61439b](c61439b))
* Reference noir master for acir tests
([#1969](#1969))
([86b72e1](86b72e1))
* remove debug output from `run_acir_tests` script
([#1970](#1970))
([74c83c5](74c83c5))
* storing `&mut context` in state vars
([#1926](#1926))
([89a7a3f](89a7a3f)),
closes
[#1805](#1805)
* sync bb master
([#1947](#1947))
([eed58e1](eed58e1))
* update to acvm 0.24.0
([#1925](#1925))
([e728304](e728304))
* Update to acvm 0.24.1
([#1978](#1978))
([31c0a02](31c0a02))
* updating docs to clang16
([#1875](#1875))
([a248dae](a248dae))


### Documentation

* **keys:** Complete addresses are now broadcast
([#1975](#1975))
([92068ad](92068ad)),
closes
[#1936](#1936)
* limitations, privacy, roadmap
([#1759](#1759))
([0cdb27a](0cdb27a))
* put dev docs before spec
([#1944](#1944))
([f1b29cd](f1b29cd))
* storage and state variables
([#1725](#1725))
([fc72f84](fc72f84))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@dan-aztec dan-aztec mentioned this pull request Sep 29, 2023
Merged
Maddiaa0 added a commit that referenced this pull request Oct 9, 2023
@dan-aztec @Maddiaa0
chore: add storage slot to docs (#2601)
a7710f0 
#1725 (comment)

acir-simulator has oracle calls for read/write public state <- read
these to see how storage actually works.
see the oracle callback, note write is only available in public context.

in aztec-nr, see the oracle-storage.nr (storage read and storage write).

---------

Co-authored-by: Maddiaa <47148561+Maddiaa0@users.noreply.github.com>
AztecBot pushed a commit to AztecProtocol/docs that referenced this pull request Oct 10, 2023
@dan-aztec @Maddiaa0 @AztecBot
chore: add storage slot to docs (#2601)
8313933 
AztecProtocol/aztec-packages#1725 (comment)

acir-simulator has oracle calls for read/write public state <- read
these to see how storage actually works.
see the oracle callback, note write is only available in public context.

in aztec-nr, see the oracle-storage.nr (storage read and storage write).

---------

Co-authored-by: Maddiaa <47148561+Maddiaa0@users.noreply.github.com>
codygunton pushed a commit that referenced this pull request Jan 23, 2024
@LHerskind
Use contract abis in blockchain (#1725)
c8a99dc 
* initial work on abis

* fix blockchain tests

* fix: RollupProcessor abi name

* fix: add symlink and update key structure

* add script for creating fixtures + fix symlink + generate prod key

* fix: prettier formatting

* fix linter issues

* re-add deploy_dev

* fix: replace mock with dummy

* update local build + increase gas for asset listing

* remove blockchain/contracts + fix last abis + anvil instead of ganache E2E

* fix: update chain id switch

* fix: Turn capped off for dev and e2e + default chain-id

* generate rollup proof data for solidity test

* fix: bump foundry version in dockers

* revert back to ganache

* fix formatting on docker-compose

* fix: return of squiggly lines

* fix: restructure abi folders
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iAmMichaelConnor iAmMichaelConnor iAmMichaelConnor approved these changes

Assignees
No one assigned
Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs/dev-docs/contracts/storage docs/dev-docs/contracts/state_variables
2 participants
@LeilaWang @iAmMichaelConnor