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

chore: move acir docs to code declaration #5040

Merged
merged 14 commits into from
Jun 4, 2024
Merged

chore: move acir docs to code declaration #5040

merged 14 commits into from
Jun 4, 2024

Conversation

michaeljklein
Copy link
Contributor

Description

Problem*

Resolves a few minor inaccuracies in the ACIR docs and moves their primary location to Rust.

Summary*

ACIR docs get stale quickly when detached from code/tests. This PR moves them to the code for now; we expect to move them back once ACIR is more stable.

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@michaeljklein
chore: move acir docs to code declaration and cleanup (some opcodes f…
f0e025c 
…rom the readme are already removed and some are missing)
@michaeljklein michaeljklein marked this pull request as ready for review May 16, 2024 20:30
TomAFrench
TomAFrench reviewed May 16, 2024
View reviewed changes
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

nit, can do a proper review later.

acvm-repo/acir/src/circuit/opcodes.rs Outdated Show resolved Hide resolved
@vezenovm
Copy link
Contributor

Can give this a proper look tomorrow

michaeljklein and others added 2 commits May 16, 2024 20:54
@michaeljklein @TomAFrench
Update acvm-repo/acir/src/circuit/opcodes.rs
5c918a9 
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@TomAFrench
chore: misc stuff
0a8bf9b
@vezenovm
Copy link
Contributor

Can give this a proper look tomorrow

Apologies for the delay will look today

vezenovm
vezenovm reviewed May 21, 2024
View reviewed changes
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/black_box_functions.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/opcodes.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/opcodes.rs Outdated Show resolved Hide resolved
acvm-repo/acir/src/circuit/opcodes.rs Outdated Show resolved Hide resolved
michaeljklein and others added 9 commits May 21, 2024 14:57
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
2e0a11f 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
2428751 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
a44b0d3 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
209844f 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
537cc5b 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/black_box_functions.rs
671ce80 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein @vezenovm
Update acvm-repo/acir/src/circuit/opcodes.rs
478f378 
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@michaeljklein
Merge branch 'master' into michaeljklein/acir-spec-with-code
2e0ac26
@michaeljklein
renamed FieldElement to witness when it could be more generic than a …
2da11bf 
…FieldElement, other responses to review comments / cleanup, cargo fmt
TomAFrench
TomAFrench approved these changes Jun 3, 2024
View reviewed changes
Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

Can you add homomorphic to cspell?

@michaeljklein michaeljklein added this pull request to the merge queue Jun 4, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 4, 2024
@vezenovm vezenovm added this pull request to the merge queue Jun 4, 2024
Merged via the queue into master with commit 2f573ec Jun 4, 2024
44 checks passed
@vezenovm vezenovm deleted the michaeljklein/acir-spec-with-code branch June 4, 2024 11:07
AztecBot added a commit to AztecProtocol/aztec-packages that referenced this pull request Jun 6, 2024
@AztecBot
[1 changes] chore: schnorr signature verification in noir (noir-lang/…
6464ee6 
…noir#5188)

fix(experimental elaborator): Fix globals which use function calls (noir-lang/noir#5172)
feat!: restrict noir word size to u32 (noir-lang/noir#5180)
chore: break out helper methods for writing foreign call results (noir-lang/noir#5181)
fix: Fix panic in `get_global_let_statement` (noir-lang/noir#5177)
fix(elaborator): Invert unconstrained check (noir-lang/noir#5176)
chore: loosen trait bounds on impls depending on `AcirField` (noir-lang/noir#5115)
feat: support casting in globals (noir-lang/noir#5164)
chore(experimental elaborator): Handle `comptime` expressions in the elaborator (noir-lang/noir#5169)
chore: avoid manual creation of contract artifact in wasm (noir-lang/noir#5117)
chore: start moving lints into a separate linting directory (noir-lang/noir#5165)
chore: move acir docs to code declaration (noir-lang/noir#5040)
feat!: separate proving from `noir_js` (noir-lang/noir#5072)
@AztecBot AztecBot mentioned this pull request Jun 6, 2024
Merged
AztecBot added a commit to AztecProtocol/aztec-packages that referenced this pull request Jun 6, 2024
@AztecBot
[1 changes] fix(elaborator): Lazily elaborate globals (noir-lang/noir…
002eecc 
…#5191)

chore: schnorr signature verification in noir (noir-lang/noir#5188)
fix(experimental elaborator): Fix globals which use function calls (noir-lang/noir#5172)
feat!: restrict noir word size to u32 (noir-lang/noir#5180)
chore: break out helper methods for writing foreign call results (noir-lang/noir#5181)
fix: Fix panic in `get_global_let_statement` (noir-lang/noir#5177)
fix(elaborator): Invert unconstrained check (noir-lang/noir#5176)
chore: loosen trait bounds on impls depending on `AcirField` (noir-lang/noir#5115)
feat: support casting in globals (noir-lang/noir#5164)
chore(experimental elaborator): Handle `comptime` expressions in the elaborator (noir-lang/noir#5169)
chore: avoid manual creation of contract artifact in wasm (noir-lang/noir#5117)
chore: start moving lints into a separate linting directory (noir-lang/noir#5165)
chore: move acir docs to code declaration (noir-lang/noir#5040)
feat!: separate proving from `noir_js` (noir-lang/noir#5072)
AztecBot added a commit to AztecProtocol/aztec-packages that referenced this pull request Jun 6, 2024
@AztecBot
fix(elaborator): Lazily elaborate globals (noir-lang/noir#5191)
bea3f5c 
chore: schnorr signature verification in noir (noir-lang/noir#5188)
fix(experimental elaborator): Fix globals which use function calls (noir-lang/noir#5172)
feat!: restrict noir word size to u32 (noir-lang/noir#5180)
chore: break out helper methods for writing foreign call results (noir-lang/noir#5181)
fix: Fix panic in `get_global_let_statement` (noir-lang/noir#5177)
fix(elaborator): Invert unconstrained check (noir-lang/noir#5176)
chore: loosen trait bounds on impls depending on `AcirField` (noir-lang/noir#5115)
feat: support casting in globals (noir-lang/noir#5164)
chore(experimental elaborator): Handle `comptime` expressions in the elaborator (noir-lang/noir#5169)
chore: avoid manual creation of contract artifact in wasm (noir-lang/noir#5117)
chore: start moving lints into a separate linting directory (noir-lang/noir#5165)
chore: move acir docs to code declaration (noir-lang/noir#5040)
feat!: separate proving from `noir_js` (noir-lang/noir#5072)
Maddiaa0 added a commit to AztecProtocol/aztec-packages that referenced this pull request Jun 6, 2024
@AztecBot @Maddiaa0 @vezenovm
feat: Sync from noir (#6941)
bf38cc2 
Automated pull of development from the
[noir](https://github.com/noir-lang/noir) programming language, a
dependency of Aztec.
BEGIN_COMMIT_OVERRIDE
fix(elaborator): Lazily elaborate globals
(noir-lang/noir#5191)
chore: schnorr signature verification in noir
(noir-lang/noir#5188)
fix(experimental elaborator): Fix globals which use function calls
(noir-lang/noir#5172)
feat!: restrict noir word size to u32
(noir-lang/noir#5180)
chore: break out helper methods for writing foreign call results
(noir-lang/noir#5181)
fix: Fix panic in `get_global_let_statement`
(noir-lang/noir#5177)
fix(elaborator): Invert unconstrained check
(noir-lang/noir#5176)
chore: loosen trait bounds on impls depending on `AcirField`
(noir-lang/noir#5115)
feat: support casting in globals
(noir-lang/noir#5164)
chore(experimental elaborator): Handle `comptime` expressions in the
elaborator (noir-lang/noir#5169)
chore: avoid manual creation of contract artifact in wasm
(noir-lang/noir#5117)
chore: start moving lints into a separate linting directory
(noir-lang/noir#5165)
chore: move acir docs to code declaration
(noir-lang/noir#5040)
feat!: separate proving from `noir_js`
(noir-lang/noir#5072)
END_COMMIT_OVERRIDE

---------

Co-authored-by: Maddiaa0 <47148561+Maddiaa0@users.noreply.github.com>
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
@AztecBot AztecBot mentioned this pull request Jun 6, 2024
Open
AztecBot added a commit to AztecProtocol/aztec-nr that referenced this pull request Jun 7, 2024
@AztecBot @Maddiaa0 @vezenovm
feat: Sync from noir (#6941)
8dde7a3 
Automated pull of development from the
[noir](https://github.com/noir-lang/noir) programming language, a
dependency of Aztec.
BEGIN_COMMIT_OVERRIDE
fix(elaborator): Lazily elaborate globals
(noir-lang/noir#5191)
chore: schnorr signature verification in noir
(noir-lang/noir#5188)
fix(experimental elaborator): Fix globals which use function calls
(noir-lang/noir#5172)
feat!: restrict noir word size to u32
(noir-lang/noir#5180)
chore: break out helper methods for writing foreign call results
(noir-lang/noir#5181)
fix: Fix panic in `get_global_let_statement`
(noir-lang/noir#5177)
fix(elaborator): Invert unconstrained check
(noir-lang/noir#5176)
chore: loosen trait bounds on impls depending on `AcirField`
(noir-lang/noir#5115)
feat: support casting in globals
(noir-lang/noir#5164)
chore(experimental elaborator): Handle `comptime` expressions in the
elaborator (noir-lang/noir#5169)
chore: avoid manual creation of contract artifact in wasm
(noir-lang/noir#5117)
chore: start moving lints into a separate linting directory
(noir-lang/noir#5165)
chore: move acir docs to code declaration
(noir-lang/noir#5040)
feat!: separate proving from `noir_js`
(noir-lang/noir#5072)
END_COMMIT_OVERRIDE

---------

Co-authored-by: Maddiaa0 <47148561+Maddiaa0@users.noreply.github.com>
Co-authored-by: Maxim Vezenov <mvezenov@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TomAFrench TomAFrench TomAFrench approved these changes

@vezenovm vezenovm vezenovm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@michaeljklein @vezenovm @TomAFrench