Use npm and git submodules #728
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
Code deduplication by getting dependencies from npm and git submodules.
* `UtilityToken` contracts are now imported as a git submodule.
* `Organization` contracst are now imported as a git submodule inside
the `UtilityToken` submodule.
* `SafeMath` is now imported as open zeppelin npm package.
Note that inside the utility token repository, `token` has not been
renamed to `value token`, and therefore some tests needed to be updated.
Also, some tests required updating as `SafeMath` does not give an error
message anymore.
`Organiation` contracts cannot be imported as a separate git submodule
dependency, as then the solidity compiler will complain that there are
multiple definitions of the same symbol (e.g. `contract Organization`).
For now it is fine to import organization from inside utility tokens,
but that will lead to an error latest when there is a diamond
dependency:
```
Organization
/ \
UtilityToken SomethingElse
\ /
NewRepository
```
In this case, it couldn't be avoided that `Organization` was defined
multiple times.
To fix this, I created follow-up ticket:
OpenST/developer-guidelines#27
Deduplicating EIP20Token is out-of-scope, as it requires changing
UtilityToken contracts (which has an EIP20Token) and all consumers of
UtilityToken, which currently may or may not rely on the EIP20Token from
there.
Simply adding the npm package does not work, as there will be an error
about multiple definitions of the same Symbol (`contract EIP20Token`).
To fix this, I created a follow-up ticket:
OpenST/developer-guidelines#28
Fixes OpenST#712
This was referenced May 7, 2019
deepesh-kn
approved these changes
May 8, 2019
|
I used 2.1.1, because that is what was used in the other repositories. For now, I would rather use the same version across all repositories. 2.2 also has no messages and 2.3 is still a pre-release... |
|
@deepesh-kn what do you think? |
The same version across all repositories sounds good to me 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Code deduplication by getting dependencies from npm and git submodules.
UtilityTokencontracts are now imported as a git submodule.Organizationcontracst are now imported as a git submodule insidethe
UtilityTokensubmodule.SafeMathis now imported as open zeppelin npm package.Note that inside the utility token repository,
tokenhas not beenrenamed to
value token, and therefore some tests needed to be updated.Also, some tests required updating as
SafeMathdoes not give an errormessage anymore.
Organiationcontracts cannot be imported as a separate git submoduledependency, as then the solidity compiler will complain that there are
multiple definitions of the same symbol (e.g.
contract Organization).For now it is fine to import organization from inside utility tokens,
but that will lead to an error latest when there is a diamond
dependency:
In this case, it couldn't be avoided that
Organizationwas definedmultiple times.
To fix this, I created follow-up ticket:
OpenST/developer-guidelines#27
Deduplicating EIP20Token is out-of-scope, as it requires changing
UtilityToken contracts (which has an EIP20Token) and all consumers of
UtilityToken, which currently may or may not rely on the EIP20Token from
there.
Simply adding the npm package does not work, as there will be an error
about multiple definitions of the same Symbol (
contract EIP20Token).To fix this, I created a follow-up ticket:
OpenST/developer-guidelines#28
Fixes #712