Skip to content

chore: housekeeping — env docs, ownership metadata, dead config - #15

Merged
IlyasRidhuan merged 1 commit into
stack/sub-readme-accuracyfrom
stack/housekeeping
Aug 12, 2026
Merged

chore: housekeeping — env docs, ownership metadata, dead config#15
IlyasRidhuan merged 1 commit into
stack/sub-readme-accuracyfrom
stack/housekeeping

Conversation

@alejoamiras

@alejoamiras alejoamiras commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

What

Repo housekeeping:

  • .env.example: previously documented VERSION and BASE_PXE_URL, which nothing reads. Now documents the vars the code actually uses: NODE_URL (tests/benchmarks), AZTEC_NODE_URL and SIGNING_KEY_SECRET (deploy script).
  • LICENSE: appends Copyright (c) 2026 Aztec Foundation (Wonderland's line retained per MIT practice); package.json author updated to match the @aztec-foundation npm scope.
  • build-package.sh: stops deleting a .jest key that doesn't exist (repo uses vitest).
  • deploy-config.ts: replaces // TODO: add mainnet-alpha with an explicit statement that deployments are dev-network-only by design.

Note: the deploy tooling and deployments.json intentionally stay — the published npm package ships deployments.json and external projects consume those testnet addresses.

Validation

bash -n on the script; no behavior changes.

🤖 Generated with Claude Code

@github-actions

This comment has been minimized.

- .env.example: document the env vars the code actually reads
  (NODE_URL, AZTEC_NODE_URL, SIGNING_KEY_SECRET); the previous VERSION
  and BASE_PXE_URL were referenced nowhere
- LICENSE: append Aztec Foundation copyright line (Wonderland's line
  retained, as MIT requires); package.json author updated to match the
  @aztec-foundation npm scope
- build-package.sh: stop deleting a .jest key that does not exist (the
  repo uses vitest)
- deploy-config.ts: replace the 'add mainnet-alpha' TODO with an
  explicit statement that deployments are dev-network-only by design

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@IlyasRidhuan
IlyasRidhuan merged commit 99495c8 into main Aug 12, 2026
9 of 13 checks passed
@alejoamiras
alejoamiras deleted the stack/housekeeping branch August 12, 2026 17:00
@github-actions

Copy link
Copy Markdown

Benchmark Comparison

CPU Cores RAM Arch
AMD EPYC 9V74 80-Core Processor 4 16 GiB x64

Contract: escrow

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
(partial) withdraw 486,936 486,936 3,744 3,744 587,800 587,800 13,692 15,058 +1,366 (+10.0%)
withdraw 331,210 331,210 832 832 499,700 499,700 10,895 12,215 +1,320 (+12.1%)
withdraw_nft 378,517 378,517 1,440 1,440 527,400 527,400 11,637 13,358 +1,721 (+14.8%)

Contract: logic

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
get_escrow 390,359 390,359 192 192 456,000 456,000 12,064 13,539 +1,475 (+12.2%)
secret_key_to_public_keys 387,718 387,718 192 192 456,000 456,000 12,136 13,436 +1,300 (+10.7%)
share_escrow 303,989 303,989 1,952 1,952 520,700 520,700 10,714 11,925 +1,211 (+11.3%)

Contract: multitoken

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
burn_private 260,810 260,810 832 832 499,700 499,700 10,055 10,932 +877 (+8.7%)
burn_public 223,823 223,823 416 416 638,292 638,292 9,673 10,542 +869 (+9.0%)
initialize_transfer_commitment 225,077 225,077 768 768 474,500 474,500 9,621 10,487 +866 (+9.0%)
mint_to_private 297,577 297,577 1,408 1,408 511,400 511,400 10,979 11,812 +833 (+7.6%)
mint_to_public 223,823 223,823 416 416 637,800 637,800 9,751 10,573 +822 (+8.4%)
transfer_private_to_commitment 264,328 264,328 1,024 1,024 511,400 511,400 10,156 10,979 +823 (+8.1%)
transfer_private_to_private 337,261 337,261 2,048 2,048 555,100 555,100 11,319 12,351 +1,032 (+9.1%)
transfer_private_to_public 307,363 307,363 1,056 1,056 714,677 714,677 11,000 11,833 +833 (+7.6%)
transfer_public_to_commitment 223,823 223,823 640 640 663,516 663,516 9,692 10,510 +818 (+8.4%)
transfer_public_to_private 298,128 298,128 1,024 1,024 683,958 683,958 10,786 11,706 +920 (+8.5%)
transfer_public_to_public 223,823 223,823 480 480 673,505 673,505 9,678 10,554 +876 (+9.1%)

Contract: nft

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
burn_private 275,257 275,257 416 416 661,052 661,052 10,649 11,390 +741 (+7.0%)
burn_public 223,823 223,823 448 448 670,034 670,034 9,658 10,519 +861 (+8.9%)
mint_to_private 341,050 341,050 1,600 1,600 735,342 735,342 11,479 12,522 +1,043 (+9.1%)
mint_to_public 223,823 223,823 448 448 670,718 670,718 9,713 10,470 +757 (+7.8%)
transfer_private_to_private 249,719 249,719 832 832 499,700 499,700 9,917 10,759 +842 (+8.5%)
transfer_private_to_public 275,286 275,286 416 416 659,258 659,258 10,625 11,415 +790 (+7.4%)
transfer_public_to_private 292,460 292,460 992 992 683,268 683,268 10,718 11,651 +933 (+8.7%)
transfer_public_to_public 223,823 223,823 384 384 633,285 633,285 9,811 10,498 +687 (+7.0%)

Contract: token

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
burn_private 303,652 303,652 1,024 1,024 713,843 713,843 10,840 11,819 +979 (+9.0%)
burn_public 223,823 223,823 448 448 672,518 672,518 9,697 10,579 +882 (+9.1%)
initialize_transfer_commitment 225,077 225,077 768 768 474,500 474,500 9,613 10,473 +860 (+8.9%)
mint_to_private 355,289 355,289 2,144 2,144 737,956 737,956 11,665 12,717 +1,052 (+9.0%)
mint_to_public 223,823 223,823 448 448 672,113 672,113 9,682 10,493 +811 (+8.4%)
transfer_private_to_commitment 260,673 260,673 992 992 511,400 511,400 10,057 10,969 +912 (+9.1%)
transfer_private_to_private 344,855 344,855 2,592 2,592 557,600 557,600 11,569 12,525 +956 (+8.3%)
transfer_private_to_public 303,708 303,708 1,024 1,024 713,990 713,990 10,990 11,870 +880 (+8.0%)
transfer_private_to_public_with_commitment 308,509 308,509 1,600 1,600 747,290 747,290 10,921 11,895 +974 (+8.9%)
transfer_public_to_commitment 223,823 223,823 576 576 662,496 662,496 9,854 10,552 +698 (+7.1%)
transfer_public_to_private 296,092 296,092 992 992 683,271 683,271 10,804 11,743 +939 (+8.7%)
transfer_public_to_public 223,823 223,823 448 448 672,515 672,515 9,645 10,576 +931 (+9.7%)

Contract: vault

🚦 Function Gates DA Gas L2 Gas Proving Time (ms)
Base PR Diff Base PR Diff Base PR Diff Base PR Diff
deposit_private_to_private 508,340 508,340 1,312 1,312 878,035 878,035 13,948 15,293 +1,345 (+9.6%)
deposit_private_to_private_exact 612,065 612,065 1,888 1,888 915,103 915,103 15,883 17,528 +1,645 (+10.4%)
deposit_private_to_public 436,085 436,085 768 768 862,060 862,060 13,005 14,187 +1,182 (+9.1%)
deposit_public_to_private 424,713 424,713 1,984 1,984 964,832 964,832 12,846 14,060 +1,214 (+9.5%)
deposit_public_to_private_exact 424,724 424,724 1,952 1,952 949,256 949,256 12,805 14,034 +1,229 (+9.6%)
deposit_public_to_public 223,823 223,823 832 832 897,350 897,350 9,590 10,473 +883 (+9.2%)
issue_private_to_private_exact 612,065 612,065 1,888 1,888 915,763 915,763 15,922 17,391 +1,469 (+9.2%)
issue_private_to_public_exact 484,820 484,820 1,344 1,344 899,785 899,785 13,759 15,051 +1,292 (+9.4%)
issue_public_to_private 346,165 346,165 1,376 1,376 921,448 921,448 11,383 12,538 +1,155 (+10.1%)
issue_public_to_public 223,823 223,823 832 832 898,040 898,040 9,509 10,536 +1,027 (+10.8%)
redeem_private_to_private_exact 614,859 614,859 1,888 1,888 915,610 915,610 16,014 17,387 +1,373 (+8.6%)
redeem_private_to_public 436,028 436,028 768 768 862,504 862,504 12,842 14,165 +1,323 (+10.3%)
redeem_public_to_private_exact 427,575 427,575 1,952 1,952 949,577 949,577 12,895 14,107 +1,212 (+9.4%)
redeem_public_to_public 223,823 223,823 832 832 897,872 897,872 9,559 10,469 +910 (+9.5%)
withdraw_private_to_private 511,134 511,134 1,312 1,312 878,245 878,245 14,095 15,351 +1,256 (+8.9%)
withdraw_private_to_private_exact 614,859 614,859 1,888 1,888 915,556 915,556 15,953 17,401 +1,448 (+9.1%)
withdraw_private_to_public_exact 484,763 484,763 1,344 1,344 900,019 900,019 13,743 14,987 +1,244 (+9.1%)
withdraw_public_to_private 440,832 440,832 2,528 2,528 967,143 967,143 13,140 14,271 +1,131 (+8.6%)
withdraw_public_to_public 223,823 223,823 832 832 898,175 898,175 9,641 10,525 +884 (+9.2%)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants