chore(boxes): refactor npx to improve readability, added upgrade option and manual versioning

[signorecello]

Part of the Boxes work, this change splits the npx files into multiple different ones and:

• Adds a "skip" option if you don't want to clone any box (i.e. you just want to install or update the sandbox)
• You can now pass "latest", "master", or any semver version to a VERSION env variable when you run the script (ex. VERSION=master npx create-aztec-app). It fetch the existent boxes at that point in time for the user to choose, and clones them
• The sandbox section now checks for the docker version of the sandbox and prompts to download it if it doesn't match the required version
• Some other minor quality of life updates

[signorecello]

• chore(boxes): adding clone contract option #4980
• chore(boxes): refactor npx to improve readability, added upgrade option and manual versioning #4855 👈
• chore(boxes): adding react frontend tests #4824
• chore(boxes): adding frontend test to vanilla-js box #4770
• master

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

Join @signorecello and the rest of your teammates on Graphite

[AztecBot]

Benchmark results

Metrics with a significant change:

• note_successful_decrypting_time_in_ms (32): 662 (+24%)
• note_trial_decrypting_time_in_ms (8): 110 (+1272%)

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,072	238,964	470,012
l1_rollup_execution_gas	194,020	500,270	909,270
l2_block_processing_time_in_ms	1,193	4,478 (-1%)	8,600 (-3%)
note_successful_decrypting_time_in_ms	198 (-1%)	⚠️ 662 (+24%)	961 (-3%)
note_trial_decrypting_time_in_ms	⚠️ 110 (+1272%)	83.8 (+45%)	93.3 (-23%)
l2_block_building_time_in_ms	16,134 (-1%)	64,347	124,774 (-3%)
l2_block_rollup_simulation_time_in_ms	12,251 (-1%)	48,759 (-1%)	94,515 (-4%)
l2_block_public_tx_process_time_in_ms	3,853	15,481 (+1%)	30,137 (-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	15,005 (+5%)	28,078 (+3%)
note_history_successful_decrypting_time_in_ms	1,246 (+1%)	2,466 (+2%)
note_history_trial_decrypting_time_in_ms	92.9 (+73%)	133 (+1%)
node_database_size_in_bytes	18,817,104	35,586,128
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	245 (-3%)	44,736	28,001
private-kernel-ordering	176 (-9%)	52,625	14,627
base-rollup	1,263 (-5%)	177,932	933
root-rollup	72.5 (+4%)	4,192	825
private-kernel-inner	313 (-2%)	73,715	28,001
public-kernel-app-logic	189 (-4%)	32,254	25,379
merge-rollup	5.61 (-2%)	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.78 (-1%)	10.1 (-8%)	14.8 (+4%)	16.4 (-1%)	21.9 (-3%)	34.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	79.0	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.567 (-1%)	0.561 (-8%)	0.632 (+5%)	0.503 (-2%)	0.460 (-2%)	0.432 (-2%)	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.1 (-1%)	70.8 (-2%)	230	429 (-3%)	867	1,659 (-3%)
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.463 (-1%)	0.438 (-2%)	0.420	0.402 (-3%)	0.413	0.398 (-3%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	N/A	N/A	N/A	54.2 (+1%)	105 (-2%)	340	638 (-4%)	1,308	2,531 (-3%)
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.481	0.474 (-2%)	0.459	0.439 (-5%)	0.455	0.439 (-3%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	N/A	N/A	59.6 (-3%)	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.522 (-3%)	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,544 (-3%)	1,336 (-3%)

Metric	0 public data writes	1 public data writes
tx_sequencer_processing_time_ms	0.0323 (+15%)	462 (-4%)

[alexghr]

IIUC npx create-aztec-app combines the sandbox installer with the aztec-cli unbox command?

[signorecello]

Yep exactly!

It is meant to replace the unbox command (which no longer exists). But it's not meant to replace the installer (it actually runs it, as you've seen), more like providing a "yes/no" interface to use it, and reduce the time needed to see your app on the screen

[signorecello]

btw you should be able to run npm create aztec. But I haven't tested it yet 😊