This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
Replace project directory in metadata with "project://" #4137
Conversation
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
eggplantzzz
reviewed
Jun 24, 2021
packages/compile-solidity/run.js
Outdated
| rawSources, | ||
| options.compilationTargets, | ||
| options.working_directory, | ||
| "project:/" //only one slash, other will already be present |
There was a problem hiding this comment.
Maybe this is a little pedantic but is it technically more proper to have this argument be the complete replacement string? Then we should strip off the relative path portion and replace it with "exactly" what we will be using? Like what if (and yeah, I think this is pretty pedantic) one day we decide to use "project::" instead of "project:/"?
There was a problem hiding this comment.
agree about replacement style - better to replace the whole thing
There was a problem hiding this comment.
OK, I've changed this.
|
I find it pretty surprising, but cool, that this is already supported by the Solidity compiler. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Addresses #4119.
Per discussion there, this PR changes our input to the Solidity compiler so that the Truffle project directory will be replaced (in input to the Solidity compiler) with
"project://". In addition to affecting the metadata, this also affects theabsolutePathfield on the AST, although we don't currently using that. It does not affect thesourcePathfield in the artifacts.Note that this only affects sources that live in the project directory. Sources imported from, e.g., NPM, will be unaffected. However, since sources imported from NPM will be given by an NPM path rather than an absolute file path, this is fine.
What about FS sources living outside the project directory? Well, those probably just won't work anymore, as the compiler won't be able to find them.
To implement this, I reused existing functionality from
compile-vyper. (Well, the functionality lives incompile-common, but it was added for Vyper purposes.) We already do something similar for Vyper, although slightly differently and for different reasons. I just expanded the functionality to cover replacing a prefix instead of just removing a prefix, and invoked it incompile-solidityas well.I also added a test, and moved a comment I noticed was in the wrong place.