Add getAllCompilerAbstracts method to compiler-artefacts.ts
#1
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,105 +1,84 @@ | ||
| 'use strict' | ||
| import {Plugin} from '@remixproject/engine' | ||
| import {util} from '@remix-project/remix-lib' | ||
| import {CompilerAbstract} from '@remix-project/remix-solidity' | ||
|
|
||
| const profile = { | ||
| name: 'compilerArtefacts', | ||
| methods: ['get', 'addResolvedContract', 'getCompilerAbstract', 'getAllContractDatas', 'getLastCompilationResult', 'getArtefactsByContractName', 'getContractDataFromAddress', 'getContractDataFromByteCode', 'saveCompilerAbstract', 'getAllCompilerAbstracts'], | ||
| events: ['compilationSaved'], | ||
| version: '0.0.1', | ||
| } | ||
|
|
||
| export class CompilerArtefacts extends Plugin { | ||
| compilersArtefactsPerFile: any | ||
| compilersArtefacts: any | ||
| constructor() { | ||
| super(profile) | ||
| this.compilersArtefacts = {} | ||
| this.compilersArtefactsPerFile = {} | ||
| } | ||
|
|
||
| clear() { | ||
| this.compilersArtefacts = {} | ||
| this.compilersArtefactsPerFile = {} | ||
| } | ||
|
|
||
| saveCompilerAbstract(file: string, compilerAbstract: CompilerAbstract) { | ||
| this.compilersArtefactsPerFile[file] = compilerAbstract | ||
| } | ||
|
|
||
| getAllCompilerAbstracts() { | ||
| return this.compilersArtefactsPerFile | ||
| } | ||
|
Comment on lines
+31
to
+33
|
||
|
|
||
| onActivation() { | ||
| const saveCompilationResult = (file, source, languageVersion, data, input?) => { | ||
| this.compilersArtefactsPerFile[file] = new CompilerAbstract(languageVersion, data, source, input) | ||
| this.compilersArtefacts.__last = this.compilersArtefactsPerFile[file] | ||
|
Comment on lines
37
to
+38
There was a problem hiding this comment. Refactored the contents of listener functions to this single function called Basically we always pass the |
||
| this.emit('compilationSaved', {[file]: this.compilersArtefactsPerFile[file]}) | ||
| } | ||
|
|
||
| this.on('solidity', 'compilationFinished', saveCompilationResult) | ||
|
There was a problem hiding this comment. I think 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 |
||
|
|
||
| this.on('vyper', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('lexon', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('yulp', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('solidityUnitTesting', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('nahmii-compiler', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('hardhat', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('truffle', 'compilationFinished', saveCompilationResult) | ||
|
|
||
| this.on('foundry', 'compilationFinished', saveCompilationResult) | ||
| } | ||
|
|
||
| /** | ||
| * Get artefacts for last compiled contract | ||
| * * @returns last compiled contract compiler abstract | ||
| */ | ||
| getLastCompilationResult() { | ||
| return this.compilersArtefacts.__last | ||
| } | ||
|
|
||
| /** | ||
| * Get compilation output for contracts compiled during a session of Remix IDE | ||
| * @returns compilatin output | ||
| */ | ||
| getAllContractDatas() { | ||
| return this.filterAllContractDatas(() => true) | ||
| } | ||
|
|
||
| /** | ||
| * filter compilation output for contracts compiled during a session of Remix IDE | ||
| * @returns compilatin output | ||
| */ | ||
| filterAllContractDatas(filter) { | ||
| const contractsData = {} | ||
| Object.keys(this.compilersArtefactsPerFile).map((targetFile) => { | ||
| const artefact = this.compilersArtefactsPerFile[targetFile] | ||
|
|
@@ -124,7 +103,7 @@ export class CompilerArtefacts extends Plugin { | |
| * @param contractName contract name | ||
| * @returns arefacts object, with fully qualified name (e.g; contracts/1_Storage.sol:Storage) as key | ||
| */ | ||
| _getAllContractArtefactsfromOutput(compilerOutput, contractName) { | ||
| const contractArtefacts = {} | ||
| for (const filename in compilerOutput) { | ||
| if (Object.keys(compilerOutput[filename]).includes(contractName)) contractArtefacts[filename + ':' + contractName] = compilerOutput[filename][contractName] | ||
|
|
@@ -139,12 +118,12 @@ export class CompilerArtefacts extends Plugin { | |
| * @param contractArtefacts populated resultant artefacts object, with fully qualified name (e.g: contracts/1_Storage.sol:Storage) as key | ||
| * Once method execution completes, contractArtefacts object will hold all possible artefacts for contract | ||
| */ | ||
| async _populateAllContractArtefactsFromFE(path, contractName, contractArtefacts) { | ||
| const dirList = await this.call('fileManager', 'dirList', path) | ||
| if (dirList && dirList.length) { | ||
| for (const dirPath of dirList) { | ||
| // check if directory contains an 'artifacts' folder and a 'build-info' folder inside 'artifacts' | ||
| if (dirPath === path + '/artifacts' && (await this.call('fileManager', 'exists', dirPath + '/build-info'))) { | ||
| const buildFileList = await this.call('fileManager', 'fileList', dirPath + '/build-info') | ||
| // process each build-info file to populate the artefacts for contractName | ||
| for (const buildFile of buildFileList) { | ||
|
|
@@ -155,7 +134,7 @@ export class CompilerArtefacts extends Plugin { | |
| // populate the resultant object with artefacts | ||
| Object.assign(contractArtefacts, artefacts) | ||
| } | ||
| } else await this._populateAllContractArtefactsFromFE(dirPath, contractName, contractArtefacts) | ||
| } | ||
| } else return | ||
| } | ||
|
|
@@ -165,31 +144,30 @@ export class CompilerArtefacts extends Plugin { | |
| * @param name contract name or fully qualified name i.e. <filename>:<contractname> e.g: contracts/1_Storage.sol:Storage | ||
| * @returns artefacts for the contract | ||
| */ | ||
| async getArtefactsByContractName(name) { | ||
| const contractsDataByFilename = this.getAllContractDatas() | ||
| // check if name is a fully qualified name | ||
| if (name.includes(':')) { | ||
| const fullyQualifiedName = name | ||
| const nameArr = fullyQualifiedName.split(':') | ||
| const filename = nameArr[0] | ||
| const contract = nameArr[1] | ||
| if (Object.keys(contractsDataByFilename).includes(filename) && contractsDataByFilename[filename][contract]) return contractsDataByFilename[filename][contract] | ||
| else { | ||
| const allContractsData = {} | ||
| await this._populateAllContractArtefactsFromFE('contracts', contract, allContractsData) | ||
| if (allContractsData[fullyQualifiedName]) return {fullyQualifiedName, artefact: allContractsData[fullyQualifiedName]} | ||
| else throw new Error(`Could not find artifacts for ${fullyQualifiedName}. Compile contract to generate artifacts.`) | ||
| } | ||
| } else { | ||
| const contractName = name | ||
| const contractArtefacts = this._getAllContractArtefactsfromOutput(contractsDataByFilename, contractName) | ||
| let keys = Object.keys(contractArtefacts) | ||
| if (!keys.length) { | ||
| await this._populateAllContractArtefactsFromFE('contracts', contractName, contractArtefacts) | ||
| keys = Object.keys(contractArtefacts) | ||
| } | ||
| if (keys.length === 1) return {fullyQualifiedName: keys[0], artefact: contractArtefacts[keys[0]]} | ||
| else if (keys.length > 1) { | ||
| throw new Error(`There are multiple artifacts for contract "${contractName}", please use a fully qualified name.\n | ||
| Please replace ${contractName} for one of these options wherever you are trying to read its artifact: \n | ||
|
|
@@ -199,7 +177,7 @@ export class CompilerArtefacts extends Plugin { | |
| } | ||
| } | ||
|
|
||
| async getCompilerAbstract(file) { | ||
| if (!file) return null | ||
| if (this.compilersArtefactsPerFile[file]) return this.compilersArtefactsPerFile[file] | ||
| const path = await this.call('fileManager', 'getPathFromUrl', file) | ||
|
|
@@ -215,30 +193,30 @@ export class CompilerArtefacts extends Plugin { | |
| return artefact | ||
| } | ||
|
|
||
| addResolvedContract(address: string, compilerData: CompilerAbstract) { | ||
| this.compilersArtefacts[address] = compilerData | ||
| } | ||
|
|
||
| isResolved(address) { | ||
| return this.compilersArtefacts[address] !== undefined | ||
| } | ||
|
|
||
| get(key) { | ||
| return this.compilersArtefacts[key] | ||
| } | ||
|
|
||
| async getContractDataFromAddress(address) { | ||
| const code = await this.call('blockchain', 'getCode', address) | ||
| return this.getContractDataFromByteCode(code) | ||
| } | ||
|
|
||
| async getContractDataFromByteCode(code) { | ||
| let found | ||
| this.filterAllContractDatas((file, contractsData) => { | ||
| for (const name of Object.keys(contractsData)) { | ||
| const contract = contractsData[name] | ||
| if (util.compareByteCode(code, '0x' + contract.evm.deployedBytecode.object)) { | ||
| found = {name, contract, file} | ||
| return true | ||
| } | ||
| } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed this but took the function's contents to
saveCompilationResult