o1-labs / docs2

Docs website for the Mina Protocol.
https://docs.minaprotocol.com
90 stars 133 forks source link

Page which explains each possible transaction failure in 1-2 paragraphs #263

Open mitschabaude opened 1 year ago

mitschabaude commented 1 year ago

There is a known list of reasons for failing transactions, that zkApp developers are frequently confronted with.

Here's a snapshot of the list: https://github.com/MinaProtocol/mina/blob/release/2.0.0/src/lib/mina_base/transaction_status.ml#L341

We need to document what these mean to help developers move more quickly.

Note: There are already 1-sentence descriptions in the code (link above), but these are simply not enough to help with understanding the error. Just a bit more detail, plus an example how this could occur, plus a suggestion for how to mitigate it, would improve it a lot.

ymekuria commented 1 year ago

This will be very helpful for devs. Once we document these failures, we can also better guide devs to show helpful error messages for their zkApp users in their UI's

jasongitmail commented 1 year ago

Prior version: https://github.com/MinaProtocol/docs/blob/main/pages/en/node-operators/transaction-failures.mdx

jasongitmail commented 1 year ago

It sounds like Protocol team is going to work on this page CC @deepthiskumar