Skip to content

ci: typecheck src and the benchmarks - #48

Merged
alejoamiras merged 1 commit into
stack/closeout-vault-overflowfrom
worktree-ci-typecheck
Oct 13, 2026
Merged

alejoamiras merged 1 commit into
stack/closeout-vault-overflowfrom
worktree-ci-typecheck

Conversation

@alejoamiras

Copy link
Copy Markdown
Collaborator

Vitest and tsx (which runs the benchmarks) only strip types, so a type error in either never failed CI. This adds yarn typecheck (tsc --noEmit) and runs it in the js-tests job of pr-checks.yml and main-tests.yml, right after setup (compile + codegen) and before the JS tests.

Locally after yarn ccc: yarn typecheck is clean (~4s), and an injected type error in a benchmark fails it.

🤖 Generated with Claude Code

Vitest and tsx (which runs the benchmarks) only strip types, so a type error
in either never failed CI. Add `yarn typecheck` (`tsc --noEmit`) and run it in
both js-tests jobs, after the setup step's compile + codegen write src/artifacts.

tsconfig changes so the project type-checks clean:
- `target/**/*` matched no JSON: an include glob only picks up .json files
  when the pattern itself ends in `.json`. Every generated src/artifacts/*.ts
  imports its `target/*.json`, which `composite` then rejects with TS6307.
  Now `target/**/*.json`.
- include `benchmarks`, which nothing type-checked before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Benchmark Comparison

CPU Cores RAM Arch
AMD EPYC 7763 64-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 354,645 354,645 3,744 3,744 587,800 587,800 9,114 8,553 -561 (-6.2%)
⚪ withdraw 270,326 270,326 832 832 499,700 499,700 7,624 7,142 -482 (-6.3%)
⚪ withdraw_nft 266,680 266,680 1,440 1,440 527,400 527,400 7,879 7,413 -466 (-5.9%)

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 298,866 298,866 192 192 456,000 456,000 8,362 7,854 -508 (-6.1%)
⚪ secret_key_to_public_keys 296,331 296,331 192 192 456,000 456,000 8,336 7,827 -509 (-6.1%)
⚪ share_escrow 245,424 245,424 1,952 1,952 520,700 520,700 7,384 6,898 -486 (-6.6%)

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 222,468 222,468 832 832 499,700 499,700 6,943 6,396 -547 (-7.9%)
⚪ burn_public 185,539 185,539 416 416 638,286 638,286 6,459 6,053 -406 (-6.3%)
⚪ initialize_transfer_commitment 188,484 188,484 768 768 474,500 474,500 6,468 6,035 -433 (-6.7%)
⚪ mint_to_private 239,217 239,217 1,408 1,408 511,400 511,400 7,281 6,815 -466 (-6.4%)
⚪ mint_to_public 185,539 185,539 416 416 637,794 637,794 6,452 6,089 -363 (-5.6%)
⚪ transfer_private_to_commitment 225,577 225,577 1,024 1,024 511,400 511,400 6,956 6,465 -491 (-7.1%)
⚪ transfer_private_to_private 278,917 278,917 2,048 2,048 555,100 555,100 7,723 7,231 -492 (-6.4%)
⚪ transfer_private_to_public 254,364 254,364 1,056 1,056 714,671 714,671 7,492 6,990 -502 (-6.7%)
⚪ transfer_public_to_commitment 185,539 185,539 640 640 663,507 663,507 6,483 6,008 -475 (-7.3%)
⚪ transfer_public_to_private 246,797 246,797 1,024 1,024 683,952 683,952 7,387 6,899 -488 (-6.6%)
⚪ transfer_public_to_public 185,539 185,539 480 480 673,499 673,499 6,492 6,052 -440 (-6.8%)

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 223,523 223,523 416 416 661,046 661,046 7,128 6,631 -497 (-7.0%)
⚪ burn_public 185,539 185,539 448 448 670,028 670,028 6,440 6,116 -324 (-5.0%)
⚪ mint_to_private 268,061 268,061 1,600 1,600 735,336 735,336 7,825 7,337 -488 (-6.2%)
⚪ mint_to_public 185,539 185,539 448 448 670,712 670,712 6,476 6,020 -456 (-7.0%)
⚪ transfer_private_to_private 211,981 211,981 832 832 499,700 499,700 6,749 6,360 -389 (-5.8%)
⚪ transfer_private_to_public 223,550 223,550 416 416 659,252 659,252 7,114 6,680 -434 (-6.1%)
⚪ transfer_public_to_private 240,913 240,913 992 992 683,262 683,262 7,309 6,847 -462 (-6.3%)
⚪ transfer_public_to_public 185,539 185,539 384 384 633,279 633,279 6,445 6,035 -410 (-6.4%)

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 250,779 250,779 1,024 1,024 713,951 713,951 7,482 6,981 -501 (-6.7%)
⚪ burn_public 185,539 185,539 448 448 672,626 672,626 6,479 6,023 -456 (-7.0%)
⚪ initialize_transfer_commitment 188,484 188,484 768 768 474,500 474,500 6,505 6,097 -408 (-6.3%)
⚪ mint_to_private 281,953 281,953 2,144 2,144 738,064 738,064 7,993 7,611 -382 (-4.8%)
⚪ mint_to_public 185,539 185,539 448 448 672,221 672,221 6,499 6,072 -427 (-6.6%)
⚪ transfer_private_to_commitment 222,045 222,045 992 992 511,400 511,400 6,932 6,469 -463 (-6.7%)
⚪ transfer_private_to_private 286,325 286,325 2,592 2,592 557,600 557,600 7,840 7,343 -497 (-6.3%)
⚪ transfer_private_to_public 250,831 250,831 1,024 1,024 714,017 714,017 7,516 6,985 -531 (-7.1%)
⚪ transfer_private_to_public_with_commitment 254,753 254,753 1,600 1,600 747,317 747,317 7,518 7,030 -488 (-6.5%)
⚪ transfer_public_to_commitment 185,539 185,539 576 576 662,520 662,520 6,487 6,070 -417 (-6.4%)
⚪ transfer_public_to_private 244,762 244,762 992 992 683,298 683,298 7,408 6,896 -512 (-6.9%)
⚪ transfer_public_to_public 185,539 185,539 448 448 672,542 672,542 6,460 6,042 -418 (-6.5%)

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 362,767 362,767 1,312 1,312 1,080,775 1,080,775 9,306 8,710 -596 (-6.4%)
⚪ deposit_private_to_private_exact 471,194 471,194 1,888 1,888 1,117,843 1,117,843 11,653 10,892 -761 (-6.5%)
⚪ deposit_private_to_public 308,983 308,983 768 768 1,064,800 1,064,800 8,420 7,903 -517 (-6.1%)
⚪ deposit_public_to_private 298,960 298,960 1,984 1,984 1,167,572 1,167,572 8,330 7,804 -526 (-6.3%)
⚪ deposit_public_to_private_exact 301,691 301,691 1,952 1,952 1,151,996 1,151,996 8,391 7,801 -590 (-7.0%)
⚪ deposit_public_to_public 185,539 185,539 832 832 1,100,090 1,100,090 6,486 6,088 -398 (-6.1%)
⚪ issue_private_to_private_exact 471,194 471,194 1,888 1,888 1,118,119 1,118,119 11,102 10,407 -695 (-6.3%)
⚪ issue_private_to_public_exact 339,595 339,595 1,344 1,344 1,102,141 1,102,141 9,022 8,435 -587 (-6.5%)
⚪ issue_public_to_private 275,652 275,652 1,376 1,376 1,123,804 1,123,804 7,898 7,381 -517 (-6.5%)
⚪ issue_public_to_public 185,539 185,539 832 832 1,100,396 1,100,396 6,474 6,069 -405 (-6.3%)
⚪ redeem_private_to_private_exact 474,161 474,161 1,888 1,888 1,118,350 1,118,350 11,140 10,418 -722 (-6.5%)
⚪ redeem_private_to_public 308,930 308,930 768 768 1,065,244 1,065,244 8,444 7,858 -586 (-6.9%)
⚪ redeem_public_to_private_exact 304,711 304,711 1,952 1,952 1,152,317 1,152,317 8,345 7,838 -507 (-6.1%)
⚪ redeem_public_to_public 185,539 185,539 832 832 1,100,612 1,100,612 6,454 6,079 -375 (-5.8%)
⚪ withdraw_private_to_private 365,734 365,734 1,312 1,312 1,080,601 1,080,601 9,352 8,717 -635 (-6.8%)
⚪ withdraw_private_to_private_exact 474,161 474,161 1,888 1,888 1,117,912 1,117,912 11,184 10,478 -706 (-6.3%)
⚪ withdraw_private_to_public_exact 339,542 339,542 1,344 1,344 1,102,375 1,102,375 9,072 8,397 -675 (-7.4%)
⚪ withdraw_public_to_private 314,923 314,923 2,528 2,528 1,169,499 1,169,499 8,602 7,965 -637 (-7.4%)
⚪ withdraw_public_to_public 185,539 185,539 832 832 1,100,531 1,100,531 6,454 6,040 -414 (-6.4%)

@alejoamiras
alejoamiras merged commit 7942f14 into stack/closeout-vault-overflow Oct 13, 2026
6 checks passed
alejoamiras added a commit that referenced this pull request Oct 13, 2026
#38)

* fix(vault): compute share<>asset conversions in a 256-bit intermediate

The conversions compute `a * b / denominator`. Done natively in u128 the
intermediate product overflows for large-but-legitimate inputs; Noir
range-checks u128, so the transaction reverts rather than wrapping. That
is an availability bug (audit F-004): a vault whose totals reach the
range can no longer be deposited to or withdrawn from, permanently
locking every participant's funds. Both sites carried TODOs.

New `conversion.nr` module with a `mul_div` primitive that widens both
operands to noir-bignum's U256 (the same library the escrow's key
derivation already uses), multiplies and divides there, then narrows the
quotient back to u128, asserting it fits. U256 arithmetic is modulo
2^256 and the largest possible product, (2^128-1)^2, is 2^129-1 short of
that modulus, so the product is always exact — no modular wraparound.

Rounding is unchanged: both old and new return
floor(p/d) + (round_up && p%d != 0). For every input the old code
accepted the results are identical; the widening only extends the domain
that succeeds. This matters because the vault's economic safety depends
on rounding always favouring the vault — a shift in either direction
would leak value between the vault and its depositors.

`mul_div` also rejects a zero denominator explicitly: noir-bignum's
constrained udiv_mod fails on it, but its unconstrained path assumes
non-zero and would return a meaningless witness. Unreachable from the
vault (denominators are total_assets+1 and total_supply+vault_offset
with vault_offset >= 1) but the helper is now safe in isolation.

Extracting mul_div into its own module is what makes the overflow
boundary testable at all: a real vault cannot be driven to a 2^128
supply in a test, but the primitive can be called directly at its edges.

Also adds `ensureVaultContractClassPublished` to the JS test utils.
Publishing just the class is what the vault tests actually need and is
substantially cheaper in DA gas than deploying a throwaway Vault to get
the class published as a side effect. It is idempotent — publication
emits a nullifier keyed on the class id, so a second publish of the same
class is rejected with "Existing nullifier"; the helper checks
registration state first, the same way DeployMethod does.

Validated: vault_contract 195 Noir tests (188 pre-existing all still
green — the strongest evidence rounding did not shift — plus 7 new
covering limb round-trips, rounding direction both ways, products that
previously overflowed, max operands, and the two revert guards).
aztec compile OK. Codex adversarial review: correct, rounding invariance
proven algebraically, no value-leak path; its zero-denominator hardening
is applied.

Note: the vault README still describes the overflow as a known issue.
That warning block is rewritten in PR #24 (unmerged); leaving it there
avoids a three-way conflict.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci: run JS tests against mainnet block geometry

`aztec start --local-network` defaults to 3s blocks. With 72s slots that
packs 21 blocks into a checkpoint, and the per-tx DA admission limit is
`ceil(daBudget / blocks * 1.5)` = 55,882 DA gas. Mainnet runs 6s blocks
(10 blocks per checkpoint) and admits 117,668.

The protocol picks that 1.5 multiplier deliberately, and says so in
aztec stdlib `gas/tx_gas_limits.ts`: it is set "so the largest tx we want
to support — a maximal contract class registration (~97k DA gas) — fits
a single block under v5 mainnet geometry (72s slots, 6s blocks -> 10
blocks per checkpoint)". The default local geometry therefore advertises
a limit well below the ~97k the protocol guarantees for exactly this
kind of transaction, and rejects contracts that are valid on the network
we ship to.

Publishing the Vault contract class costs ~64k DA gas. That is fine on
mainnet and inside the protocol's stated envelope, but over the local
55,882 cap. Note this is not specific to any one change: main's Vault
already sits at ~54k, i.e. 97% of the local ceiling, so essentially any
growth in that contract trips it.

Reusable workflows do not inherit the caller's `env`, and
aztec-ci-actions' run-tests.yml exposes no knob for this, so the JS job
is inlined here (`run-js-tests: false` on the reusable call) purely to
own the environment. It still calls the same pinned `setup-aztec` and
`js-tests` composite actions, so behaviour is otherwise unchanged.

NOTE FOR REVIEWERS: this renames the check from "checks / JS Tests" to
"JS Tests". Any branch protection rule naming the old check needs
updating, or it will block merges waiting on a check that no longer runs.

The better long-term fix is upstream — either the local network should
default to mainnet geometry, or run-tests.yml should expose the knob.
Worth raising with the Aztec CI folks.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* ci: run benchmarks at mainnet block geometry

The Vault benchmark's setup publishes the Vault contract class (63,776 DA
gas). The local network's default 3s blocks cap a tx at 55,836, and
aztec-benchmark's reusable workflows had no way to change that.

Pin both workflows to AztecProtocol/aztec-benchmark#3, which adds a
block-duration-ms input, and pass 6000 (mainnet's 6s blocks: 117,624).
This is a pre-release commit; swap it for the v6.0.0-rc.1 tag commit
before merging.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* ci: pin aztec-benchmark to the v6.0.0-rc.1 release

879fa93 is the squash commit of aztec-benchmark#3 that v6.0.0-rc.1 tags.
Its pr-benchmark.yml and update-baseline.yml are byte-identical to the
d623993 head they were verified at; only publish.yml differs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* chore(deps): bump @aztec-foundation/aztec-benchmark to 6.0.0-rc.1

5.0.1 declared @aztec/aztec.js and @aztec/wallets peers (<6) and typed
its Benchmark base class against them, so against this repo's
@aztec-labs/* v6 packages the peers were unmet and the benchmark files
carried 33 type errors (unseen: tsx does not type-check). 6.0.0-rc.1 peers
@aztec-labs/* >=6.0.0-0 <7 and the benchmark files type-check clean.

Its gitHead and SLSA provenance name 879fa93, the commit both benchmark
workflows are pinned to.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(bump-aztec-version): aztec-benchmark v6 peers, pins and the DA cap

The benchmark gotcha described 5.0.1's v5 peers as current. 6.0.0-rc.1
is the first @aztec-labs release. A peer mismatch fails nothing (yarn
warns, tsconfig skips benchmarks/, tsx doesn't type-check), so document
the explicit typecheck. Record that the devDependency and both workflow
pins move together, and the local-network DA cap that the Vault class
publication hits without 6s blocks.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(vault): the conversion intermediate is 256-bit, not 512

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* ci: stop passing `secrets: inherit` to reusable workflows (#47)

None of the called workflows (aztec-ci-actions run-tests.yml, aztec-benchmark
pr-benchmark.yml and update-baseline.yml, at both the v5.0.1 and v6.0.0-rc.1
pins) declare `on.workflow_call.secrets` or read `secrets.*`, and the repo has
no repo, org or environment secrets. `inherit` passes nothing today, but it
would hand any secret added later to workflows that live in other repos, so a
future pin bump that starts reading one gets it without us ever opting in.

A called workflow always gets `github.token` / `secrets.GITHUB_TOKEN`, scoped by
the caller job's `permissions`, so the benchmark PR comment keeps working.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

* ci: typecheck src and the benchmarks (#48)

Vitest and tsx (which runs the benchmarks) only strip types, so a type error
in either never failed CI. Add `yarn typecheck` (`tsc --noEmit`) and run it in
both js-tests jobs, after the setup step's compile + codegen write src/artifacts.

tsconfig changes so the project type-checks clean:
- `target/**/*` matched no JSON: an include glob only picks up .json files
  when the pattern itself ends in `.json`. Every generated src/artifacts/*.ts
  imports its `target/*.json`, which `composite` then rejects with TS6307.
  Now `target/**/*.json`.
- include `benchmarks`, which nothing type-checked before.

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

* fix(vault): restore an accurate capacity warning and test the fix on the contract path

The conversions still add `vault_offset` to the share supply and 1 to total
assets in u128 before `mul_div`. A deposit can leave the supply above
2^128 - 1 - vault_offset, after which every conversion reverts, withdrawals
included; with a large offset that takes few assets. The READMEs had dropped
the overflow warning entirely: restore it as a precise second known issue, and
correct comments that called the remaining overflow impossible.

`conversion.nr`'s tests run constrained; the vault runs it in public. Add a
2^100-scale deposit and redeem through the contract (fails on the old u128 math)
and a case that only the `hi < 256` narrowing bound rejects.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* docs(skills): point the bump skill at `yarn typecheck`

It still described a temporary tsconfig and said tsconfig.json skips
benchmarks/, both stale since typecheck joined CI.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
@alejoamiras
alejoamiras deleted the worktree-ci-typecheck branch October 13, 2026 19:57
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.

1 participant