snarkVM
AGENTS.md1.2k starsChanged 21 days agoApache-2.0View on GitHub
snarkVM is a virtual machine for zero-knowledge proof execution on the Aleo blockchain. Crate dependencies: - snarkvm-utilities - no deps, macros and parallel primitives - snarkvm-fields - depends on utilities, finite field arithmetic - snarkvm-curves - depends on fields, elliptic curve implementations - snarkvm-algorithms - depends on curves/fields, cryptographic primitives (Poseidon, Marlin, Polycommit) - snarkvm-console - depends on algorithms, plaintext VM types (Address, Field, Group, Scalar, programs) - snarkvm-circuit - depends on console, circuit/constraint equivalents of console types - snarkvm-ledger…
Trending
More talk lately.about the whole repository
Who's talking about ProvableHQ/snarkVM
- aleo-labs-protocol/snarkOS“[Feature] Expose new API endpoint which can read view function data”GitHub · Jun 9, 2026 · 1 reactions
- aleo-labs-protocol/snarkOS“[Feature] Introduce backwards compatibility CI job”GitHub · May 28, 2026 · 1 reactions
- aleo-labs-protocol/snarkVM“[Proposal] Reduce snarkVM CI benchmark scope”GitHub · May 12, 2026 · 1 reactions
- aleo-labs-protocol/snarkOS“[Bug] [CI] many jobs failing due to parameter downloads”GitHub · Apr 29, 2026 · 1 reactions
- aleo-labs-protocol/snarkVM“Remove .circleci/config.yml to eliminate runaway CI timeouts”GitHub · Mar 25, 2026 · 1 reactions
The biggest 5 of 50 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 50
Talked about on GitHub (50 times).
On GitHub · 50
- Jun 9, 2026[Feature] Expose new API endpoint which can read view function data — aleo-labs-protocol/snarkOS1 reaction
- May 28, 2026[Feature] Introduce backwards compatibility CI job — aleo-labs-protocol/snarkOS1 reaction
- May 12, 2026[Proposal] Reduce snarkVM CI benchmark scope — aleo-labs-protocol/snarkVMsays it tested it1 reaction · 1 comment
- Apr 29, 2026[Bug] [CI] many jobs failing due to parameter downloads — aleo-labs-protocol/snarkOS1 reaction
- Mar 25, 2026Remove .circleci/config.yml to eliminate runaway CI timeouts — aleo-labs-protocol/snarkVM1 reaction
45 more on GitHub
- Jan 14, 2026[Feature] Add build feature to store rejection error strings to finalize_store — aleo-labs-protocol/snarkVM1 reaction
- Dec 2, 2025[Feat] Add 2 new REST routes — aleo-labs-protocol/snarkOS1 reaction
- Oct 31, 2025[Proposal] Reduce CI time to max ~15 min. per run — aleo-labs-protocol/snarkVM1 reaction · 3 comments
- Oct 16, 2025[Feature] Expose and support execution_cost_for_authorization — ProvableHQ/sdk1 reaction
- Aug 12, 2025Improved varuna logging — aleo-labs-protocol/snarkVM1 reaction · 3 comments
- Jul 31, 2025WIP: Add database read/write/delete timing metrics — aleo-labs-protocol/snarkVM1 reaction · 2 comments
- Mar 15, 2025snarkVM — rkdud007/awesome-zkvm1 reaction
- Jan 22, 2025[Feature] Batch proposal spend limits — aleo-labs-protocol/snarkVM1 reaction · 5 comments
- Oct 13, 2026Upgrade snarkVM to v4.12.0 (signing changes) — ProvableHQ/service0 reactions
- Oct 12, 2026Bump snarkVM to ProvableHQ/snarkVM@bcf2847b8 — 14MR/snarkOS0 reactions
- Oct 12, 2026Bump snarkVM to ProvableHQ/snarkVM@9796eb19d — aleo-labs-protocol/snarkOS0 reactions
- Oct 6, 2026fix(utilities): correct array serialized size and cover containers — aleo-labs-protocol/snarkVM0 reactions
- Oct 6, 2026Run benchmarks on pushes to testnet and mainnet — aleo-labs-protocol/snarkOSsays it tested it0 reactions
- Oct 6, 2026Run benchmarks on pushes to testnet and mainnet — aleo-labs-protocol/snarkVMsays it tested it0 reactions
- Oct 5, 2026feat: write credits.aleo history as JSON from snarkos start --history-json — aleo-labs-protocol/snarkOS0 reactions
- Oct 5, 2026Bump snarkVM to ProvableHQ/snarkVM@8fab0f156 — aleo-labs-protocol/snarkOS0 reactions · 1 comment
- Sep 24, 2026[Feat] Support opening RocksDB in secondary mode — aleo-labs-protocol/snarkVM0 reactions
- Sep 24, 2026[Feat] Announce blocks via TCP — aleo-labs-protocol/snarkVM0 reactions · 1 comment
- Sep 23, 2026feat: serve mapping history from snarkos start --history — aleo-labs-protocol/snarkOS0 reactions
- Sep 23, 2026Enable dev_genesis_state_root for test_network — aleo-labs-protocol/snarkOS0 reactions
- Sep 18, 2026Cut sequential-thread occupancy for self-constructed blocks — aleo-labs-protocol/snarkVM0 reactions · 4 comments
- Sep 18, 2026Prevent off-thread speculative reads from stalling atomic_speculate — aleo-labs-protocol/snarkOS0 reactions
- Sep 10, 2026[Feature] [Perf] Extend partially_verified_transactions cache — aleo-labs-protocol/snarkVM0 reactions
- Aug 26, 2026ci: pin the nightly check-fmt formats with, via an enum — aleo-labs-protocol/snarkOS0 reactions
- Aug 25, 2026[Perf] Deserialization incurs duplicate allocation — aleo-labs-protocol/snarkVM0 reactions
- Aug 18, 2026[Proposal] Replace transaction constraint limits to a static block-wide density limit — aleo-labs-protocol/snarkVM0 reactions
- Aug 18, 2026Write DynamicRecord version 2 — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Aug 18, 2026Accept DynamicRecord encoding version 2 and carry entry data — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Aug 13, 2026Use an array for handling values that change between consensus versions — aleo-labs-protocol/snarkVM0 reactions · 1 comment
- Aug 4, 2026[Perf] Simplify PoseidonSponge::compress_elements (reopening) — aleo-labs-protocol/snarkVM0 reactions · 1 comment
- Jul 30, 2026Make synthesis limit tracking robust against function calls — aleo-labs-protocol/snarkVM0 reactions
- Jul 29, 2026snarkVM v4.9.0 is available (SDK on v4.8.1) — ProvableHQ/sdk0 reactions
- Jul 24, 2026Fix stack handling in casts involving external structs — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Jun 23, 2026General multi-request signing — ProvableHQ/sdk0 reactions · 1 comment
- Jun 4, 2026feat: add a compile-time flag for credits-only history — aleo-labs-protocol/snarkOS0 reactions
- Jun 1, 2026[Feature] Support authorizing multiple requests — ProvableHQ/sdk0 reactions
- May 27, 2026Limitations in the size of Aleo arrays — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Feb 11, 2026Improve logged errors — aleo-labs-protocol/snarkVM0 reactions
- Jan 29, 2026[Proposal] Get rid of the expectation-based integration test suite. — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Dec 3, 2025[Bug] CI not running `snarkvm-ledger` tests that require the `test` feature. — aleo-labs-protocol/snarkVM0 reactions · 6 comments
- Nov 21, 2025[Feature] Implement a parallel chunked serialization utility — aleo-labs-protocol/snarkVM0 reactions · 2 comments
- Nov 19, 2025[Docs] Document announce-blocks — aleo-labs-protocol/snarkVM0 reactions
- Nov 13, 2025[Refactor] Cleanup and unify program rules — aleo-labs-protocol/snarkVM0 reactions
- Oct 23, 2025[Tracking issue] consensus improvements — aleo-labs-protocol/snarkOS0 reactions
- Oct 14, 2025Add unit tests for `CanonicalSerialize` — aleo-labs-protocol/snarkVM0 reactions
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository5 other files it gives its agents.
- .claude/CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- snarkvm-fixSkill
- snarkvm-githubSkill
- snarkvm-reviewSkill
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
18 rules. About 0 are common, 13 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈13
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 4
Search for existing implementations.
- Distinctive: line 5
Read the target module and match its patterns exactly.
- Distinctive: line 27
When modifying one, check the other.
- Distinctive: line 28
Test circuit equivalence by comparing constraint counts.
- Distinctive: line 31
All changes must be backwards compatible — no consensus forks.
- Distinctive: line 39
Test-driven development: write failing tests first.
- Very specific: line 41
Prefer zip_eq over zip when lengths must match.
- Very specific: line 43
Prefer into_iter() over iter().cloned().
- Very specific: line 44
Use iterators; avoid intermediate .collect() when a single pass follows.
- Very specific: line 70
Use --features test,dev-print for integration tests.
- Distinctive: line 95
Never commit unless explicitly asked.
- Very specific: line 97
Run cargo +nightly-2026-04-02 fmt --all before staging.
- Distinctive: line 101
Write the PR README in Simplified Technical English.
- Distinctive: line 102
Keep the pull request description succinct and DRY.
- Distinctive: line 144
Start from program input.
- Distinctive: line 145
Follow through console types -> circuit synthesis -> proof generation.
- Distinctive: line 147
Verify output matches expected proof/execution result.
- Distinctive: line 160
All randomness is derived from cryptographically secure sources.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
snarkVM
Before Writing Code
- Search for existing implementations.
- Read the target module and match its patterns exactly.
- Scope out necessary tests ahead of time.
- If uncertain, ask.
- Think very hard in your planning process.
- New files, crates, dependencies, abstractions, traits, or error types require approval.
Architecture
snarkVM is a virtual machine for zero-knowledge proof execution on the Aleo blockchain.
Crate dependencies:
snarkvm-utilities- no deps, macros and parallel primitivessnarkvm-fields- depends on utilities, finite field arithmeticsnarkvm-curves- depends on fields, elliptic curve implementationssnarkvm-algorithms- depends on curves/fields, cryptographic primitives (Poseidon, Marlin, Polycommit)snarkvm-console- depends on algorithms, plaintext VM types (Address, Field, Group, Scalar, programs)snarkvm-circuit- depends on console, circuit/constraint equivalents of console typessnarkvm-ledger- depends on synthesizer, blockchain state (blocks, transactions, storage)snarkvm-synthesizer- depends on console/circuit/algorithms, program execution and proof generation
console / circuit sync requirement:
- These crate families must stay in sync. Same structure, same API.
- When modifying one, check the other.
- Test circuit equivalence by comparing constraint counts.
Rules
- All changes must be backwards compatible — no consensus forks.
- New files, crates, dependencies, abstractions, or traits require approval.
unwraps must have a comment justifying why they can't panic.
Forking Risk
There are deployed versions of this software in the wild. Changes that alter consensus behavior (same inputs producing different outputs) will fork the network. All changes must either be backwards compatible or gated behind a consensus version so they can be rolled in at the appropriate time. Not all code has been released publicly, so if you are unsure whether a change is safe on a PR, ask before proceeding.
Code and Patterns
- Test-driven development: write failing tests first.
unwraps must be commented with justification.- Prefer
zip_eqoverzipwhen lengths must match. - Pre-allocate with
with_capacitywhen final size is known. - Prefer
into_iter()overiter().cloned(). Prefer references over.clone(). - Use iterators; avoid intermediate
.collect()when a single pass follows. - Trait impls (ToBits, FromBits, ToField, FromField) should follow existing patterns in the same file.
See @CONTRIBUTING.md for detailed memory and performance guidelines.
Code comments
Comments must describe the state of the code today -- not a previous state or an alternative state.
Exception: Comments may describe an alternative possible state of the code, if they are documenting a hazard that a future developer may otherwise walk into.
Comments must not describe the rationale for a change.
Rationale may appear in: the commit message and the pull request. You may self-comment on your own github pull request at select positions in the code to aide reviewers.
Comments must help someone who has never heard of this change you are making.
Comments must not state the obvious. Comments that explain what attributes do or how language constructs work are unhelpful.
Testing
Synthesizer tests are slow — run only the specific test function.
Use --features test,dev-print for integration tests.
cargo test -p <crate> # Run crate tests
cargo test -p <crate> -- test_name # Run specific test
cargo test -p snarkvm-synthesizer --features test,dev-print # Integration testsValidation
Run in order:
cargo check -p <crate>
cargo clippy -p <crate> -- -D warnings
cargo +nightly-2026-04-02 fmt --check
cargo test -p <crate>Clippy warnings are errors. Formatting requires the nightly .github/workflows/ci.yml pins as
FMT_TOOLCHAIN (cargo +nightly-2026-04-02 fmt --all to fix) -- .rustfmt.toml uses
nightly-only options, and plain cargo fmt drops them silently rather than refusing.
Pre-commit hook runs workspace-wide: cargo clippy --workspace --all-targets --all-features -- -D warnings && cargo +nightly-2026-04-02 fmt --all -- --check
Git
- Never commit unless explicitly asked.
- Stage with
git addonly if requested. - Run
cargo +nightly-2026-04-02 fmt --allbefore staging.
Pull requests
- Follow
.github/PULL_REQUEST_TEMPLATE.md. - Write the PR README in Simplified Technical English. Use short sentences, the active voice, and one idea per sentence.
- Keep the pull request description succinct and DRY.
- Explain each commit in one line.
Style
- One blank line between functions.
- No trailing whitespace.
- Imports: std first, external crates second, crate-local third.
- Match existing file patterns exactly — if the file uses
Self::, you useSelf::. - Comments must be concise, complete, punctuated sentences.
#![forbid(unsafe_code)]in all crates unless approved.- License header required (enforced by
tests/sources.rs).
Review Checklist
Correctness
- Logic traced step-by-step.
- Boundary conditions handled: zero, empty, max, off-by-one.
- Error handling correct; no panics in production paths.
- Serialization/deserialization roundtrips verified.
Crypto-Specific
- Field operations use checked arithmetic where needed.
- Randomness sources are cryptographically secure.
- No consensus-breaking changes (same inputs must produce same outputs).
- Circuit constraints match console logic exactly.
- Proof verification logic is sound.
Memory & Performance
- No unnecessary allocations in hot paths.
- Pre-allocation with
with_capacitywhere size known. - No unnecessary
.clone()— prefer references. - Iterators used efficiently; no intermediate collections.
- Parallel execution with rayon where appropriate.
Security
- Input validation at trust boundaries.
- No information leakage in error messages.
- Fail-closed (reject on uncertainty).
Deep Analysis Techniques
Trace Execution
- Start from program input.
- Follow through console types -> circuit synthesis -> proof generation.
- Track field element transformations.
- Verify output matches expected proof/execution result.
Enumerate Failure Modes
For each operation, ask:
- What if input is zero/empty/max?
- What if field elements overflow?
- What if serialization format changes?
- What if circuit constraints don't match console logic?
Check Invariants
- Console and circuit types produce identical outputs for identical inputs.
- Serialization is deterministic and backwards compatible.
- Proof verification succeeds for valid proofs and fails for invalid ones.
- All randomness is derived from cryptographically secure sources.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

