safe-global / safe-modules / 7815188231

100%

master: 85%

push

github

[L-03, N-01, N-02] Fixes to `SafeSetupModule` (formerly `AddModulesLib`) (#241)

This PR contains fixes to 3 issues from the audit report. They were
combined into a single PR in order to prevent git merge conflicts once
the review is complete. Each fix is in an individual commit to
facilitate the review.

# L-03 - Add Missing DocStrings

There were missing NatSpec documents for both the `SafeModuleSetup`
(formerly `AddModulesLib`) contract and `enableModules` function. Both
were added to ensure high quality documentation.

# N-01 - Improve `enableModules` Implementation

The `enableModules` function used a reverse loop to go through the
modules to add. This was done in order to preserve module order and
_thought_ to be slightly more gas efficient. It turns out to not be the
case with the current compiler and flags. The loop was changed into a
forward loop, making both the implementation more clear, but also
slightly more gas efficient.

# N-02 - Rename `AddModulesLib`

The module name could be misconstrued to imply that it was a Solidity
library, while it is in fact a contract (the `-Lib` was intended to
indicate it was a "library" in the Safe sense of the word). The contract
was renamed to more clearly state it purpose: enable modules during Safe
setup.

39 of 60 branches covered (0.0%)

Branch coverage included in aggregate %.

108 of 119 relevant lines covered (90.76%)

10.76 hits per line