crytic/slither

slither-read-storage: add support for nested structs

Open

#2,077 opened on Aug 3, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (886 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (4,769 stars)
PR merge metrics
 (Avg merge 54d 9h) (2 merged PRs in 30d)

Description

For example: https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/e6e6d73c6219a9e436cdc91ac4f943c7699831c0/contracts/utils/structs/EnumerableSetUpgradeable.sol#L233-L235

This needs to be updated to calculate the slot for UserDefinedType https://github.com/crytic/slither/blob/3f90e86badfa956b5cc692e0421c2b8065c31d43/slither/tools/read_storage/read_storage.py#L593

Test case slither-read-storage bsc:0x52Dcd80506bc421cae6927C73f306FD0d083e43a

Contributor guide

Research direction
Examine the storage slot calculation logic in read storage.py around line 593, then extend it to handle nested struct types by recursively computing the slot offset for each nested field.
Tech stack
python
Domain
blockchain
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSolidity basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50