feat: implement flattening api [APE-794]

[z80dev]

What I did

fixes: APE-794

How I did it

Recursively get the contents of imported files, then concatenate all into one output.

This matches hardhat's behavior of not processing the files in certain ways required for actual compilation, for example removing multiple (and sometimes conflicting) SPDX license lines

How to verify it

tests WIP

Checklist

• Passes all linting checks (pre-commit and CI jobs)
• New test cases have been added and are passing
• Documentation has been updated
• PR title follows Conventional Commit standard (will be automatically included in the changelog)

[z80dev]

Much closer now. Added the following features:

• Remove 'import' statements from flattened output
• Include original filename in comment (i.e. // File: @devorg/contracts/CoolContract.sol before the contents from that file)

Missing: Everything around handling the license issue, I will begin by implementing license conflict detection and warning in the case of multiple licenses. In the case of only one license, I'll strip all the SPDX statements and leave one at the top of the file

[antazoey]

talked offline, but thinking we could do a reverse look-up for the File comment to get the path you need

[antazoey]

this looking close!

when you get a chance, can you start the test? i would like to see what a flattened Imports.sol looks like

[antazoey]

Looks like a test needs updating! See it failing in CI. It is from the newly added import, you just need to add it to the expected fields, or adjust the test.

[antazoey]

mainly wondering about multiple pragmas now

[z80dev]

Weird unrelated test error occuring on python 3.8, tests run locally on my machine with 3.10 all pass. index out of bounds error

any ideas @antazoey ?

[antazoey]

any ideas @antazoey ?

I am pretty sure I ran into this on a separate branch and fixed it there. I just merged that PR and then updated your branch here and so no we will see if that fixes it.