-
Notifications
You must be signed in to change notification settings - Fork 615
feat(docs): Notes page #11746
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.
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
Merged
Merged
feat(docs): Notes page #11746
Changes from 69 commits
Commits
Show all changes
72 commits
Select commit
Hold shift + click to select a range
9c6c3e1
initial restructure, broken
catmcgee eb30ea7
scripts
catmcgee 978dc5d
sidebars
catmcgee 4b490bb
some links
catmcgee 674b776
concepts rearranging
catmcgee cdc1fec
fix build
catmcgee 6098351
Merge branch 'master' into docs/restructure-feedback
catmcgee d347638
node docs drqafts
catmcgee 6bcafcc
tidied up
catmcgee 23e9868
governance and upgrades docs
catmcgee 5015d04
tyo
catmcgee 308fbe7
Merge remote-tracking branch 'origin' into docs/restructure-feedback
catmcgee 05642b7
bb
catmcgee 70fbcba
bb
catmcgee 60558f7
bb
catmcgee dff94a9
broken links
catmcgee b8bc309
prover docs
catmcgee 371f58c
Merge branch 'master' into docs/restructure-feedback
catmcgee c05d1b5
upgrades
catmcgee e78f17a
added aztec strqter
catmcgee 19b5f58
broken links
catmcgee 865108c
Merge branch 'master' into docs/restructure-feedback
catmcgee 5a2024f
redirects
catmcgee b381605
merge
catmcgee f0b8c90
oops
catmcgee d6a88e8
Merge branch 'master' into docs/restructure-feedback
catmcgee 947b942
delete unnecessary index page
catmcgee 294a2b8
build
catmcgee 9849ded
Merge remote-tracking branch 'origin/master' into docs/restructure-fe…
catmcgee a84275f
links
catmcgee a20f348
title
catmcgee 2e21362
some final touches
catmcgee fdd1fab
feedback
catmcgee 93dcf0c
feedback
catmcgee 8af9988
pedro suggestions
catmcgee 3a5d9a4
sequencer concept docs are drafts
catmcgee cadb097
conflicts
catmcgee f13dbaf
bb
catmcgee 6b50ded
bb
catmcgee a97ebbb
bb
catmcgee e068808
paclagejson
catmcgee 9c96ce6
yarnlock
catmcgee ead0d23
setting soe things as drafts
catmcgee 061a1ba
broken links
catmcgee d93fe61
Merge branch 'master' into docs/restructure-feedback
catmcgee bfefcb1
Merge branch 'master' into docs/restructure-feedback
catmcgee 152d9a3
remove network concepts (per amin, outdated)
catmcgee a8eb27f
remove references to network docs
catmcgee 3f14bb8
pls build
catmcgee 096e1cb
Merge branch 'master' into docs/restructure-feedback
catmcgee c5e4cdc
monorepo links
catmcgee e1fa087
Merge branch 'master' into docs/restructure-feedback
catmcgee 019a009
Merge branch 'master' into docs/restructure-feedback
catmcgee ffb268b
bbg
catmcgee d2f1a79
bb
catmcgee a55717c
josh suggestison
catmcgee 5b47f05
mistek
catmcgee 4e77e2e
fix build
critesjosh 3d5d9cc
Merge branch 'master' into docs/restructure-feedback
critesjosh 9bf540f
remove comments from docusaursu config
catmcgee a6f1624
Merge branch 'master' into docs/restructure-feedback
catmcgee 43d4c29
Merge remote-tracking branch 'origin' into docs/restructure-feedback
catmcgee 260bf03
note page
catmcgee 83e7bbf
Merge remote-tracking branch 'origin' into docs/notes-page
catmcgee 95202db
notes pae
catmcgee 8671153
Merge branch 'master' into docs/notes-page
catmcgee 9a27a87
notes docs
catmcgee 51e3b6e
broken anchor
catmcgee 3098529
Merge branch 'master' into docs/notes-page
catmcgee 2b47ebe
Apply suggestions from code review
catmcgee da0fa33
Update notes.md
catmcgee c6c0493
edits
critesjosh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| --- | ||
| title: Notes (UTXOs) | ||
| sidebar_position: 5 | ||
| tags: [notes, storage] | ||
| --- | ||
|
|
||
| import Image from "@theme/IdealImage"; | ||
|
|
||
| The [state model page](./state_model.md) explains that there is a difference between public and private state. Private state uses UTXOs, also known as notes. This page introduces the concept of UTXOs and how notes are abstracted on Aztec. | ||
|
|
||
| ## What are notes? | ||
|
|
||
| In an account-based model such as Ethereum, each account owns a specific amount of asset. In a UTXO model, each note has an owner. Notes are encrypted pieces of data that can only be decrypted by their owner. To change the owner of a note, Aztec destroys the original note, creates a nullifier, and creates a new note that is encrypted to the new owner. This helps to maintain privacy. | ||
|
catmcgee marked this conversation as resolved.
Outdated
|
||
|
|
||
| <Image img={require("/img/public-and-private-state-diagram.png")} /> | ||
|
|
||
| Notes are comparable to cash. When you want to spend $3.50 USD in real life, you give your $5 note to a cashier who will keep $3.50 and give you separate notes that add up to $1.50. Only you and the cashier are aware of this transaction. | ||
|
|
||
| ## Abstracting notes from from apps & users | ||
|
|
||
| When using the Aztec protocol, users may not be aware of the specific notes that they own. Their experience should be similar to Ethereum, and should instead see the amount of their assets inside their account. | ||
|
|
||
| This is accomplished through the smart contract library, Aztec.nr, which abstracts notes by allowing developers to specify their own note types. This means they can specify how they are interacted with, nullified, transferred, and displayed. | ||
|
catmcgee marked this conversation as resolved.
Outdated
|
||
|
|
||
| To understand note abstraction in Aztec.nr, you can read the [Build section](../../../developers/guides/smart_contracts/writing_contracts/notes/index.md). | ||
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we say what UTXOs are (unspent transaction outputs, similar to bitcoin) ? Or should we assume this is pre-requisite knowledge?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i added a
(unspent transaction outputs)which i think is enough considering the rest of the page