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

Update token docs #444

Closed
critesjosh opened this issue Nov 13, 2024 · 0 comments · Fixed by AztecProtocol/aztec-packages#9954
Closed

Update token docs #444

critesjosh opened this issue Nov 13, 2024 · 0 comments · Fixed by AztecProtocol/aztec-packages#9954
Assignees
Milestone

Comments

@critesjosh
Copy link
Collaborator

this PR: AztecProtocol/aztec-packages#9606

From Jan:
I recently did a ton of changes to the token:

  • introduced new "shield" flow that leverages partial notes,
  • nuked the old "shield" flow,
  • renamed a few functions (that should already be fixed in the docs),
  • updated token bridging to use the new "shield" flow.

Since the token is used quite widely a lot of the docs is quite outdated.
Anything that contains the following words needs to get updated:secret_hash_for_redeeming_minted_notes, shield, redeem_shield or TransparentNote . The secret_hash_for_redeeming_minted_notes should not be in the docs anywhere because now the L1->L2 message never contains that value since there is no longer any TransparentNote (that hash was the hash used in the transparent note).

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 a pull request may close this issue.

1 participant