chore(docs): update box readme, remove duplicated features, added box install to the docs

[signorecello]

TL;DR (AI generated)

Simplified the Aztec app creation process by removing sandbox-related functionality and updating documentation.

What changed?

• Removed sandbox installation, update, and run steps from the aztec-app command.
• Updated README files and documentation to reflect the removal of sandbox-related features.
• Changed the command from npx create-aztec-app to npx aztec-app throughout the project.
• Removed sandbox-related scripts and dependencies.
• Updated the onCreateCommand script in the devcontainer configuration.

How to test?

1. Run npx aztec-app and verify that it only prompts for project options without mentioning sandbox installation.
2. Check that the README files in various boxes (react, vanilla, contract-only) no longer mention sandbox installation or management.
3. Verify that the devcontainer script uses the new npx aztec-app command.

Why make this change?

This change simplifies the Aztec app creation process by focusing solely on project setup and removing the complexity of sandbox management. It allows users to handle sandbox installation and management separately, providing a more streamlined experience for creating Aztec projects.

[signorecello]

• chore(docs): update box readme, remove duplicated features, added box install to the docs #8254 👈
• 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]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• protocol_circuit_simulation_time_in_ms (private-kernel-tail-to-public): 776 (-38%)
• protocol_circuit_input_size_in_bytes (public-kernel-tail): 390,582 (-21%)
• avm_simulation_time_ms (Token:mint_public): 472 (+50%)
• avm_simulation_time_ms (Token:assert_minter_and_mint): 45.7 (-87%)
• avm_simulation_time_ms (Token:transfer_public): 18.7 (+32%)
• avm_simulation_bytecode_size_in_bytes (Token:constructor): 15,813 (+22%)
• avm_simulation_bytecode_size_in_bytes (FPC:constructor): 9,720 (+26%)
• avm_simulation_bytecode_size_in_bytes (FeeJuice:check_balance): 2,357 (+19%)
• avm_simulation_bytecode_size_in_bytes (Token:transfer_public): 10,812 (+22%)

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,757	1,568 (+1%)	716 (+3%)	765 (-1%)	775
proof_construction_time_sha256_30_ms	11,481 (-3%)	3,100 (-2%)	1,384 (-1%)	1,447 (+1%)	1,460 (-1%)
proof_construction_time_sha256_100_ms	44,215 (-3%)	11,830 (-3%)	5,467 (-10%)	5,759 (-4%)	5,740 (+4%)
proof_construction_time_poseidon_hash_ms	78.0 (-1%)	34.0	34.0	59.0 (+2%)	87.0 (-1%)
proof_construction_time_poseidon_hash_30_ms	1,528	439 (+6%)	204 (+1%)	222	267 (+1%)
proof_construction_time_poseidon_hash_100_ms	5,637	1,510 (+1%)	678 (+1%)	733 (-1%)	748 (-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,356	7,876	14,884
l1_rollup_calldata_gas	50,220	92,994	177,880
l1_rollup_execution_gas	843,061	1,576,731	3,361,673
l2_block_processing_time_in_ms	256 (+2%)	451 (+4%)	823 (+3%)
l2_block_building_time_in_ms	11,292 (-2%)	22,036 (-2%)	44,213 (-2%)
l2_block_rollup_simulation_time_in_ms	11,291 (-2%)	22,035 (-2%)	44,213 (-2%)
l2_block_public_tx_process_time_in_ms	9,642 (-3%)	20,362 (-2%)	42,512 (-2%)

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,058 (-8%)	3,893 (-7%)
node_database_size_in_bytes	12,615,760 (-11%)	16,719,952 (-8%)
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	75.0	380 (+1%)	21,390 (+1%)	44,898	N/A
private-kernel-inner	160 (+14%)	679	72,372 (+1%)	45,020	N/A
private-kernel-reset-tiny	298 (+3%)	687 (+3%)	65,095 (+1%)	44,886	N/A
private-kernel-tail	160 (+7%)	132 (+4%)	50,608	52,921 (-7%)	N/A
base-parity	5.62 (+2%)	N/A	160	96.0	N/A
root-parity	35.5 (+1%)	N/A	73,948	96.0	N/A
base-rollup	2,844 (+10%)	N/A	189,183	664	N/A
block-root-rollup	41.1 (-1%)	N/A	58,205	2,448	N/A
public-kernel-setup	80.6 (-3%)	N/A	105,085 (-8%)	71,222 (-10%)	N/A
public-kernel-app-logic	94.4 (-2%)	N/A	104,897 (-8%)	71,222 (-10%)	N/A
public-kernel-tail	846 (-1%)	N/A	⚠️ 390,582 (-21%)	16,414	N/A
private-kernel-reset-small	293 (+7%)	N/A	66,341	45,629	N/A
private-kernel-tail-to-public	⚠️ 776 (-38%)	586 (-8%)	453,751 (+1%)	1,825	N/A
public-kernel-teardown	81.2 (-1%)	N/A	105,349 (-8%)	71,222 (-10%)	N/A
merge-rollup	20.1	N/A	38,174	664	N/A
undefined	N/A	N/A	N/A	N/A	82,203 (-2%)

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	347 (+2%)
ContractInstanceDeployer:deploy	1,408	11,731	18.3 (+1%)
MultiCallEntrypoint:entrypoint	1,920	11,731	402 (-4%)
FeeJuice:deploy	1,376	11,731	388 (+1%)
SchnorrAccount:constructor	1,312	11,731	62.9 (+4%)
SchnorrAccount:entrypoint	2,336	11,731	371 (+1%)
FeeJuice:claim	1,344	11,731	35.9 (+5%)
Token:privately_mint_private_note	1,280	11,731	73.9 (+2%)
FPC:fee_entrypoint_public	1,344	11,731	24.2 (-9%)
Token:transfer	1,312	11,731	215 (+4%)
Benchmarking:create_note	1,344	11,731	76.0 (+1%)
SchnorrAccount:verify_private_authwit	1,280	11,731	26.6 (+1%)
Token:unshield	1,376	11,731	503 (+4%)
FPC:fee_entrypoint_private	1,376	11,731	672 (+5%)

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
FeeJuice:_increase_public_balance	47.8 (-8%)	2,431 (+8%)
FeeJuice:set_portal	13.4 (+23%)	2,930 (+13%)
Token:constructor	78.9 (-1%)	⚠️ 15,813 (+22%)
FPC:constructor	47.5	⚠️ 9,720 (+26%)
FeeJuice:check_balance	37.7 (+2%)	⚠️ 2,357 (+19%)
Token:mint_public	⚠️ 472 (+50%)	5,011 (+13%)
Token:assert_minter_and_mint	⚠️ 45.7 (-87%)	3,155 (+9%)
AuthRegistry:set_authorized	36.1 (-21%)	924
FPC:prepare_fee	72.2 (+4%)	4,245 (+8%)
Token:transfer_public	⚠️ 18.7 (+32%)	⚠️ 10,812 (+22%)
FPC:pay_refund	43.6 (+4%)	5,195 (+7%)
Benchmarking:increment_balance	1,205 (-2%)	3,496 (+12%)
Token:_increase_public_balance	47.6 (+25%)	2,408 (+8%)
FPC:pay_refund_with_shielded_rebate	56.5 (+9%)	5,195 (+7%)

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.154 (-9%)

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.18 (+2%)	3.88 (+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.113 (+2%)	0.109 (+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.2 (+1%)	18.0 (+3%)	31.0 (+2%)	59.5	113 (+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.107	0.105 (+4%)	0.101 (+2%)	0.103	0.101 (+1%)
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	14.4 (+1%)	25.8	43.3 (-1%)	82.7	162 (+1%)
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	108 (-1%)	207	355 (-1%)	691	1,363
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.111 (+2%)	0.103 (-1%)	0.104 (-1%)	0.103 (+1%)	0.103 (+1%)
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	16.6 (+4%)	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	132 (+2%)	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.107 (+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,838 (-10%)	668,997

Transaction size based on fee payment method

| Metric | |
| - | |

[catmcgee]

should this work? getting zlib: unexpected end of file on all options

○ → npx aztec-app
? Please choose your type of project: Boilerplate project with frontend
? Please choose your Aztec boilerplate: React App
? Your box name: my-aztec-box
✖ Cloning the box code...
zlib: unexpected end of file

[signorecello]

should this work? getting zlib: unexpected end of file on all options

○ → npx aztec-app
? Please choose your type of project: Boilerplate project with frontend
? Please choose your Aztec boilerplate: React App
? Your box name: my-aztec-box
✖ Cloning the box code...
zlib: unexpected end of file

Sorry I should've put the repro steps in the description:

• Check out the branch
• Head to boxes
• Run npx . and the rest of the command

In any case aztec-app shouldn't break like it did for you :D So I'll investigate

edit: it works on my machine hahah I'll reach out to you offline

[critesjosh]

What is the --github_token option for?

[critesjosh]

When testing the React box (UPDATE: got the same error with vanilla UI), I got an error:

yarn add assert and adding the fallback

      assert: require.resolve('assert/'),

to webpack.config.js here resolved it. Try it out on your side and see if it fixes it

[critesjosh]

When I install the contract example, I still get a package.json and a tsconfig.json that are irrelevant for a simple contract example. Can you update so that unnecessary files are not installed?

[signorecello]

What is the --github_token option for?

It's optional, you can pass it to avoid rate limiting (i.e. for testing)

[signorecello]

When testing the React box (UPDATE: got the same error with vanilla UI), I got an error:

yarn add assert and adding the fallback

      assert: require.resolve('assert/'),

to webpack.config.js here resolved it. Try it out on your side and see if it fixes it

Need to check why wasn't this caught in the CI testing...

[critesjosh]

I am still getting a package.json and .yarnrc.yml file in project when running npx init. Is this intentional?

Also I am still seeing the following error. I am on your branch, running npx . new and moving into the created directory. Is there something else that needs updating?

[signorecello]

I am still getting a package.json and .yarnrc.yml file in project when running npx init. Is this intentional?

I'm an idiot and removed those files from contract_only boxes instead of the init... ** breathes deeply **

Also I am still seeing the following error. I am on your branch, running npx . new and moving into the created directory. Is there something else that needs updating?

So this is confusing, but actually makes sense. Bear with me:

• npx . new will run the bin.js file (which is tested by bin.test.js).
• This file runs the CLI tool and assumes you want to clone the latest version. You can change that by passing the -v flag, for example -v master
• In this case, running npx . will run the bin file as per the current branch, but it will still try to clone the box as it was on the latest release. If you've changed anything in the box (ex. added a new dependency), it won't know, it will always clone the box as per the latest release.
• In this case in order to test, you want it to clone the box as per this branch. Once it's merged and gets into a new release, that will be the version the user will get when he runs npx aztec-app

So to answer your question, you need to pass this branch in order to get the box exactly as it will look like once merged. Even though the -v flag is meant to be used with versions or master, you can actually pass a branch like this npx . new -v zpedro/boxes_readme. You may need to adjust the @aztec dependencies to latest, though, but it will work :)

[github-actions]

Changes to circuit sizes

Generated at commit: 2ffd178c7eafe3539704ee995989cdffc04f8fee, compared to commit: f7e4bfb0fc8070b7b79366241f3d37357dfaee27

🧾 Summary (100% most significant diffs)

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
private_kernel_inner	0 ➖	0.00%	+1,330 ❌	+2.04%
private_kernel_init	0 ➖	0.00%	+672 ❌	+1.78%
private_kernel_reset_tiny	0 ➖	0.00%	+455 ❌	+0.59%
private_kernel_reset_small	0 ➖	0.00%	+455 ❌	+0.44%
private_kernel_reset_medium	0 ➖	0.00%	+455 ❌	+0.29%
private_kernel_reset_big	0 ➖	0.00%	+455 ❌	+0.17%
private_kernel_tail	0 ➖	0.00%	+17 ❌	+0.14%
private_kernel_reset_full_inner	0 ➖	0.00%	+455 ❌	+0.10%
private_kernel_reset	0 ➖	0.00%	+455 ❌	+0.10%
rollup_base	0 ➖	0.00%	+3 ❌	+0.00%
private_kernel_tail_to_public	-256 ✅	-0.68%	-264 ✅	-0.46%
public_kernel_setup	-19,784 ✅	-8.53%	-51,851 ✅	-2.68%
public_kernel_teardown	-19,796 ✅	-8.53%	-51,866 ✅	-2.69%
public_kernel_app_logic	-19,796 ✅	-8.56%	-51,866 ✅	-2.69%
private_kernel_tail_to_public_simulated	0 ➖	0.00%	-256 ✅	-6.58%
public_kernel_app_logic_simulated	0 ➖	0.00%	-256 ✅	-6.58%
public_kernel_setup_simulated	0 ➖	0.00%	-256 ✅	-6.58%
public_kernel_teardown_simulated	0 ➖	0.00%	-256 ✅	-6.58%
public_kernel_tail	-33,792 ✅	-6.75%	-274,597 ✅	-8.43%

---

Full diff report 👇

Program	ACIR opcodes (+/-)	%	Circuit size (+/-)	%
private_kernel_inner	48,931 (0)	0.00%	66,676 (+1,330)	+2.04%
private_kernel_init	27,819 (0)	0.00%	38,460 (+672)	+1.78%
private_kernel_reset_tiny	35,560 (0)	0.00%	77,790 (+455)	+0.59%
private_kernel_reset_small	39,387 (0)	0.00%	104,196 (+455)	+0.44%
private_kernel_reset_medium	47,044 (0)	0.00%	157,187 (+455)	+0.29%
private_kernel_reset_big	62,353 (0)	0.00%	263,372 (+455)	+0.17%
private_kernel_tail	4,910 (0)	0.00%	12,253 (+17)	+0.14%
private_kernel_reset_full_inner	85,690 (0)	0.00%	445,025 (+455)	+0.10%
private_kernel_reset	92,596 (0)	0.00%	474,705 (+455)	+0.10%
rollup_base	347,688 (0)	0.00%	3,607,503 (+3)	+0.00%
private_kernel_tail_to_public	37,122 (-256)	-0.68%	57,044 (-264)	-0.46%
public_kernel_setup	212,017 (-19,784)	-8.53%	1,879,749 (-51,851)	-2.68%
public_kernel_teardown	212,176 (-19,796)	-8.53%	1,877,315 (-51,866)	-2.69%
public_kernel_app_logic	211,545 (-19,796)	-8.56%	1,876,531 (-51,866)	-2.69%
private_kernel_tail_to_public_simulated	1 (0)	0.00%	3,637 (-256)	-6.58%
public_kernel_app_logic_simulated	1 (0)	0.00%	3,634 (-256)	-6.58%
public_kernel_setup_simulated	1 (0)	0.00%	3,634 (-256)	-6.58%
public_kernel_teardown_simulated	1 (0)	0.00%	3,634 (-256)	-6.58%
public_kernel_tail	467,011 (-33,792)	-6.75%	2,982,927 (-274,597)	-8.43%

[signorecello]

Just pushed the change to make sure the init command now won't add useless package.json:

[signorecello]

Merge activity

• Sep 9, 10:42 AM EDT: @signorecello started a stack merge that includes this pull request via Graphite.
• Sep 9, 10:45 AM EDT: @signorecello merged this pull request with Graphite.