Skip to content

chore(docs): remove npm refs#3668

Closed
critesjosh wants to merge 13 commits into
masterfrom
docs/jc/remove-npm-refs
Closed

chore(docs): remove npm refs#3668
critesjosh wants to merge 13 commits into
masterfrom
docs/jc/remove-npm-refs

Conversation

@critesjosh

Copy link
Copy Markdown
Contributor

This PR removes references to installing @aztec/aztec-sandbox and @aztec/cli via NPM in favor of installing via Docker. It also updates notes about types imports for the token contract contract tutorial and the token reference in the "writing a dapp" tutorial.

Note: recent additions broke the Quickstart guide. The docs got out of sync with the latest version because docs are always tested against master. This should be fixed with the new release going out tomorrow morning, so I'm not bothering to change it now, but we should test the Quickstart page again once the new release goes out. @catmcgee do you think we should implement docs versioning to help prevent this from happening? It will increase the maintenance overhead of the docs.

closes #3540 #3541

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

@AztecBot

AztecBot commented Dec 12, 2023

Copy link
Copy Markdown
Collaborator

Benchmark results

Metrics with a significant change:

  • note_history_trial_decrypting_time_in_ms (10): 228 (-50%)
  • note_trial_decrypting_time_in_ms (32): 69.0 (+47%)
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 53eb54fb 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 128 txs
l1_rollup_calldata_size_in_bytes 45,444 179,588 716,132
l1_rollup_calldata_gas 222,924 868,136 3,449,648
l1_rollup_execution_gas 842,011 3,595,244 22,205,017
l2_block_processing_time_in_ms 2,212 8,517 35,099
note_successful_decrypting_time_in_ms 317 (+1%) 942 (+3%) 3,351 (+1%)
note_trial_decrypting_time_in_ms 25.6 (+25%) ⚠️ 69.0 (+47%) 198 (-1%)
l2_block_building_time_in_ms 20,139 80,313 322,490
l2_block_rollup_simulation_time_in_ms 16,615 66,389 266,575
l2_block_public_tx_process_time_in_ms 3,492 13,842 55,670

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 24,583 (-2%) 46,666 (-2%)
note_history_successful_decrypting_time_in_ms 2,143 (-3%) 4,296 (-1%)
note_history_trial_decrypting_time_in_ms 162 (-1%) ⚠️ 228 (-50%)
node_database_size_in_bytes 3,630,803 3,913,240
pxe_database_size_in_bytes 29,748 59,307

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 199 43,109 20,441
private-kernel-ordering 114 (-1%) 25,833 9,689
base-rollup 2,955 667,692 873
root-rollup 86.3 4,072 881
private-kernel-inner 260 64,516 20,441
public-kernel-private-input 171 25,203 20,441
public-kernel-non-first-iteration 168 25,245 20,441
merge-rollup 10.8 2,592 873

Miscellaneous

Transaction sizes based on how many contracts are deployed in the tx.

Metric 0 deployed contracts 1 deployed contracts
tx_size_in_bytes 10,323 25,938

@critesjosh

Copy link
Copy Markdown
Contributor Author

closing in favor of #3676

@critesjosh critesjosh closed this Dec 13, 2023
@ludamad ludamad deleted the docs/jc/remove-npm-refs branch August 22, 2024 15:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

No open projects
Archived in project

Development

Successfully merging this pull request may close these issues.

Docs: remove references to NPM install flow

4 participants