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

docs(yellow-paper): Note hash, nullifier, and public data trees #3518

Merged
merged 1 commit into from
Dec 6, 2023
Merged

docs(yellow-paper): Note hash, nullifier, and public data trees #3518

merged 1 commit into from
Dec 6, 2023

Conversation

spalladino
Copy link
Collaborator

Related to #3087

@spalladino spalladino mentioned this pull request Dec 1, 2023
Closed
LHerskind
LHerskind approved these changes Dec 6, 2023
View reviewed changes
Copy link
Contributor

@LHerskind LHerskind left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good. Will be extending on it for state in a separate PR.

yellow-paper/docs/state/index.md

# State

Global state in the Aztec Network is represented by a set of Merkle trees: the [Note Hash tree](./note_hash_tree.md), [Nullifier tree](./nullifier_tree.md), and [Public Data tree](./public_data_tree.md) reflect the latest state of the chain.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are additional state. But I will add it in an extension to this pr.

yellow-paper/docs/state/index.md

Global state in the Aztec Network is represented by a set of Merkle trees: the [Note Hash tree](./note_hash_tree.md), [Nullifier tree](./nullifier_tree.md), and [Public Data tree](./public_data_tree.md) reflect the latest state of the chain.

Merkle trees are either [append-only](./tree_impls.md#append-only-merkle-trees), for storing immutable data, or [indexed](./tree_impls.md#indexed-merkle-trees), for storing data that requires proofs of non-membership.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the wording with immutable can be a little weird. The nullifiers are immutable, but the leaves in the tree won't be because of the successor references.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, but it's not a property of indexed trees to have immutable values (eg the public data tree is indexed and not immutable).

yellow-paper/docs/state/note_hash_tree.md

The Note Hash tree is an [append-only Merkle tree](./tree_impls.md#append-only-merkle-trees) that stores siloed note hashes as its elements. Each element in the tree is a 254-bit altBN-254 scalar field element. This tree is part of the global state, and allows to prove existence of private notes via Merkle membership proofs.

Note commitments are immutable once created, since notes cannot be modified. Still, notes can be consumed, which means they can no longer be used. To preserve privacy, a consumed note is not removed from the tree, otherwise it would be possible to link the transaction that created a note with the one that consumed it. Instead, a note is consumed by emitting a deterministic [nullifier](./nullifier_tree.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably be very consistent on calling either commitments or note hashes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. Do we have a consensus on which we should use?

@LHerskind LHerskind merged commit 0e2db8b into master Dec 6, 2023
3 checks passed
@LHerskind LHerskind deleted the palla/yellow-paper-l2-state branch December 6, 2023 16:11
@AztecBot AztecBot mentioned this pull request Dec 6, 2023
Merged
alexghr pushed a commit that referenced this pull request Dec 6, 2023
@AztecBot
chore(master): Release 0.16.7 (#3603)
080230c 
🤖 I have created a release *beep* *boop*
---


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

##
[0.16.7](aztec-packages-v0.16.6...aztec-packages-v0.16.7)
(2023-12-06)


### Features

* Encapsulated Goblin
([#3524](#3524))
([2f08423](2f08423))


### Bug Fixes

* Extract whole archive instead of subset
([#3604](#3604))
([cb000d8](cb000d8))


### Documentation

* **yellow-paper:** Note hash, nullifier, and public data trees
([#3518](#3518))
([0e2db8b](0e2db8b))
</details>

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

##
[0.16.7](barretenberg.js-v0.16.6...barretenberg.js-v0.16.7)
(2023-12-06)


### Miscellaneous

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

<details><summary>barretenberg: 0.16.7</summary>

##
[0.16.7](barretenberg-v0.16.6...barretenberg-v0.16.7)
(2023-12-06)


### Features

* Encapsulated Goblin
([#3524](#3524))
([2f08423](2f08423))
</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 Dec 7, 2023
@AztecBot
chore(master): Release 0.16.7 (#3603)
14ad7d4 
🤖 I have created a release *beep* *boop*
---


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

##
[0.16.7](AztecProtocol/aztec-packages@aztec-packages-v0.16.6...aztec-packages-v0.16.7)
(2023-12-06)


### Features

* Encapsulated Goblin
([#3524](AztecProtocol/aztec-packages#3524))
([2f08423](AztecProtocol/aztec-packages@2f08423))


### Bug Fixes

* Extract whole archive instead of subset
([#3604](AztecProtocol/aztec-packages#3604))
([cb000d8](AztecProtocol/aztec-packages@cb000d8))


### Documentation

* **yellow-paper:** Note hash, nullifier, and public data trees
([#3518](AztecProtocol/aztec-packages#3518))
([0e2db8b](AztecProtocol/aztec-packages@0e2db8b))
</details>

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

##
[0.16.7](AztecProtocol/aztec-packages@barretenberg.js-v0.16.6...barretenberg.js-v0.16.7)
(2023-12-06)


### Miscellaneous

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

<details><summary>barretenberg: 0.16.7</summary>

##
[0.16.7](AztecProtocol/aztec-packages@barretenberg-v0.16.6...barretenberg-v0.16.7)
(2023-12-06)


### Features

* Encapsulated Goblin
([#3524](AztecProtocol/aztec-packages#3524))
([2f08423](AztecProtocol/aztec-packages@2f08423))
</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

@LHerskind LHerskind LHerskind approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@spalladino @LHerskind