Repository navigation
Conversation
noir-protocol-circuits/ABOUT.md
- Rewrite the block, checkpoint and epoch sections from the code: block-root,
block-root-single-tx and block-root-no-txs (each at any position in the
checkpoint), inbox-parity-{4,16,64,256,1024}, checkpoint-root-single-block,
checkpoint-padding, current ALLOWED_* lists, message bundles and the message
sponge in place of in_hash, epoch out hash tree, MAX_BLOCKS_PER_CHECKPOINT.
- Fix the root section heading, the AVM VK claim, the .sh script name, and
the tx-base next-circuit lists. Write the tx-merge section.
- Define tx chain-state checks, tx effect absorption and merge
consecutiveness once; keep per-circuit extras (timestamp rules, blob
challenge equality). Add source-of-truth pointers; remove author notes.
noir-protocol-circuits/README.md
- noirup v1.0.0-rc.3 and the noir-from-release.flag route; bb path depth;
./bootstrap.sh generate_variants; flamegraph output dir; Build outputs and
VKs section; one Composer/Validator/hint definition that matches the code;
Further reading links.
private-kernel-lib accumulated_data.md (absorbs types/src/utils/arrays.md)
- Real Init helper names and constrained composer; read requests appended
as-is (already scoped by the app) in Init, Inner and the table; batched
Init-N/Inner-N section; Reset vs Reset-tail/Reset-tail-to-public; dense and
trimmed checks attributed to previous_kernel_for_tail_validator; arrays.md
diagrams fenced, with the bounds-check and sorted-output corrections.
private-kernel-lib components/README.md
- Output validator = Inner only; batch validator = Init-N/Inner-N; Init
composer constrained; all 14 modules; pattern defined in README.md.
bignum, bigcurve READMEs: short provenance notes citing 12182b5.
blob/README.md: what the library crate is and how to test it.
mock-protocol-circuits/README.md: actual crates, build entry point, consumer.
Scripts
- flamegraph.sh: read .pattern from chonk_circuits.json entries.
- noir-protocol-circuits/bootstrap.sh: test the variable, not a literal.
- mock-protocol-circuits/bootstrap.sh: forward all arguments and pass
NOIR_PROTOCOL_CIRCUITS_SKIP_CHECK_WARNINGS to the call it controls.
Re-enabling the dead `nargo check` warnings step changes what every full build runs and conflicts with cb/circuits-lib-warnings-check, which fixes the same bug with --deny-warnings and the correct ordering. Keep only the argument-forwarding fix in the mock-protocol-circuits wrapper.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In one paragraph
Protocol circuit docs:
ABOUT.md,accumulated_data.md, the components README, the bignum, bigcurve and blob crate READMEs, and the mock circuits README. Rewrites the stale sections from the Noir source and fixes two one-line script bugs found while checking the README commands (ajqpath inflamegraph.sh; argument forwarding in the mockbootstrap.sh). No.nrfile,Nargo.toml, or toolchain pin is touched, so the compiled circuits and their verification keys are unchanged.What kind of changes (line counts)
flamegraph.sh:jqpath.[]→.[].pattern; mockbootstrap.sh:"${1:-}"→"$@". Both developer tooling; neither changes what the circuit build produces.Counts are
git diff --numstat -M origin/v6...HEAD. "Code comments" means the only changed lines in that file are comment lines; the classification was checked line by line.Files created, moved, renamed or deleted
noir-projects/fnd/noir-protocol-circuits/crates/types/src/utils/arrays.mdaccumulated_data.md("Claimed lengths and padding").Verification keys and build artifacts
No circuit source (
.nr,Nargo.toml), no C++/TypeScript/Rust/Solidity code, and no toolchain pin changes in this PR, so no verification key, proof, compiled contract or published package changes.CI cache keys that change: noir-protocol-circuits (
circuits_hashcoverscrates/**,bootstrap.shandscripts/; matches 7 files:crates/bigcurve/README.md,crates/bignum/README.md,crates/blob/README.md,crates/private-kernel-lib/src/accumulated_data/accumulated_data.md,crates/private-kernel-lib/src/components/README.md,crates/types/src/utils/arrays.md,scripts/flamegraph.sh). The content hash for those components includes these files, so CI rebuilds them once and re-uploads byte-identical outputs. The rebuild is the only cost; nothing in the outputs changes.Base branch and stacking
Flat PR against
v6, not stacked: it does not depend on any other cleanup PR and no other cleanup PR depends on it. The ten PRs touch disjoint files.If the target becomes
nextinstead: every touched file is identical onv6andnext, and a dry-run rebase ontonext(git merge-tree --merge-base=origin/v6 origin/next HEAD) applies cleanly.Summary
The protocol-circuit docs described the pre-v6 circuit set. ABOUT.md listed first-block block roots, parity base/root,
in_hashand a 6-entry checkpoint-root VK list, none of which exist. accumulated_data.md named six functions that do not exist and documented separate tail circuits. components/README.md said the output validator covers Init. The bignum, bigcurve and blob READMEs were vendored upstream text or dead personal notes. This PR rewrites the wrong sections from the Noir source (crates/,constants.nr, theALLOWED_*globals), keeps the still-accurate tx-level sections and the per-circuit extras, and fixes three one-line script bugs found while checking the README commands. Reviewer: Michael.Changes by file
noir-projects/fnd/noir-protocol-circuits/ABOUT.md— block, checkpoint and epoch sections rewritten for the v6 circuits (block-root / -single-tx / -no-txs, inbox-parity-S, checkpoint-root-single-block, checkpoint-padding, currentALLOWED_*lists, message bundles and sponge, epoch out hash tree); tree uses real crate names incl. init-N/inner-N/reset-tail; root heading, AVM VK,.shname,BUG?markers fixed; tx-merge section written; shared checks defined once; source-of-truth pointers; author notes removed.noir-projects/fnd/noir-protocol-circuits/README.md—noirup --version v1.0.0-rc.3(+noir-from-release.flagroute);../../../barretenbergbb path;./bootstrap.sh generate_variants; flamegraph output dir; "Build outputs and VKs" section; Composer/hint/Builder definitions match the code; Further reading links..../private-kernel-lib/src/accumulated_data/accumulated_data.md— real Init helpers and constrained composer; read requests appended as-is, already scoped by the app (Init, Inner, table); Init-N/Inner-N section; Reset vs Reset-tail/-to-public; dense/trimmed checks attributed toprevious_kernel_for_tail_validator; overview table moved to the top; arrays.md diagrams merged in, fenced and corrected..../types/src/utils/arrays.md— deleted; content merged into accumulated_data.md ("Claimed lengths and padding")..../private-kernel-lib/src/components/README.md— output validator = Inner only, batch validator = Init-N/Inner-N, composer rows per circuit; 14 modules; pattern defined once in README.md; "Why This Pattern?" and box diagram replaced by one sentence..../crates/bignum/README.md,.../crates/bigcurve/README.md— short provenance notes citing commit12182b58d17, the replaced tags, the path deps, and the bigcurve subgroup-check note..../crates/blob/README.md— what the library crate does, how to test it, how to profile it.noir-projects/fnd/mock-protocol-circuits/README.md— removed the non-existentpublic-kernelsection; lists the crates, build entry point, published package and consumer.Non-Markdown files touched
noir-projects/fnd/noir-protocol-circuits/scripts/flamegraph.shL126 —jq -r '.[]'→jq -r '.[].pattern'.chonk_circuits.jsonentries are{pattern, kind}objects, so no kernel matched and kernel flamegraphs used--scheme ultra_honk.bootstrap.shandgates_report.shalready read.pattern.noir-projects/fnd/mock-protocol-circuits/bootstrap.sh— forwards"$@"instead of"${1:-}", so./bootstrap.sh compile <name>keeps the name. No-argument calls still reachbuild(ci3/source_bootstrapsetscmd=${1:-}). Nothing else in the script changes.Removed-content ledger
ABOUT.md
init,inner,reset,tail,hiding,tail-to-public,hiding-to-public,parity base/root,block-root-first— dead (crates do not exist;constants.nrL116-117, L127-128). Replaced by the real crate list.unravel_favourite_structs.js— wrong extension, now.sh..finish()blob/out_hash bullets repeated in both tx-base sections — now once under "Tx effect absorption".contract_class_log_fieldsdescription repeated in tx-base-public — replaced by "as fortx-base-private".crates/blob/src/abis/blob_accumulator.nr).avmperforms it".AVM_VK_INDEXin the vk tree" — false (types/src/proof/proof_data.nrL80-86: VK hard-coded in the verifier); replaced.block-root<-- BUG?" andblock-root-first-single-txbullets — false/dead (block_root_rollup.nrL17-18).tx_merge_rollup.nr.block-root-first*block, "Empty (block-root-first-empty-tx only)", "First (…) Validate the parity root proof / Inserts the poseidon2 version of the l1_to_l2_msg subtree",parity-base,parity-rootsections — dead topology. Their surviving facts are restated: empty-block zero values and unchanged state (nowblock-root-no-txs), message insertion (now per block, "All variants"), parity (nowinbox-parity-<S>).block-root-no-txstakes a witnessed start sponge blob, pinned by the checkpoint root or block merge.[u32; 6]list and the "single block … first block" notice — dead; replaced by the current 4- and 3-entry lists and thecheckpoint-root-single-blocksection.validate_consecutive_block_rollupsasserts equal timestamps, so blocks in a checkpoint share one timestamp; strictly increasing across checkpoints is kept.checkpoint_rollup_public_inputs_composer.nrL78: block headers carry noin_hash). Replaced by the message-sponge equality and the parity rolling hashes.#### checkpoint-mergeheading under#### root— copy-paste error.blob_fields→blobs_fields(code name) and the limit expressed via the constants.README.md
noirup --version nightly-2026-01-13— wrong pin; nowv1.0.0-rc.3.yarn && node ./scripts/generate_variants.js" — replaced by./bootstrap.sh generate_variants, which runs exactly those two commands (bootstrap.sh L355-359); outputs now named.compose_output_for_init, rollupTxBasePublicInputsComposer); replaced....Composerstructs)" and the open question — false/unresolved: Builder structs exist only in tests andprotocol-test-utils(FixtureBuilder); the open question goes to Questions.accumulated_data.md
validate_incrementing_counters_within_range,validate_incrementing_call_request_counters_within_range,validate_propagated_from_initial_private_call,assert_array_appended_to_empty_dest_and_scoped,assert_array_appended_to_empty_dest,assert_array_appended_reversed_to_empty_dest) — dead; replaced by the real helpers.ResetOutputValidatorin the final reset iteration" — the content is kept, moved under Reset-tail (siloing only runs there;constants.nrL129-134).private_kernel_tail.nr,private_kernel_tail_to_public.nrtitles — dead files; content kept under Reset-tail / Reset-tail-to-public.TailOutputValidator/TailToPublicOutputValidator:assert_dense_trimmed_array…" — misattributed; now undervalidate_previous_kernel_for_tailwith the exact per-array checks.arrays.md (deleted; merged into accumulated_data.md "Claimed lengths and padding")
validate_claimed_lengths); corrected.[ b, f, a, d, …].textfences.components/README.md
bignum/README.md (582 → 9 lines)
tag = "v0.4.2", wrong for a path dep), "930 gates for 2048-bit multiplication", single-limb caveat, and v0.3.0/v0.4.x benchmarks — upstream documentation; the README links upstream and says the code may differ. The description,BigNumParams,src/lib.nrandsrc/fields/pointers are kept.bigcurve/README.md (215 → 16 lines)
S = a*G + …example (which referenced a non-existent earlier example), "Feature requests" table row — upstream documentation, linked. Kept: the curve equation,BigCurveParams, the Overview's modular-reduction / constrained-unconstrained / lookup-table notes, the package-vs-import name, and thefrom_coordinates_unsafe/validate_in_subgroupnote.blob/README.md
nargo compile,bb gates … target/blob.json, noir-profiler commands, bbup install frommaster, nargo 0.33.0 / bb 0.48.0,~/packages/…and~/.bb/bbpaths, "Current count: 428,240" — dead:blobistype = "lib", so no artifact exists (03 results L107-109). Replaced bynargo testand profiling viarollup_checkpoint_root. The "serve an existing flamegraph"python3 -m http.serverstep is covered byflamegraph.sh -s.mock-protocol-circuits/README.md
Questions for the owner
blob. Should a current figure forrollup_checkpoint_rootbe recorded somewhere?bigcurvehas no LICENSE file, and upstreamnoir_bigcurvemain ships none either (raw LICENSE 404). Isbignum/LICENSEmeant to cover it, or should a LICENSE be added?private_kernel_circuit_output_composer.nrL1-8 still says "Generates the output for Private Kernel Init and Inner circuits (unconstrained)" and points to the README;compose_output_for_initis constrained. That comment is outside this PR's file list.Not done
scripts/flamegraph.shL105[[ ! $ALLOW_NO_CIRCUIT_NAMES ]]is always false (dead guard), and-llists.gzwitness files as duplicate names. Not in this PR's script list.flamegraph.shdoes not treathiding*circuits as Chonk (the hiding pattern lives only inbootstrap.sh), so hiding kernels still get--scheme ultra_honk. Fixing it is more than a one-line jq change.protocol-circuits-artifacts,protocol-contracts-artifacts,mock-protocol-circuits-artifacts) have findings in batch L but are not in this PR's file list.types/src/utils/arrays/claimed_length_array.nr's doc comment to the merged section would be a code-comment edit outside the file list.Evidence
Findings: https://gist.github.com/AztecBot/48c4773b53be34ed390fd1cf692a1289 (batch
25-L-noir-projects.md). Verified commands:03-command-test-results.mdin the same gist. Report and PR plan: https://gist.github.com/AztecBot/a930919653a16ab8cd533c5f76b86b70. Noir pin checked:noir/noir-repogitlink5a7ee9bf=v1.0.0-rc.3;tools/bin/nargo --versionreports 1.0.0-rc.3+5a7ee9bf. No nargo compiles were run.Deliberately not changed
noir-projects/fnd/noir-protocol-circuits/bootstrap.shL235 tests a literal string instead of theNOIR_PROTOCOL_CIRCUITS_SKIP_CHECK_WARNINGSvariable, so the "Checking libraries for warnings" step never runs. The guard is still broken on bothv6andnext. A fix exists on the branchcb/circuits-lib-warnings-check(public #25508, private aztec-packages-private#804), but both PRs were closed unmerged on 2026-09-17. That fix is a build-behaviour change (every circuits build runsnargo check --deny-warningson the library crates, and it fails until the twelve library warnings it found are fixed), so it does not belong in a docs PR; reopen or re-land it on its own. This PR leaves L235 and the dead assignment on mockbootstrap.shL5 alone.Created by claudebox · group:
slackbot· requested by Mike (@iAmMichaelConnor) · Slack thread