feat(forge): error hints

[onbjerg]

Motivation

Some cheatcodes lack context when they fail, but our current setup does not allow us to add very much context without the output of forge test becoming super cluttered

Solution

Allow reverts from our backend and our inspectors to include optional hints

Effectively closes https://github.com/foundry-rs/foundry/issues/928 as some of the more annoying cheatcode reverts are documented in other issues

[onbjerg]

@gakonst adding an example rn, but for example u could use it for expectEmit - its a long standing issue that the error msg sucks a lot here since it doesn't tell u what part of the log didn't match, so u could add hints that explain what parts match and what parts dont

[onbjerg]

Not the best example (expectEmit will take more work) but instead of writing the really big number inside of the short test result it could be a hint:

Similarly, sometimes the forking backend might fail for whatever reason - it might be that the account is not accessible on your node, so a hint could be added that it's too far back if we think it is and suggest an archive node or moving the block you're forking from

[gakonst]

OK! This makes sense. Supportive.

[gakonst]

Closing as stale.