guidelines.md

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 definied (e.g. fallback_manager.handler.address for the handler addres 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 to this location with

bytes32 slot = VARIABLE_SLOT;
// solhint-disable-next-line no-inline-assembly
assembly {
    sstore(slot, value)
}

and read with

bytes32 slot = VARIABLE_SLOT;
// solhint-disable-next-line no-inline-assembly
assembly {
    value := sload(slot)
}

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