feat: document that fallback user cannot be address(0)

catalystdao · Jan 18, 2024 · 3831b29 · 3831b29
1 parent 73b5bd0
commit 3831b29
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/evm/src/CatalystVaultCommon.sol b/evm/src/CatalystVaultCommon.sol
@@ -389,6 +389,7 @@ abstract contract CatalystVaultCommon is
     //-- Escrow Functions --//
 
     /// @notice Creates a token escrow for a swap.
+    /// @param fallbackUser The user who the escrow belongs to. Do not set to address(0).
     function _setTokenEscrow(
         bytes32 sendAssetHash,
         address fallbackUser,
@@ -404,6 +405,7 @@ abstract contract CatalystVaultCommon is
     }
 
     /// @notice Creates a liquidity escrow for a swap.
+    /// @param fallbackUser The user who the escrow belongs to. Do not set to address(0).
     function _setLiquidityEscrow(
         bytes32 sendLiquidityHash,
         address fallbackUser,