Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.

Review Initializable and Migratable base contracts #2

Closed
spalladino opened this issue Aug 6, 2018 · 4 comments
Closed

Review Initializable and Migratable base contracts #2

spalladino opened this issue Aug 6, 2018 · 4 comments
Assignees
Labels
kind:enhancement Enhancement to an existing feature topic:contracts Smart contracts in SDK topic:upgrades Contract upgrades
Milestone

Comments

@spalladino
Copy link
Contributor

spalladino commented Aug 6, 2018

The Migratable contract from zos-lib is not trivial to use, as there is often confusion around the need of specifying the contract name, or what does the "version" represent. We agreed on reviewing these contracts to see if we could somehow simplify them (they also currently emit a solc compiler warning, at least let's fix that!).

Add a section in the documentation explaining how to use the new contracts. Review the existing documentation around the usage of Migratable, change it to use the new versions, and clarify the need for it. Several users believe that it is mandatory to use Migratable for a contract to be used with zOS, increasing the fear of lock-in into the platform, so we need to make sure in the docs that it is not the case.

@spalladino spalladino added kind:enhancement Enhancement to an existing feature topic:upgrades Contract upgrades topic:contracts Smart contracts in SDK labels Aug 6, 2018
@spalladino spalladino added this to the v2.0.0 milestone Aug 6, 2018
@spalladino
Copy link
Contributor Author

Once documented, ping OpenZeppelin/openzeppelin-labs#129 to check if the clarification helps solve the issue.

@frangio
Copy link
Contributor

frangio commented Aug 9, 2018

@spalladino What solc warning were you referring to?

@spalladino
Copy link
Contributor Author

@frangio I got a report on it, but did not attempt to reproduce it. If it is not present in #12, I'd discard the issue.

@spalladino
Copy link
Contributor Author

Closing via #12

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind:enhancement Enhancement to an existing feature topic:contracts Smart contracts in SDK topic:upgrades Contract upgrades
Projects
None yet
Development

No branches or pull requests

2 participants