Storage layout specifier docs #15892
Conversation
matheusaaguiar
force-pushed
the
storageLayoutSpecifierDocs
branch
from
50ba958 to
88792ee
Compare
|
Please link to the issue in PR description. |
| a contract definition, either after or before the inheritance specifier. | ||
| It can be given at most once. | ||
| The ``base-slot-expression`` must be an expression consisting of number literals | ||
| that can be evaluated at compile time and yield in a rational value in the range of ``uint256``. |
There was a problem hiding this comment.
Perhaps another section describing that the max number of available storage slots will be (uint256::max - user defined base slot address + 1), and that a revert will be triggered in case an attempt is made to exceed the maximum number of available slots.
There was a problem hiding this comment.
Not a revert. A compilation error.
matheusaaguiar
force-pushed
the
storageLayoutSpecifierDocs
branch
from
803a4b2 to
74f84d3
Compare
There was a problem hiding this comment.
Note that this page still says that the storage always starts at zero:
Except for dynamically-sized arrays and mappings (see below), data is stored contiguously item after item starting with the first state variable, which is stored in slot ``0``. For each variable,
Please also check if there's anything in the rest of the text that needs updating too.
nikola-matic
force-pushed
the
storageLayoutSpecifierDocs
branch
from
8c93ccf to
4034c14
Compare
matheusaaguiar
force-pushed
the
storageLayoutSpecifierDocs
branch
from
5ccc7d7 to
cbd4ad8
Compare
matheusaaguiar
force-pushed
the
storageLayoutSpecifierDocs
branch
from
5e46227 to
05b0efb
Compare
There was a problem hiding this comment.
I did a final pass over the PR, doing proofreading, fixing some grammar and generally rewording things to sound nicer. I also added some diagrams to your example (this is what I meant by showing the layout) and also extended the example to show more things (dynamic variables, more complex packing, etc.)
I pushed that as fixups just now. Please take a look and if you're fine with it, please squash, rebase and we can merge.
Part of #597/#15727.