Skip to content

Upgrades Plugins: document rename and retype annotations on struct members #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericglau merged 1 commit into from
Oct 23, 2026
Merged

Upgrades Plugins: document rename and retype annotations on struct members #255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion content/upgrades-plugins/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,34 @@ contract V2 {
}
```

Docstring comments don鈥檛 yet work for struct members, due to a current Solidity limitation.
Since `@openzeppelin/upgrades-core@1.47.0`, these docstring comments can also be used on struct members, including members of [namespaced storage](/upgrades-plugins/writing-upgradeable#namespaced-storage-layout) structs, for example:

```solidity
contract V1 {
/// @custom:storage-location erc7201:example.main
struct MainStorage {
uint x;
bool f;
}

...
}
contract V2 {
/// @custom:storage-location erc7201:example.main
struct MainStorage {
/// @custom:oz-renamed-from x
uint y;
/// @custom:oz-retyped-from bool
uint8 f;
}

...
}
```

<Callout>
When validating with the [OpenZeppelin Upgrades CLI](/upgrades-plugins/api-core), which [Foundry Upgrades](/upgrades-plugins/foundry/foundry-upgrades) also uses, the storage slots of namespaced struct members are not available. As a result, a `@custom:oz-retyped-from` annotation on a namespaced struct member is only accepted for type changes known to keep the same layout, such as between `bool` and `uint8`.
</Callout>

## How can I use internal functions in storage variables?

Expand Down
Loading