chore(contracts): uml storage viz #900
Draft
Conversation
This file contains hidden or 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
✅ Deploy Preview for kleros-v2-contracts ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✅ Deploy Preview for kleros-v2 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
jaybuidl
reviewed
Jun 12, 2023
|
Kudos, SonarCloud Quality Gate passed!
|
|
Let's dig in the sol2uml docs and find a solution to the custom interface types (so we don't have to replace every types to an address in the contracts) before merging. |
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.
This PR includes a script to produce uml diagrams of the storage layout of any contract. There was a small modification to store a "user defined type" IERC20 interface as an address instead and cast it where necessary (actually nowhere, the type was cast to an address where used)
This visualization will be good to make sure we planned the contract upgradability correctly.