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(AuthWit): Add more examples and extend docs #3092

Closed
Tracked by #2658
critesjosh opened this issue Oct 27, 2023 · 6 comments
Closed
Tracked by #2658

docs(AuthWit): Add more examples and extend docs #3092

critesjosh opened this issue Oct 27, 2023 · 6 comments
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback

Comments

@critesjosh
Copy link
Contributor

The current references to the authwit patterns rely heavily on token examples. Create additional references and link to them in the docs.

Some additional use cases to consider:

  • multisig accounts
  • token transfers from other contracts. example here
@critesjosh critesjosh added A-documentation Area: relates to documentation T-feedback Type: recording user feedback labels Oct 27, 2023
@critesjosh
Copy link
Contributor Author

critesjosh commented Mar 7, 2024

Document we return IS_VALID_SELECTOR instead of a boolean from is_valid? It’s due to risk of accidentally calling another function with the same selector or a fallback function that returns something that gets understood by the caller as a boolean. But it’s not documented anywhere.

https://docs.google.com/document/d/1BERcO9Aj1N9lU79pYWlJJiGfVDwMD680oVWJp_QI2QM/edit

@LHerskind LHerskind changed the title Add more Authwit examples and add to docs docs(AuthWit): Add more examples and extend docs Mar 8, 2024
@LHerskind LHerskind added this to the Developer Facing Aztec.nr milestone Mar 8, 2024
@benesjan
Copy link
Contributor

I was considering picking up this issue but the ikigai example is too outdated and unfinished to use it as reference and regarding the multisig it would make sense to wait for it to be merged so that we can use the #include_code macro without which it would most likely get outdated and broken.

@critesjosh Do you know what is blocking the multisig from being merged?

@critesjosh
Copy link
Contributor Author

@spalladino did some low level hacking around the kernel circuits, iirc, and I'm not sure that the changes we made ever made it into master.

@spalladino
Copy link
Collaborator

They didn't, as they require calling a private function as unconstrained from a contract, which I don't know whether it's tracked.

@critesjosh
Copy link
Contributor Author

closed by #6220

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: relates to documentation T-feedback Type: recording user feedback
Projects
Archived in project
Development

No branches or pull requests

4 participants