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

[docs]: add some partial notes docs #382

Closed
Tracked by #220
catmcgee opened this issue Sep 2, 2024 · 1 comment
Closed
Tracked by #220

[docs]: add some partial notes docs #382

catmcgee opened this issue Sep 2, 2024 · 1 comment
Assignees

Comments

@catmcgee
Copy link
Collaborator

catmcgee commented Sep 2, 2024

One request/modification - can we make the use cases section more tailored for external devs. Instead of a hyper specific example like FPC (which isn't relevant for most), lets use an app example:
DEX: Currently to swap privately, there are 2 tx: one to start your swap from ETH->DAI. And later to privately claim DAI from the DEX. Instead you can create a partial swaped note (create a DAI note with nil value). And in public complete it with the final amount!
Lending: same as DEX. Borrow privately and claim the borrowed token in 1 tx instead of 2!
Shielding: going from public -> private. We won't use partial notes for this case but still a good example to build mental models.
Refunds: original inspiration for partial notes. Currently you need 2 transactions: to initiate a refund. And another to claim refund note. We can combine to 1 step. In the example of fees on Aztec: without partial notes, you have to claim your refund note. But the act of claiming itself needs gas! What if you overpaid fees on the refund tx? Then you have another 2nd order refund that you need to claim. This creates a never ending cycle!

@critesjosh
Copy link
Collaborator

Shielding: going from public -> private. We won't use partial notes for this case but still a good example to build mental models.

Not sure if we should mention this if it's not going to be used. I feel like it could introduce confusion

critesjosh added a commit to AztecProtocol/aztec-packages that referenced this issue Sep 9, 2024
Included in this PR:
- updates to a key rotation page, closes
AztecProtocol/dev-rel#312
- update docs on unencrypted events, private functions cannot emit
unencrypted events. closes
AztecProtocol/dev-rel#377
- add detail on partial note use cases
AztecProtocol/dev-rel#382
- closes AztecProtocol/dev-rel#391
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants