OpenZeppelin / OpenZeppelin/openzeppelin-upgrades

Use storage layout from solc output for more sophisticated storage checks

Open
#3 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

storage-checks
Dominant language
TypeScript
Stars
658
Forks
286
PR merge metrics
No merged PRs in 30d

Description

Solidity 0.5.13 introduced the storageLayout compiler output, which gives accurate information about the size and alignment of items in a storage layout. We should use this information instead of the AST. Given this accurate information, the use of the Levenshtein algorithm may have to change quite a bit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how the project currently reads the AST and applies the Levenshtein algorithm for storage checks, then compare that with Solidity 0.5.13's storageLayout compiler output. Done means the checks use the accurate storage size and alignment information and account for any required changes to the comparison algorithm.

Written by the indexing model from the issue text.

Assessment

Tech stack
solidity, typescript
Domain
blockchain, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.