feat(docs): Publish PDF of protocol specs + remove links to pages in item lists in protocol specs

[critesjosh]

Linking to pages that are in the category items are redundant are messing up this docs to pdf tool.

The plan is to include a command like

npx docusaurus-prince-pdf -u http://docs.aztec.network/protocol-specs/intro --dest ./docs/pdf -o protocol-specs

to the release pipeline, so once the new docs site is published, all of the pages under docs.aztec.network/protocol-specs are added to a file called protocol-specs.pdf in docs/pdf.

closes: AztecProtocol/dev-rel#260

[AztecBot]

Docs Preview

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

[AztecBot]

Benchmark results

Metrics with a significant change:

• proof_construction_time_poseidon_hash_100_ms (1): 5,734 (-18%)
• proof_construction_time_sha256_30_ms (16): 1,796 (+31%)

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_30_ms	11,386 (-7%)	3,109 (-7%)	⚠️ 1,796 (+31%)	1,435 (-3%)	1,458 (-1%)
proof_construction_time_sha256_100_ms	44,734 (-4%)	12,106 (+1%)	5,730 (+1%)	5,579 (+1%)	5,553 (-1%)
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	59.0 (+4%)	87.0
proof_construction_time_poseidon_hash_30_ms	1,515	419	202	224 (+1%)	269 (+1%)
proof_construction_time_poseidon_hash_100_ms	⚠️ 5,734 (-18%)	1,568	726 (-1%)	781 (-1%)	795 (-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	1,412	1,412	1,412
l1_rollup_calldata_gas	9,476	9,464	9,440
l1_rollup_execution_gas	610,297	610,285	610,261
l2_block_processing_time_in_ms	762 (+3%)	1,414 (+1%)	2,699 (+1%)
l2_block_building_time_in_ms	25,552 (-10%)	51,098 (-2%)	100,392 (-6%)
l2_block_rollup_simulation_time_in_ms	25,456 (-10%)	50,797 (-2%)	100,038 (-6%)
l2_block_public_tx_process_time_in_ms	21,898 (-11%)	47,026 (-1%)	96,322 (-6%)

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	7,002 (+1%)	9,883 (+2%)
node_database_size_in_bytes	12,181,584	16,109,648
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	proving_time_in_ms	input_size_in_bytes	output_size_in_bytes	proof_size_in_bytes	num_public_inputs	size_in_gates
private-kernel-init	130 (-3%)	498	12,155 (-2%)	20,634	67,190	92,352	2,819	524,288
private-kernel-inner	394 (-3%)	1,014 (-8%)	44,633 (-1%)	94,902	67,190	92,352	2,819	2,097,152
private-kernel-tail	372 (-1%)	1,875	46,272	99,121	71,733	14,912	399	2,097,152
base-parity	6.26 (-4%)	1,934 (-3%)	2,517 (-1%)	128	64.0	2,208	2.00	131,072
root-parity	50.4 (-2%)	48.2 (-2%)	33,646 (-2%)	27,100	64.0	2,720	18.0	2,097,152
base-rollup	7,908 (-2%)	4,390 (+1%)	72,131	170,330	756	3,648	47.0	4,194,304
root-rollup	112	62.9 (-6%)	19,674 (+1%)	25,309	620	3,456	41.0	1,048,576
public-kernel-setup	719	3,119	38,721 (-1%)	116,905	93,334	125,344	3,850	2,097,152
public-kernel-app-logic	616 (-2%)	4,143 (-1%)	39,964	116,905	93,334	125,344	3,850	2,097,152
public-kernel-tail	1,414 (-3%)	34,753 (+14%)	164,968 (-1%)	511,910	10,014	14,912	399	8,388,608
private-kernel-reset-small	594 (-1%)	2,120 (-1%)	41,193	123,313	67,190	92,352	2,819	2,097,152
public-kernel-teardown	623 (+1%)	4,181 (+1%)	40,646	116,905	93,334	125,344	3,850	2,097,152
merge-rollup	29.2 (-4%)	N/A	N/A	16,542	756	N/A	N/A	N/A
private-kernel-tail-to-public	N/A	7,785 (+8%)	85,056 (+1%)	N/A	N/A	125,344	3,850	4,194,304

Stats on running time collected for app circuits

Function	input_size_in_bytes	output_size_in_bytes	witness_generation_time_in_ms	proof_size_in_bytes	proving_time_in_ms	size_in_gates	num_public_inputs
ContractClassRegisterer:register	1,344	9,944	404 (-10%)	N/A	N/A	N/A	N/A
ContractInstanceDeployer:deploy	1,408	9,944	40.6 (-9%)	N/A	N/A	N/A	N/A
MultiCallEntrypoint:entrypoint	1,920	9,944	1,805 (-8%)	N/A	N/A	N/A	N/A
GasToken:deploy	1,376	9,944	983	N/A	N/A	N/A	N/A
SchnorrAccount:constructor	1,312	9,944	1,459 (-7%)	N/A	N/A	N/A	N/A
SchnorrAccount:entrypoint	2,304	9,944	2,823 (-4%)	16,768	51,060	2,097,152	457
Token:privately_mint_private_note	1,280	9,944	1,740 (-1%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_public	1,344	9,944	378 (+1%)	16,768	10,262 (-4%)	524,288	457
Token:transfer	1,312	9,944	4,533	16,768	41,549 (-1%)	2,097,152	457
AuthRegistry:set_authorized (avm)	21,043	N/A	N/A	87,200	1,627 (+1%)	N/A	N/A
FPC:prepare_fee (avm)	28,841	N/A	N/A	88,032	4,843 (-4%)	N/A	N/A
Token:transfer_public (avm)	44,971	N/A	N/A	87,865	4,135 (-1%)	N/A	N/A
AuthRegistry:consume (avm)	34,973	N/A	N/A	87,616	2,841 (-1%)	N/A	N/A
FPC:pay_refund (avm)	33,573	N/A	N/A	88,448	9,096 (-1%)	N/A	N/A
Benchmarking:create_note	1,344	9,944	1,392 (-4%)	N/A	N/A	N/A	N/A
SchnorrAccount:verify_private_authwit	1,280	9,944	78.7 (+8%)	N/A	N/A	N/A	N/A
Token:unshield	1,376	9,944	3,605	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_private	1,376	9,944	4,563	N/A	N/A	N/A	N/A

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
GasToken:_increase_public_balance	69.2 (+2%)	13,873
GasToken:set_portal	17.8 (+5%)	3,495
Token:constructor	96.2 (+2%)	24,207
FPC:constructor	62.4 (-5%)	13,893
GasToken:mint_public	53.4 (-1%)	10,241
Token:mint_public	76.4 (+6%)	19,216
Token:assert_minter_and_mint	227	13,034
AuthRegistry:set_authorized	34.0 (+4%)	7,869
FPC:prepare_fee	183 (+25%)	15,187
Token:transfer_public	32.2 (-17%)	31,425
FPC:pay_refund	115 (-23%)	20,080
Benchmarking:increment_balance	2,683 (-2%)	15,465
Token:_increase_public_balance	56.1 (-1%)	15,089
FPC:pay_refund_with_shielded_rebate	148 (-4%)	21,167

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.174 (-2%)

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	10.4	16.8 (-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.600	0.518 (-2%)	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_32_depth_ms	N/A	N/A	48.4	76.3 (+1%)	130	245	468
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.494	0.469 (+1%)	0.448	0.444	0.437
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	59.8	111 (+1%)	181 (+1%)	350	689
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.506	0.498	0.479	0.475	0.474
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	72.7	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	133	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.518	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	85,672	670,983

Transaction size based on fee payment method

| Metric | |
| - | |

[critesjosh]

Do I need to check out this repo again, since it was done above?

[critesjosh]

I believe the docs are built earlier, how can I access the build so I don't need to build them again and can just serve them? Will it work to serve them locally in Earthly, or should I try to grab the pages from the published url above?