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.

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

feat(docs): Note discovery concepts page #11760

Merged
merged 17 commits into from
Feb 18, 2025
Merged

feat(docs): Note discovery concepts page #11760

merged 17 commits into from
Feb 18, 2025

Conversation

catmcgee
Copy link
Contributor

@catmcgee catmcgee commented Feb 5, 2025

Closes #10497

and a couple nits

@catmcgee catmcgee self-assigned this Feb 5, 2025
@catmcgee catmcgee marked this pull request as ready for review February 6, 2025 14:17
@catmcgee catmcgee requested a review from a team February 6, 2025 14:17
@AztecBot
Copy link
Collaborator

AztecBot commented Feb 6, 2025

Docs Preview

Hey there! 👋 You can check your preview at https://67a4d6e94f0fca2b3abdb0ed--aztec-docs-dev.netlify.app

Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

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

Some minor comments attempting to add clarity.

Copy link
Contributor

Choose a reason for hiding this comment

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

After reading through the page that you added, wondering if we should add info to this page about the various ways that creators of notes can "send" notes to recipients? E.g. Emit them as encrypted logs or share them out of band (offchain), or for notes that are created for yourself, you don't have to emit or share anything, but you need to make sure you have that note information available to spend the note

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added some info

@critesjosh critesjosh requested a review from nventuro February 7, 2025 10:21

### Off-chain communication

Another proposed solution is having the sender give the note content to the recipient via some off-chain communication. While it solves the brute force issue, it introduces reliance on side channels which we don't want in a self-sufficient network. This option incurs lower transaction costs because fewer logs needs to be posted on-chain.
Copy link
Contributor

Choose a reason for hiding this comment

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

It should be noted that Aztec apps will be able to do this if they wish

Comment on lines 33 to 35
#### Discovering notes in Aztec contracts

This note discovery scheme is implemented by Aztec contracts rather than by the PXE. This means that users can update or use other types of note discovery to suit their needs.
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not true atm, though we will eventually achieve this, perhaps around June 2025.

catmcgee and others added 2 commits February 11, 2025 18:54
Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>
@catmcgee catmcgee merged commit 2979bbd into master Feb 18, 2025
12 checks passed
@catmcgee catmcgee deleted the docs/note-discovery branch February 18, 2025 13:33
TomAFrench added a commit that referenced this pull request Feb 19, 2025
* master: (245 commits)
  chore: Fix unbound CI variable on release image bootstrap (#12095)
  fix: dry run on grind (#12088)
  fix(spartan): eth-execution logging (#12094)
  fix: aws_handle_evict recovery & termination (#12086)
  chore: Use native acvm when available on orchestrator tests (#11560)
  refactor: function macros cleanup (#12066)
  refactor: remove `addNullifiedNote` from pxe (#11822)
  fix: `#[aztec]` macro warnings (#12038)
  refactor!: Notes implementing `Packable<N>` (#12004)
  chore(ops): add gcloud cli into devbox base image (#12082)
  fix: hotfix grinding
  fix: L1 deployment on reth (#12060)
  fix: Add missing bootstrap fast aliases (#12078)
  fix: hash_str caching (#12074)
  fix: Naive attempt to fix nightly deployments (#12079)
  fix: kind smoke (#12084)
  refactor!: nuking `NoteHeader` (#11942)
  fix: inject dockerhub creds (#12072)
  feat(docs): Note discovery concepts page (#11760)
  chore: cleanup libp2p logger (#12058)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Note discovery concepts page
4 participants