feat!: introduce WithHash<T> + use it in PublicImmutable

[benesjan]

Fixes #8399

Introducing WithHash<T> which Nico originally implemented in #11684 and using that in PublicImmutable.

+ Fixes a bug with generating TS artifacts of contracts containing storage slots larger than 9 (see comments below for explanation).

Optimizes PublicImmutable by storing packed values along with their hash in storage, then fetching the packed values in unconstrained, fetching hash in constrained and checking the hash.

Note: It's not worthwhile to optimize the case where we store only 1 field in storage by not going with the loading-in-unconstrained flow because hashing 2 fields costs 80 gates and here we would hash just 1 extra field (to get the value hash). The gain is not worth the complexity here.

1 field gate diff:

TokenBridge::get_portal_address
Before: 9787
After: 9869

diff: +82 gates

As expected for 1 field we get a gate count rise as we do 1 more pedersen hash.

2 fields gate diff:

FPC::fee_entrypoint_private(...) gates
Before: 14219
After: 10464

diff: -3755 gates

3 fields gate diff:

AMM:add_liquidity
Before: 19113
After: 12039

diff: -7074 gates

[benesjan]

• feat!: using WithHash<T> in SharedMutable + fixing slot allocation #11716
• feat!: introduce WithHash<T> + use it in PublicImmutable #8022 👈 (View in Graphite)
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

[AztecBot]

Benchmark results

Metrics with a significant change:

• proof_construction_time_sha256_100_ms (16): 5,545 (-17%)
• protocol_circuit_simulation_time_in_ms (private-kernel-tail-to-public): 825 (-19%)

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,843 (+1%)	1,594 (+2%)	736 (+4%)	782 (+3%)	801 (+5%)
proof_construction_time_sha256_30_ms	11,877	3,193	1,428 (+1%)	1,459 (+1%)	1,479
proof_construction_time_sha256_100_ms	47,854 (+5%)	12,069 (+1%)	⚠️ 5,545 (-17%)	5,423	5,382
proof_construction_time_poseidon_hash_ms	79.0	35.0 (+3%)	34.0	59.0	88.0 (+1%)
proof_construction_time_poseidon_hash_30_ms	1,538	423	202	226	274 (-1%)
proof_construction_time_poseidon_hash_100_ms	5,697 (+1%)	1,535 (+1%)	696 (+3%)	746 (+1%)	756 (+1%)

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,324	7,844	14,852
l1_rollup_calldata_gas	49,708	92,414	177,764
l1_rollup_execution_gas	1,383,157	2,130,831	3,958,220
l2_block_processing_time_in_ms	240 (-5%)	446 (+1%)	803 (-1%)
l2_block_building_time_in_ms	9,247	18,049	35,990
l2_block_rollup_simulation_time_in_ms	9,247	18,049	35,990
l2_block_public_tx_process_time_in_ms	7,798	16,502	34,421

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	2,915 (+1%)	3,861 (-1%)
node_database_size_in_bytes	12,619,856	16,703,568
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	98.1 (+7%)	384 (-4%)	21,673	44,858	N/A
private-kernel-inner	164	687 (-4%)	72,309	45,005	N/A
private-kernel-reset-tiny	505 (+1%)	884 (-7%)	65,974	44,844	N/A
private-kernel-tail	208 (+1%)	163 (-2%)	50,728	52,256	N/A
base-parity	5.62 (+1%)	N/A	160	96.0	N/A
root-parity	33.3	N/A	69,084	96.0	N/A
base-rollup	2,855 (+1%)	N/A	187,817	664	N/A
root-rollup	38.6 (-1%)	N/A	54,525	716	N/A
public-kernel-setup	101 (+3%)	N/A	103,760	71,222	N/A
public-kernel-app-logic	104 (+1%)	N/A	103,599	71,222	N/A
public-kernel-tail	583 (+1%)	N/A	409,190	16,414	N/A
private-kernel-reset-small	491	N/A	66,085	45,629	N/A
private-kernel-tail-to-public	⚠️ 825 (-19%)	660	492,960	1,697	N/A
public-kernel-teardown	95.0 (+2%)	N/A	104,005	71,222	N/A
merge-rollup	19.1	N/A	35,742	664	N/A
undefined	N/A	N/A	N/A	N/A	69,409 (+7%)

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	343
ContractInstanceDeployer:deploy	1,408	11,731	18.1 (-2%)
MultiCallEntrypoint:entrypoint	1,920	11,731	424
FeeJuice:deploy	1,376	11,731	386 (-1%)
SchnorrAccount:constructor	1,312	11,731	106 (+2%)
SchnorrAccount:entrypoint	2,304	11,731	434
Token:privately_mint_private_note	1,280	11,731	140 (-1%)
FPC:fee_entrypoint_public	1,344	11,731	28.6 (-2%)
Token:transfer	1,312	11,731	281 (-2%)
Benchmarking:create_note	1,344	11,731	105 (+1%)
SchnorrAccount:verify_private_authwit	1,280	11,731	27.8
Token:unshield	1,376	11,731	570 (+2%)
FPC:fee_entrypoint_private	1,376	11,731	760 (+1%)

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
FeeJuice:_increase_public_balance	53.9 (-1%)	8,139
FeeJuice:set_portal	12.8 (+9%)	2,362
Token:constructor	87.8 (+9%)	31,107
FPC:constructor	55.6 (+4%)	22,380
FeeJuice:mint_public	43.5 (+13%)	6,150
Token:mint_public	77.9 (-6%)	11,720
Token:assert_minter_and_mint	40.1 (+3%)	8,028
AuthRegistry:set_authorized	48.3 (+6%)	4,537
FPC:prepare_fee	245 (+2%)	8,812
Token:transfer_public	20.2 (-1%)	47,374
FPC:pay_refund	66.9 (+16%)	12,114
Benchmarking:increment_balance	966	7,450
Token:_increase_public_balance	39.6 (-2%)	8,960
FPC:pay_refund_with_shielded_rebate	67.5 (+2%)	12,663

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.165 (+4%)

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.17	3.91 (+2%)	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.112 (-1%)	0.111 (+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.5	17.8 (+1%)	30.9 (-3%)	60.6 (+3%)	112 (+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.110	0.103 (+1%)	0.101 (-2%)	0.104 (+3%)	0.100 (+1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	14.4	26.2 (+3%)	43.4	84.7 (+3%)	159 (-2%)
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	0.106 (+3%)	0.105 (+1%)	0.105 (+4%)	0.100 (-2%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	16.5 (+1%)	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.105 (+1%)	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 | |
| - | |

[github-actions]

Changes to public function bytecode sizes

Generated at commit: ba9b793d6829a4714b1168ebb57e3fdc0d1a7c9d, compared to commit: 2fd08babea610f97d63adcea5630cfd3065fd3a8

🧾 Summary (100% most significant diffs)

Program	Bytecode size in bytes (+/-)	%
DocsExample::initialize_public_immutable	+1,431 ❌	+619.48%
FeeJuice::set_portal	+1,146 ❌	+370.87%
DocsExample::public_dispatch	+1,289 ❌	+35.45%
AvmInitializerTest::constructor	+459 ❌	+24.34%
AppSubscription::constructor	+670 ❌	+21.85%
Crowdfunding::init	+488 ❌	+17.62%
AvmInitializerTest::public_dispatch	+464 ❌	+17.55%
AppSubscription::public_dispatch	+670 ❌	+15.91%
AMM::constructor	+419 ❌	+15.56%
FPC::constructor	+343 ❌	+12.95%
Crowdfunding::public_dispatch	+483 ❌	+11.84%
TokenBridge::constructor	+305 ❌	+11.35%
Token::constructor	+483 ❌	+11.07%
FeeJuice::public_dispatch	+440 ❌	+9.64%
EasyPrivateVoting::constructor	+239 ❌	+9.40%
Uniswap::constructor	+234 ❌	+9.34%
Auth::constructor	+234 ❌	+9.19%
NFT::constructor	+249 ❌	+5.81%
EasyPrivateVoting::public_dispatch	+239 ❌	+5.20%
FPC::public_dispatch	+361 ❌	+3.59%
Claim::constructor	+97 ❌	+3.48%
Claim::public_dispatch	+92 ❌	+2.59%
Auth::public_dispatch	+220 ❌	+2.38%
TokenBridge::public_dispatch	+440 ❌	+2.09%
AMM::public_dispatch	+421 ❌	+1.62%
Token::public_dispatch	+443 ❌	+1.39%
NFT::public_dispatch	+228 ❌	+0.90%
Uniswap::public_dispatch	+220 ❌	+0.84%
Auth::set_authorized	+5 ❌	+0.10%
Auth::set_authorized_delay	+5 ❌	+0.10%
TokenBridge::exit_to_l1_public	+5 ❌	+0.06%
TokenBridge::claim_public	+5 ❌	+0.04%

---

Full diff report 👇

Program	Bytecode size in bytes (+/-)	%
DocsExample::initialize_public_immutable	1,662 (+1,431)	+619.48%
FeeJuice::set_portal	1,455 (+1,146)	+370.87%
DocsExample::public_dispatch	4,925 (+1,289)	+35.45%
AvmInitializerTest::constructor	2,345 (+459)	+24.34%
AppSubscription::constructor	3,736 (+670)	+21.85%
Crowdfunding::init	3,257 (+488)	+17.62%
AvmInitializerTest::public_dispatch	3,108 (+464)	+17.55%
AppSubscription::public_dispatch	4,880 (+670)	+15.91%
AMM::constructor	3,111 (+419)	+15.56%
FPC::constructor	2,992 (+343)	+12.95%
Crowdfunding::public_dispatch	4,564 (+483)	+11.84%
TokenBridge::constructor	2,993 (+305)	+11.35%
Token::constructor	4,847 (+483)	+11.07%
FeeJuice::public_dispatch	5,002 (+440)	+9.64%
EasyPrivateVoting::constructor	2,782 (+239)	+9.40%
Uniswap::constructor	2,740 (+234)	+9.34%
Auth::constructor	2,781 (+234)	+9.19%
NFT::constructor	4,538 (+249)	+5.81%
EasyPrivateVoting::public_dispatch	4,831 (+239)	+5.20%
FPC::public_dispatch	10,409 (+361)	+3.59%
Claim::constructor	2,884 (+97)	+3.48%
Claim::public_dispatch	3,644 (+92)	+2.59%
Auth::public_dispatch	9,480 (+220)	+2.38%
TokenBridge::public_dispatch	21,534 (+440)	+2.09%
AMM::public_dispatch	26,466 (+421)	+1.62%
Token::public_dispatch	32,282 (+443)	+1.39%
NFT::public_dispatch	25,467 (+228)	+0.90%
Uniswap::public_dispatch	26,288 (+220)	+0.84%
Auth::set_authorized	4,860 (+5)	+0.10%
Auth::set_authorized_delay	4,958 (+5)	+0.10%
TokenBridge::exit_to_l1_public	7,991 (+5)	+0.06%
TokenBridge::claim_public	12,716 (+5)	+0.04%

[nventuro]

Very lovely, thanks for linking to the commits in each message in the review!