Skip to content

chore: update docs about integer overflows#7370

Merged
TomAFrench merged 1 commit intomasterfrom
ab/update-overflow-docs
Feb 13, 2025
Merged

chore: update docs about integer overflows#7370
TomAFrench merged 1 commit intomasterfrom
ab/update-overflow-docs

Conversation

@asterite
Copy link
Collaborator

@asterite asterite commented Feb 13, 2025

Description

Problem

Resolves #7367

Summary

The code in the docs doesn't end up producing an overflow so here it's changed to do so. Also an explanation of when overflows might not be triggered is added.

Additional Context

Documentation

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 13, 2025
@TomAFrench TomAFrench changed the title fix: update docs about integer overflows chore: update docs about integer overflows Feb 13, 2025
@TomAFrench TomAFrench enabled auto-merge February 13, 2025 14:53
@github-actions
Copy link
Contributor

github-actions bot commented Feb 13, 2025

🚀 Deployed on https://67ae0903d7c1a2e227fed724--noir-docs.netlify.app

@github-actions
Copy link
Contributor

github-actions bot commented Feb 13, 2025

FYI @noir-lang/developerrelations on Noir doc changes.

@TomAFrench TomAFrench added this pull request to the merge queue Feb 13, 2025
Merged via the queue into master with commit fd37b1f Feb 13, 2025
105 checks passed
@TomAFrench TomAFrench deleted the ab/update-overflow-docs branch February 13, 2025 15:15
TomAFrench added a commit that referenced this pull request Feb 13, 2025
@TomAFrench
Merge branch 'master' into tf/optimize-brillig-radix
6ca45a6 
* master:
  chore: avoid u128s in brillig memory (#7363)
  chore: update docs about integer overflows (#7370)
  fix!: Only decrement the counter of an array if its address has not changed (#7297)
  fix: let LSP read `noirfmt.toml` for formatting files (#7355)
  chore: deprecate keccak256 (#7361)
AztecBot pushed a commit to AztecProtocol/aztec-packages that referenced this pull request Feb 13, 2025
[1 changes] chore: avoid u128s in brillig memory (noir-lang/noir#7363)
986ba4c 
chore: update docs about integer overflows (noir-lang/noir#7370)
fix!: Only decrement the counter of an array if its address has not changed (noir-lang/noir#7297)
fix: let LSP read `noirfmt.toml` for formatting files (noir-lang/noir#7355)
@AztecBot AztecBot mentioned this pull request Feb 13, 2025
Merged
TomAFrench added a commit to AztecProtocol/aztec-packages that referenced this pull request Feb 13, 2025
@AztecBot @TomAFrench
feat: Sync from noir (#11995)
4d35d2f 
Automated pull of development from the
[noir](https://github.com/noir-lang/noir) programming language, a
dependency of Aztec.
BEGIN_COMMIT_OVERRIDE
chore: avoid u128s in brillig memory
(noir-lang/noir#7363)
chore: update docs about integer overflows
(noir-lang/noir#7370)
fix!: Only decrement the counter of an array if its address has not
changed (noir-lang/noir#7297)
fix: let LSP read `noirfmt.toml` for formatting files
(noir-lang/noir#7355)
END_COMMIT_OVERRIDE

---------

Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
@AztecBot AztecBot mentioned this pull request Feb 13, 2025
Merged
TomAFrench added a commit that referenced this pull request Feb 14, 2025
@TomAFrench
Merge branch 'master' into tf/u128-hacky
5d8f6c5 
* master: (42 commits)
  fix: give "correct" error when trying to use AsTraitPath (#7360)
  chore: avoid u128s in brillig memory (#7363)
  chore: update docs about integer overflows (#7370)
  fix!: Only decrement the counter of an array if its address has not changed (#7297)
  fix: let LSP read `noirfmt.toml` for formatting files (#7355)
  chore: deprecate keccak256 (#7361)
  feat: `FunctionDefinition::as_typed_expr` (#7358)
  feat(performance): Check sub operations against induction variables (#7356)
  chore: avoid doing all brillig integer arithmetic on u128s (#7357)
  feat(cli): Add `--target-dir` option (#7350)
  fix(ssa): Make the lookback feature opt-in (#7190)
  feat(performance): Use unchecked ops based upon known induction variables (#7344)
  chore: mark sha256 as deprecated from the stdlib (#7351)
  fix: incorrect secondary file in LSP errors (#7347)
  chore: Basic test for MSM in Noir to catch performance improvements and regressions (#7341)
  fix(cli): Only lock the packages selected in the workspace (#7345)
  chore: remove some unused types and functions in the AST (#7339)
  chore: remove foreign calls array from Brillig VM constructor (#7337)
  chore(ci): Add Vecs and vecs to cspell (#7342)
  chore: redo typo PR by osrm (#7238)
  ...
TomAFrench added a commit that referenced this pull request Feb 14, 2025
@TomAFrench
Merge branch 'master' into mv/duplicate-brillig-entry-points-called-f…
13e1dc3 
…rom-brillig

* master:
  chore: allow opting in to displaying benchmark comments (#7399)
  chore: box `ExprValue` in `Value` enum (#7388)
  chore: pull out refactored methods from u128 branch (#7385)
  feat: require safety comments instead of safety doc comments (#7295)
  fix(ssa): Do not deduplicate division by a zero constant (#7393)
  chore: document traits required to be in scope (#7387)
  fix: field zero division in brillig (#7386)
  chore: box `ParserError`s in `InterpreterError` (#7373)
  chore: remove unnecessary dereferencing within brillig vm (#7375)
  fix: give "correct" error when trying to use AsTraitPath (#7360)
  chore: avoid u128s in brillig memory (#7363)
  chore: update docs about integer overflows (#7370)
  fix!: Only decrement the counter of an array if its address has not changed (#7297)
  fix: let LSP read `noirfmt.toml` for formatting files (#7355)
  chore: deprecate keccak256 (#7361)
  feat: `FunctionDefinition::as_typed_expr` (#7358)
  feat(performance): Check sub operations against induction variables (#7356)
  chore: avoid doing all brillig integer arithmetic on u128s (#7357)
rahul-kothari pushed a commit to AztecProtocol/aztec-packages that referenced this pull request Mar 5, 2025
@AztecBot
chore(master): Release 0.77.0 (#11985)
d041cbc 
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.77.0</summary>

##
[0.77.0](aztec-package-v0.76.4...aztec-package-v0.77.0)
(2025-02-14)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg.js: 0.77.0</summary>

##
[0.77.0](barretenberg.js-v0.76.4...barretenberg.js-v0.77.0)
(2025-02-14)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>aztec-packages: 0.77.0</summary>

##
[0.77.0](aztec-packages-v0.76.4...aztec-packages-v0.77.0)
(2025-02-14)


### ⚠ BREAKING CHANGES

* Only decrement the counter of an array if its address has not changed
(noir-lang/noir#7297)

### Features

* PIL relations modifications for bc decomposition
([#11935](#11935))
([6c93058](6c93058))
* Poseidon2 in vm2
([#11597](#11597))
([2c199d8](2c199d8))
* Refactor `append_tx_effects_for_blob`
([#11805](#11805))
([e5a055b](e5a055b))


### Bug Fixes

* **docs:** Update token bridge diagram
([#11982](#11982))
([e5da9ed](e5da9ed))
* Let LSP read `noirfmt.toml` for formatting files
(noir-lang/noir#7355)
([4d35d2f](4d35d2f))
* Only decrement the counter of an array if its address has not changed
(noir-lang/noir#7297)
([4d35d2f](4d35d2f))
* Test more prover agents devnet
([#11990](#11990))
([f12be5f](f12be5f))


### Miscellaneous

* Avoid u128s in brillig memory
(noir-lang/noir#7363)
([4d35d2f](4d35d2f))
* **ci:** Downgrade 4epochs test to transfer test
([#11983](#11983))
([2340aab](2340aab))
* Explanations about skippable
([#11984](#11984))
([19589bc](19589bc))
* Op wires index from 0
([#11986](#11986))
([be1b563](be1b563))
* Prep for ci3
([8edee9e](8edee9e))
* Remove browser test
([3e570be](3e570be))
* Replace relative paths to noir-protocol-circuits
([b8ba716](b8ba716))
* Some polishing on the skippable document
([#11997](#11997))
([50e0a38](50e0a38))
* Update docs about integer overflows
(noir-lang/noir#7370)
([4d35d2f](4d35d2f))
</details>

<details><summary>barretenberg: 0.77.0</summary>

##
[0.77.0](barretenberg-v0.76.4...barretenberg-v0.77.0)
(2025-02-14)


### Features

* PIL relations modifications for bc decomposition
([#11935](#11935))
([6c93058](6c93058))
* Poseidon2 in vm2
([#11597](#11597))
([2c199d8](2c199d8))


### Miscellaneous

* Explanations about skippable
([#11984](#11984))
([19589bc](19589bc))
* Op wires index from 0
([#11986](#11986))
([be1b563](be1b563))
* Some polishing on the skippable document
([#11997](#11997))
([50e0a38](50e0a38))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
AztecBot added a commit to AztecProtocol/barretenberg that referenced this pull request Mar 6, 2025
@AztecBot
chore(master): Release 0.77.0 (#11985)
0653c46 
🤖 I have created a release *beep* *boop*
---


<details><summary>aztec-package: 0.77.0</summary>

##
[0.77.0](AztecProtocol/aztec-packages@aztec-package-v0.76.4...aztec-package-v0.77.0)
(2025-02-14)


### Miscellaneous

* **aztec-package:** Synchronize aztec-packages versions
</details>

<details><summary>barretenberg.js: 0.77.0</summary>

##
[0.77.0](AztecProtocol/aztec-packages@barretenberg.js-v0.76.4...barretenberg.js-v0.77.0)
(2025-02-14)


### Miscellaneous

* **barretenberg.js:** Synchronize aztec-packages versions
</details>

<details><summary>aztec-packages: 0.77.0</summary>

##
[0.77.0](AztecProtocol/aztec-packages@aztec-packages-v0.76.4...aztec-packages-v0.77.0)
(2025-02-14)


### ⚠ BREAKING CHANGES

* Only decrement the counter of an array if its address has not changed
(noir-lang/noir#7297)

### Features

* PIL relations modifications for bc decomposition
([#11935](AztecProtocol/aztec-packages#11935))
([6c93058](AztecProtocol/aztec-packages@6c93058))
* Poseidon2 in vm2
([#11597](AztecProtocol/aztec-packages#11597))
([2c199d8](AztecProtocol/aztec-packages@2c199d8))
* Refactor `append_tx_effects_for_blob`
([#11805](AztecProtocol/aztec-packages#11805))
([e5a055b](AztecProtocol/aztec-packages@e5a055b))


### Bug Fixes

* **docs:** Update token bridge diagram
([#11982](AztecProtocol/aztec-packages#11982))
([e5da9ed](AztecProtocol/aztec-packages@e5da9ed))
* Let LSP read `noirfmt.toml` for formatting files
(noir-lang/noir#7355)
([4d35d2f](AztecProtocol/aztec-packages@4d35d2f))
* Only decrement the counter of an array if its address has not changed
(noir-lang/noir#7297)
([4d35d2f](AztecProtocol/aztec-packages@4d35d2f))
* Test more prover agents devnet
([#11990](AztecProtocol/aztec-packages#11990))
([f12be5f](AztecProtocol/aztec-packages@f12be5f))


### Miscellaneous

* Avoid u128s in brillig memory
(noir-lang/noir#7363)
([4d35d2f](AztecProtocol/aztec-packages@4d35d2f))
* **ci:** Downgrade 4epochs test to transfer test
([#11983](AztecProtocol/aztec-packages#11983))
([2340aab](AztecProtocol/aztec-packages@2340aab))
* Explanations about skippable
([#11984](AztecProtocol/aztec-packages#11984))
([19589bc](AztecProtocol/aztec-packages@19589bc))
* Op wires index from 0
([#11986](AztecProtocol/aztec-packages#11986))
([be1b563](AztecProtocol/aztec-packages@be1b563))
* Prep for ci3
([8edee9e](AztecProtocol/aztec-packages@8edee9e))
* Remove browser test
([3e570be](AztecProtocol/aztec-packages@3e570be))
* Replace relative paths to noir-protocol-circuits
([b8ba716](AztecProtocol/aztec-packages@b8ba716))
* Some polishing on the skippable document
([#11997](AztecProtocol/aztec-packages#11997))
([50e0a38](AztecProtocol/aztec-packages@50e0a38))
* Update docs about integer overflows
(noir-lang/noir#7370)
([4d35d2f](AztecProtocol/aztec-packages@4d35d2f))
</details>

<details><summary>barretenberg: 0.77.0</summary>

##
[0.77.0](AztecProtocol/aztec-packages@barretenberg-v0.76.4...barretenberg-v0.77.0)
(2025-02-14)


### Features

* PIL relations modifications for bc decomposition
([#11935](AztecProtocol/aztec-packages#11935))
([6c93058](AztecProtocol/aztec-packages@6c93058))
* Poseidon2 in vm2
([#11597](AztecProtocol/aztec-packages#11597))
([2c199d8](AztecProtocol/aztec-packages@2c199d8))


### Miscellaneous

* Explanations about skippable
([#11984](AztecProtocol/aztec-packages#11984))
([19589bc](AztecProtocol/aztec-packages@19589bc))
* Op wires index from 0
([#11986](AztecProtocol/aztec-packages#11986))
([be1b563](AztecProtocol/aztec-packages@be1b563))
* Some polishing on the skippable document
([#11997](AztecProtocol/aztec-packages#11997))
([50e0a38](AztecProtocol/aztec-packages@50e0a38))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TomAFrench TomAFrench TomAFrench approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Missing overflow on integers

2 participants

@asterite @TomAFrench