Support for Solidity 0.8.4

[blitz-1306]

Status

Ready. There is an issue with compiler release, that is not yet properly handled. However, I do not think that it blocks us from merge as compiler is already released so we would have to deal with it anyway. The onlything we can do is to explicitly throw an error when we meet a particular edge case.

Changes

• Bumped dependency versions: web3-eth-abi to ^1.3.5, also development dependencies to use latest tools.
• Added support for Solidity 0.8.4 release on compile level (solc@0.8.4).
• Added support for Solidity 0.8.4 release on AST level:
  • Introduced new statement node RevertStatement.
  • Introduced new definition node ErrorDefinition.
  • Tweaked ContractDefinition:
    • Introduced usedErrors and vUsedErrors properties to track used errors.
    • Introduced vErrors property.
    • Tweaked constructor to accept additional required array argument for usedErrors (a breaking change).
  • Tweaked SourceUnit:
    • Tweaked ExportedSymbol type to also allow ErrorDefinitions (this also will affect imports, a breaking change).
    • Introduced vErrors property.
• Updated NODE_LIST to mention new nodes.
• Tweaked sanity checking logic to respect the changes.
• Tweaked AST-to-source writing components to respect the changes (see Concerns section).
• Tweaked ASTNodeFactory to respect the changes.
• Tweaked related test suites and samples.

Concerns

I believe that YulHexStringLiterals are underworked in compiler:

• I did not found a convenient way to distiguish common Yul string literal from YulHexStringLiteral. Due to this, it is really hard to make a decision how to write any string literals (common string or hex). The Solidity AST have Literal.kind, that allows to determine how to write node properly, but Yul does not.
• I did not found a proper solution to analyze YulHexStringLiteral content values to write them as hex"" and get same output, as input was. Maybe there is something happening during JSON serialization/deserialization, that causes content fragmentation. The most stable approach I recall produces something, that is different from expectations (see the original source).

I created a related issue in Solidity repository to figure out how to solve this.

Notes

• This PR causes backward incompatibility due to changes in node constructor signatures (ContractDefinition) and arguments for ASTNodeFactory methods.
• The legacy AST reading is adjusted just to not crash. It is only in maintenance mode until further notifications. New functionality is undefined by default of legacy AST nodes and related processing logic.

Related links

• Solidity 0.8.4 release notes
• Solidity 0.8.4 release blog post
• Solidity blog article on custom errors
• PR with YulHexStringLiterals support for Solidity 0.8.4
• Git commit of YulHexStringLiterals support

Regards.

[codecov-commenter]

Codecov Report

Merging #33 (d5e3595) into master (709043c) will increase coverage by 0.00%.
The diff coverage is 92.40%.

@@           Coverage Diff           @@
##           master      #33   +/-   ##
=======================================
  Coverage   92.82%   92.83%           
=======================================
  Files         208      212    +4     
  Lines        4184     4257   +73     
  Branches      596      603    +7     
=======================================
+ Hits         3884     3952   +68     
- Misses        186      188    +2     
- Partials      114      117    +3     

Impacted Files	Coverage Δ
src/ast/legacy/contract_definition_processor.ts	94.44% <ø> (ø)
...cessing/structured_documentation_reconstruction.ts	100.00% <ø> (ø)
src/ast/ast_node_factory.ts	71.52% <62.50%> (-0.01%)	⬇️
src/ast/modern/error_definition_processor.ts	80.00% <80.00%> (ø)
src/ast/sanity.ts	73.00% <92.30%> (+0.78%)	⬆️
.../implementation/declaration/contract_definition.ts	95.94% <100.00%> (+0.35%)	⬆️
...ast/implementation/declaration/error_definition.ts	100.00% <100.00%> (ø)
src/ast/implementation/declaration/index.ts	100.00% <100.00%> (ø)
src/ast/implementation/meta/source_unit.ts	100.00% <100.00%> (ø)
src/ast/implementation/statement/index.ts	100.00% <100.00%> (ø)
... and 12 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 709043c...d5e3595. Read the comment docs.

[cd1m0]

Couple of nits, otherwise LGTM.