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

refactor: Join-split example Part 1 #4965

Merged
merged 29 commits into from
Mar 8, 2024
Merged

refactor: Join-split example Part 1 #4965

merged 29 commits into from
Mar 8, 2024

Conversation

codygunton
Copy link
Contributor

@codygunton codygunton commented Mar 5, 2024

The first of a two-part series to refactor the join-split example, the goal being to focus the tests on circuit writing (no proof construction), update them to reflect our newer idioms, and relocate them. Key changes

  1. Keep a subset of tests relating to circuit writing.
  2. Remove code that has to do with proof construction.
  3. Add a new circuit change detection paradigm: rather than hashing a verification key (a proving system-dependent object), simply hash the circuit-defining data in the circuit builder.
  4. Delete unused code (some unused before, some unused now).

The next PR #5016 will move and condense files, and update namespaces.

@AztecBot
Copy link
Collaborator

AztecBot commented Mar 5, 2024

Benchmark results

Metrics with a significant change:

  • note_trial_decrypting_time_in_ms (8): 6.97 (-94%)
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 6522738a 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,700 18,884 36,452
l1_rollup_calldata_gas 66,516 239,336 470,036
l1_rollup_execution_gas 194,464 500,642 909,294
l2_block_processing_time_in_ms 1,188 (-1%) 4,474 8,902 (-1%)
note_successful_decrypting_time_in_ms 200 (+1%) 543 992 (-1%)
note_trial_decrypting_time_in_ms ⚠️ 6.97 (-94%) 60.3 (-5%) 127 (-2%)
l2_block_building_time_in_ms 16,677 (+2%) 69,958 (+5%) 139,051 (+4%)
l2_block_rollup_simulation_time_in_ms 12,719 (+2%) 53,409 (+5%) 106,205 (+4%)
l2_block_public_tx_process_time_in_ms 3,926 (+2%) 16,479 (+4%) 32,719 (+3%)

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,592 (-3%) 27,340 (-1%)
note_history_successful_decrypting_time_in_ms 1,244 (+1%) 2,409 (+2%)
note_history_trial_decrypting_time_in_ms 90.2 (+47%) 147 (+36%)
node_database_size_in_bytes 18,808,912 35,586,128
pxe_database_size_in_bytes 29,923 59,478

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 263 (+4%) 44,736 28,001
private-kernel-ordering 201 (+4%) 52,625 14,627
base-rollup 1,380 (+3%) 177,932 997
root-rollup 73.0 4,320 825
private-kernel-inner 335 (+4%) 73,715 28,001
public-kernel-app-logic 200 (+1%) 32,254 25,379
merge-rollup 8.73 2,840 997

Tree insertion stats

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

Metric 1 leaves 2 leaves 8 leaves 16 leaves 32 leaves 64 leaves 128 leaves 512 leaves 1024 leaves 2048 leaves 4096 leaves
batch_insert_into_append_only_tree_16_depth_ms 9.94 (+1%) 10.1 (-7%) 14.8 (-12%) 16.4 (+2%) 22.2 (+1%) 35.3 (-1%) N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_count 16.9 17.5 23.0 31.6 47.0 79.0 N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_ms 0.577 (+1%) 0.562 (-7%) 0.631 (-11%) 0.507 (+2%) 0.465 0.440 (-1%) N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_32_depth_ms N/A N/A N/A N/A N/A 46.4 (+2%) 72.0 (-1%) 230 443 869 (-1%) 1,730 (-1%)
batch_insert_into_append_only_tree_32_depth_hash_count N/A N/A N/A N/A N/A 96.0 159 543 1,055 2,079 4,127
batch_insert_into_append_only_tree_32_depth_hash_ms N/A N/A N/A N/A N/A 0.476 (+2%) 0.445 (-1%) 0.420 0.415 0.413 (-1%) 0.414 (-1%)
batch_insert_into_indexed_tree_20_depth_ms N/A N/A N/A N/A N/A 54.1 (-2%) 107 (-1%) 339 (-1%) 659 1,313 2,604 (-1%)
batch_insert_into_indexed_tree_20_depth_hash_count N/A N/A N/A N/A N/A 104 207 691 1,363 2,707 5,395
batch_insert_into_indexed_tree_20_depth_hash_ms N/A N/A N/A N/A N/A 0.482 (-2%) 0.483 (-1%) 0.457 (-1%) 0.454 0.454 (-1%) 0.453 (-1%)
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A N/A 61.4 (+1%) N/A N/A N/A N/A N/A N/A
batch_insert_into_indexed_tree_40_depth_hash_count N/A N/A N/A N/A 109 N/A N/A N/A N/A N/A N/A
batch_insert_into_indexed_tree_40_depth_hash_ms N/A N/A N/A N/A 0.537 (+1%) N/A N/A N/A N/A N/A N/A

Miscellaneous

Transaction sizes based on how many contracts are deployed in the tx.

Metric 0 deployed contracts
tx_size_in_bytes 19,179

Transaction processing duration by data writes.

Metric 0 new note hashes 1 new note hashes
tx_pxe_processing_time_ms 2,616 1,425 (+3%)
Metric 0 public data writes 1 public data writes
tx_sequencer_processing_time_ms 0.0292 (-2%) 486

@codygunton codygunton self-assigned this Mar 5, 2024
@codygunton codygunton changed the title refactor: Join-split example and versioning refactor: Join-split refactor 1 and versioning Mar 6, 2024
@codygunton codygunton changed the title refactor: Join-split refactor 1 and versioning refactor: Join-split refactor 1 Mar 6, 2024
@codygunton codygunton changed the title refactor: Join-split refactor 1 refactor: Join-split Part 1 Mar 6, 2024
@codygunton codygunton changed the title refactor: Join-split Part 1 refactor: Join-split example Part 1 Mar 6, 2024
@codygunton codygunton marked this pull request as ready for review March 6, 2024 23:05
@@ -33,7 +33,6 @@ TESTS=(
crypto_schnorr_tests
crypto_sha256_tests
ecc_tests
join_split_example_proofs_inner_proof_data_tests
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a serialization tests, not worth illustrating (tests deleted too).

Copy link
Contributor

Choose a reason for hiding this comment

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

we have proper serialization tests elsewhere that tests what this test used to test?


bool proof_result = verifier.verify_proof(proof);
EXPECT_EQ(proof_result, true);
EXPECT_EQ(CircuitChecker::check(builder), true);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Goal is to illustrate use of stdlib. In particular, no reason to generate proofs.

@@ -2659,9 +2659,39 @@ template <typename Arithmetization> void UltraCircuitBuilder_<Arithmetization>::
}
}

template <typename Arithmetization> uint256_t UltraCircuitBuilder_<Arithmetization>::hash_circuit()
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Core change

Copy link
Contributor

Choose a reason for hiding this comment

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

do we not care about the other member variables in ultra_circuit_builder? like lookup tables and real_variable_tags and num_gates, etc...

@@ -79,6 +79,9 @@
// Some settings can only be configured here.
// The following are just provided as example.
"settings": {
"files.associations": {
Copy link
Contributor

Choose a reason for hiding this comment

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

thats nice

Copy link
Contributor

@lucasxia01 lucasxia01 left a comment

Choose a reason for hiding this comment

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

Seems fine in general, but I'm not convinced we haven't lost testing functionality from deleting those tests. I'm also not sure about the hashing function being complete.

@@ -33,7 +33,6 @@ TESTS=(
crypto_schnorr_tests
crypto_sha256_tests
ecc_tests
join_split_example_proofs_inner_proof_data_tests
Copy link
Contributor

Choose a reason for hiding this comment

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

we have proper serialization tests elsewhere that tests what this test used to test?

sum_of_block_sizes += block.size();
}

size_t num_bytes_in_selectors_and_variables = sizeof(FF) * Arithmetization::NUM_SELECTORS * sum_of_block_sizes;
Copy link
Contributor

Choose a reason for hiding this comment

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

doesn't look like this contains variables?

@@ -2659,9 +2659,39 @@ template <typename Arithmetization> void UltraCircuitBuilder_<Arithmetization>::
}
}

template <typename Arithmetization> uint256_t UltraCircuitBuilder_<Arithmetization>::hash_circuit()
{
Copy link
Contributor

Choose a reason for hiding this comment

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

do we not care about the other member variables in ultra_circuit_builder? like lookup tables and real_variable_tags and num_gates, etc...

@codygunton
Copy link
Contributor Author

@lucasxia01 made an issue to follow up on a particular question: AztecProtocol/barretenberg#900

@codygunton codygunton merged commit b9de0f5 into master Mar 8, 2024
95 checks passed
@codygunton codygunton deleted the cg/js-split branch March 8, 2024 17:18
PhilWindle pushed a commit that referenced this pull request Mar 8, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.26.6](aztec-package-v0.26.5...aztec-package-v0.26.6)
(2024-03-08)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](barretenberg.js-v0.26.5...barretenberg.js-v0.26.6)
(2024-03-08)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](aztec-cli-v0.26.5...aztec-cli-v0.26.6)
(2024-03-08)


### Features

* Show bytecode size per function in CLI inspect-contract
([#5059](#5059))
([cb9fdc6](cb9fdc6))
</details>

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

##
[0.26.6](aztec-packages-v0.26.5...aztec-packages-v0.26.6)
(2024-03-08)


### Features

* Basic public reverts
([#4870](#4870))
([5cccc78](5cccc78))
* Deploying new inbox
([#5036](#5036))
([fed729d](fed729d))
* Detect unknown note type ids in compute_note_hash
([#5086](#5086))
([6206bec](6206bec))
* Easy deployment of protocol contracts in e2e
([#4983](#4983))
([480161f](480161f))
* IPA documentation
([#4924](#4924))
([48bd22e](48bd22e))
* Nullifier read requests in public kernel
([#4910](#4910))
([0e44247](0e44247))
* Show bytecode size per function in CLI inspect-contract
([#5059](#5059))
([cb9fdc6](cb9fdc6))
* Updating an SMT solver class
([#4981](#4981))
([4b94d58](4b94d58))


### Bug Fixes

* Canonical contract address
([#5030](#5030))
([b2af880](b2af880))
* Flaky deployment test
([#5035](#5035))
([039eafc](039eafc))
* Pull the correct platform image for noir
([#5097](#5097))
([3342371](3342371))
* Sleep function memory leak
([#5023](#5023))
([a72cfea](a72cfea)),
closes
[#4817](#4817)
* Storage v2
([#5027](#5027))
([fe3190e](fe3190e))
* Update protogalaxy cmake dependencies
([#5066](#5066))
([507c374](507c374))


### Miscellaneous

* Address warnings in noir test suite
([#4966](#4966))
([7ef4ef5](7ef4ef5))
* Bootstrap noir natively if nargo is invalid
([#5034](#5034))
([df089de](df089de))
* Build avm transpiler if we are on mac
([#5039](#5039))
([c2966b9](c2966b9))
* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](#5065))
([58e1ff4](58e1ff4))
* Cleanup of prover and verifier instances
([#4959](#4959))
([f2fdefd](f2fdefd))
* Delete bootstrap scripts from `noir/noir-repo`
([#5044](#5044))
([add91ca](add91ca))
* Disable `hello_world_example` noir test in aztec-packages CI
([#5061](#5061))
([1be9243](1be9243))
* Join-split example Part 1
([#4965](#4965))
([b9de0f5](b9de0f5))
* Moving RootRollupInputs impl
([#5087](#5087))
([f3d9f9b](f3d9f9b))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](#5084))
([77954ab](77954ab))


### Documentation

* Parity circuit naming fixes
([#5076](#5076))
([c255255](c255255))
</details>

<details><summary>barretenberg: 0.26.6</summary>

##
[0.26.6](barretenberg-v0.26.5...barretenberg-v0.26.6)
(2024-03-08)


### Features

* IPA documentation
([#4924](#4924))
([48bd22e](48bd22e))
* Updating an SMT solver class
([#4981](#4981))
([4b94d58](4b94d58))


### Bug Fixes

* Storage v2
([#5027](#5027))
([fe3190e](fe3190e))
* Update protogalaxy cmake dependencies
([#5066](#5066))
([507c374](507c374))


### Miscellaneous

* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](#5065))
([58e1ff4](58e1ff4))
* Cleanup of prover and verifier instances
([#4959](#4959))
([f2fdefd](f2fdefd))
* Join-split example Part 1
([#4965](#4965))
([b9de0f5](b9de0f5))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](#5084))
([77954ab](77954ab))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
codygunton added a commit that referenced this pull request Mar 8, 2024
Flatten join_split_example/ and move inside of examples/

Follows: #4965
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Mar 9, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.26.6](AztecProtocol/aztec-packages@aztec-package-v0.26.5...aztec-package-v0.26.6)
(2024-03-08)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](AztecProtocol/aztec-packages@barretenberg.js-v0.26.5...barretenberg.js-v0.26.6)
(2024-03-08)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

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

##
[0.26.6](AztecProtocol/aztec-packages@aztec-cli-v0.26.5...aztec-cli-v0.26.6)
(2024-03-08)


### Features

* Show bytecode size per function in CLI inspect-contract
([#5059](AztecProtocol/aztec-packages#5059))
([cb9fdc6](AztecProtocol/aztec-packages@cb9fdc6))
</details>

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

##
[0.26.6](AztecProtocol/aztec-packages@aztec-packages-v0.26.5...aztec-packages-v0.26.6)
(2024-03-08)


### Features

* Basic public reverts
([#4870](AztecProtocol/aztec-packages#4870))
([5cccc78](AztecProtocol/aztec-packages@5cccc78))
* Deploying new inbox
([#5036](AztecProtocol/aztec-packages#5036))
([fed729d](AztecProtocol/aztec-packages@fed729d))
* Detect unknown note type ids in compute_note_hash
([#5086](AztecProtocol/aztec-packages#5086))
([6206bec](AztecProtocol/aztec-packages@6206bec))
* Easy deployment of protocol contracts in e2e
([#4983](AztecProtocol/aztec-packages#4983))
([480161f](AztecProtocol/aztec-packages@480161f))
* IPA documentation
([#4924](AztecProtocol/aztec-packages#4924))
([48bd22e](AztecProtocol/aztec-packages@48bd22e))
* Nullifier read requests in public kernel
([#4910](AztecProtocol/aztec-packages#4910))
([0e44247](AztecProtocol/aztec-packages@0e44247))
* Show bytecode size per function in CLI inspect-contract
([#5059](AztecProtocol/aztec-packages#5059))
([cb9fdc6](AztecProtocol/aztec-packages@cb9fdc6))
* Updating an SMT solver class
([#4981](AztecProtocol/aztec-packages#4981))
([4b94d58](AztecProtocol/aztec-packages@4b94d58))


### Bug Fixes

* Canonical contract address
([#5030](AztecProtocol/aztec-packages#5030))
([b2af880](AztecProtocol/aztec-packages@b2af880))
* Flaky deployment test
([#5035](AztecProtocol/aztec-packages#5035))
([039eafc](AztecProtocol/aztec-packages@039eafc))
* Pull the correct platform image for noir
([#5097](AztecProtocol/aztec-packages#5097))
([3342371](AztecProtocol/aztec-packages@3342371))
* Sleep function memory leak
([#5023](AztecProtocol/aztec-packages#5023))
([a72cfea](AztecProtocol/aztec-packages@a72cfea)),
closes
[#4817](AztecProtocol/aztec-packages#4817)
* Storage v2
([#5027](AztecProtocol/aztec-packages#5027))
([fe3190e](AztecProtocol/aztec-packages@fe3190e))
* Update protogalaxy cmake dependencies
([#5066](AztecProtocol/aztec-packages#5066))
([507c374](AztecProtocol/aztec-packages@507c374))


### Miscellaneous

* Address warnings in noir test suite
([#4966](AztecProtocol/aztec-packages#4966))
([7ef4ef5](AztecProtocol/aztec-packages@7ef4ef5))
* Bootstrap noir natively if nargo is invalid
([#5034](AztecProtocol/aztec-packages#5034))
([df089de](AztecProtocol/aztec-packages@df089de))
* Build avm transpiler if we are on mac
([#5039](AztecProtocol/aztec-packages#5039))
([c2966b9](AztecProtocol/aztec-packages@c2966b9))
* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](AztecProtocol/aztec-packages#5065))
([58e1ff4](AztecProtocol/aztec-packages@58e1ff4))
* Cleanup of prover and verifier instances
([#4959](AztecProtocol/aztec-packages#4959))
([f2fdefd](AztecProtocol/aztec-packages@f2fdefd))
* Delete bootstrap scripts from `noir/noir-repo`
([#5044](AztecProtocol/aztec-packages#5044))
([add91ca](AztecProtocol/aztec-packages@add91ca))
* Disable `hello_world_example` noir test in aztec-packages CI
([#5061](AztecProtocol/aztec-packages#5061))
([1be9243](AztecProtocol/aztec-packages@1be9243))
* Join-split example Part 1
([#4965](AztecProtocol/aztec-packages#4965))
([b9de0f5](AztecProtocol/aztec-packages@b9de0f5))
* Moving RootRollupInputs impl
([#5087](AztecProtocol/aztec-packages#5087))
([f3d9f9b](AztecProtocol/aztec-packages@f3d9f9b))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](AztecProtocol/aztec-packages#5084))
([77954ab](AztecProtocol/aztec-packages@77954ab))


### Documentation

* Parity circuit naming fixes
([#5076](AztecProtocol/aztec-packages#5076))
([c255255](AztecProtocol/aztec-packages@c255255))
</details>

<details><summary>barretenberg: 0.26.6</summary>

##
[0.26.6](AztecProtocol/aztec-packages@barretenberg-v0.26.5...barretenberg-v0.26.6)
(2024-03-08)


### Features

* IPA documentation
([#4924](AztecProtocol/aztec-packages#4924))
([48bd22e](AztecProtocol/aztec-packages@48bd22e))
* Updating an SMT solver class
([#4981](AztecProtocol/aztec-packages#4981))
([4b94d58](AztecProtocol/aztec-packages@4b94d58))


### Bug Fixes

* Storage v2
([#5027](AztecProtocol/aztec-packages#5027))
([fe3190e](AztecProtocol/aztec-packages@fe3190e))
* Update protogalaxy cmake dependencies
([#5066](AztecProtocol/aztec-packages#5066))
([507c374](AztecProtocol/aztec-packages@507c374))


### Miscellaneous

* **ci:** Re-enable certain bb solidity ACIR tests
([#5065](AztecProtocol/aztec-packages#5065))
([58e1ff4](AztecProtocol/aztec-packages@58e1ff4))
* Cleanup of prover and verifier instances
([#4959](AztecProtocol/aztec-packages#4959))
([f2fdefd](AztecProtocol/aztec-packages@f2fdefd))
* Join-split example Part 1
([#4965](AztecProtocol/aztec-packages#4965))
([b9de0f5](AztecProtocol/aztec-packages@b9de0f5))
* Remove eccvm functionality to update the op queue and ensure ultra ops
are populated through function
([#5084](AztecProtocol/aztec-packages#5084))
([77954ab](AztecProtocol/aztec-packages@77954ab))
</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 pushed a commit to AztecProtocol/barretenberg that referenced this pull request Mar 9, 2024
Flatten join_split_example/ and move inside of examples/

Follows: AztecProtocol/aztec-packages#4965
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.

4 participants