Repository navigation
chore: add experimental software warning to README - #23
Merged
Merged
Conversation
TomAFrench
approved these changes
Oct 20, 2026
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
2 participants
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.
Adds a
> [!WARNING]callout to the top of the README. It says sparse_array is experimental, has not been fully audited, and is not guaranteed to be secure. It also warns that bugs can produce under-constrained circuits that accept invalid proofs.The wording follows the noir-lang/noir README ("It has not been reviewed or audited... Expect bugs!") and the AztecProtocol/aztec-packages SECURITY.md ("novel software, so we expect there to be bugs"). It matches the warning in noir-bignum and noir_bigcurve#131.
Unlike the noir-bignum version, this callout does not point to private vulnerability reporting, because that is disabled on this repo (
GET /repos/noir-lang/sparse_array/private-vulnerability-reportingreturnsenabled: false). It keeps the "as is / see LICENSE" sentence, because the repo has a LICENSE file.The
LICENSEcopyright notice names both holders,Copyright 2024-2025 Aztec LabsandCopyright 2026 Aztec Foundation, because ownership moved to the Foundation in 2026. It replaces the Apache template placeholderCopyright [yyyy] [name of copyright owner].The PR also ports the CI fix from noir-bignum@4bdf96a, which CI needs after the change to how Noir is released. It bumps
noir-lang/noirupto v0.1.5. It also changes the supported-version query intest.yml, because Noir'sv1.0.0-*releases are now marked as pre-releases. The query no longer excludes pre-releases, filters outnightly-*tags, and strips thevprefix.MINIMUM_NOIR_VERSIONdrops itsvprefix to match.Created by claudebox · group:
slackbot· requested by Tom (@TomAFrench) · Slack thread