Renamed flag isDecrease to enforceDecrease

Author: hanzel98

src/enforcers/ERC1155BalanceChangeEnforcer.sol

@@ -10,7 +10,7 @@ import { ModeCode } from "../utils/Types.sol";
  * @title ERC1155BalanceChangeEnforcer
  * @dev This contract allows setting up some guardrails around balance changes. By specifying an amount and a direction
  * (decrease/increase), one can enforce a maximum decrease or minimum increase in after-execution balance.
- * The change can be either a decrease or increase based on the `isDecrease` flag.
+ * The change can be either a decrease or increase based on the `enforceDecrease` flag.
  * @dev This contract has no enforcement of how the balance changes. It's meant to be used alongside additional enforcers to
  * create granular permissions.
  * @dev This enforcer operates only in default execution mode.
@@ -61,7 +61,7 @@ contract ERC1155BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: token ID
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _mode The execution mode. (Must be Default execType)
      * @param _delegationHash The hash of the delegation.
      */
@@ -94,7 +94,7 @@ contract ERC1155BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: token ID
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _delegationHash The hash of the delegation.
      */
     function afterHook(
@@ -109,11 +109,11 @@ contract ERC1155BalanceChangeEnforcer is CaveatEnforcer {
         public
         override
     {
-        (bool isDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_) = getTermsInfo(_terms);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_) = getTermsInfo(_terms);
         bytes32 hashKey_ = _getHashKey(msg.sender, token_, recipient_, tokenId_, _delegationHash);
         delete isLocked[hashKey_];
         uint256 balance_ = IERC1155(token_).balanceOf(recipient_, tokenId_);
-        if (isDecrease_) {
+        if (enforceDecrease_) {
             require(balance_ >= balanceCache[hashKey_] - amount_, "ERC1155BalanceChangeEnforcer:exceeded-balance-decrease");
         } else {
             require(balance_ >= balanceCache[hashKey_] + amount_, "ERC1155BalanceChangeEnforcer:insufficient-balance-increase");
@@ -123,20 +123,20 @@ contract ERC1155BalanceChangeEnforcer is CaveatEnforcer {
     /**
      * @notice Decodes the terms used in this CaveatEnforcer.
      * @param _terms Encoded data that is used during the execution hooks.
-     * @return isDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
+     * @return enforceDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
      * @return token_ The address of the ERC1155 token.
      * @return recipient_ The address of the recipient of the token.
      * @return tokenId_ The ID of the ERC1155 token.
      * @return amount_ Balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      */
     function getTermsInfo(bytes calldata _terms)
         public
         pure
-        returns (bool isDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_)
+        returns (bool enforceDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_)
     {
         require(_terms.length == 105, "ERC1155BalanceChangeEnforcer:invalid-terms-length");
-        isDecrease_ = _terms[0] != 0;
+        enforceDecrease_ = _terms[0] != 0;
         token_ = address(bytes20(_terms[1:21]));
         recipient_ = address(bytes20(_terms[21:41]));
         tokenId_ = uint256(bytes32(_terms[41:73]));

src/enforcers/ERC20BalanceChangeEnforcer.sol

@@ -10,7 +10,7 @@ import { ModeCode } from "../utils/Types.sol";
  * @title ERC20BalanceChangeEnforcer
  * @dev This contract allows setting up some guardrails around balance changes. By specifying an amount and a direction
  * (decrease/increase), one can enforce a maximum decrease or minimum increase in after-execution balance.
- * The change can be either a decrease or increase based on the `isDecrease` flag.
+ * The change can be either a decrease or increase based on the `enforceDecrease` flag.
  * @dev This contract has no enforcement of how the balance changes. It's meant to be used alongside additional enforcers to
  * create granular permissions.
  * @dev This enforcer operates only in default execution mode.
@@ -48,7 +48,7 @@ contract ERC20BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the token
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _mode The execution mode. (Must be Default execType)
      */
     function beforeHook(
@@ -79,7 +79,7 @@ contract ERC20BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the token
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      */
     function afterHook(
         bytes calldata _terms,
@@ -93,11 +93,11 @@ contract ERC20BalanceChangeEnforcer is CaveatEnforcer {
         public
         override
     {
-        (bool isDecrease_, address token_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
         bytes32 hashKey_ = _getHashKey(msg.sender, token_, _delegationHash);
         delete isLocked[hashKey_];
         uint256 balance_ = IERC20(token_).balanceOf(recipient_);
-        if (isDecrease_) {
+        if (enforceDecrease_) {
             require(balance_ >= balanceCache[hashKey_] - amount_, "ERC20BalanceChangeEnforcer:exceeded-balance-decrease");
         } else {
             require(balance_ >= balanceCache[hashKey_] + amount_, "ERC20BalanceChangeEnforcer:insufficient-balance-increase");
@@ -107,19 +107,19 @@ contract ERC20BalanceChangeEnforcer is CaveatEnforcer {
     /**
      * @notice Decodes the terms used in this CaveatEnforcer.
      * @param _terms encoded data that is used during the execution hooks.
-     * @return isDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
+     * @return enforceDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
      * @return token_ The address of the token.
      * @return recipient_ The address of the recipient.
      * @return amount_ Balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      */
     function getTermsInfo(bytes calldata _terms)
         public
         pure
-        returns (bool isDecrease_, address token_, address recipient_, uint256 amount_)
+        returns (bool enforceDecrease_, address token_, address recipient_, uint256 amount_)
     {
         require(_terms.length == 73, "ERC20BalanceChangeEnforcer:invalid-terms-length");
-        isDecrease_ = _terms[0] != 0;
+        enforceDecrease_ = _terms[0] != 0;
         token_ = address(bytes20(_terms[1:21]));
         recipient_ = address(bytes20(_terms[21:41]));
         amount_ = uint256(bytes32(_terms[41:]));

src/enforcers/ERC721BalanceChangeEnforcer.sol

@@ -10,7 +10,7 @@ import { ModeCode } from "../utils/Types.sol";
  * @title ERC721BalanceChangeEnforcer
  * @dev This contract allows setting up some guardrails around balance changes. By specifying an amount and a direction
  * (decrease/increase), one can enforce a maximum decrease or minimum increase in after-execution balance.
- * The change can be either a decrease or increase based on the `isDecrease` flag.
+ * The change can be either a decrease or increase based on the `enforceDecrease` flag.
  * @dev This contract has no enforcement of how the balance changes. It's meant to be used alongside additional enforcers to
  * create granular permissions.
  * @dev This enforcer operates only in default execution mode.
@@ -58,7 +58,7 @@ contract ERC721BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the ERC721 token
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _mode The execution mode. (Must be Default execType)
      * @param _delegationHash The hash of the delegation.
      */
@@ -90,7 +90,7 @@ contract ERC721BalanceChangeEnforcer is CaveatEnforcer {
      * - next 20 bytes: address of the ERC721 token
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _delegationHash The hash of the delegation.
      */
     function afterHook(
@@ -105,11 +105,11 @@ contract ERC721BalanceChangeEnforcer is CaveatEnforcer {
         public
         override
     {
-        (bool isDecrease_, address token_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
         bytes32 hashKey_ = _getHashKey(msg.sender, token_, recipient_, _delegationHash);
         delete isLocked[hashKey_];
         uint256 balance_ = IERC721(token_).balanceOf(recipient_);
-        if (isDecrease_) {
+        if (enforceDecrease_) {
             require(balance_ >= balanceCache[hashKey_] - amount_, "ERC721BalanceChangeEnforcer:exceeded-balance-decrease");
         } else {
             require(balance_ >= balanceCache[hashKey_] + amount_, "ERC721BalanceChangeEnforcer:insufficient-balance-increase");
@@ -119,19 +119,19 @@ contract ERC721BalanceChangeEnforcer is CaveatEnforcer {
     /**
      * @notice Decodes the terms used in this CaveatEnforcer.
      * @param _terms Encoded data that is used during the execution hooks.
-     * @return isDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
+     * @return enforceDecrease_ Boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00).
      * @return token_ The address of the ERC721 token.
      * @return recipient_ The address of the recipient of the token.
      * @return amount_ Balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      */
     function getTermsInfo(bytes calldata _terms)
         public
         pure
-        returns (bool isDecrease_, address token_, address recipient_, uint256 amount_)
+        returns (bool enforceDecrease_, address token_, address recipient_, uint256 amount_)
     {
         require(_terms.length == 73, "ERC721BalanceChangeEnforcer:invalid-terms-length");
-        isDecrease_ = _terms[0] != 0;
+        enforceDecrease_ = _terms[0] != 0;
         token_ = address(bytes20(_terms[1:21]));
         recipient_ = address(bytes20(_terms[21:41]));
         amount_ = uint256(bytes32(_terms[41:]));

src/enforcers/NativeBalanceChangeEnforcer.sol

@@ -8,7 +8,7 @@ import { ModeCode } from "../utils/Types.sol";
  * @title NativeBalanceChangeEnforcer
  * @dev This contract allows setting up some guardrails around balance changes. By specifying an amount and a direction
  * (decrease/increase), one can enforce a maximum decrease or minimum increase in after-execution balance.
- * The change can be either a decrease or increase based on the `isDecrease` flag.
+ * The change can be either a decrease or increase based on the `enforceDecrease` flag.
  * @dev This contract has no enforcement of how the balance changes. It's meant to be used alongside additional enforcers to
  * create granular permissions.
  * @dev This enforcer operates only in default execution mode.
@@ -44,7 +44,7 @@ contract NativeBalanceChangeEnforcer is CaveatEnforcer {
      * - first byte: boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00)
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _mode The execution mode. (Must be Default execType)
      * @param _delegationHash The hash of the delegation.
      */
@@ -74,7 +74,7 @@ contract NativeBalanceChangeEnforcer is CaveatEnforcer {
      * - first byte: boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00)
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      * @param _delegationHash The hash of the delegation.
      */
     function afterHook(
@@ -89,10 +89,10 @@ contract NativeBalanceChangeEnforcer is CaveatEnforcer {
         public
         override
     {
-        (bool isDecrease_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
+        (bool enforceDecrease_, address recipient_, uint256 amount_) = getTermsInfo(_terms);
         bytes32 hashKey_ = _getHashKey(msg.sender, _delegationHash);
         delete isLocked[hashKey_];
-        if (isDecrease_) {
+        if (enforceDecrease_) {
             require(recipient_.balance >= balanceCache[hashKey_] - amount_, "NativeBalanceChangeEnforcer:exceeded-balance-decrease");
         } else {
             require(
@@ -107,15 +107,15 @@ contract NativeBalanceChangeEnforcer is CaveatEnforcer {
      * - first byte: boolean indicating if the balance should decrease (true | 0x01) or increase (false | 0x00)
      * - next 20 bytes: address of the recipient
      * - next 32 bytes: balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
-     * @return isDecrease_ Boolean indicating if the balance should decrease (true) or increase (false).
+     * enforceDecrease)
+     * @return enforceDecrease_ Boolean indicating if the balance should decrease (true) or increase (false).
      * @return recipient_ The address of the recipient whose balance will change.
      * @return amount_ Balance change guardrail amount (i.e., minimum increase OR maximum decrease, depending on
-     * isDecrease)
+     * enforceDecrease)
      */
-    function getTermsInfo(bytes calldata _terms) public pure returns (bool isDecrease_, address recipient_, uint256 amount_) {
+    function getTermsInfo(bytes calldata _terms) public pure returns (bool enforceDecrease_, address recipient_, uint256 amount_) {
         require(_terms.length == 53, "NativeBalanceChangeEnforcer:invalid-terms-length");
-        isDecrease_ = _terms[0] != 0;
+        enforceDecrease_ = _terms[0] != 0;
         recipient_ = address(bytes20(_terms[1:21]));
         amount_ = uint256(bytes32(_terms[21:]));
     }

test/enforcers/ERC1155BalanceChangeEnforcer.t.sol

@@ -47,8 +47,9 @@ contract ERC1155BalanceChangeEnforcerTest is CaveatEnforcerBaseTest {
     // Terms format: [bool shouldBalanceIncrease, address token, address recipient, uint256 tokenId, uint256 amount]
     function test_decodedTheTerms() public {
         bytes memory terms_ = abi.encodePacked(true, address(token), address(delegator), uint256(tokenId), uint256(100));
-        (bool isDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_) = enforcer.getTermsInfo(terms_);
-        assertEq(isDecrease_, true);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 tokenId_, uint256 amount_) =
+            enforcer.getTermsInfo(terms_);
+        assertEq(enforceDecrease_, true);
         assertEq(token_, address(token));
         assertEq(recipient_, delegator);
         assertEq(tokenId_, tokenId);

test/enforcers/ERC20BalanceChangeEnforcer.t.sol

@@ -43,8 +43,8 @@ contract ERC20BalanceChangeEnforcerTest is CaveatEnforcerBaseTest {
     // Validates the terms get decoded correctly for an increase scenario
     function test_decodedTheTerms() public {
         bytes memory terms_ = abi.encodePacked(false, address(token), address(recipient), uint256(100));
-        (bool isDecrease_, address token_, address recipient_, uint256 amount_) = enforcer.getTermsInfo(terms_);
-        assertEq(isDecrease_, false);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 amount_) = enforcer.getTermsInfo(terms_);
+        assertEq(enforceDecrease_, false);
         assertEq(token_, address(token));
         assertEq(recipient_, address(recipient));
         assertEq(amount_, 100);

test/enforcers/ERC721BalanceChangeEnforcer.t.sol

@@ -43,8 +43,8 @@ contract ERC721BalanceChangeEnforcerTest is CaveatEnforcerBaseTest {
     // Validates the terms get decoded correctly (increase scenario)
     function test_decodedTheTerms() public {
         bytes memory terms_ = abi.encodePacked(true, address(token), address(delegator), uint256(1));
-        (bool isDecrease_, address token_, address recipient_, uint256 amount_) = enforcer.getTermsInfo(terms_);
-        assertTrue(isDecrease_);
+        (bool enforceDecrease_, address token_, address recipient_, uint256 amount_) = enforcer.getTermsInfo(terms_);
+        assertTrue(enforceDecrease_);
         assertEq(token_, address(token));
         assertEq(recipient_, delegator);
         assertEq(amount_, 1);

test/enforcers/NativeBalanceChangeEnforcer.t.sol

@@ -34,11 +34,11 @@ contract NativeBalanceChangeEnforcerTest is CaveatEnforcerBaseTest {
     // Validates the terms get decoded correctly
     function test_decodedTheTerms() public {
         bytes memory terms_ = abi.encodePacked(false, address(users.carol.deleGator), uint256(100));
-        bool isDecrease_;
+        bool enforceDecrease_;
         uint256 amount_;
         address recipient_;
-        (isDecrease_, recipient_, amount_) = enforcer.getTermsInfo(terms_);
-        assertFalse(isDecrease_);
+        (enforceDecrease_, recipient_, amount_) = enforcer.getTermsInfo(terms_);
+        assertFalse(enforceDecrease_);
         assertEq(recipient_, address(users.carol.deleGator));
         assertEq(amount_, 100);
     }