Split audit macro (#250)

* releasable functions in preset PaymentSplitterUpgradeable

* remove inaccurate comments from distribute functions

Author: kumaryash90

contracts/Split.sol

@@ -126,7 +126,6 @@ contract Split is
     function distribute() public virtual {
         uint256 count = payeeCount();
         for (uint256 i = 0; i < count; i++) {
-            // note: `_release` should not fail because payee always has shares, protected by `_appPay`
             _release(payable(payee(i)));
         }
     }
@@ -137,7 +136,6 @@ contract Split is
     function distribute(IERC20Upgradeable token) public virtual {
         uint256 count = payeeCount();
         for (uint256 i = 0; i < count; i++) {
-            // note: `_release` should not fail because payee always has shares, protected by `_appPay`
             _release(token, payee(i));
         }
     }

contracts/openzeppelin-presets/finance/PaymentSplitterUpgradeable.sol

@@ -14,6 +14,7 @@ import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
  *          - `_totalReleased`, `_released`, `_erc20TotalReleased`, `_erc20Released`, `_pendingPayment`
  *
  *      - Add `payeeCount`: returns the length of `_payees`
+ *      - Add `releasable` functions as per recent updates in OZ PaymentSplitterUpgradeable (v4.7.0)
  */
 
 /**
@@ -144,15 +145,31 @@ contract PaymentSplitterUpgradeable is Initializable, ContextUpgradeable {
         return _payees.length;
     }
 
+    /**
+     * @dev Getter for the amount of payee's releasable Ether.
+     */
+    function releasable(address account) public view returns (uint256) {
+        uint256 totalReceived = address(this).balance + totalReleased();
+        return _pendingPayment(account, totalReceived, released(account));
+    }
+
+    /**
+     * @dev Getter for the amount of payee's releasable `token` tokens. `token` should be the address of an
+     * IERC20 contract.
+     */
+    function releasable(IERC20Upgradeable token, address account) public view returns (uint256) {
+        uint256 totalReceived = token.balanceOf(address(this)) + totalReleased(token);
+        return _pendingPayment(account, totalReceived, released(token, account));
+    }
+
     /**
      * @dev Triggers a transfer to `account` of the amount of Ether they are owed, according to their percentage of the
      * total shares and their previous withdrawals.
      */
     function release(address payable account) public virtual {
         require(_shares[account] > 0, "PaymentSplitter: account has no shares");
 
-        uint256 totalReceived = address(this).balance + totalReleased();
-        uint256 payment = _pendingPayment(account, totalReceived, released(account));
+        uint256 payment = releasable(account);
 
         require(payment != 0, "PaymentSplitter: account is not due payment");
 
@@ -171,8 +188,7 @@ contract PaymentSplitterUpgradeable is Initializable, ContextUpgradeable {
     function release(IERC20Upgradeable token, address account) public virtual {
         require(_shares[account] > 0, "PaymentSplitter: account has no shares");
 
-        uint256 totalReceived = token.balanceOf(address(this)) + totalReleased(token);
-        uint256 payment = _pendingPayment(account, totalReceived, released(token, account));
+        uint256 payment = releasable(token, account);
 
         require(payment != 0, "PaymentSplitter: account is not due payment");
 

docs/PaymentSplitterUpgradeable.md

@@ -43,6 +43,51 @@ function payeeCount() external view returns (uint256)
 *Get the number of payees*
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### releasable
+
+```solidity
+function releasable(address account) external view returns (uint256)
+```
+
+
+
+*Getter for the amount of payee's releasable Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### releasable
+
+```solidity
+function releasable(contract IERC20Upgradeable token, address account) external view returns (uint256)
+```
+
+
+
+*Getter for the amount of payee's releasable `token` tokens. `token` should be the address of an IERC20 contract.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token | contract IERC20Upgradeable | undefined |
+| account | address | undefined |
+
 #### Returns
 
 | Name | Type | Description |

docs/Split.md

@@ -309,6 +309,51 @@ function payeeCount() external view returns (uint256)
 *Get the number of payees*
 
 
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### releasable
+
+```solidity
+function releasable(address account) external view returns (uint256)
+```
+
+
+
+*Getter for the amount of payee's releasable Ether.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| account | address | undefined |
+
+#### Returns
+
+| Name | Type | Description |
+|---|---|---|
+| _0 | uint256 | undefined |
+
+### releasable
+
+```solidity
+function releasable(contract IERC20Upgradeable token, address account) external view returns (uint256)
+```
+
+
+
+*Getter for the amount of payee's releasable `token` tokens. `token` should be the address of an IERC20 contract.*
+
+#### Parameters
+
+| Name | Type | Description |
+|---|---|---|
+| token | contract IERC20Upgradeable | undefined |
+| account | address | undefined |
+
 #### Returns
 
 | Name | Type | Description |