This repository has been archived by the owner on Feb 26, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Internal improvement: Update compile interface #3252
Merged
Merged
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
…e its return format
8e5d19b
to
fb11826
Compare
eggplantzzz
commented
Aug 13, 2020
gnidan
reviewed
Aug 16, 2020
gnidan
suggested changes
Aug 16, 2020
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.
Here's a round of changes to the types!
Just looked over this at large and it's nice how it's taking shape!
…-compile-interface
gnidan
reviewed
Sep 10, 2020
gnidan
reviewed
Sep 15, 2020
gnidan
approved these changes
Sep 15, 2020
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.
Here we go!
9 tasks
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.
This PR changes a couple of interfaces in Truffle:
First, it aims to standardize and interface for compilation packages. They all now export a
Compile
object which has anall
andnecessary
method which is required to use withworkflow-compile
.compile-solidity
,compile-vyper
, andexternal-compile
now return aCompilerResult
which is an array ofCompilation
s. (see the new types incompile-common
) Currently they all still only return 1 compilation per package but in the future we plan to potentially return multiple compilations per package. This would be especially helpful when, for example, we might need to use multiple versions of the Solidity compiler for a set of contracts.Second, it changes the return from
workflow-compile
(WorkflowCompileResult
). It now returns an object withcontracts
andcompilations
.In addition to the above, it also begins moving some shimming logic to
compile-common
.🛠️ NOTE: This is a breaking change for
compile-solidity
,workflow-compile
,compile-vyper
, andexternal-compile
.