Add getAllCompilerAbstracts method to compiler-artefacts.ts
#1
Conversation
The current compilerArtefacts plugin's existing methods had two flaws: 1. It wasn't possible to get all Compiler Abstracts available in one go. 2. It was possible to first get all files with `getAllContractsData` and then call each CompilerAbstract one by one with `getCompilerAbstract`, however, in that case the CompilerAbstract was missing the `input` because it wasn't passed to the contructor and saveCompilationPerFileResult. It was only done so for the `solidityUnitTesting` plugin listener. The compiler input is needed for consistent contract verification. While it's possible to generate a compiler input from the contract artefact, via the metadata, it is not always possible to get a match due to known bugs in compiler's AST generation in prev. versions. This results in different bytecode from the original compiler input's output vs the compilation output from the metadata file.
| getAllCompilerAbstracts() { | ||
| return this.compilersArtefactsPerFile | ||
| } |
| this.compilersArtefactsPerFile[file] = compilerAbstract | ||
| } | ||
|
|
||
| onActivation () { | ||
| const saveCompilationPerFileResult = (file, source, languageVersion, data, input?) => { |
There was a problem hiding this comment.
Removed this but took the function's contents to saveCompilationResult
| const saveCompilationResult = (file, source, languageVersion, data, input?) => { | ||
| this.compilersArtefacts.__last = new CompilerAbstract(languageVersion, data, source, input) | ||
| this.compilersArtefactsPerFile[file] = new CompilerAbstract(languageVersion, data, source, input) | ||
| } |
There was a problem hiding this comment.
Refactored the contents of listener functions to this single function called saveCompilationResult. This also contains what the prev. saveCompilationPerFileResult has
| this.compilersArtefactsPerFile[file] = new CompilerAbstract(languageVersion, data, source, input) | ||
| this.compilersArtefacts.__last = this.compilersArtefactsPerFile[file] |
There was a problem hiding this comment.
Refactored the contents of listener functions to this single function called saveCompilationResult. This also contains what the prev. saveCompilationPerFileResult has.
Basically we always pass the input to the CompilerAbstract constructor and then point this one as the __last artefact. Maybe we might want to create a separate new CompilerAbstract for __last but this seemed proper to me.e
| this.compilersArtefacts.__last = new CompilerAbstract(languageVersion, data, source, input) | ||
| saveCompilationPerFileResult(file, source, languageVersion, data) | ||
| }) | ||
| this.on('solidity', 'compilationFinished', saveCompilationResult) |
There was a problem hiding this comment.
I think saveCompilationResult can take at most 5 parameters
There was a problem hiding this comment.
Yes it has 5 parameters?
remix-project/libs/remix-core-plugin/src/lib/compiler-artefacts.ts
Lines 36 to 39 in fcc0275
The "compiler input JSON" is needed for consistent contract verification. While it's possible to generate a compiler input from the contract artefact, via the Solidity metadata, it is not always possible to get a match due to known bugs in compiler's AST generation in prev. versions. This results in different bytecode from the original compiler input's output vs the compilation output from the metadata file.
So, to get the compiler input of contracts, I tried using the current compilerArtefacts plugin's existing methods, but they had two flaws:
getAllContractsDataand then call each CompilerAbstract one by one withgetCompilerAbstract, however, in that case the CompilerAbstract was missing theinputbecause it wasn't passed to the contructor and saveCompilationPerFileResult. It was only done so for thesolidityUnitTestingplugin listener.inputwas being saved in__lastbut not in other artefacts?inputfield from all these listeners? likevyper,yulpetc? It seemed yes to me