Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.1 KB

guidelines.md

File metadata and controls

39 lines (28 loc) · 1.1 KB
Raw

Coding Guidelines

Declaration of variables

New variables will use a hash based storage approach to avoid conflicts in the storage layout of the proxy contract when updating the master copy.

For this, a variable identifier should be defined (e.g. fallback_manager.handler.address for the handler address in the fallback manager contract) and hash this identifier to generate the storage location from where the data should be loaded.

The data can be stored in this location with

bytes32 slot = VARIABLE_SLOT;
/* solhint-disable no-inline-assembly */
/// @solidity memory-safe-assembly
assembly {
    sstore(slot, value)
}
/* solhint-enable no-inline-assembly */

and read with

bytes32 slot = VARIABLE_SLOT;
/* solhint-disable no-inline-assembly */
/// @solidity memory-safe-assembly
assembly {
    value := sload(slot)
}
/* solhint-enable no-inline-assembly */

Note: Make sure to use a unique identifier else unexpected behaviour will occur

Code comments

Use /** */ for multiline comments and // for single-line comments.

The comment should start with a capital letter and end with a dot.