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

feat: Choose constructor method in Contract.deploy #4939

Merged
merged 1 commit into from
Mar 5, 2024

Conversation

spalladino
Copy link
Collaborator

Adds a new deployWithOpts method to the autogenerated contract typescript interfaces which allows the caller to choose which constructor method to call during deployment. Arguments are type-checked based on the method chosen.

Depends on #4896

@AztecBot
Copy link
Collaborator

AztecBot commented Mar 4, 2024

Benchmark results

Metrics with a significant change:

  • note_history_trial_decrypting_time_in_ms (5): 112 (+108%)
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 dddc35f3 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,168 239,048 470,000
l1_rollup_execution_gas 194,116 500,354 909,258
l2_block_processing_time_in_ms 1,196 4,480 8,972 (+1%)
note_successful_decrypting_time_in_ms 207 (+4%) 543 (+1%) 1,000 (+1%)
note_trial_decrypting_time_in_ms 12.6 (+57%) 64.8 (+12%) 34.3 (-72%)
l2_block_building_time_in_ms 16,501 (+2%) 64,767 130,772 (+1%)
l2_block_rollup_simulation_time_in_ms 12,538 (+2%) 49,265 (+1%) 99,856 (+1%)
l2_block_public_tx_process_time_in_ms 3,928 (+2%) 15,415 30,773

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 14,860 (+4%) 27,655 (+1%)
note_history_successful_decrypting_time_in_ms 1,258 (+2%) 2,382 (-2%)
note_history_trial_decrypting_time_in_ms ⚠️ 112 (+108%) 133 (+1%)
node_database_size_in_bytes 18,776,144 35,590,224
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 252 44,736 28,001
private-kernel-ordering 193 52,625 14,627
base-rollup 1,321 177,932 933
root-rollup 70.1 4,192 825
private-kernel-inner 321 73,715 28,001
public-kernel-app-logic 196 (-1%) 32,254 25,379
merge-rollup 5.74 2,712 933

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.89 (+1%) 10.7 (-2%) 12.4 (-13%) 16.3 (-2%) 22.5 35.6 (+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.574 (+1%) 0.595 (-2%) 0.526 (-12%) 0.503 (-1%) 0.469 0.444 (+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 45.9 72.4 231 444 871 1,732 (+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.470 0.446 0.422 0.416 0.415 0.415 (+1%)
batch_insert_into_indexed_tree_20_depth_ms N/A N/A N/A N/A N/A 54.0 107 336 (-1%) 661 (-1%) 1,312 2,636 (+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.480 0.484 0.458 0.455 (-1%) 0.456 0.454
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A N/A 61.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.535 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,655 (+1%) 1,374
Metric 0 public data writes 1 public data writes
tx_sequencer_processing_time_ms 0.0292 (+4%) 478 (-1%)

@@ -81,6 +81,7 @@ contract StatefulTest {
}

#[aztec(public)]
#[aztec(noinitcheck)]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Just a clarifying question: even if something is flagged noinitcheck, the call will if the instance has not been initialized (and is not in the process of being initialized) right?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If the instance has not been initialized and the function is flagged noinitcheck, then the call will succeed. So this should be used sparingly, and #4937 removes many of the noinitchecks I added all over the place.

) {
super(wallet);
const constructorArtifact = artifact.functions.find(f => f.name === 'constructor');
const constructorArtifact = artifact.functions.find(f => f.name === constructorName);
if (!constructorArtifact) {
throw new Error('Cannot find constructor in the artifact.');
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nit: probably helps to include the variable name in the error here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Will do in a subsequent PR!

@spalladino spalladino force-pushed the palla/contract-deploy-21 branch from 3dd1231 to 4b37252 Compare March 5, 2024 16:56
Base automatically changed from palla/contract-deploy-21 to master March 5, 2024 17:22
@spalladino spalladino force-pushed the palla/contract-deploy-23 branch from 2138f39 to 01cdf94 Compare March 5, 2024 17:58
@spalladino spalladino merged commit e899e56 into master Mar 5, 2024
65 checks passed
@spalladino spalladino deleted the palla/contract-deploy-23 branch March 5, 2024 18:39
PhilWindle pushed a commit that referenced this pull request Mar 6, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.26.1](aztec-package-v0.26.0...aztec-package-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](barretenberg.js-v0.26.0...barretenberg.js-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](aztec-cli-v0.26.0...aztec-cli-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](aztec-packages-v0.26.0...aztec-packages-v0.26.1)
(2024-03-06)


### Features

* Adding fr compatibility to smt variables api
([#4884](#4884))
([c085cbb](c085cbb))
* **avm-simulator:** Implement EMITUNENCRYPTEDLOG
([#4926](#4926))
([5f3304e](5f3304e))
* Choose constructor method in Contract.deploy
([#4939](#4939))
([e899e56](e899e56))
* Indirect mem flag deserialisation
([#4877](#4877))
([4c6820f](4c6820f))


### Miscellaneous

* Add missing jobs to CI end
([#4963](#4963))
([ff4110e](ff4110e))
* **avm-simulator:** Better type env getters
([#4950](#4950))
([8f97977](8f97977))
* **avm-simulator:** Revive field comparison
([#4957](#4957))
([ee21374](ee21374))
* **avm-simulator:** Test improvements
([#4946](#4946))
([f74e6a1](f74e6a1))
* Fix CCI config
([#4974](#4974))
([40178f0](40178f0))
* Remove commitment key copy out of instance
([#4893](#4893))
([6eb6778](6eb6778))
* **vscode:** Add avm-transpiler to vscode rust-analyzer settings
([#4952](#4952))
([db915e5](db915e5))
</details>

<details><summary>barretenberg: 0.26.1</summary>

##
[0.26.1](barretenberg-v0.26.0...barretenberg-v0.26.1)
(2024-03-06)


### Features

* Adding fr compatibility to smt variables api
([#4884](#4884))
([c085cbb](c085cbb))
* Indirect mem flag deserialisation
([#4877](#4877))
([4c6820f](4c6820f))


### Miscellaneous

* Remove commitment key copy out of instance
([#4893](#4893))
([6eb6778](6eb6778))
</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 7, 2024
🤖 I have created a release *beep* *boop*
---


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

##
[0.26.1](AztecProtocol/aztec-packages@aztec-package-v0.26.0...aztec-package-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](AztecProtocol/aztec-packages@barretenberg.js-v0.26.0...barretenberg.js-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](AztecProtocol/aztec-packages@aztec-cli-v0.26.0...aztec-cli-v0.26.1)
(2024-03-06)


### Miscellaneous

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

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

##
[0.26.1](AztecProtocol/aztec-packages@aztec-packages-v0.26.0...aztec-packages-v0.26.1)
(2024-03-06)


### Features

* Adding fr compatibility to smt variables api
([#4884](AztecProtocol/aztec-packages#4884))
([c085cbb](AztecProtocol/aztec-packages@c085cbb))
* **avm-simulator:** Implement EMITUNENCRYPTEDLOG
([#4926](AztecProtocol/aztec-packages#4926))
([5f3304e](AztecProtocol/aztec-packages@5f3304e))
* Choose constructor method in Contract.deploy
([#4939](AztecProtocol/aztec-packages#4939))
([e899e56](AztecProtocol/aztec-packages@e899e56))
* Indirect mem flag deserialisation
([#4877](AztecProtocol/aztec-packages#4877))
([4c6820f](AztecProtocol/aztec-packages@4c6820f))


### Miscellaneous

* Add missing jobs to CI end
([#4963](AztecProtocol/aztec-packages#4963))
([ff4110e](AztecProtocol/aztec-packages@ff4110e))
* **avm-simulator:** Better type env getters
([#4950](AztecProtocol/aztec-packages#4950))
([8f97977](AztecProtocol/aztec-packages@8f97977))
* **avm-simulator:** Revive field comparison
([#4957](AztecProtocol/aztec-packages#4957))
([ee21374](AztecProtocol/aztec-packages@ee21374))
* **avm-simulator:** Test improvements
([#4946](AztecProtocol/aztec-packages#4946))
([f74e6a1](AztecProtocol/aztec-packages@f74e6a1))
* Fix CCI config
([#4974](AztecProtocol/aztec-packages#4974))
([40178f0](AztecProtocol/aztec-packages@40178f0))
* Remove commitment key copy out of instance
([#4893](AztecProtocol/aztec-packages#4893))
([6eb6778](AztecProtocol/aztec-packages@6eb6778))
* **vscode:** Add avm-transpiler to vscode rust-analyzer settings
([#4952](AztecProtocol/aztec-packages#4952))
([db915e5](AztecProtocol/aztec-packages@db915e5))
</details>

<details><summary>barretenberg: 0.26.1</summary>

##
[0.26.1](AztecProtocol/aztec-packages@barretenberg-v0.26.0...barretenberg-v0.26.1)
(2024-03-06)


### Features

* Adding fr compatibility to smt variables api
([#4884](AztecProtocol/aztec-packages#4884))
([c085cbb](AztecProtocol/aztec-packages@c085cbb))
* Indirect mem flag deserialisation
([#4877](AztecProtocol/aztec-packages#4877))
([4c6820f](AztecProtocol/aztec-packages@4c6820f))


### Miscellaneous

* Remove commitment key copy out of instance
([#4893](AztecProtocol/aztec-packages#4893))
([6eb6778](AztecProtocol/aztec-packages@6eb6778))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
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