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

Document how to capture assertion exceptions and show in a zkApp UI #264

Merged
merged 11 commits into from
Feb 11, 2023

Conversation

ymekuria
Copy link
Contributor

@ymekuria ymekuria commented Feb 9, 2023

Closes #232

This PR adds a section at the end of the section How to Write a zkApp UI on how to capture assertion errors and display helpful messages in the UI.

We can link to this page documenting all the assertion exceptions and ways to mitigate them when it is created.

@vercel
Copy link

vercel bot commented Feb 9, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 10, 2023 at 8:05PM (UTC)

Copy link
Contributor

@jasongitmail jasongitmail left a comment

Choose a reason for hiding this comment

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

Left a question, but approving.

Should we mention or show an example assertion that uses a custom error message of INSUFFICIENT_BALANCE so they understand how the pieces fit together? (I mean literally the assertion itself, and no other lines of surrounding code.)

docs/zkapps/how-to-write-a-zkapp-ui.mdx Outdated Show resolved Hide resolved
@jasongitmail jasongitmail merged commit 2f57ba3 into main Feb 11, 2023
@jasongitmail jasongitmail deleted the docs/display-errors-ui branch February 11, 2023 05:19
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.

Document how to capture assertion exceptions and show in a zkApp UI
2 participants