kleros-v2 icon indicating copy to clipboard operation
kleros-v2 copied to clipboard

chore(contracts): uml storage viz

Open shotaronowhere opened this issue 2 years ago • 4 comments

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)

image

This visualization will be good to make sure we planned the contract upgradability correctly.

shotaronowhere avatar Jun 12 '23 05:06 shotaronowhere

Deploy Preview for kleros-v2-contracts ready!

Name Link
Latest commit 7cbea685b80ff952984dde60ad79c6caa044e891
Latest deploy log https://app.netlify.com/sites/kleros-v2-contracts/deploys/6486e8fb26c48a0008a714ff
Deploy Preview https://deploy-preview-900--kleros-v2-contracts.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Jun 12 '23 05:06 netlify[bot]

Deploy Preview for kleros-v2 ready!

Name Link
Latest commit 7cbea685b80ff952984dde60ad79c6caa044e891
Latest deploy log https://app.netlify.com/sites/kleros-v2/deploys/6486e8fbc8333a0008a72f1f
Deploy Preview https://deploy-preview-900--kleros-v2.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Jun 12 '23 05:06 netlify[bot]

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

sonarqubecloud[bot] avatar Jun 12 '23 09:06 sonarqubecloud[bot]

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.

jaybuidl avatar Jun 12 '23 09:06 jaybuidl