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.

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

chore: aztec-macros refactor #5127

Merged
merged 10 commits into from
Mar 11, 2024
Merged

chore: aztec-macros refactor #5127

merged 10 commits into from
Mar 11, 2024

Conversation

Thunkar
Copy link
Contributor

@Thunkar Thunkar commented Mar 11, 2024

Partially addresses #5080

Until we have full macro support in noir, this PR aims to make using what we currently have a little bit less painful.
The crate is now divided into utils of several kind (ast manipulation, error handling, hir manipulation...) and transforms.

A transform is an end-to-end modification to the noir code that generates a valid compilation result from a given contract. This makes it easier to manipulate (and hopefully soon, replace) said modifications atomically, improving readability.

This also modifies the first macro pass to iterate over all crates, not only the root one, which allows us to implement more stuff without having to dig deep into the def collector or (god forbid) the interner.

The second macro pass has been renamed to process_collected_defs. Tried to generalize it a bit more, but providing a mutable ref for the whole def_collector turned out to be tricky without cloning def_maps, so it's staying like it is now.

@Thunkar Thunkar self-assigned this Mar 11, 2024
@AztecBot
Copy link
Collaborator

AztecBot commented Mar 11, 2024

Benchmark results

Metrics with a significant change:

  • note_successful_decrypting_time_in_ms (32): 476 (-28%)
Detailed results

All benchmarks are run on txs on the Benchmarking contract on the repository. Each tx consists of a batch call to create_note and increment_balance, which guarantees that each tx has a private call, a nested private call, a public call, and a nested public call, as well as an emitted private note, an unencrypted log, and public storage read and write.

This benchmark source data is available in JSON format on S3 here.

Values are compared against data from master at commit 9ca41ef6 and shown if the difference exceeds 1%.

L2 block published to L1

Each column represents the number of txs on an L2 block published to L1.

Metric 8 txs 32 txs 64 txs
l1_rollup_calldata_size_in_bytes 5,668 18,820 36,356
l1_rollup_calldata_gas 66,028 238,684 468,608
l1_rollup_execution_gas 666,508 953,393 1,335,764
l2_block_processing_time_in_ms 1,324 (+2%) 4,614 8,764 (-7%)
note_successful_decrypting_time_in_ms 141 (-6%) ⚠️ 476 (-28%) 1,007 (+2%)
note_trial_decrypting_time_in_ms 45.6 (-19%) 91.1 (+19%) 40.7 (-65%)
l2_block_building_time_in_ms 12,429 (-1%) 49,074 96,840 (-1%)
l2_block_rollup_simulation_time_in_ms 7,344 (-1%) 29,111 57,495
l2_block_public_tx_process_time_in_ms 5,055 19,896 (-1%) 39,232 (-1%)

L2 chain processing

Each column represents the number of blocks on the L2 chain where each block has 16 txs.

Metric 5 blocks 10 blocks
node_history_sync_time_in_ms 13,940 25,496 (-6%)
note_history_successful_decrypting_time_in_ms 1,191 (+1%) 2,340 (-3%)
note_history_trial_decrypting_time_in_ms 65.2 (+9%) 180 (+8%)
node_database_size_in_bytes 18,657,360 35,524,688 (+1%)
pxe_database_size_in_bytes 29,859 59,414

Circuits stats

Stats on running time and I/O sizes collected for every circuit run across all benchmarks.

Circuit circuit_simulation_time_in_ms circuit_input_size_in_bytes circuit_output_size_in_bytes
private-kernel-init 272 44,338 27,700
private-kernel-ordering 205 (-1%) 52,324 14,326
base-rollup 652 (-2%) 177,083 925
root-rollup 67.8 (-1%) 4,176 789
private-kernel-inner 361 73,197 27,700
public-kernel-app-logic 179 (-1%) 34,582 27,671
public-kernel-tail 91.5 (-1%) 34,206 27,671
merge-rollup 8.14 (-1%) 2,696 925

Tree insertion stats

The duration to insert a fixed batch of leaves into each tree type.

Metric 1 leaves 16 leaves 64 leaves 128 leaves 512 leaves 1024 leaves 2048 leaves 4096 leaves 32 leaves
batch_insert_into_append_only_tree_16_depth_ms 10.2 (+1%) 15.7 (-1%) N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_count 16.8 31.6 N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_ms 0.593 (+1%) 0.487 (-1%) N/A N/A N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_32_depth_ms N/A N/A 46.1 (-3%) 70.9 (-1%) 231 432 (-2%) 864 1,668 (-2%) N/A
batch_insert_into_append_only_tree_32_depth_hash_count N/A N/A 96.0 159 543 1,055 2,079 4,127 N/A
batch_insert_into_append_only_tree_32_depth_hash_ms N/A N/A 0.474 (-3%) 0.438 (-1%) 0.422 0.405 (-3%) 0.411 0.400 (-2%) N/A
batch_insert_into_indexed_tree_20_depth_ms N/A N/A 52.9 (-1%) 105 (-1%) 336 641 (-2%) 1,293 (-1%) 2,548 (-2%) N/A
batch_insert_into_indexed_tree_20_depth_hash_count N/A N/A 104 207 691 1,363 2,707 5,395 N/A
batch_insert_into_indexed_tree_20_depth_hash_ms N/A N/A 0.472 (-1%) 0.474 (-1%) 0.458 0.442 (-2%) 0.450 (-1%) 0.444 (-2%) N/A
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A N/A N/A N/A N/A N/A 59.8 (-2%)
batch_insert_into_indexed_tree_40_depth_hash_count N/A N/A N/A N/A N/A N/A N/A N/A 109
batch_insert_into_indexed_tree_40_depth_hash_ms N/A N/A N/A N/A N/A N/A N/A N/A 0.525 (-2%)

Miscellaneous

Transaction sizes based on how many contract classes are registered in the tx.

Metric 0 registered classes
tx_size_in_bytes 19,191

Transaction processing duration by data writes.

Metric 0 new note hashes 1 new note hashes
tx_pxe_processing_time_ms 2,805 (-1%) 1,429 (-1%)
Metric 0 public data writes 1 public data writes
tx_sequencer_processing_time_ms 9.87 (-7%) 610 (-1%)

@Thunkar Thunkar marked this pull request as ready for review March 11, 2024 11:56
Copy link
Contributor

@sirasistant sirasistant left a comment

Choose a reason for hiding this comment

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

Just some nits!

Copy link
Contributor

@vezenovm vezenovm left a comment

Choose a reason for hiding this comment

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

Much nicer to have this package split up

@Thunkar Thunkar merged commit 2195441 into master Mar 11, 2024
97 checks passed
@Thunkar Thunkar deleted the gj/aztec-macros-refactor branch March 11, 2024 15:52
AztecBot added a commit to noir-lang/noir that referenced this pull request Mar 11, 2024
Partially addresses
AztecProtocol/aztec-packages#5080

Until we have full macro support in noir, this PR aims to make using
what we currently have a little bit less painful.
The crate is now divided into utils of several kind (ast manipulation,
error handling, hir manipulation...) and transforms.

A transform is an end-to-end modification to the noir code that
generates a valid compilation result from a given contract. This makes
it easier to manipulate (and hopefully soon, replace) said modifications
atomically, improving readability.

This also modifies the first macro pass to iterate over all crates, not
only the root one, which allows us to implement more stuff without
having to dig deep into the def collector or (god forbid) the interner.

The second macro pass has been renamed to `process_collected_defs`.
Tried to generalize it a bit more, but providing a mutable ref for the
whole `def_collector` turned out to be tricky without cloning
`def_maps`, so it's staying like it is now.
critesjosh pushed a commit that referenced this pull request Mar 12, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.27.0</summary>

##
[0.27.0](aztec-package-v0.26.6...aztec-package-v0.27.0)
(2024-03-12)


### Features

* Add api for inclusion proof of outgoing message in block
[#4562](#4562)
([#4899](#4899))
([26d2643](26d2643))


### Miscellaneous

* Pin foundry
([#5151](#5151))
([69bd7dd](69bd7dd))
* Remove old contract deployment flow
([#4970](#4970))
([6d15947](6d15947))
</details>

<details><summary>barretenberg.js: 0.27.0</summary>

##
[0.27.0](barretenberg.js-v0.26.6...barretenberg.js-v0.27.0)
(2024-03-12)


### Miscellaneous

* Move alpine containers to ubuntu
([#5026](#5026))
([d483e67](d483e67)),
closes
[#4708](#4708)
</details>

<details><summary>aztec-cli: 0.27.0</summary>

##
[0.27.0](aztec-cli-v0.26.6...aztec-cli-v0.27.0)
(2024-03-12)


### Miscellaneous

* Remove old contract deployment flow
([#4970](#4970))
([6d15947](6d15947))
</details>

<details><summary>aztec-packages: 0.27.0</summary>

##
[0.27.0](aztec-packages-v0.26.6...aztec-packages-v0.27.0)
(2024-03-12)


### ⚠ BREAKING CHANGES

* Remove open keyword from Noir
([#4967](#4967))

### Features

* Add api for inclusion proof of outgoing message in block
[#4562](#4562)
([#4899](#4899))
([26d2643](26d2643))
* **avm-simulator:** External calls + integration
([#5051](#5051))
([dde33f4](dde33f4))
* **avm-simulator:** External static calls + integration
([#5089](#5089))
([428d950](428d950))
* **avm:** Equivalence check between Main trace and Mem trace
([#5032](#5032))
([7f216eb](7f216eb)),
closes
[#4955](#4955)
* **avm:** Fix some Brillig problems
([#5091](#5091))
([07dd821](07dd821))
* Initial integration avm prover
([#4878](#4878))
([2e2554e](2e2554e))
* Noir pull action
([#5062](#5062))
([b2d7d14](b2d7d14))
* Restore contract inclusion proofs
([#5141](#5141))
([a39cd61](a39cd61))
* Update the core of SMT Circuit class
([#5096](#5096))
([1519d3b](1519d3b))
* Updating archiver with new inbox
([#5025](#5025))
([f6d17c9](f6d17c9)),
closes
[#4828](#4828)


### Bug Fixes

* Duplicate factory code temporarily to unblock
([#5099](#5099))
([8b10600](8b10600))
* Remove hard coded canonical gas address
([#5106](#5106))
([dc2fd9e](dc2fd9e))


### Miscellaneous

* **avm-simulator:** Enable compressed strings unencrypted log test
([#5083](#5083))
([8f7519b](8f7519b))
* **avm-simulator:** Formatting and fixes
([#5092](#5092))
([b3fa084](b3fa084))
* **AVM:** Negative unit tests for inter table relations
([#5143](#5143))
([a74dccb](a74dccb)),
closes
[#5033](#5033)
* Aztec-macros refactor
([#5127](#5127))
([2195441](2195441))
* **ci:** Fail on clippy warnings in noir
([#5101](#5101))
([54af648](54af648))
* Extract bb binary in bs fast
([#5128](#5128))
([9ca41ef](9ca41ef))
* Increase bytecode size limit
([#5098](#5098))
([53b2381](53b2381))
* Increase permitted bytecode size
([#5136](#5136))
([6865c34](6865c34))
* Join-split example Part 2
([#5016](#5016))
([0718320](0718320))
* Move alpine containers to ubuntu
([#5026](#5026))
([d483e67](d483e67)),
closes
[#4708](#4708)
* Nicer snapshots
([#5133](#5133))
([9a737eb](9a737eb))
* Pin foundry
([#5151](#5151))
([69bd7dd](69bd7dd))
* Remove old contract deployment flow
([#4970](#4970))
([6d15947](6d15947))
* Remove open keyword from Noir
([#4967](#4967))
([401557e](401557e))
* Run nargo fmt on each nargo project
([#5102](#5102))
([b327254](b327254))
* Use context interface in mark-as-initialized
([#5142](#5142))
([932c1d5](932c1d5))
</details>

<details><summary>barretenberg: 0.27.0</summary>

##
[0.27.0](barretenberg-v0.26.6...barretenberg-v0.27.0)
(2024-03-12)


### Features

* **avm:** Equivalence check between Main trace and Mem trace
([#5032](#5032))
([7f216eb](7f216eb)),
closes
[#4955](#4955)
* Initial integration avm prover
([#4878](#4878))
([2e2554e](2e2554e))
* Update the core of SMT Circuit class
([#5096](#5096))
([1519d3b](1519d3b))


### Miscellaneous

* **AVM:** Negative unit tests for inter table relations
([#5143](#5143))
([a74dccb](a74dccb)),
closes
[#5033](#5033)
* Extract bb binary in bs fast
([#5128](#5128))
([9ca41ef](9ca41ef))
* Join-split example Part 2
([#5016](#5016))
([0718320](0718320))
* Move alpine containers to ubuntu
([#5026](#5026))
([d483e67](d483e67)),
closes
[#4708](#4708)
* Pin foundry
([#5151](#5151))
([69bd7dd](69bd7dd))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Mar 13, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.27.0</summary>

##
[0.27.0](AztecProtocol/aztec-packages@aztec-package-v0.26.6...aztec-package-v0.27.0)
(2024-03-12)


### Features

* Add api for inclusion proof of outgoing message in block
[#4562](AztecProtocol/aztec-packages#4562)
([#4899](AztecProtocol/aztec-packages#4899))
([26d2643](AztecProtocol/aztec-packages@26d2643))


### Miscellaneous

* Pin foundry
([#5151](AztecProtocol/aztec-packages#5151))
([69bd7dd](AztecProtocol/aztec-packages@69bd7dd))
* Remove old contract deployment flow
([#4970](AztecProtocol/aztec-packages#4970))
([6d15947](AztecProtocol/aztec-packages@6d15947))
</details>

<details><summary>barretenberg.js: 0.27.0</summary>

##
[0.27.0](AztecProtocol/aztec-packages@barretenberg.js-v0.26.6...barretenberg.js-v0.27.0)
(2024-03-12)


### Miscellaneous

* Move alpine containers to ubuntu
([#5026](AztecProtocol/aztec-packages#5026))
([d483e67](AztecProtocol/aztec-packages@d483e67)),
closes
[#4708](AztecProtocol/aztec-packages#4708)
</details>

<details><summary>aztec-cli: 0.27.0</summary>

##
[0.27.0](AztecProtocol/aztec-packages@aztec-cli-v0.26.6...aztec-cli-v0.27.0)
(2024-03-12)


### Miscellaneous

* Remove old contract deployment flow
([#4970](AztecProtocol/aztec-packages#4970))
([6d15947](AztecProtocol/aztec-packages@6d15947))
</details>

<details><summary>aztec-packages: 0.27.0</summary>

##
[0.27.0](AztecProtocol/aztec-packages@aztec-packages-v0.26.6...aztec-packages-v0.27.0)
(2024-03-12)


### ⚠ BREAKING CHANGES

* Remove open keyword from Noir
([#4967](AztecProtocol/aztec-packages#4967))

### Features

* Add api for inclusion proof of outgoing message in block
[#4562](AztecProtocol/aztec-packages#4562)
([#4899](AztecProtocol/aztec-packages#4899))
([26d2643](AztecProtocol/aztec-packages@26d2643))
* **avm-simulator:** External calls + integration
([#5051](AztecProtocol/aztec-packages#5051))
([dde33f4](AztecProtocol/aztec-packages@dde33f4))
* **avm-simulator:** External static calls + integration
([#5089](AztecProtocol/aztec-packages#5089))
([428d950](AztecProtocol/aztec-packages@428d950))
* **avm:** Equivalence check between Main trace and Mem trace
([#5032](AztecProtocol/aztec-packages#5032))
([7f216eb](AztecProtocol/aztec-packages@7f216eb)),
closes
[#4955](AztecProtocol/aztec-packages#4955)
* **avm:** Fix some Brillig problems
([#5091](AztecProtocol/aztec-packages#5091))
([07dd821](AztecProtocol/aztec-packages@07dd821))
* Initial integration avm prover
([#4878](AztecProtocol/aztec-packages#4878))
([2e2554e](AztecProtocol/aztec-packages@2e2554e))
* Noir pull action
([#5062](AztecProtocol/aztec-packages#5062))
([b2d7d14](AztecProtocol/aztec-packages@b2d7d14))
* Restore contract inclusion proofs
([#5141](AztecProtocol/aztec-packages#5141))
([a39cd61](AztecProtocol/aztec-packages@a39cd61))
* Update the core of SMT Circuit class
([#5096](AztecProtocol/aztec-packages#5096))
([1519d3b](AztecProtocol/aztec-packages@1519d3b))
* Updating archiver with new inbox
([#5025](AztecProtocol/aztec-packages#5025))
([f6d17c9](AztecProtocol/aztec-packages@f6d17c9)),
closes
[#4828](AztecProtocol/aztec-packages#4828)


### Bug Fixes

* Duplicate factory code temporarily to unblock
([#5099](AztecProtocol/aztec-packages#5099))
([8b10600](AztecProtocol/aztec-packages@8b10600))
* Remove hard coded canonical gas address
([#5106](AztecProtocol/aztec-packages#5106))
([dc2fd9e](AztecProtocol/aztec-packages@dc2fd9e))


### Miscellaneous

* **avm-simulator:** Enable compressed strings unencrypted log test
([#5083](AztecProtocol/aztec-packages#5083))
([8f7519b](AztecProtocol/aztec-packages@8f7519b))
* **avm-simulator:** Formatting and fixes
([#5092](AztecProtocol/aztec-packages#5092))
([b3fa084](AztecProtocol/aztec-packages@b3fa084))
* **AVM:** Negative unit tests for inter table relations
([#5143](AztecProtocol/aztec-packages#5143))
([a74dccb](AztecProtocol/aztec-packages@a74dccb)),
closes
[#5033](AztecProtocol/aztec-packages#5033)
* Aztec-macros refactor
([#5127](AztecProtocol/aztec-packages#5127))
([2195441](AztecProtocol/aztec-packages@2195441))
* **ci:** Fail on clippy warnings in noir
([#5101](AztecProtocol/aztec-packages#5101))
([54af648](AztecProtocol/aztec-packages@54af648))
* Extract bb binary in bs fast
([#5128](AztecProtocol/aztec-packages#5128))
([9ca41ef](AztecProtocol/aztec-packages@9ca41ef))
* Increase bytecode size limit
([#5098](AztecProtocol/aztec-packages#5098))
([53b2381](AztecProtocol/aztec-packages@53b2381))
* Increase permitted bytecode size
([#5136](AztecProtocol/aztec-packages#5136))
([6865c34](AztecProtocol/aztec-packages@6865c34))
* Join-split example Part 2
([#5016](AztecProtocol/aztec-packages#5016))
([0718320](AztecProtocol/aztec-packages@0718320))
* Move alpine containers to ubuntu
([#5026](AztecProtocol/aztec-packages#5026))
([d483e67](AztecProtocol/aztec-packages@d483e67)),
closes
[#4708](AztecProtocol/aztec-packages#4708)
* Nicer snapshots
([#5133](AztecProtocol/aztec-packages#5133))
([9a737eb](AztecProtocol/aztec-packages@9a737eb))
* Pin foundry
([#5151](AztecProtocol/aztec-packages#5151))
([69bd7dd](AztecProtocol/aztec-packages@69bd7dd))
* Remove old contract deployment flow
([#4970](AztecProtocol/aztec-packages#4970))
([6d15947](AztecProtocol/aztec-packages@6d15947))
* Remove open keyword from Noir
([#4967](AztecProtocol/aztec-packages#4967))
([401557e](AztecProtocol/aztec-packages@401557e))
* Run nargo fmt on each nargo project
([#5102](AztecProtocol/aztec-packages#5102))
([b327254](AztecProtocol/aztec-packages@b327254))
* Use context interface in mark-as-initialized
([#5142](AztecProtocol/aztec-packages#5142))
([932c1d5](AztecProtocol/aztec-packages@932c1d5))
</details>

<details><summary>barretenberg: 0.27.0</summary>

##
[0.27.0](AztecProtocol/aztec-packages@barretenberg-v0.26.6...barretenberg-v0.27.0)
(2024-03-12)


### Features

* **avm:** Equivalence check between Main trace and Mem trace
([#5032](AztecProtocol/aztec-packages#5032))
([7f216eb](AztecProtocol/aztec-packages@7f216eb)),
closes
[#4955](AztecProtocol/aztec-packages#4955)
* Initial integration avm prover
([#4878](AztecProtocol/aztec-packages#4878))
([2e2554e](AztecProtocol/aztec-packages@2e2554e))
* Update the core of SMT Circuit class
([#5096](AztecProtocol/aztec-packages#5096))
([1519d3b](AztecProtocol/aztec-packages@1519d3b))


### Miscellaneous

* **AVM:** Negative unit tests for inter table relations
([#5143](AztecProtocol/aztec-packages#5143))
([a74dccb](AztecProtocol/aztec-packages@a74dccb)),
closes
[#5033](AztecProtocol/aztec-packages#5033)
* Extract bb binary in bs fast
([#5128](AztecProtocol/aztec-packages#5128))
([9ca41ef](AztecProtocol/aztec-packages@9ca41ef))
* Join-split example Part 2
([#5016](AztecProtocol/aztec-packages#5016))
([0718320](AztecProtocol/aztec-packages@0718320))
* Move alpine containers to ubuntu
([#5026](AztecProtocol/aztec-packages#5026))
([d483e67](AztecProtocol/aztec-packages@d483e67)),
closes
[#4708](AztecProtocol/aztec-packages#4708)
* Pin foundry
([#5151](AztecProtocol/aztec-packages#5151))
([69bd7dd](AztecProtocol/aztec-packages@69bd7dd))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
github-merge-queue bot pushed a commit to noir-lang/noir that referenced this pull request Mar 13, 2024
Automated pull of Noir development from
[aztec-packages](https://github.com/AztecProtocol/aztec-packages).
BEGIN_COMMIT_OVERRIDE
chore!: Remove open keyword from Noir
(AztecProtocol/aztec-packages#4967)
chore: aztec-macros refactor
(AztecProtocol/aztec-packages#5127)
feat: make brillig-gen more AVM-friendly
(AztecProtocol/aztec-packages#5091)
feat: Integrated native ACVM
(AztecProtocol/aztec-packages#4903)
END_COMMIT_OVERRIDE

---------

Co-authored-by: sirasistant <sirasistant@gmail.com>
Co-authored-by: Maddiaa <47148561+Maddiaa0@users.noreply.github.com>
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
Co-authored-by: TomAFrench <tom@tomfren.ch>
Co-authored-by: Alex Gherghisan <alexghr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants