Publish organization and utility tokens as npm package #27
Labels
Comments
schemar
added a commit
to schemar/mosaic-contracts
that referenced
this issue
May 7, 2019
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
/ \
UtilitToken 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
schemar
added a commit
to schemar/mosaic-contracts
that referenced
this issue
May 7, 2019
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
schemar
added a commit
to schemar/mosaic-contracts
that referenced
this issue
May 7, 2019
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Follow-up to OpenST/mosaic-contracts#728
Organization and utility token contracts should be published and included as NPM packages to prevent multiple definitions of the same contract. See OpenST/mosaic-contracts#728 for details.
A follow-up ticket would be to use the npm packages instead of git-submodules in the consumers.
The text was updated successfully, but these errors were encountered: