feat(docs): add partial notes doc #8192

critesjosh · 2024-08-26T19:35:25Z

Adds a doc on partial notes as a concept.

AztecBot · 2024-08-26T20:02:42Z

Benchmark results

Metrics with a significant change:

avm_simulation_time_ms (Token:mint_public): 44.3 (-37%)
avm_simulation_time_ms (Token:assert_minter_and_mint): 67.2 (+66%)

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.

Proof generation

Each column represents the number of threads used in proof generation.

Metric	1 threads	4 threads	16 threads	32 threads	64 threads
proof_construction_time_sha256_ms	5,756	1,560	712	758	775
proof_construction_time_sha256_30_ms	11,477	3,079	1,377	1,430 (+1%)	1,460 (-1%)
proof_construction_time_sha256_100_ms	43,951	11,785	5,408	5,565 (+4%)	5,699
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	58.0 (-3%)	90.0 (+2%)
proof_construction_time_poseidon_hash_30_ms	1,527	421 (-3%)	202	230 (-3%)	266 (-4%)
proof_construction_time_poseidon_hash_100_ms	5,643	1,513	671	718	746

L2 block published to L1

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

Metric	4 txs	8 txs	16 txs
l1_rollup_calldata_size_in_bytes	4,356	7,876	14,884
l1_rollup_calldata_gas	50,256	93,004	177,856
l1_rollup_execution_gas	842,916	1,576,560	3,361,468
l2_block_processing_time_in_ms	249 (-5%)	452	843 (+1%)
l2_block_building_time_in_ms	11,441	22,283	44,978 (+1%)
l2_block_rollup_simulation_time_in_ms	11,441	22,282	44,978 (+1%)
l2_block_public_tx_process_time_in_ms	9,716 (+1%)	20,471	43,105 (+1%)

L2 chain processing

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

Metric	3 blocks	5 blocks
node_history_sync_time_in_ms	3,048 (+3%)	3,892
node_database_size_in_bytes	12,623,952	16,699,472
pxe_database_size_in_bytes	16,254	26,813

Circuits stats

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

Circuit	simulation_time_in_ms	witness_generation_time_in_ms	input_size_in_bytes	output_size_in_bytes	proving_time_in_ms
private-kernel-init	91.5	393	21,735	44,860	N/A
private-kernel-inner	178 (+1%)	700	72,544	45,007	N/A
private-kernel-reset-tiny	311	718 (+1%)	65,593	44,846	N/A
private-kernel-tail	166 (-1%)	136 (-1%)	50,644	52,257	N/A
base-parity	5.63	N/A	160	96.0	N/A
root-parity	35.7	N/A	73,948	96.0	N/A
base-rollup	3,460	N/A	189,136	664	N/A
block-root-rollup	42.2 (+2%)	N/A	58,205	2,448	N/A
public-kernel-setup	85.3 (+1%)	N/A	105,085	71,222	N/A
public-kernel-app-logic	97.0	N/A	104,911	71,222	N/A
public-kernel-tail	864	N/A	390,582	16,414	N/A
private-kernel-reset-small	311 (+1%)	N/A	66,341	45,629	N/A
private-kernel-tail-to-public	671 (-2%)	608	455,400	1,825	N/A
public-kernel-teardown	84.3 (+1%)	N/A	105,349	71,222	N/A
merge-rollup	20.3 (-1%)	N/A	38,174	664	N/A
undefined	N/A	N/A	N/A	N/A	77,503 (-1%)

Stats on running time collected for app circuits

Function	input_size_in_bytes	output_size_in_bytes	witness_generation_time_in_ms
ContractClassRegisterer:register	1,344	11,731	348 (+2%)
ContractInstanceDeployer:deploy	1,408	11,731	18.3 (-1%)
MultiCallEntrypoint:entrypoint	1,920	11,731	408 (+1%)
FeeJuice:deploy	1,376	11,731	389 (+1%)
SchnorrAccount:constructor	1,312	11,731	73.6 (-1%)
SchnorrAccount:entrypoint	2,304	11,731	397 (+1%)
Token:privately_mint_private_note	1,280	11,731	108 (+6%)
FPC:fee_entrypoint_public	1,344	11,731	25.7
Token:transfer	1,312	11,731	240 (+6%)
Benchmarking:create_note	1,344	11,731	85.5 (-1%)
SchnorrAccount:verify_private_authwit	1,280	11,731	27.7 (-6%)
Token:unshield	1,376	11,731	531 (+2%)
FPC:fee_entrypoint_private	1,376	11,731	712 (+1%)

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
FeeJuice:_increase_public_balance	55.2 (-1%)	7,101
FeeJuice:set_portal	11.1 (+2%)	2,128
Token:constructor	82.2 (+1%)	25,285
FPC:constructor	54.1 (-1%)	17,853
FeeJuice:mint_public	40.2 (-4%)	5,415
Token:mint_public	⚠️ 44.3 (-37%)	10,101
Token:assert_minter_and_mint	⚠️ 67.2 (+66%)	6,844
AuthRegistry:set_authorized	37.0 (-22%)	3,969
FPC:prepare_fee	230 (-1%)	6,747
Token:transfer_public	19.9 (-26%)	38,126
FPC:pay_refund	49.8 (-17%)	9,398
Benchmarking:increment_balance	1,209	6,179
Token:_increase_public_balance	46.8 (+18%)	7,705
FPC:pay_refund_with_shielded_rebate	75.0 (+21%)	9,881

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.162

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	256 leaves	512 leaves	1024 leaves
batch_insert_into_append_only_tree_16_depth_ms	2.24	4.01 (+3%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_count	16.8	31.7	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.117 (+1%)	0.113 (+2%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_32_depth_ms	N/A	N/A	11.6	17.8	31.3 (-1%)	59.3 (-1%)	114 (-1%)
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	95.9	159	287	543	1,055
batch_insert_into_append_only_tree_32_depth_hash_ms	N/A	N/A	0.111	0.103	0.101 (-1%)	0.102	0.102 (-1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	14.4 (-1%)	26.0 (-1%)	44.4	83.2	163
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	109	207	355	691	1,363
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.109 (-2%)	0.104 (-2%)	0.106 (-1%)	0.103 (+1%)	0.102 (-1%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	16.8	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	132	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.108	N/A	N/A	N/A	N/A

Miscellaneous

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

Metric	0 registered classes	1 registered classes
tx_size_in_bytes	64,779	668,997

Transaction size based on fee payment method

| Metric | |
| - | |

critesjosh · 2024-08-27T12:58:02Z

@catmcgee wdyt about the current location?

AztecBot · 2024-08-27T13:01:22Z

Docs Preview

Hey there! 👋 You can check your preview at https://66cf862d5c35cb1ef1bce154--aztec-docs-dev.netlify.app

benesjan · 2024-08-28T10:45:58Z

docs/docs/aztec/concepts/storage/partial_notes.md

@@ -47,11 +82,13 @@ $$
 P_a' := \text{funded amount}*G_{amount} + \text{alice address}*G_{address} + \text{rand}_a*G_{randomness}
 $$

-Where did that $\text{rand}_a$ come from? Well from Alice of course. So we can't trust it is random. So we hash it with Alice's address and emit it as a nullifier.


Mitch originally though this might be a problem because at the time we did not have nonces in publicly injected note hashes and for this reason if user would use the same randomness twice and the note would end up having the same amount you would inject 2 equal notes into a note hash tree and effectively lose one of those because you could spend only 1 of those (because nullifier would be the same).
A while ago Leila implemented nonces in the public note hashes so this is no longer a problem.

benesjan · 2024-08-28T12:37:28Z

noir-projects/noir-contracts/contracts/token_contract/src/main.nr

@@ -491,18 +491,23 @@ contract Token {
    /// We need to use different randomness for the user and for the fee payer notes because if the randomness values
    /// were the same we could fingerprint the user by doing the following:
    ///      1) randomness_influence = fee_payer_point - G_npk * fee_payer_npk =


Realized that this was not updated with slots so I did it.

benesjan

LGTM

catmcgee · 2024-08-28T15:49:13Z

wdyt about the current location

@critesjosh I think this works for now. i'll create a notes dropdown under storage and put it in there with some extra info at a later point

docs/docs/aztec/concepts/storage/partial_notes.md

🤖 I have created a release *beep* *boop* --- <details><summary>aztec-package: 0.51.1</summary> ## [0.51.1](aztec-package-v0.51.0...aztec-package-v0.51.1) (2024-08-29) ### Features * Add status check to prover agent ([#8248](#8248)) ([7b3006a](7b3006a)) * Faster L1 deployment ([#8234](#8234)) ([51d6699](51d6699)) * Spartan token transfer ([#8163](#8163)) ([38f0157](38f0157)) </details> <details><summary>barretenberg.js: 0.51.1</summary> ## [0.51.1](barretenberg.js-v0.51.0...barretenberg.js-v0.51.1) (2024-08-29) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>aztec-packages: 0.51.1</summary> ## [0.51.1](aztec-packages-v0.51.0...aztec-packages-v0.51.1) (2024-08-29) ### Features * Add CLI command for gathering proving metrics ([#8221](#8221)) ([5929a42](5929a42)) * Add status check to prover agent ([#8248](#8248)) ([7b3006a](7b3006a)) * **avm:** 1-slot sload/sstore (nr, ts) ([#8264](#8264)) ([bdd9b06](bdd9b06)) * **avm:** Range check gadget ([#7967](#7967)) ([0dd954e](0dd954e)) * **docs:** Add partial notes doc ([#8192](#8192)) ([4299bbd](4299bbd)) * Faster L1 deployment ([#8234](#8234)) ([51d6699](51d6699)) * Initial validator set ([#8133](#8133)) ([6d31ad2](6d31ad2)) * L1-publisher cleanup ([#8148](#8148)) ([6ae2535](6ae2535)) * Proof surgery class ([#8236](#8236)) ([10d7edd](10d7edd)) * Request specific transactions through the p2p layer ([#8185](#8185)) ([54e1cc7](54e1cc7)) * Slot duration flexibility ([#8122](#8122)) ([708e4e5](708e4e5)) * Spartan token transfer ([#8163](#8163)) ([38f0157](38f0157)) ### Bug Fixes * Attempt to fix nightly test ([#8222](#8222)) ([477eec5](477eec5)) * **avm-simulator:** Await avm bytecode check ([#8268](#8268)) ([4410eb3](4410eb3)) * **bb-prover:** Create structure for AVM vk ([#8233](#8233)) ([55b6ba2](55b6ba2)) * **bb:** Mac build ([#8255](#8255)) ([ac54f5c](ac54f5c)) * **ci:** Spot-runner-action was not built ([#8274](#8274)) ([c1509c1](c1509c1)) * **ci:** Try fix brotli edge-case ([#8256](#8256)) ([e03ea0b](e03ea0b)) * Docker containers healthchecks ([#8228](#8228)) ([19edbbb](19edbbb)) * **docs:** Update entrypoint details on accounts page ([#8184](#8184)) ([8453ec7](8453ec7)) * Export brillig names in contract functions ([#8212](#8212)) ([4745741](4745741)) * Fixes for the nightly test run against Sepolia ([#8229](#8229)) ([cfc65c6](cfc65c6)) * Handle constant output for sha256 ([#8251](#8251)) ([0653ba5](0653ba5)) * Log public vm errors as warn in prover-agent ([#8247](#8247)) ([9f4ea9f](9f4ea9f)) * Remove devnet ARM builds for now ([#8202](#8202)) ([81ef715](81ef715)) * Remove fundFpc step from bootstrap ([#8245](#8245)) ([a742531](a742531)) * Ts codegen ([#8267](#8267)) ([cb58800](cb58800)) ### Miscellaneous * Add check to just release images to devnet-deploys ([#8242](#8242)) ([aa6791d](aa6791d)) * Add partial note support for value note ([#8141](#8141)) ([daa57cc](daa57cc)) * Always run `build-check` step in `publish-bb.yml` ([#8240](#8240)) ([5e9749f](5e9749f)) * **avm:** Replace range and cmp with gadgets ([#8164](#8164)) ([cc12558](cc12558)) * Basic network matrix ([#8257](#8257)) ([2a76b1a](2a76b1a)), closes [#8001](#8001) * **bb:** Use std::span in pippenger for scalars ([#8269](#8269)) ([2323cd5](2323cd5)) * Configure interval mining for anvil ([#8211](#8211)) ([eba57b4](eba57b4)) * Create external-ci-approved.yml ([#8235](#8235)) ([24b059b](24b059b)) * Disallow prune in devnet + add onlyOwners ([#8134](#8134)) ([c736f96](c736f96)) * Fix various warnings in noir code ([#8258](#8258)) ([1c6b478](1c6b478)) * Less noisy AVM failures in proving ([#8227](#8227)) ([03bcd62](03bcd62)) * Open an issue if publishing bb fails ([#8223](#8223)) ([2d7a775](2d7a775)) * Reinstate l1-contracts package ([#8250](#8250)) ([263a912](263a912)) * Remove unused generic parameters ([#8249](#8249)) ([00ed045](00ed045)) * Replace relative paths to noir-protocol-circuits ([1783c80](1783c80)) * Replace relative paths to noir-protocol-circuits ([ffe1f35](ffe1f35)) * Report prover metrics ([#8155](#8155)) ([dc7bcdf](dc7bcdf)), closes [#7675](#7675) * Rework balances map ([#8127](#8127)) ([1cac3dd](1cac3dd)), closes [#8104](#8104) * Run CI after merges to provernet ([#8244](#8244)) ([97e5e25](97e5e25)) ### Documentation * Minor fixes ([#8273](#8273)) ([2b8af9e](2b8af9e)) </details> <details><summary>barretenberg: 0.51.1</summary> ## [0.51.1](barretenberg-v0.51.0...barretenberg-v0.51.1) (2024-08-29) ### Features * **avm:** 1-slot sload/sstore (nr, ts) ([#8264](#8264)) ([bdd9b06](bdd9b06)) * **avm:** Range check gadget ([#7967](#7967)) ([0dd954e](0dd954e)) * Proof surgery class ([#8236](#8236)) ([10d7edd](10d7edd)) ### Bug Fixes * **bb-prover:** Create structure for AVM vk ([#8233](#8233)) ([55b6ba2](55b6ba2)) * **bb:** Mac build ([#8255](#8255)) ([ac54f5c](ac54f5c)) * Handle constant output for sha256 ([#8251](#8251)) ([0653ba5](0653ba5)) ### Miscellaneous * **avm:** Replace range and cmp with gadgets ([#8164](#8164)) ([cc12558](cc12558)) * **bb:** Use std::span in pippenger for scalars ([#8269](#8269)) ([2323cd5](2323cd5)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

add partial notes doc

3a5dd50

fix paths

fee7fa5

critesjosh requested review from catmcgee and benesjan August 27, 2024 12:56

critesjosh requested a review from rahul-kothari August 27, 2024 14:47

critesjosh marked this pull request as ready for review August 27, 2024 15:07

critesjosh and others added 2 commits August 27, 2024 11:07

Merge branch 'master' into jc/partial-notes

a876b51

WIP

1c13443

benesjan force-pushed the jc/partial-notes branch from 2cdc522 to 1c13443 Compare August 28, 2024 10:44

benesjan reviewed Aug 28, 2024

View reviewed changes

benesjan added 2 commits August 28, 2024 11:46

last touches

2340fb2

desc fix

7a7716b

benesjan reviewed Aug 28, 2024

View reviewed changes

benesjan approved these changes Aug 28, 2024

View reviewed changes

catmcgee requested changes Aug 28, 2024

View reviewed changes

cats feedback

6345070

critesjosh requested a review from catmcgee August 28, 2024 20:11

catmcgee approved these changes Aug 29, 2024

View reviewed changes

critesjosh merged commit 4299bbd into master Aug 29, 2024
97 of 98 checks passed

critesjosh deleted the jc/partial-notes branch August 29, 2024 12:54

AztecBot mentioned this pull request Aug 29, 2024

chore(master): Release 0.51.1 #8218

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): add partial notes doc #8192

feat(docs): add partial notes doc #8192

critesjosh commented Aug 26, 2024 •

edited

Loading

AztecBot commented Aug 26, 2024 •

edited

Loading

Proof generation

L2 block published to L1

L2 chain processing

Circuits stats

AVM Simulation

Public DB Access

Tree insertion stats

Miscellaneous

critesjosh commented Aug 27, 2024

AztecBot commented Aug 27, 2024 •

edited

Loading

benesjan Aug 28, 2024

benesjan Aug 28, 2024

benesjan left a comment

catmcgee commented Aug 28, 2024 •

edited

Loading

feat(docs): add partial notes doc #8192

feat(docs): add partial notes doc #8192

Conversation

critesjosh commented Aug 26, 2024 • edited Loading

AztecBot commented Aug 26, 2024 • edited Loading

Benchmark results

Proof generation

L2 block published to L1

L2 chain processing

Circuits stats

AVM Simulation

Public DB Access

Tree insertion stats

Miscellaneous

critesjosh commented Aug 27, 2024

AztecBot commented Aug 27, 2024 • edited Loading

Docs Preview

benesjan Aug 28, 2024

Choose a reason for hiding this comment

benesjan Aug 28, 2024

Choose a reason for hiding this comment

benesjan left a comment

Choose a reason for hiding this comment

catmcgee commented Aug 28, 2024 • edited Loading

critesjosh commented Aug 26, 2024 •

edited

Loading

AztecBot commented Aug 26, 2024 •

edited

Loading

AztecBot commented Aug 27, 2024 •

edited

Loading

catmcgee commented Aug 28, 2024 •

edited

Loading