morpho-org/morpho-blue-bundlers

Potentially misleading warning comments

QGarchery opened this issue · 1 comments

This kind of comment
https://github.com/morpho-labs/morpho-blue-bundlers/blob/cdf0034cac923d8053bcd5ead0eb0389b3aef953/src/TransferBundler.sol#L49
feels misleading because

  • being inside a multicall does not guarantee that it’s safe, it should still not leave tokens on the contract
  • being outside a multicall already prevents calling this function (because the default initiator cannot transfer funds)

Additionally, we should consider documenting that some other functions (notably the Morpho functions with callbacks) are well-suited to be called directly

Do you have a suggestion for another phrasing?

I don't feel like the current wording makes the reader think that calling this function can be considered safe inside a multicall. It only highlights that this function is not intended to be called outside a multicall, even though it may not even work outside a multicall