Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document confusing naming: noteHash == commitment #1679

Closed
Tracked by #1601
dbanks12 opened this issue Aug 20, 2023 · 2 comments · Fixed by #2127 or #2137
Closed
Tracked by #1601

Document confusing naming: noteHash == commitment #1679

dbanks12 opened this issue Aug 20, 2023 · 2 comments · Fixed by #2127 or #2137
Assignees
@suyash67
Labels
A-documentation Area: relates to documentation

Comments

@dbanks12
Copy link
Collaborator

No description provided.

@dbanks12 dbanks12 added the A-documentation Area: relates to documentation label Aug 20, 2023
@dbanks12 dbanks12 added this to A3 Aug 20, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Aug 20, 2023
@dbanks12 dbanks12 mentioned this issue Aug 20, 2023
Closed
@suyash67 suyash67 self-assigned this Aug 21, 2023
@iAmMichaelConnor iAmMichaelConnor modified the milestones: 🚀 Initial Aztec Sandbox Release, 📢 Initial Public Sandbox Release Aug 25, 2023
@dbanks12
Copy link
Collaborator Author

Either document or just fix....

@suyash67 suyash67 mentioned this issue Sep 8, 2023
Merged
4 tasks
@suyash67
Copy link
Contributor

suyash67 commented Sep 8, 2023

The PR #2066 changes "commitment" to "note_hash" all across the code base (only in places relevant to aztec notes). Even though we agreed that we should make the note nomenclature consistent, it doesn't seem to be wise to merge this PR for the following reasons:

  1. Biggest of all, I think this will ruin everyone’s life with unnecessary merge hell.
  2. While working on this, I feel “commitment” is still a standard name used in a lot of places (i.e. even the documentation of Merkle trees defines commitment as the leaf value, etc). This has been a well accepted and familiar term to the community and more importantly our engineers.
  3. If we want external noir devs to not be confused by “commitment”, its okay to keep “note_hash” only in noir (i.e. user facing code) and write in limitations that note_commitment means note_hash.

Therefore, PR #2127 takes over and only documents this "limitation".

suyash67 added a commit that referenced this issue Sep 8, 2023
@suyash67
chore(documentation): document noteCommitment vs noteHash (#2127)
73b484f 
resolves #1679
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Sep 8, 2023
This was referenced Sep 8, 2023
Closed
Merged
PhilWindle pushed a commit that referenced this issue Sep 8, 2023
@github-actions
chore(master): Release 0.5.2 (#2137)
ce90b1f 
🤖 I have created a release *beep* *boop*
---


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

##
[0.5.2](aztec-packages-v0.5.1...aztec-packages-v0.5.2)
(2023-09-08)


### Bug Fixes

* **build:** Config fixes for release please
([#2123](#2123))
([7b4f30d](7b4f30d))
* **build:** Don't include component in tag
([#2128](#2128))
([b588e3a](b588e3a))
* **build:** Updated version file
([#2131](#2131))
([30f9935](30f9935))
* Canary browser test transfer method
([#2126](#2126))
([a23b037](a23b037))
* File reference to canary docker-compose file
([#2124](#2124))
([13d3f16](13d3f16))
* Retry with -eu was suspect in retrospect
([#2110](#2110))
([7265c2a](7265c2a))


### Miscellaneous

* **build:** Enabled components in tags
([#2139](#2139))
([ccb38fb](ccb38fb))
* **build:** Fixed manifest
([#2122](#2122))
([91faa66](91faa66))
* **build:** Force a rebuild
([#2136](#2136))
([f26c9a0](f26c9a0))
* **build:** Reset version back
([#2132](#2132))
([750a757](750a757))
* **build:** Unify barretenberg releases with aztec-packages
([#2120](#2120))
([82823d8](82823d8))
* Delete broken bb Dockerfile.arm64-linux-gcc
([#2138](#2138))
([0f988b7](0f988b7))
* **documentation:** Document noteCommitment vs noteHash
([#2127](#2127))
([73b484f](73b484f)),
closes
[#1679](#1679)
* **master:** Release 0.6.0
([#2121](#2121))
([9bc8e11](9bc8e11))
</details>

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

##
[0.5.2](barretenberg.js-v0.5.1...barretenberg.js-v0.5.2)
(2023-09-08)


### Miscellaneous

* **master:** Release 0.6.0
([#2121](#2121))
([9bc8e11](9bc8e11))
</details>

<details><summary>barretenberg: 0.5.2</summary>

##
[0.5.2](barretenberg-v0.5.1...barretenberg-v0.5.2)
(2023-09-08)


### Miscellaneous

* **master:** Release 0.6.0
([#2121](#2121))
([9bc8e11](9bc8e11))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@suyash67 suyash67

Labels
A-documentation Area: relates to documentation
Projects
A3
Archived in project
Milestone
No milestone
3 participants
@suyash67 @iAmMichaelConnor @dbanks12