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

feat(docs): DIP1 - Extracting how-tos #4251

Merged
merged 38 commits into from
Feb 9, 2024
Merged

feat(docs): DIP1 - Extracting how-tos #4251

merged 38 commits into from
Feb 9, 2024

Conversation

catmcgee
Copy link
Contributor

@catmcgee catmcgee commented Jan 29, 2024 •
edited
Loading

@AztecBot
Copy link
Collaborator

AztecBot commented Jan 31, 2024 •
edited
Loading

Benchmark results

Metrics with a significant change:

  • note_trial_decrypting_time_in_ms (32): 114 (+159%)
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 e78b86f9 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,412 (-1%) 179,524 (-1%) 716,068 (-1%)
l1_rollup_calldata_gas 221,644 (-1%) 866,908 3,448,492 (-1%)
l1_rollup_execution_gas 314,131 (-1%) 984,648 (-1%) 3,668,149
l2_block_processing_time_in_ms 1,146 (-2%) 4,380 17,170 (-2%)
note_successful_decrypting_time_in_ms 325 878 (-14%) 3,546 (-8%)
note_trial_decrypting_time_in_ms 37.6 (+13%) ⚠️ 114 (+159%) 141 (-10%)
l2_block_building_time_in_ms 18,007 (+1%) 71,519 (+1%) 286,591 (+1%)
l2_block_rollup_simulation_time_in_ms 12,927 (-1%) 51,367 (-1%) 206,645 (-1%)
l2_block_public_tx_process_time_in_ms 5,055 (+8%) 20,029 (+7%) 79,696 (+7%)

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,442 (-2%) 25,546 (-4%)
note_history_successful_decrypting_time_in_ms 2,297 (-3%) 4,465 (-5%)
note_history_trial_decrypting_time_in_ms 165 (+59%) 199 (-14%)
node_database_size_in_bytes 17,293,392 33,206,352 (+1%)
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 315 (+3%) 44,897 (+1%) 26,193 (+1%)
private-kernel-ordering 191 (-2%) 44,513 (+1%) 14,929 (-8%)
base-rollup 1,394 (-1%) 128,970 881 (-6%)
root-rollup 81.6 (-3%) 4,088 (-2%) 677 (-7%)
private-kernel-inner 421 (-4%) 72,056 (+1%) 26,193 (+1%)
public-kernel-private-input 240 32,615 (+1%) 26,193 (+1%)
public-kernel-non-first-iteration 239 (+1%) 32,657 (+1%) 26,193 (+1%)
merge-rollup 7.91 (-1%) 2,608 (-4%) 881 (-6%)

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 128 leaves 64 leaves 512 leaves 1024 leaves 2048 leaves 8192 leaves
batch_insert_into_append_only_tree_16_depth_ms 10.3 10.8 (-1%) 12.6 (-2%) 17.0 (-4%) 22.9 (-1%) 63.6 (-2%) 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 143 N/A N/A N/A N/A N/A
batch_insert_into_append_only_tree_16_depth_hash_ms 0.597 0.602 (-1%) 0.540 (-1%) 0.526 (-3%) 0.478 (-1%) 0.439 (-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 74.4 (-5%) 47.7 238 (-1%) 461 899 (-1%) 3,538 (-1%)
batch_insert_into_append_only_tree_32_depth_hash_count N/A N/A N/A N/A N/A 159 96.0 543 1,055 2,079 8,223
batch_insert_into_append_only_tree_32_depth_hash_ms N/A N/A N/A N/A N/A 0.460 (-5%) 0.490 0.435 (-1%) 0.432 0.428 0.426 (-1%)
batch_insert_into_indexed_tree_20_depth_ms N/A N/A N/A N/A N/A 104 (-1%) 56.7 349 (-3%) 687 1,369 5,398 (-1%)
batch_insert_into_indexed_tree_20_depth_hash_count N/A N/A N/A N/A N/A 197 104 691 1,363 2,707 10,771
batch_insert_into_indexed_tree_20_depth_hash_ms N/A N/A N/A N/A N/A 0.494 (-1%) 0.497 0.474 (-2%) 0.474 0.474 0.471 (-1%)
batch_insert_into_indexed_tree_40_depth_ms N/A N/A N/A 56.6 N/A 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 94.1 N/A 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 0.580 N/A 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 1 deployed contracts
tx_size_in_bytes 15,575 (-8%) 36,576 (-9%)

Transaction processing duration by data writes.

Metric 0 new commitments 1 new commitments
tx_pxe_processing_time_ms 582 (+5%) 1,357 (+4%)
Metric 1 public data writes
tx_sequencer_processing_time_ms 621 (+8%)

@catmcgee catmcgee marked this pull request as ready for review February 2, 2024 07:23
critesjosh
critesjosh reviewed Feb 2, 2024
View reviewed changes
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

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

Overall i really like the new structure and I think it will make it easier to navigate. Most of my suggestions are just implementation details (links, code refs, missing pages in the sidebar) and not pertaining to the overall structure.

docs/docs/developers/aztecjs/guides/call_view_function.md

To do this from the CLI, go [here](../../sandbox/references/cli-commands.md#calling-an-unconstrained-view-function).

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i cant find it anywhere in the monorepo. only overcomplicated examples. wdyt?

docs/docs/developers/aztecjs/guides/create_account.md

To do this from the CLI, go [here](../../sandbox/references/cli-commands.md#creating-accounts).

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

Copy link
Contributor

Choose a reason for hiding this comment

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

could be this https://github.com/AztecProtocol/aztec-packages/blob/master//yarn-project/end-to-end/src/guides/writing_an_account_contract.test.ts#L58-L63

docs/docs/developers/aztecjs/guides/deploy_contract.md

To do this from the CLI, go [here](../../sandbox/references/cli-commands.md#deploying-a-token-contract).

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

docs/docs/developers/aztecjs/guides/send_transaction.md

To do this from the CLI, go [here](../../sandbox/references/cli-commands.md#sending-a-transaction).

```typescript
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we link the reference code to source somewhere, so if the API changes the docs automatically reflect that?

docs/docs/developers/contracts/compiling_contracts/how_to_compile_contract.md Show resolved Hide resolved
docs/docs/developers/contracts/writing_contracts/portals/deploy_with_portal.md Show resolved Hide resolved
docs/docs/developers/contracts/writing_contracts/portals/deploy_with_portal.md Outdated Show resolved Hide resolved
docs/docs/developers/contracts/writing_contracts/portals/portals.md Outdated Show resolved Hide resolved
docs/docs/developers/contracts/writing_contracts/storage/main.md Outdated Show resolved Hide resolved
docs/docs/developers/wallets/architecture.md Show resolved Hide resolved
signorecello
signorecello approved these changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@signorecello signorecello left a comment

Choose a reason for hiding this comment

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

I'm approving because it looks good to me, but don't merge before solving the git conflicts I pointed out!

docs/docs/developers/contracts/syntax/context.md Outdated Show resolved Hide resolved
docs/docs/developers/contracts/writing_contracts/functions/context.md Outdated Show resolved Hide resolved
@catmcgee catmcgee merged commit 9d50e24 into master Feb 9, 2024
85 checks passed
@catmcgee catmcgee deleted the docs/dip1-howtos branch February 9, 2024 08:08
@AztecBot AztecBot mentioned this pull request Feb 9, 2024
Merged
rahul-kothari pushed a commit that referenced this pull request Feb 13, 2024
@AztecBot
chore(master): Release 0.24.0 (#4491)
30d3b96 
🤖 I have created a release *beep* *boop*
---


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

##
[0.24.0](aztec-packages-v0.23.0...aztec-packages-v0.24.0)
(2024-02-13)


### ⚠ BREAKING CHANGES

* move noir out of yarn-project
([#4479](#4479))
* note type ids
([#4500](#4500))

### Features

* Add fee payment methods
([#4504](#4504))
([d107746](d107746))
* Add hashing to stdlib transcript
([#4161](#4161))
([e78b86f](e78b86f))
* Added cast opcode and cast calldata
([#4423](#4423))
([e58eda8](e58eda8))
* Added cast opcode and cast calldata
(#4423)
([db803bd](db803bd))
* **avm-transpiler:** Implement tags for SET and others
([#4545](#4545))
([3063bf3](3063bf3))
* **avm:** Implement addressing modes for MOV
([#4490](#4490))
([ab4eaf0](ab4eaf0))
* **avm:** Introduce small e2e test
([#4470](#4470))
([7b4c6e7](7b4c6e7))
* Aztec.js API for registering a contract class
([#4469](#4469))
([d566c74](d566c74))
* **docs:** DIP1 - Extracting how-tos
([#4251](#4251))
([9d50e24](9d50e24))
* Enable gmock and upgrade gtest to 1.13
([#4480](#4480))
([5fc02e7](5fc02e7))
* IVC bench
([#4515](#4515))
([d8ae42b](d8ae42b))
* Nicer API for instance deployment
([#4493](#4493))
([99c3fba](99c3fba))
* Note type ids
([#4500](#4500))
([e1da2fd](e1da2fd))
* Op count timers
([#4471](#4471))
([26918de](26918de))
* PG + Goblin
([#4399](#4399))
([295cd55](295cd55))
* Prototype native merkle trees
([#4457](#4457))
([7d5e056](7d5e056))
* Update rollup circuits and contracts in yp
([#4536](#4536))
([6e89d53](6e89d53))


### Bug Fixes

* **bb:** Publishing bb for mac intel
([#4523](#4523))
([4982e3c](4982e3c))
* Broken links in docs [REDO]
([#4540](#4540))
([ce2a205](ce2a205))
* **build-system:** Image expiring
([#4521](#4521))
([1501afd](1501afd))
* Convert folding recursive verifier ops to batch mul
([#4517](#4517))
([3750b26](3750b26))
* Cycle_group validate_is_on_curve bug
([#4494](#4494))
([fecf3f7](fecf3f7))
* Field divison / journal comparisions
([#4489](#4489))
([15c06c5](15c06c5))
* Master
([#4547](#4547))
([490ca26](490ca26))
* Mirror_noir_subrepo.yml
([#4550](#4550))
([f8d8311](f8d8311))
* Mul with endomorphism
([#4538](#4538))
([1f4c90d](1f4c90d))
* **noir-mirror:** Don't update .gitrepo on push
([#4555](#4555))
([686140a](686140a))
* Recreate jest.config.ts for sequencer-client
([#4553](#4553))
([d172f0b](d172f0b))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([#4530](#4530))
([ce51d20](ce51d20))
* Use ordered-binary value encoding for multi maps
([#4565](#4565))
([04ae0d2](04ae0d2))


### Miscellaneous

* Aligning some naming in `BaseOrMergeRollupPublicInputs`
([#4510](#4510))
([47d66f9](47d66f9))
* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([#4554](#4554))
([ca4dd60](ca4dd60))
* **avm-simulator:** Reduce boilerplate in AVM memory types
([#4542](#4542))
([da2f5ed](da2f5ed))
* **avm:** Add/improve tests for AvmContext, tagged memory, etc
([#4484](#4484))
([2fccdf2](2fccdf2))
* **avm:** Remove field support for comparators and bitwise ops
([#4516](#4516))
([87a9663](87a9663))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([#4502](#4502))
([bf4fc6c](bf4fc6c)),
closes
[#4495](#4495)
* Cleanup of `abi.nr` in `aztec-nr`
([#4473](#4473))
([6d9c73a](6d9c73a))
* Cleanup of `abi.nr` in `aztec-nr`
(#4473) [skip ci]
([db803bd](db803bd))
* Create constraints for sha256 compression opcode
([#4503](#4503))
([64bef49](64bef49))
* Little cpp style improvements
([#4528](#4528))
([dcc9ba4](dcc9ba4))
* Move noir out of yarn-project
([#4479](#4479))
([1fe674b](1fe674b)),
closes
[#4107](#4107)
* Pull noir
([#4546](#4546))
([acf5cf2](acf5cf2))
* Pull noir (#4546)
([db803bd](db803bd))
* Redo noir subrepo force push
([#4514](#4514))
([7b519a4](7b519a4))
* Remove .oldValue in contract state update request
([#4499](#4499))
([a796bef](a796bef))
* Removing redundant utilities
([#4532](#4532))
([79bf445](79bf445)),
closes
[#3470](#3470)
* Rename kernel circuits and disambiguate inputs
([#4535](#4535))
([ed6d521](ed6d521))
* Replace relative paths to noir-protocol-circuits
([f1accbf](f1accbf))
* Replace relative paths to noir-protocol-circuits
([20ee430](20ee430))
* Replace relative paths to noir-protocol-circuits
([101ab59](101ab59))
* Simulator utils cleanup
([#4507](#4507))
([1dd0ebf](1dd0ebf))
* Sync to noir-lang/noir
([db803bd](db803bd))
* Testing all values in `PublicGlobalVariables` and
`PrivateGlobalVariables`
([#4481](#4481))
([bc25f9b](bc25f9b))
* Testing historical header in contexts
([#4509](#4509))
([c00229a](c00229a))
* Updating field conversion code without pointer hack
([#4537](#4537))
([94f436e](94f436e))
* Uses sha256compression opcode in Noir and implements acvm solver for
it
([#4511](#4511))
([9dc05bc](9dc05bc))


### Documentation

* Describe the new message box model
([#4485](#4485))
([14cc1dd](14cc1dd))
* Review of docs, so far
([#4505](#4505))
([140c508](140c508))
* **yellowpaper:** Avm tree-access operations
([#4552](#4552))
([913f4bd](913f4bd))
* **yellowpaper:** Separate section for AVM state
([#4440](#4440))
([7881f09](7881f09))
</details>

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

##
[0.24.0](barretenberg.js-v0.23.0...barretenberg.js-v0.24.0)
(2024-02-13)


### Features

* Prototype native merkle trees
([#4457](#4457))
([7d5e056](7d5e056))
</details>

<details><summary>barretenberg: 0.24.0</summary>

##
[0.24.0](barretenberg-v0.23.0...barretenberg-v0.24.0)
(2024-02-13)


### Features

* Add hashing to stdlib transcript
([#4161](#4161))
([e78b86f](e78b86f))
* Added cast opcode and cast calldata
([#4423](#4423))
([e58eda8](e58eda8))
* Enable gmock and upgrade gtest to 1.13
([#4480](#4480))
([5fc02e7](5fc02e7))
* IVC bench
([#4515](#4515))
([d8ae42b](d8ae42b))
* Op count timers
([#4471](#4471))
([26918de](26918de))
* PG + Goblin
([#4399](#4399))
([295cd55](295cd55))
* Prototype native merkle trees
([#4457](#4457))
([7d5e056](7d5e056))


### Bug Fixes

* Convert folding recursive verifier ops to batch mul
([#4517](#4517))
([3750b26](3750b26))
* Cycle_group validate_is_on_curve bug
([#4494](#4494))
([fecf3f7](fecf3f7))
* Mul with endomorphism
([#4538](#4538))
([1f4c90d](1f4c90d))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([#4530](#4530))
([ce51d20](ce51d20))


### Miscellaneous

* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([#4554](#4554))
([ca4dd60](ca4dd60))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([#4502](#4502))
([bf4fc6c](bf4fc6c)),
closes
[#4495](#4495)
* Create constraints for sha256 compression opcode
([#4503](#4503))
([64bef49](64bef49))
* Little cpp style improvements
([#4528](#4528))
([dcc9ba4](dcc9ba4))
* Updating field conversion code without pointer hack
([#4537](#4537))
([94f436e](94f436e))


### Documentation

* **yellowpaper:** Avm tree-access operations
([#4552](#4552))
([913f4bd](913f4bd))
</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 Feb 14, 2024
@AztecBot
chore(master): Release 0.24.0 (#4491)
5964af5 
🤖 I have created a release *beep* *boop*
---


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

##
[0.24.0](AztecProtocol/aztec-packages@aztec-packages-v0.23.0...aztec-packages-v0.24.0)
(2024-02-13)


### ⚠ BREAKING CHANGES

* move noir out of yarn-project
([#4479](AztecProtocol/aztec-packages#4479))
* note type ids
([#4500](AztecProtocol/aztec-packages#4500))

### Features

* Add fee payment methods
([#4504](AztecProtocol/aztec-packages#4504))
([d107746](AztecProtocol/aztec-packages@d107746))
* Add hashing to stdlib transcript
([#4161](AztecProtocol/aztec-packages#4161))
([e78b86f](AztecProtocol/aztec-packages@e78b86f))
* Added cast opcode and cast calldata
([#4423](AztecProtocol/aztec-packages#4423))
([e58eda8](AztecProtocol/aztec-packages@e58eda8))
* Added cast opcode and cast calldata
(AztecProtocol/aztec-packages#4423)
([db803bd](AztecProtocol/aztec-packages@db803bd))
* **avm-transpiler:** Implement tags for SET and others
([#4545](AztecProtocol/aztec-packages#4545))
([3063bf3](AztecProtocol/aztec-packages@3063bf3))
* **avm:** Implement addressing modes for MOV
([#4490](AztecProtocol/aztec-packages#4490))
([ab4eaf0](AztecProtocol/aztec-packages@ab4eaf0))
* **avm:** Introduce small e2e test
([#4470](AztecProtocol/aztec-packages#4470))
([7b4c6e7](AztecProtocol/aztec-packages@7b4c6e7))
* Aztec.js API for registering a contract class
([#4469](AztecProtocol/aztec-packages#4469))
([d566c74](AztecProtocol/aztec-packages@d566c74))
* **docs:** DIP1 - Extracting how-tos
([#4251](AztecProtocol/aztec-packages#4251))
([9d50e24](AztecProtocol/aztec-packages@9d50e24))
* Enable gmock and upgrade gtest to 1.13
([#4480](AztecProtocol/aztec-packages#4480))
([5fc02e7](AztecProtocol/aztec-packages@5fc02e7))
* IVC bench
([#4515](AztecProtocol/aztec-packages#4515))
([d8ae42b](AztecProtocol/aztec-packages@d8ae42b))
* Nicer API for instance deployment
([#4493](AztecProtocol/aztec-packages#4493))
([99c3fba](AztecProtocol/aztec-packages@99c3fba))
* Note type ids
([#4500](AztecProtocol/aztec-packages#4500))
([e1da2fd](AztecProtocol/aztec-packages@e1da2fd))
* Op count timers
([#4471](AztecProtocol/aztec-packages#4471))
([26918de](AztecProtocol/aztec-packages@26918de))
* PG + Goblin
([#4399](AztecProtocol/aztec-packages#4399))
([295cd55](AztecProtocol/aztec-packages@295cd55))
* Prototype native merkle trees
([#4457](AztecProtocol/aztec-packages#4457))
([7d5e056](AztecProtocol/aztec-packages@7d5e056))
* Update rollup circuits and contracts in yp
([#4536](AztecProtocol/aztec-packages#4536))
([6e89d53](AztecProtocol/aztec-packages@6e89d53))


### Bug Fixes

* **bb:** Publishing bb for mac intel
([#4523](AztecProtocol/aztec-packages#4523))
([4982e3c](AztecProtocol/aztec-packages@4982e3c))
* Broken links in docs [REDO]
([#4540](AztecProtocol/aztec-packages#4540))
([ce2a205](AztecProtocol/aztec-packages@ce2a205))
* **build-system:** Image expiring
([#4521](AztecProtocol/aztec-packages#4521))
([1501afd](AztecProtocol/aztec-packages@1501afd))
* Convert folding recursive verifier ops to batch mul
([#4517](AztecProtocol/aztec-packages#4517))
([3750b26](AztecProtocol/aztec-packages@3750b26))
* Cycle_group validate_is_on_curve bug
([#4494](AztecProtocol/aztec-packages#4494))
([fecf3f7](AztecProtocol/aztec-packages@fecf3f7))
* Field divison / journal comparisions
([#4489](AztecProtocol/aztec-packages#4489))
([15c06c5](AztecProtocol/aztec-packages@15c06c5))
* Master
([#4547](AztecProtocol/aztec-packages#4547))
([490ca26](AztecProtocol/aztec-packages@490ca26))
* Mirror_noir_subrepo.yml
([#4550](AztecProtocol/aztec-packages#4550))
([f8d8311](AztecProtocol/aztec-packages@f8d8311))
* Mul with endomorphism
([#4538](AztecProtocol/aztec-packages#4538))
([1f4c90d](AztecProtocol/aztec-packages@1f4c90d))
* **noir-mirror:** Don't update .gitrepo on push
([#4555](AztecProtocol/aztec-packages#4555))
([686140a](AztecProtocol/aztec-packages@686140a))
* Recreate jest.config.ts for sequencer-client
([#4553](AztecProtocol/aztec-packages#4553))
([d172f0b](AztecProtocol/aztec-packages@d172f0b))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([#4530](AztecProtocol/aztec-packages#4530))
([ce51d20](AztecProtocol/aztec-packages@ce51d20))
* Use ordered-binary value encoding for multi maps
([#4565](AztecProtocol/aztec-packages#4565))
([04ae0d2](AztecProtocol/aztec-packages@04ae0d2))


### Miscellaneous

* Aligning some naming in `BaseOrMergeRollupPublicInputs`
([#4510](AztecProtocol/aztec-packages#4510))
([47d66f9](AztecProtocol/aztec-packages@47d66f9))
* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([#4554](AztecProtocol/aztec-packages#4554))
([ca4dd60](AztecProtocol/aztec-packages@ca4dd60))
* **avm-simulator:** Reduce boilerplate in AVM memory types
([#4542](AztecProtocol/aztec-packages#4542))
([da2f5ed](AztecProtocol/aztec-packages@da2f5ed))
* **avm:** Add/improve tests for AvmContext, tagged memory, etc
([#4484](AztecProtocol/aztec-packages#4484))
([2fccdf2](AztecProtocol/aztec-packages@2fccdf2))
* **avm:** Remove field support for comparators and bitwise ops
([#4516](AztecProtocol/aztec-packages#4516))
([87a9663](AztecProtocol/aztec-packages@87a9663))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([#4502](AztecProtocol/aztec-packages#4502))
([bf4fc6c](AztecProtocol/aztec-packages@bf4fc6c)),
closes
[#4495](AztecProtocol/aztec-packages#4495)
* Cleanup of `abi.nr` in `aztec-nr`
([#4473](AztecProtocol/aztec-packages#4473))
([6d9c73a](AztecProtocol/aztec-packages@6d9c73a))
* Cleanup of `abi.nr` in `aztec-nr`
(AztecProtocol/aztec-packages#4473) [skip ci]
([db803bd](AztecProtocol/aztec-packages@db803bd))
* Create constraints for sha256 compression opcode
([#4503](AztecProtocol/aztec-packages#4503))
([64bef49](AztecProtocol/aztec-packages@64bef49))
* Little cpp style improvements
([#4528](AztecProtocol/aztec-packages#4528))
([dcc9ba4](AztecProtocol/aztec-packages@dcc9ba4))
* Move noir out of yarn-project
([#4479](AztecProtocol/aztec-packages#4479))
([1fe674b](AztecProtocol/aztec-packages@1fe674b)),
closes
[#4107](AztecProtocol/aztec-packages#4107)
* Pull noir
([#4546](AztecProtocol/aztec-packages#4546))
([acf5cf2](AztecProtocol/aztec-packages@acf5cf2))
* Pull noir (AztecProtocol/aztec-packages#4546)
([db803bd](AztecProtocol/aztec-packages@db803bd))
* Redo noir subrepo force push
([#4514](AztecProtocol/aztec-packages#4514))
([7b519a4](AztecProtocol/aztec-packages@7b519a4))
* Remove .oldValue in contract state update request
([#4499](AztecProtocol/aztec-packages#4499))
([a796bef](AztecProtocol/aztec-packages@a796bef))
* Removing redundant utilities
([#4532](AztecProtocol/aztec-packages#4532))
([79bf445](AztecProtocol/aztec-packages@79bf445)),
closes
[#3470](AztecProtocol/aztec-packages#3470)
* Rename kernel circuits and disambiguate inputs
([#4535](AztecProtocol/aztec-packages#4535))
([ed6d521](AztecProtocol/aztec-packages@ed6d521))
* Replace relative paths to noir-protocol-circuits
([f1accbf](AztecProtocol/aztec-packages@f1accbf))
* Replace relative paths to noir-protocol-circuits
([20ee430](AztecProtocol/aztec-packages@20ee430))
* Replace relative paths to noir-protocol-circuits
([101ab59](AztecProtocol/aztec-packages@101ab59))
* Simulator utils cleanup
([#4507](AztecProtocol/aztec-packages#4507))
([1dd0ebf](AztecProtocol/aztec-packages@1dd0ebf))
* Sync to noir-lang/noir
([db803bd](AztecProtocol/aztec-packages@db803bd))
* Testing all values in `PublicGlobalVariables` and
`PrivateGlobalVariables`
([#4481](AztecProtocol/aztec-packages#4481))
([bc25f9b](AztecProtocol/aztec-packages@bc25f9b))
* Testing historical header in contexts
([#4509](AztecProtocol/aztec-packages#4509))
([c00229a](AztecProtocol/aztec-packages@c00229a))
* Updating field conversion code without pointer hack
([#4537](AztecProtocol/aztec-packages#4537))
([94f436e](AztecProtocol/aztec-packages@94f436e))
* Uses sha256compression opcode in Noir and implements acvm solver for
it
([#4511](AztecProtocol/aztec-packages#4511))
([9dc05bc](AztecProtocol/aztec-packages@9dc05bc))


### Documentation

* Describe the new message box model
([#4485](AztecProtocol/aztec-packages#4485))
([14cc1dd](AztecProtocol/aztec-packages@14cc1dd))
* Review of docs, so far
([#4505](AztecProtocol/aztec-packages#4505))
([140c508](AztecProtocol/aztec-packages@140c508))
* **yellowpaper:** Avm tree-access operations
([#4552](AztecProtocol/aztec-packages#4552))
([913f4bd](AztecProtocol/aztec-packages@913f4bd))
* **yellowpaper:** Separate section for AVM state
([#4440](AztecProtocol/aztec-packages#4440))
([7881f09](AztecProtocol/aztec-packages@7881f09))
</details>

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

##
[0.24.0](AztecProtocol/aztec-packages@barretenberg.js-v0.23.0...barretenberg.js-v0.24.0)
(2024-02-13)


### Features

* Prototype native merkle trees
([#4457](AztecProtocol/aztec-packages#4457))
([7d5e056](AztecProtocol/aztec-packages@7d5e056))
</details>

<details><summary>barretenberg: 0.24.0</summary>

##
[0.24.0](AztecProtocol/aztec-packages@barretenberg-v0.23.0...barretenberg-v0.24.0)
(2024-02-13)


### Features

* Add hashing to stdlib transcript
([#4161](AztecProtocol/aztec-packages#4161))
([e78b86f](AztecProtocol/aztec-packages@e78b86f))
* Added cast opcode and cast calldata
([#4423](AztecProtocol/aztec-packages#4423))
([e58eda8](AztecProtocol/aztec-packages@e58eda8))
* Enable gmock and upgrade gtest to 1.13
([#4480](AztecProtocol/aztec-packages#4480))
([5fc02e7](AztecProtocol/aztec-packages@5fc02e7))
* IVC bench
([#4515](AztecProtocol/aztec-packages#4515))
([d8ae42b](AztecProtocol/aztec-packages@d8ae42b))
* Op count timers
([#4471](AztecProtocol/aztec-packages#4471))
([26918de](AztecProtocol/aztec-packages@26918de))
* PG + Goblin
([#4399](AztecProtocol/aztec-packages#4399))
([295cd55](AztecProtocol/aztec-packages@295cd55))
* Prototype native merkle trees
([#4457](AztecProtocol/aztec-packages#4457))
([7d5e056](AztecProtocol/aztec-packages@7d5e056))


### Bug Fixes

* Convert folding recursive verifier ops to batch mul
([#4517](AztecProtocol/aztec-packages#4517))
([3750b26](AztecProtocol/aztec-packages@3750b26))
* Cycle_group validate_is_on_curve bug
([#4494](AztecProtocol/aztec-packages#4494))
([fecf3f7](AztecProtocol/aztec-packages@fecf3f7))
* Mul with endomorphism
([#4538](AztecProtocol/aztec-packages#4538))
([1f4c90d](AztecProtocol/aztec-packages@1f4c90d))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([#4530](AztecProtocol/aztec-packages#4530))
([ce51d20](AztecProtocol/aztec-packages@ce51d20))


### Miscellaneous

* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([#4554](AztecProtocol/aztec-packages#4554))
([ca4dd60](AztecProtocol/aztec-packages@ca4dd60))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([#4502](AztecProtocol/aztec-packages#4502))
([bf4fc6c](AztecProtocol/aztec-packages@bf4fc6c)),
closes
[#4495](AztecProtocol/aztec-packages#4495)
* Create constraints for sha256 compression opcode
([#4503](AztecProtocol/aztec-packages#4503))
([64bef49](AztecProtocol/aztec-packages@64bef49))
* Little cpp style improvements
([#4528](AztecProtocol/aztec-packages#4528))
([dcc9ba4](AztecProtocol/aztec-packages@dcc9ba4))
* Updating field conversion code without pointer hack
([#4537](AztecProtocol/aztec-packages#4537))
([94f436e](AztecProtocol/aztec-packages@94f436e))


### Documentation

* **yellowpaper:** Avm tree-access operations
([#4552](AztecProtocol/aztec-packages#4552))
([913f4bd](AztecProtocol/aztec-packages@913f4bd))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
michaelelliot pushed a commit to Swoir/noir_rs that referenced this pull request Feb 28, 2024
@catmcgee
feat(docs): DIP1 - Extracting how-tos (AztecProtocol#4251)
f4f0c8f 
Closes AztecProtocol/dev-rel#110
Closes AztecProtocol#3282
Closes AztecProtocol/dev-rel#114
Closes AztecProtocol/dev-rel#116

---------

Co-authored-by: Cat McGee <catmcgee@Cats-MacBook-Pro.local>
michaelelliot pushed a commit to Swoir/noir_rs that referenced this pull request Feb 28, 2024
@AztecBot
chore(master): Release 0.24.0 (AztecProtocol#4491)
dce6957 
🤖 I have created a release *beep* *boop*
---


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

##
[0.24.0](AztecProtocol/aztec-packages@aztec-packages-v0.23.0...aztec-packages-v0.24.0)
(2024-02-13)


### ⚠ BREAKING CHANGES

* move noir out of yarn-project
([AztecProtocol#4479](AztecProtocol#4479))
* note type ids
([AztecProtocol#4500](AztecProtocol#4500))

### Features

* Add fee payment methods
([AztecProtocol#4504](AztecProtocol#4504))
([d107746](AztecProtocol@d107746))
* Add hashing to stdlib transcript
([AztecProtocol#4161](AztecProtocol#4161))
([e78b86f](AztecProtocol@e78b86f))
* Added cast opcode and cast calldata
([AztecProtocol#4423](AztecProtocol#4423))
([e58eda8](AztecProtocol@e58eda8))
* Added cast opcode and cast calldata
(AztecProtocol#4423)
([db803bd](AztecProtocol@db803bd))
* **avm-transpiler:** Implement tags for SET and others
([AztecProtocol#4545](AztecProtocol#4545))
([3063bf3](AztecProtocol@3063bf3))
* **avm:** Implement addressing modes for MOV
([AztecProtocol#4490](AztecProtocol#4490))
([ab4eaf0](AztecProtocol@ab4eaf0))
* **avm:** Introduce small e2e test
([AztecProtocol#4470](AztecProtocol#4470))
([7b4c6e7](AztecProtocol@7b4c6e7))
* Aztec.js API for registering a contract class
([AztecProtocol#4469](AztecProtocol#4469))
([d566c74](AztecProtocol@d566c74))
* **docs:** DIP1 - Extracting how-tos
([AztecProtocol#4251](AztecProtocol#4251))
([9d50e24](AztecProtocol@9d50e24))
* Enable gmock and upgrade gtest to 1.13
([AztecProtocol#4480](AztecProtocol#4480))
([5fc02e7](AztecProtocol@5fc02e7))
* IVC bench
([AztecProtocol#4515](AztecProtocol#4515))
([d8ae42b](AztecProtocol@d8ae42b))
* Nicer API for instance deployment
([AztecProtocol#4493](AztecProtocol#4493))
([99c3fba](AztecProtocol@99c3fba))
* Note type ids
([AztecProtocol#4500](AztecProtocol#4500))
([e1da2fd](AztecProtocol@e1da2fd))
* Op count timers
([AztecProtocol#4471](AztecProtocol#4471))
([26918de](AztecProtocol@26918de))
* PG + Goblin
([AztecProtocol#4399](AztecProtocol#4399))
([295cd55](AztecProtocol@295cd55))
* Prototype native merkle trees
([AztecProtocol#4457](AztecProtocol#4457))
([7d5e056](AztecProtocol@7d5e056))
* Update rollup circuits and contracts in yp
([AztecProtocol#4536](AztecProtocol#4536))
([6e89d53](AztecProtocol@6e89d53))


### Bug Fixes

* **bb:** Publishing bb for mac intel
([AztecProtocol#4523](AztecProtocol#4523))
([4982e3c](AztecProtocol@4982e3c))
* Broken links in docs [REDO]
([AztecProtocol#4540](AztecProtocol#4540))
([ce2a205](AztecProtocol@ce2a205))
* **build-system:** Image expiring
([AztecProtocol#4521](AztecProtocol#4521))
([1501afd](AztecProtocol@1501afd))
* Convert folding recursive verifier ops to batch mul
([AztecProtocol#4517](AztecProtocol#4517))
([3750b26](AztecProtocol@3750b26))
* Cycle_group validate_is_on_curve bug
([AztecProtocol#4494](AztecProtocol#4494))
([fecf3f7](AztecProtocol@fecf3f7))
* Field divison / journal comparisions
([AztecProtocol#4489](AztecProtocol#4489))
([15c06c5](AztecProtocol@15c06c5))
* Master
([AztecProtocol#4547](AztecProtocol#4547))
([490ca26](AztecProtocol@490ca26))
* Mirror_noir_subrepo.yml
([AztecProtocol#4550](AztecProtocol#4550))
([f8d8311](AztecProtocol@f8d8311))
* Mul with endomorphism
([AztecProtocol#4538](AztecProtocol#4538))
([1f4c90d](AztecProtocol@1f4c90d))
* **noir-mirror:** Don't update .gitrepo on push
([AztecProtocol#4555](AztecProtocol#4555))
([686140a](AztecProtocol@686140a))
* Recreate jest.config.ts for sequencer-client
([AztecProtocol#4553](AztecProtocol#4553))
([d172f0b](AztecProtocol@d172f0b))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([AztecProtocol#4530](AztecProtocol#4530))
([ce51d20](AztecProtocol@ce51d20))
* Use ordered-binary value encoding for multi maps
([AztecProtocol#4565](AztecProtocol#4565))
([04ae0d2](AztecProtocol@04ae0d2))


### Miscellaneous

* Aligning some naming in `BaseOrMergeRollupPublicInputs`
([AztecProtocol#4510](AztecProtocol#4510))
([47d66f9](AztecProtocol@47d66f9))
* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([AztecProtocol#4554](AztecProtocol#4554))
([ca4dd60](AztecProtocol@ca4dd60))
* **avm-simulator:** Reduce boilerplate in AVM memory types
([AztecProtocol#4542](AztecProtocol#4542))
([da2f5ed](AztecProtocol@da2f5ed))
* **avm:** Add/improve tests for AvmContext, tagged memory, etc
([AztecProtocol#4484](AztecProtocol#4484))
([2fccdf2](AztecProtocol@2fccdf2))
* **avm:** Remove field support for comparators and bitwise ops
([AztecProtocol#4516](AztecProtocol#4516))
([87a9663](AztecProtocol@87a9663))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([AztecProtocol#4502](AztecProtocol#4502))
([bf4fc6c](AztecProtocol@bf4fc6c)),
closes
[AztecProtocol#4495](AztecProtocol#4495)
* Cleanup of `abi.nr` in `aztec-nr`
([AztecProtocol#4473](AztecProtocol#4473))
([6d9c73a](AztecProtocol@6d9c73a))
* Cleanup of `abi.nr` in `aztec-nr`
(AztecProtocol#4473) [skip ci]
([db803bd](AztecProtocol@db803bd))
* Create constraints for sha256 compression opcode
([AztecProtocol#4503](AztecProtocol#4503))
([64bef49](AztecProtocol@64bef49))
* Little cpp style improvements
([AztecProtocol#4528](AztecProtocol#4528))
([dcc9ba4](AztecProtocol@dcc9ba4))
* Move noir out of yarn-project
([AztecProtocol#4479](AztecProtocol#4479))
([1fe674b](AztecProtocol@1fe674b)),
closes
[AztecProtocol#4107](AztecProtocol#4107)
* Pull noir
([AztecProtocol#4546](AztecProtocol#4546))
([acf5cf2](AztecProtocol@acf5cf2))
* Pull noir (AztecProtocol#4546)
([db803bd](AztecProtocol@db803bd))
* Redo noir subrepo force push
([AztecProtocol#4514](AztecProtocol#4514))
([7b519a4](AztecProtocol@7b519a4))
* Remove .oldValue in contract state update request
([AztecProtocol#4499](AztecProtocol#4499))
([a796bef](AztecProtocol@a796bef))
* Removing redundant utilities
([AztecProtocol#4532](AztecProtocol#4532))
([79bf445](AztecProtocol@79bf445)),
closes
[AztecProtocol#3470](AztecProtocol#3470)
* Rename kernel circuits and disambiguate inputs
([AztecProtocol#4535](AztecProtocol#4535))
([ed6d521](AztecProtocol@ed6d521))
* Replace relative paths to noir-protocol-circuits
([f1accbf](AztecProtocol@f1accbf))
* Replace relative paths to noir-protocol-circuits
([20ee430](AztecProtocol@20ee430))
* Replace relative paths to noir-protocol-circuits
([101ab59](AztecProtocol@101ab59))
* Simulator utils cleanup
([AztecProtocol#4507](AztecProtocol#4507))
([1dd0ebf](AztecProtocol@1dd0ebf))
* Sync to noir-lang/noir
([db803bd](AztecProtocol@db803bd))
* Testing all values in `PublicGlobalVariables` and
`PrivateGlobalVariables`
([AztecProtocol#4481](AztecProtocol#4481))
([bc25f9b](AztecProtocol@bc25f9b))
* Testing historical header in contexts
([AztecProtocol#4509](AztecProtocol#4509))
([c00229a](AztecProtocol@c00229a))
* Updating field conversion code without pointer hack
([AztecProtocol#4537](AztecProtocol#4537))
([94f436e](AztecProtocol@94f436e))
* Uses sha256compression opcode in Noir and implements acvm solver for
it
([AztecProtocol#4511](AztecProtocol#4511))
([9dc05bc](AztecProtocol@9dc05bc))


### Documentation

* Describe the new message box model
([AztecProtocol#4485](AztecProtocol#4485))
([14cc1dd](AztecProtocol@14cc1dd))
* Review of docs, so far
([AztecProtocol#4505](AztecProtocol#4505))
([140c508](AztecProtocol@140c508))
* **yellowpaper:** Avm tree-access operations
([AztecProtocol#4552](AztecProtocol#4552))
([913f4bd](AztecProtocol@913f4bd))
* **yellowpaper:** Separate section for AVM state
([AztecProtocol#4440](AztecProtocol#4440))
([7881f09](AztecProtocol@7881f09))
</details>

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

##
[0.24.0](AztecProtocol/aztec-packages@barretenberg.js-v0.23.0...barretenberg.js-v0.24.0)
(2024-02-13)


### Features

* Prototype native merkle trees
([AztecProtocol#4457](AztecProtocol#4457))
([7d5e056](AztecProtocol@7d5e056))
</details>

<details><summary>barretenberg: 0.24.0</summary>

##
[0.24.0](AztecProtocol/aztec-packages@barretenberg-v0.23.0...barretenberg-v0.24.0)
(2024-02-13)


### Features

* Add hashing to stdlib transcript
([AztecProtocol#4161](AztecProtocol#4161))
([e78b86f](AztecProtocol@e78b86f))
* Added cast opcode and cast calldata
([AztecProtocol#4423](AztecProtocol#4423))
([e58eda8](AztecProtocol@e58eda8))
* Enable gmock and upgrade gtest to 1.13
([AztecProtocol#4480](AztecProtocol#4480))
([5fc02e7](AztecProtocol@5fc02e7))
* IVC bench
([AztecProtocol#4515](AztecProtocol#4515))
([d8ae42b](AztecProtocol@d8ae42b))
* Op count timers
([AztecProtocol#4471](AztecProtocol#4471))
([26918de](AztecProtocol@26918de))
* PG + Goblin
([AztecProtocol#4399](AztecProtocol#4399))
([295cd55](AztecProtocol@295cd55))
* Prototype native merkle trees
([AztecProtocol#4457](AztecProtocol#4457))
([7d5e056](AztecProtocol@7d5e056))


### Bug Fixes

* Convert folding recursive verifier ops to batch mul
([AztecProtocol#4517](AztecProtocol#4517))
([3750b26](AztecProtocol@3750b26))
* Cycle_group validate_is_on_curve bug
([AztecProtocol#4494](AztecProtocol#4494))
([fecf3f7](AztecProtocol@fecf3f7))
* Mul with endomorphism
([AztecProtocol#4538](AztecProtocol#4538))
([1f4c90d](AztecProtocol@1f4c90d))
* StandardCircuitBuilder create_logic_constraint and uint logic_operator
([AztecProtocol#4530](AztecProtocol#4530))
([ce51d20](AztecProtocol@ce51d20))


### Miscellaneous

* **avm-circuit:** Tests use OpCode enum's instead of hardcoded values
([AztecProtocol#4554](AztecProtocol#4554))
([ca4dd60](AztecProtocol@ca4dd60))
* **avm:** Use some matchers gtest functionalities to improve unit tests
([AztecProtocol#4502](AztecProtocol#4502))
([bf4fc6c](AztecProtocol@bf4fc6c)),
closes
[AztecProtocol#4495](AztecProtocol#4495)
* Create constraints for sha256 compression opcode
([AztecProtocol#4503](AztecProtocol#4503))
([64bef49](AztecProtocol@64bef49))
* Little cpp style improvements
([AztecProtocol#4528](AztecProtocol#4528))
([dcc9ba4](AztecProtocol@dcc9ba4))
* Updating field conversion code without pointer hack
([AztecProtocol#4537](AztecProtocol#4537))
([94f436e](AztecProtocol@94f436e))


### Documentation

* **yellowpaper:** Avm tree-access operations
([AztecProtocol#4552](AztecProtocol#4552))
([913f4bd](AztecProtocol@913f4bd))
</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
Reviewers

@jzaki jzaki jzaki left review comments

@signorecello signorecello signorecello approved these changes

@critesjosh critesjosh Awaiting requested review from critesjosh

Assignees
No one assigned
Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
5 participants
@catmcgee @AztecBot @jzaki @critesjosh @signorecello