|
| 1 | +--- |
| 2 | +title: Support |
| 3 | +sidebar_position: 5 |
| 4 | +description: Where to ask questions, report bugs, request features, and disclose security issues for the Aztec stack. |
| 5 | +--- |
| 6 | + |
| 7 | +This page tells you where to go when something does not work, when you want to file a bug, when you have a feature idea, or when you have found a possible security issue. Pick the section that matches your situation. |
| 8 | + |
| 9 | +:::warning Security issues are different |
| 10 | +If your issue involves loss of funds, key or seed disclosure, leakage of private notes, a way to forge or replay transactions, or anything you suspect could harm users, **do not open a public GitHub issue or post in Discord**. Use the [security disclosure process](#security-issues) instead. |
| 11 | +::: |
| 12 | + |
| 13 | +## Quick decision tree |
| 14 | + |
| 15 | +| Your situation | Where to go | |
| 16 | +| --- | --- | |
| 17 | +| Possible security issue (funds, keys, privacy, exploit) | [Security disclosure](#security-issues) | |
| 18 | +| You are not sure if the bug is real, or you cannot reproduce it yet | [Ask first: Forum or Discord](#ask-first-forum-and-discord) | |
| 19 | +| You have a reproducible bug in `aztec-packages` (PXE, aztec.js, aztec-nr, local network, CLI, AVM, barretenberg, L1 contracts) | [File a bug on GitHub](#file-a-bug) | |
| 20 | +| You have a Noir compiler or language bug | [Noir issues on `noir-lang/noir`](https://github.com/noir-lang/noir/issues) | |
| 21 | +| You have a feature request or enhancement idea | [File a feature request](#feature-requests) | |
| 22 | +| You are running a node, sequencer, or prover and hit an operator problem | [Operator support](#operator-and-node-issues) | |
| 23 | +| You want to suggest a documentation change | [File a docs issue](#documentation-issues) | |
| 24 | + |
| 25 | +## Ask first: Forum and Discord |
| 26 | + |
| 27 | +If you are not yet sure whether your problem is a real bug or a configuration issue, start in the community channels. You can often get a faster answer there, and the team can help you build a minimal reproduction before you open a GitHub issue. |
| 28 | + |
| 29 | +- [Noir Discord](https://discord.com/invite/JtqzkdeQ6G): the developer-focused channel for syntax issues, compiler questions, and language-level help with Aztec.nr contracts. |
| 30 | +- [Aztec Forum](https://forum.aztec.network): long-form Q&A, best for design discussions, complex bug reports, and conversations you want indexed and searchable. |
| 31 | +- [Aztec Discord](https://discord.gg/aztec): the broader Aztec community space, and the live support channel for node operators (sequencers, provers, RPC nodes). |
| 32 | + |
| 33 | +Once you have a clear reproduction, the right next step is to file a GitHub issue using the form below. |
| 34 | + |
| 35 | +## File a bug |
| 36 | + |
| 37 | +Reproducible bugs in the Aztec stack belong on GitHub. Use the bug template, which automatically labels your issue and helps a maintainer triage it. |
| 38 | + |
| 39 | +[Open a new bug report](https://github.com/AztecProtocol/aztec-packages/issues/new?template=bug_report.yml) |
| 40 | + |
| 41 | +### What a high-quality bug report includes |
| 42 | + |
| 43 | +The template asks for these, and your issue will be triaged faster if you provide all of them. |
| 44 | + |
| 45 | +1. **Aztec version**, for example `0.85.0-alpha-testnet.2`. Use `aztec-up list` if you are not sure. |
| 46 | +2. **What you were trying to do**, in one or two sentences. |
| 47 | +3. **A minimal, runnable reproduction**. A code snippet that compiles, or a link to a public repo branch, is much more useful than prose. If your reproduction is large, please trim it before filing. |
| 48 | +4. **Expected vs. actual behavior**. |
| 49 | +5. **Environment**: operating system, Node.js version, and browser if relevant. |
| 50 | +6. **Logs and errors**: the failing block, ideally with `LOG_LEVEL=debug` for the module that failed. |
| 51 | +7. **What you already tried**: workarounds, version downgrades, related issues you read. |
| 52 | + |
| 53 | +### Where bugs in specific components go |
| 54 | + |
| 55 | +All of the components below live in [`AztecProtocol/aztec-packages`](https://github.com/AztecProtocol/aztec-packages), so use the bug template above and let triage attach the component label. |
| 56 | + |
| 57 | +- **PXE, wallet, CLI**: `aztec`, `aztec-wallet`, `aztec.js`, `bb.js`, local network. |
| 58 | +- **Aztec.nr framework**: the `aztec-nr` smart contract framework. |
| 59 | +- **Protocol circuits or protocol specs**: the rollup, kernels, and other circuits. |
| 60 | +- **Barretenberg, AVM, L1 contracts**: the prover backend, the Aztec Virtual Machine, and the Ethereum-side rollup contracts. |
| 61 | + |
| 62 | +For the **Noir compiler** or the Noir language itself, file on [`noir-lang/noir`](https://github.com/noir-lang/noir/issues) instead. |
| 63 | + |
| 64 | +## Feature requests |
| 65 | + |
| 66 | +Use the feature request template for new functionality, enhancements to existing components, or proposed changes to the developer experience. |
| 67 | + |
| 68 | +[Open a feature request](https://github.com/AztecProtocol/aztec-packages/issues/new?template=feature_request.yml) |
| 69 | + |
| 70 | +Include: |
| 71 | + |
| 72 | +- The problem you are trying to solve. |
| 73 | +- A concrete example or use case, if you have one. |
| 74 | +- Why this is impactful: what is unblocked or made easier if it ships. |
| 75 | + |
| 76 | +## Documentation issues |
| 77 | + |
| 78 | +If something in the docs is wrong, outdated, or missing, please **[open an issue](https://github.com/AztecProtocol/aztec-packages/issues/new?template=bug_report.yml)** with the bug template and quote the URL and paragraph that needs fixing. Docs issues are routed to [`@AztecProtocol/devrel`](https://github.com/orgs/AztecProtocol/teams/devrel) so a docs maintainer can pick them up. |
| 79 | + |
| 80 | +This includes typos and small text issues: please file them as issues rather than opening single-line PRs. A maintainer can fix several at once, which is faster to review than a stream of one-line pull requests. |
| 81 | + |
| 82 | +For larger restructures or new pages, open an issue first so a maintainer can confirm the direction before you write the change. Every docs page in this site has an "Edit this page" link at the bottom that takes you to the right file in [`docs-developers/`](https://github.com/AztecProtocol/aztec-packages/tree/next/docs/docs-developers) once the direction is agreed. |
| 83 | + |
| 84 | +## Operator and node issues |
| 85 | + |
| 86 | +For real-time help, the [Aztec Discord](https://discord.gg/aztec) is the fastest way to reach other operators and the Aztec team. Use it to sanity-check a failure mode before filing, or to coordinate with the team during an incident. |
| 87 | + |
| 88 | +If you are running a node, sequencer, or prover and you hit a reproducible operational problem (sync failures, missed proposals, prover crashes, deployment errors), [open a bug report](https://github.com/AztecProtocol/aztec-packages/issues/new?template=bug_report.yml) and include the following alongside the standard bug-report fields: |
| 89 | + |
| 90 | +- **Network** (mainnet, testnet, devnet, or local). |
| 91 | +- **Role** (sequencer, prover, RPC node). |
| 92 | +- **Block height at failure** and approximate UTC timestamp. |
| 93 | +- **Hardware**: CPU model, RAM, disk type and size. |
| 94 | +- **Container runtime and image version**. |
| 95 | +- **Configuration** (your `config.json` or environment block, with secrets redacted). |
| 96 | +- **Logs**: the last few hundred lines around the failure, with sensitive keys redacted. |
| 97 | + |
| 98 | +Operator-specific guides live in the [Operate section](/operate/operators). |
| 99 | + |
| 100 | +## Security issues |
| 101 | + |
| 102 | +**Do not open a public GitHub issue for a suspected vulnerability.** Public disclosure can put users at risk before a fix is available. |
| 103 | + |
| 104 | +Use one of the following, in order of preference: |
| 105 | + |
| 106 | +1. **[Aztec Network Bug Bounty on Cantina](https://cantina.xyz/bounties/80e74370-10d8-4e52-8e4b-7294deb7c9ee)** if the issue is in scope of the bounty program. |
| 107 | +2. **[GitHub Private Vulnerability Reporting (PVR)](https://github.com/AztecProtocol/aztec-packages/security/advisories/new)** for any other suspected vulnerability. Go to the "Security" tab of the repository and click "Report a vulnerability". |
| 108 | +3. **Email `security@aztec.foundation`** if neither Cantina nor PVR is available to you. Send a brief impact summary first, without exploit details or reproduction steps, and wait for the team to confirm a secure channel before sharing them. |
| 109 | + |
| 110 | +If you believe a vulnerability is being actively exploited or has severe impact (loss of funds, key compromise, or broad user impact), mark the report as **CRITICAL** in the PVR or email subject. |
| 111 | + |
| 112 | +See the full [security policy](https://github.com/AztecProtocol/aztec-packages/blob/next/SECURITY.md) for more. |
| 113 | + |
| 114 | +## What happens after you file |
| 115 | + |
| 116 | +When you file a GitHub issue using one of the templates above, it is automatically tagged so the team can triage it. A maintainer will: |
| 117 | + |
| 118 | +1. Confirm the component the issue belongs to. |
| 119 | +2. Set a priority based on impact. |
| 120 | +3. Ask follow-up questions if the report is missing a reproduction or context. |
| 121 | +4. Route the issue to the owning team. |
| 122 | + |
| 123 | +The fastest way to a fix is a small, runnable reproduction. If you can attach one, please do. |
| 124 | + |
| 125 | +## See also |
| 126 | + |
| 127 | +- [`CONTRIBUTING.md`](https://github.com/AztecProtocol/aztec-packages/blob/next/CONTRIBUTING.md) for contribution guidelines. |
| 128 | +- [`SECURITY.md`](https://github.com/AztecProtocol/aztec-packages/blob/next/SECURITY.md) for the full security disclosure policy. |
| 129 | +- The [Aztec project board](https://github.com/orgs/AztecProtocol/projects/22) for in-flight work. |
0 commit comments