Slots documentation #315
Slots documentation #315
Conversation
LogvinovLeon
force-pushed
the
ania/slots_docs
branch
from
70be1c1 to
0c28d5c
Compare
| pub(crate) fn mapping(slot: Bytes32, key: Bytes32) -> Bytes32; | ||
| ``` | ||
|
|
||
| Calculates slot number of value corresponding to a mapping `key`. `Slot` argument is the storage location of the mapping calculated after applying storage layout rules. |
There was a problem hiding this comment.
Slot number doesn't make sense. Slot itself is a number.
Calculates THE slot
Of A value
There was a problem hiding this comment.
How slot if calculated is irrelevant in the context of this function. It deals with calculating it's return value. You can mention that it concatenates & hashes
There was a problem hiding this comment.
I wanted to include the explanation of what is this slot argument, because we need to emphasise the difference between this argument and the one with the same name in the function mentioned later.
There was a problem hiding this comment.
There will be a link to documentation about solidity storage layout where concatenation and hashing will be explained. So I don't think we need to repeat that here.
|
|
||
| Calculates slot number where element at `index` in dynamic array is located. `Slot` argument is the storage location of the dynamic array calculated after applying storage layout rules. `Size` defines the size of elements in the array. | ||
|
|
||
| - There is an analogical function where `slot` argument is a precalculated slot of the first element in the array: |
There was a problem hiding this comment.
Let's describe - when is the other function useful. Some example code in Sol.
There was a problem hiding this comment.
Actually there is an example of usage for this function below.
| @@ -72,3 +72,11 @@ pub fn sub_array_equals<TItem, SUBARRAY_LEN, ARRAY_LEN>( | |||
| } | |||
| result | |||
| } | |||
|
|
|||
| pub fn slice_to_array<LENGTH>(slice: [u8]) -> [u8; LENGTH] { | |||
There was a problem hiding this comment.
ethereum/circuits/lib/README.md
Outdated
| U256 is a structure to use as a type for big numbers. | ||
| It is used when dealing with numbers up to 2<sup>256</sup>. They can exceed Field maximum value. | ||
|
|
||
| [There](.src/uint256.nr) is an unoptimized implementation of this type using two U128 structures. Optimized version will appear in Noir. | ||
|
|
There was a problem hiding this comment.
This should mention - why are U256 useful. That they are a word size in ETH and therefore a basic type used in both storage and slot values calculations
uin256.nrfrom misc to main part of libraryslot_test.nrand fixed wrong order of arguments given todynamic_arrayfunctionfield_to_bytes32function fromfield.nrtobytes32.nrfile