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!: consistent deploy method params #2975

Merged
merged 12 commits into from
Oct 24, 2023

Conversation

benesjan
Copy link
Contributor

@benesjan benesjan commented Oct 23, 2023

  1. Fixes deploy method of Contract.ts uses wallet and generated TS types uses PXE #2974
  2. Fixed ordering of params in deployWithPublicKey
  3. Sneaked in removal of deprecated isMined from Tx (this was a bit of a mistake as the change turned out to be larger than I expected which resulted in this PR being a bit cluttered)

Note: Removing the isMined method made deploying a contract when you don't want a contract instance clumsy because now you are forced to provide a wallet to the wait method. One option how to tackle this would be renaming the DeploySentTx.wait to something like DeploySentTx.waitAndGetInstance which would result in the SentTx.wait method being exposed on DeploySentTx. But this would make the main usecase have a pretty annoying and long naming so it's probably ok to leave it as it is.

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).

@AztecBot
Copy link
Collaborator

AztecBot commented Oct 23, 2023

Benchmark results

No metrics with a significant change found.

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 51efbcef 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 128 txs
l1_rollup_calldata_size_in_bytes 45,444 179,588 716,132
l1_rollup_calldata_gas 222,900 868,160 3,447,812
l1_rollup_execution_gas 841,987 3,595,268 22,203,181
l2_block_processing_time_in_ms 1,027 3,823 (-3%) 15,245 (-3%)
note_successful_decrypting_time_in_ms 335 (-2%) 1,001 (-5%) 3,928 (-4%)
note_trial_decrypting_time_in_ms 37.0 (-14%) 108 (-15%) 137
l2_block_building_time_in_ms 9,080 35,557 (-2%) 158,291 (-1%)
l2_block_rollup_simulation_time_in_ms 6,720 (+1%) 26,338 (-1%) 105,959 (-1%)
l2_block_public_tx_process_time_in_ms 2,317 (-1%) 9,096 (-3%) 51,637 (-2%)

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 11,588 22,042
note_history_successful_decrypting_time_in_ms 2,393 (-1%) 4,901 (+1%)
note_history_trial_decrypting_time_in_ms 123 150 (+2%)
node_database_size_in_bytes 1,626,363 1,091,383
pxe_database_size_in_bytes 27,188 54,187

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 47.6 (-1%) 61,697 18,841
private-kernel-ordering 23.8 (+1%) 24,233 8,089
base-rollup 851 639,797 811
root-rollup 39.0 4,072 1,097
private-kernel-inner 42.9 81,504 18,841
public-kernel-private-input 48.1 41,455 18,841
public-kernel-non-first-iteration 30.9 (-1%) 41,497 18,841
merge-rollup 0.819 (-4%) 2,592 873

Miscellaneous

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

Metric 0 deployed contracts 1 deployed contracts
tx_size_in_bytes 8,723 27,510

@benesjan benesjan marked this pull request as draft October 23, 2023 14:04
@benesjan benesjan force-pushed the janb/improved-contract-class-consistency branch from 8a1f21a to dd8b9ba Compare October 24, 2023 07:54
@benesjan benesjan requested a review from spalladino October 24, 2023 07:56
@benesjan benesjan marked this pull request as ready for review October 24, 2023 07:56
Copy link
Collaborator

@spalladino spalladino left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for tackling this!

@benesjan benesjan merged commit c50aefb into master Oct 24, 2023
2 checks passed
@benesjan benesjan deleted the janb/improved-contract-class-consistency branch October 24, 2023 12:44
kevaundray pushed a commit that referenced this pull request Oct 24, 2023
🤖 I have created a release *beep* *boop*
---


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

##
[0.11.0](aztec-packages-v0.10.1...aztec-packages-v0.11.0)
(2023-10-24)


### ⚠ BREAKING CHANGES

* consistent `deploy` method params
([#2975](#2975))

### Features

* Consistent `deploy` method params
([#2975](#2975))
([c50aefb](c50aefb))
* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))


### Bug Fixes

* TokenBox
([#3003](#3003))
([1ad6647](1ad6647))


### Miscellaneous

* Update acir_tests reference branch
([#2993](#2993))
([91813a5](91813a5))
</details>

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

##
[0.11.0](barretenberg.js-v0.10.1...barretenberg.js-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))
</details>

<details><summary>barretenberg: 0.11.0</summary>

##
[0.11.0](barretenberg-v0.10.1...barretenberg-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))


### Miscellaneous

* Update acir_tests reference branch
([#2993](#2993))
([91813a5](91813a5))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Maddiaa0 pushed a commit that referenced this pull request Oct 25, 2023
1. Fixes #2974
2. Fixed ordering of params in `deployWithPublicKey`
3. Sneaked in removal of deprecated `isMined` from `Tx` (this was a bit
of a mistake as the change turned out to be larger than I expected which
resulted in this PR being a bit cluttered)

**Note**: Removing the `isMined` method made deploying a contract when
you don't want a contract instance clumsy because now you are forced to
provide a wallet to the wait method. One option how to tackle this would
be renaming the `DeploySentTx.wait` to something like
`DeploySentTx.waitAndGetInstance` which would result in the
`SentTx.wait` method being exposed on `DeploySentTx`. But this would
make the main usecase have a pretty annoying and long naming so it's
probably ok to leave it as it is.
Maddiaa0 pushed a commit that referenced this pull request Oct 25, 2023
🤖 I have created a release *beep* *boop*
---


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

##
[0.11.0](aztec-packages-v0.10.1...aztec-packages-v0.11.0)
(2023-10-24)


### ⚠ BREAKING CHANGES

* consistent `deploy` method params
([#2975](#2975))

### Features

* Consistent `deploy` method params
([#2975](#2975))
([c50aefb](c50aefb))
* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))


### Bug Fixes

* TokenBox
([#3003](#3003))
([1ad6647](1ad6647))


### Miscellaneous

* Update acir_tests reference branch
([#2993](#2993))
([91813a5](91813a5))
</details>

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

##
[0.11.0](barretenberg.js-v0.10.1...barretenberg.js-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))
</details>

<details><summary>barretenberg: 0.11.0</summary>

##
[0.11.0](barretenberg-v0.10.1...barretenberg-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](#2990))
([2a4c548](2a4c548))


### Miscellaneous

* Update acir_tests reference branch
([#2993](#2993))
([91813a5](91813a5))
</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 Oct 27, 2023
🤖 I have created a release *beep* *boop*
---


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

##
[0.11.0](AztecProtocol/aztec-packages@aztec-packages-v0.10.1...aztec-packages-v0.11.0)
(2023-10-24)


### ⚠ BREAKING CHANGES

* consistent `deploy` method params
([#2975](AztecProtocol/aztec-packages#2975))

### Features

* Consistent `deploy` method params
([#2975](AztecProtocol/aztec-packages#2975))
([c50aefb](AztecProtocol/aztec-packages@c50aefb))
* Pedersen hash in acir format
([#2990](AztecProtocol/aztec-packages#2990))
([2a4c548](AztecProtocol/aztec-packages@2a4c548))


### Bug Fixes

* TokenBox
([#3003](AztecProtocol/aztec-packages#3003))
([1ad6647](AztecProtocol/aztec-packages@1ad6647))


### Miscellaneous

* Update acir_tests reference branch
([#2993](AztecProtocol/aztec-packages#2993))
([91813a5](AztecProtocol/aztec-packages@91813a5))
</details>

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

##
[0.11.0](AztecProtocol/aztec-packages@barretenberg.js-v0.10.1...barretenberg.js-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](AztecProtocol/aztec-packages#2990))
([2a4c548](AztecProtocol/aztec-packages@2a4c548))
</details>

<details><summary>barretenberg: 0.11.0</summary>

##
[0.11.0](AztecProtocol/aztec-packages@barretenberg-v0.10.1...barretenberg-v0.11.0)
(2023-10-24)


### Features

* Pedersen hash in acir format
([#2990](AztecProtocol/aztec-packages#2990))
([2a4c548](AztecProtocol/aztec-packages@2a4c548))


### Miscellaneous

* Update acir_tests reference branch
([#2993](AztecProtocol/aztec-packages#2993))
([91813a5](AztecProtocol/aztec-packages@91813a5))
</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
Archived in project
Development

Successfully merging this pull request may close these issues.

deploy method of Contract.ts uses wallet and generated TS types uses PXE
3 participants