feat: use zksync-error for halt and revert errors

[dutterbutter]

Note: This is branched off from #555 to initiate discussion on defining halt / revert errors and how we would prefer them displayed to users.

Once zksync-error repo is made public and #555 is updated / merged, and feedback is provided for error definitions / display I will prepare this PR to be merged.

The following etc/resources/anvil.json json file outlines the errors that could be hit based on the errors defined here. To make it easier to review and have discussion please refer to this Notion page where the json schema and display are also present for easier dialogue. Feedback would be appreciated, especially as many error cases I am unfamiliar with so assistance in properly defining cause / fixes would be helpful.

cc: @sayon @itegulov @popzxc

What 💻

• Uses zksync-error to define Halt and Revert errors to be displayed to users
• Adds definitions / documentation for those errors
• Related to Fix: CallErrorTracer Logging and Update Revert/Halt Handling #436 and [FEAT] Integrate error-codegen for insightful and actionable debugging #537

Why ✋

• Provide the user with informative and actionable error messaging

Evidence 📷

Include screenshots, screen recordings, or console output here demonstrating that your changes work as intended

Previous errors shown

03:11:55  INFO Unable to estimate gas for the request with our suggested gas limit of 104010000. The transaction is most likely unexecutable. Breakdown of estimation:
03:11:55  INFO 	Estimated transaction body gas cost: 80000000
03:11:55  INFO 	Gas for pubdata: 0
03:11:55  INFO 	Overhead: 10000
03:11:55  INFO execution reverted: Account validation error: Error function_selector = 0x03eb8b54, data = 0x03eb8b540000000000000000000000000000000000000000000000008ad7db82e7522d000000000000000000000000000000000000000000000000000010b87e5d6a2d00

Note: We print gas estimation details implying its a gas issue even though this error is the account having insufficient funds.

Defined structured errors shown

error: [anvil-halt-1] Account validation error: InsufficientFunds(uint256,uint256): 03eb8b540000000000000000000000000000000000000000000000008ad7db82e7522d000000000000000000000000000000000000000000000000000010b87e5d6a2d00
    |
    = error: Account validation failed during execution.
    | 
    | Transaction details:
    |   Transaction Type: EIP1559Transaction
    |   Nonce: 0
    |   To: 0x36615cf349d7f6344891b1e7ca7c72883f5dc049
    |   From: 0xfac041bcf2c4b43319c2c0a39aba53f4cbe44fe5
    |   Gas Limit: 0
    |   Gas Price: 0.04525000 gwei
    |   Gas Per Pubdata Limit: 50000
    | 
    | Likely causes:
    |   - Insufficient funds to cover transaction costs.
    |   - Invalid account state or credentials.
    | 
    | Possible fixes:
    |   - Add enough balance to the account to pay for gas and the transaction amount.
    |   - Verify that the account used has a valid signature and nonce.
    |
note: This error occurs when the account validation step fails during the verification and execution of a transaction.
error: transaction execution halted due to the above error

Note: same error.

[dutterbutter]

Not sure how to handle linting checks for zksync-error crate given its mostly auto generated?

[popzxc]

Not sure how to handle linting checks for zksync-error crate given its mostly auto generated?

Normally the generated code must have all the related allow(clippy::whatever) attributes. E.g. it should be handled by the codegen.

[dutterbutter]

Not sure how to handle linting checks for zksync-error crate given its mostly auto generated?

Normally the generated code must have all the related allow(clippy::whatever) attributes. E.g. it should be handled by the codegen.

@sayon can you add that to the library please 🙏

[sayon]

Sure, I am currently cleaning the generator and will make it produce a warning-free code.

[popzxc]

Overall I think it's a great effort and I like what I see a lot

[popzxc]

Agreed

[popzxc]

Something we need to figure out about hierarchy: I guess these errors would be the same for the main node.
How do we avoid duplication? Should the domain be EraVM maybe? Although then it becomes a bit less clear how to share the error definitions between anvil-zksync and core. Hmm..

[dutterbutter]

Yes, very much so agree. Unfortunately cannot use EraVM here as its already defined in the error definitions.

It would be nice to have conformity, a written standard / policy perhaps, that keeps error code component naming conventional?

[sayon]

We can define another piece of error hierarchy related to eravm and wrap these errors as a field or one of anvil errors. It would however require to simulateneously change eravm code, or writing an adapter here. I will produce an example to illustrate wrapping

[popzxc]

I was thinking more about changing the error schema as it evolves. Writing adapters makes it even more complex.
OTOH once these errors are battle-tested, we can move them to EraVM scope and deprecate them here.