Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OZ-L13: Docstrings n cleanup #335

Merged
merged 12 commits into from
Sep 4, 2024
Next Next commit
oz-L13: natspec for action constants
saucepoint committed Sep 3, 2024

Verified

This commit was signed with the committer’s verified signature.
commit 18790ad668634b17566411eceb0299c19a4097b8
7 changes: 6 additions & 1 deletion src/libraries/ActionConstants.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity ^0.8.0;

/// @title Action Constants
/// @notice Common constants used in actions
/// @dev Constants are gas efficient alternatives to their literal values
library ActionConstants {
/// @notice used to signal that an action should use the input value of the open delta on the pool manager
/// or of the balance that the contract holds
@@ -9,7 +12,9 @@ library ActionConstants {
/// This value is equivalent to 1<<255, i.e. a singular 1 in the most significant bit.
uint256 internal constant CONTRACT_BALANCE = 0x8000000000000000000000000000000000000000000000000000000000000000;

/// @notice used to signal that the recipient of an action should be the msgSender or address(this)
/// @notice used to signal that the recipient of an action should be the msgSender
address internal constant MSG_SENDER = address(1);

/// @notice used to signal that the recipient of an action should be the address(this)
address internal constant ADDRESS_THIS = address(2);
}