@rev-net/core-v6 0.0.7 → 0.0.9

package/src/REVLoans.sol

@@ -57,14 +57,15 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
 
     error REVLoans_CollateralExceedsLoan(uint256 collateralToReturn, uint256 loanCollateral);
     error REVLoans_InvalidPrepaidFeePercent(uint256 prepaidFeePercent, uint256 min, uint256 max);
-    error REVLoans_NotEnoughCollateral();
-    error REVLoans_OverflowAlert(uint256 value, uint256 limit);
-    error REVLoans_OverMaxRepayBorrowAmount(uint256 maxRepayBorrowAmount, uint256 repayBorrowAmount);
-    error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
+    error REVLoans_InvalidTerminal(address terminal, uint256 revnetId);
+    error REVLoans_LoanExpired(uint256 timeSinceLoanCreated, uint256 loanLiquidationDuration);
     error REVLoans_NewBorrowAmountGreaterThanLoanAmount(uint256 newBorrowAmount, uint256 loanAmount);
     error REVLoans_NoMsgValueAllowed();
+    error REVLoans_NotEnoughCollateral();
     error REVLoans_NothingToRepay();
-    error REVLoans_LoanExpired(uint256 timeSinceLoanCreated, uint256 loanLiquidationDuration);
+    error REVLoans_OverMaxRepayBorrowAmount(uint256 maxRepayBorrowAmount, uint256 repayBorrowAmount);
+    error REVLoans_OverflowAlert(uint256 value, uint256 limit);
+    error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
     error REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(uint256 newBorrowAmount, uint256 loanAmount);
     error REVLoans_SourceMismatch();
     error REVLoans_Unauthorized(address caller, address owner);
@@ -257,6 +258,13 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         return _determineSourceFeeAmount(loan, amount);
     }
 
+    /// @notice The revnet ID for the loan with the provided loan ID.
+    /// @param loanId The loan ID of the loan to get the revnet ID of.
+    /// @return The ID of the revnet.
+    function revnetIdOfLoanWith(uint256 loanId) public pure override returns (uint256) {
+        return loanId / _ONE_TRILLION;
+    }
+
     /// @notice Returns the URI where the ERC-721 standard JSON of a loan is hosted.
     /// @param loanId The ID of the loan to get a URI of.
     /// @return The token URI to use for the provided `loanId`.
@@ -271,13 +279,6 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         return resolver.getUri(loanId);
     }
 
-    /// @notice The revnet ID for the loan with the provided loan ID.
-    /// @param loanId The loan ID of the loan to get the revnet ID of.
-    /// @return The ID of the revnet.
-    function revnetIdOfLoanWith(uint256 loanId) public pure override returns (uint256) {
-        return loanId / _ONE_TRILLION;
-    }
-
     //*********************************************************************//
     // -------------------------- internal views ------------------------- //
     //*********************************************************************//
@@ -556,6 +557,11 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         // A loan needs to have collateral.
         if (collateralCount == 0) revert REVLoans_ZeroCollateralLoanIsInvalid();
 
+        // Make sure the source terminal is registered in the directory for this revnet.
+        if (!DIRECTORY.isTerminalOf(revnetId, IJBTerminal(address(source.terminal)))) {
+            revert REVLoans_InvalidTerminal(address(source.terminal), revnetId);
+        }
+
         // Make sure the prepaid fee percent is between `MIN_PREPAID_FEE_PERCENT` and `MAX_PREPAID_FEE_PERCENT`. Meaning
         // an 16 year loan can be paid upfront with a
         // payment of 50% of the borrowed assets, the cheapest possible rate.
@@ -839,6 +845,56 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
     // --------------------- internal transactions ----------------------- //
     //*********************************************************************//
 
+    /// @notice Accepts an incoming token.
+    /// @param token The token being accepted.
+    /// @param amount The number of tokens being accepted.
+    /// @param allowance The permit2 context.
+    /// @return amount The number of tokens which have been accepted.
+    function _acceptFundsFor(
+        address token,
+        uint256 amount,
+        JBSingleAllowance memory allowance
+    )
+        internal
+        returns (uint256)
+    {
+        // If the token is the native token, override `amount` with `msg.value`.
+        if (token == JBConstants.NATIVE_TOKEN) return msg.value;
+
+        // If the token is not native, revert if there is a non-zero `msg.value`.
+        if (msg.value != 0) revert REVLoans_NoMsgValueAllowed();
+
+        // Check if the metadata contains permit data.
+        if (allowance.amount != 0) {
+            // Make sure the permit allowance is enough for this payment. If not we revert early.
+            if (allowance.amount < amount) {
+                revert REVLoans_PermitAllowanceNotEnough(allowance.amount, amount);
+            }
+
+            // Keep a reference to the permit rules.
+            IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer.PermitSingle({
+                details: IAllowanceTransfer.PermitDetails({
+                    token: token, amount: allowance.amount, expiration: allowance.expiration, nonce: allowance.nonce
+                }),
+                spender: address(this),
+                sigDeadline: allowance.sigDeadline
+            });
+
+            // Set the allowance to `spend` tokens for the user.
+            try PERMIT2.permit({owner: _msgSender(), permitSingle: permitSingle, signature: allowance.signature}) {}
+                catch (bytes memory) {}
+        }
+
+        // Get a reference to the balance before receiving tokens.
+        uint256 balanceBefore = _balanceOf(token);
+
+        // Transfer tokens to this terminal from the msg sender.
+        _transferFrom({from: _msgSender(), to: payable(address(this)), token: token, amount: amount});
+
+        // The amount should reflect the change in balance.
+        return _balanceOf(token) - balanceBefore;
+    }
+
     /// @notice Adds collateral to a loan by burning the collateral tokens permanently.
     /// @dev The collateral tokens are burned via the controller, not held in escrow. They are only re-minted if the
     /// loan is repaid. If the loan expires and is liquidated, the burned collateral is permanently lost.
@@ -1028,67 +1084,118 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         }
     }
 
-    /// @notice Accepts an incoming token.
-    /// @param token The token being accepted.
-    /// @param amount The number of tokens being accepted.
-    /// @param allowance The permit2 context.
-    /// @return amount The number of tokens which have been accepted.
-    function _acceptFundsFor(
-        address token,
-        uint256 amount,
-        JBSingleAllowance memory allowance
+    /// @notice Logic to be triggered before transferring tokens from this contract.
+    /// @param to The address the transfer is going to.
+    /// @param token The token being transferred.
+    /// @param amount The number of tokens being transferred, as a fixed point number with the same number of decimals
+    /// as the token specifies.
+    /// @return payValue The value to attach to the transaction being sent.
+    function _beforeTransferTo(address to, address token, uint256 amount) internal returns (uint256) {
+        // If the token is the native token, no allowance needed.
+        if (token == JBConstants.NATIVE_TOKEN) return amount;
+        IERC20(token).safeIncreaseAllowance(to, amount);
+        return 0;
+    }
+
+    /// @notice Reallocates collateral from a loan by making a new loan based on the original, with reduced collateral.
+    /// @param loanId The ID of the loan to reallocate collateral from.
+    /// @param revnetId The ID of the revnet the loan is from.
+    /// @param collateralCountToRemove The amount of collateral to remove from the loan.
+    /// @return reallocatedLoanId The ID of the loan.
+    /// @return reallocatedLoan The reallocated loan.
+    function _reallocateCollateralFromLoan(
+        uint256 loanId,
+        uint256 revnetId,
+        uint256 collateralCountToRemove
     )
         internal
-        returns (uint256)
+        returns (uint256 reallocatedLoanId, REVLoan storage reallocatedLoan)
     {
-        // If the token is the native token, override `amount` with `msg.value`.
-        if (token == JBConstants.NATIVE_TOKEN) return msg.value;
+        // Burn the original loan.
+        _burn(loanId);
 
-        // If the token is not native, revert if there is a non-zero `msg.value`.
-        if (msg.value != 0) revert REVLoans_NoMsgValueAllowed();
+        // Keep a reference to loan having its collateral reduced.
+        REVLoan storage loan = _loanOf[loanId];
 
-        // Check if the metadata contains permit data.
-        if (allowance.amount != 0) {
-            // Make sure the permit allowance is enough for this payment. If not we revert early.
-            if (allowance.amount < amount) {
-                revert REVLoans_PermitAllowanceNotEnough(allowance.amount, amount);
-            }
+        // Make sure there is enough collateral to transfer.
+        if (collateralCountToRemove > loan.collateral) revert REVLoans_NotEnoughCollateral();
 
-            // Keep a reference to the permit rules.
-            IAllowanceTransfer.PermitSingle memory permitSingle = IAllowanceTransfer.PermitSingle({
-                details: IAllowanceTransfer.PermitDetails({
-                    token: token, amount: allowance.amount, expiration: allowance.expiration, nonce: allowance.nonce
-                }),
-                spender: address(this),
-                sigDeadline: allowance.sigDeadline
-            });
+        // Keep a reference to the new collateral amount.
+        uint256 newCollateralCount = loan.collateral - collateralCountToRemove;
 
-            // Set the allowance to `spend` tokens for the user.
-            try PERMIT2.permit({owner: _msgSender(), permitSingle: permitSingle, signature: allowance.signature}) {}
-                catch (bytes memory) {}
+        // Keep a reference to the new borrow amount.
+        uint256 borrowAmount = _borrowAmountFrom({loan: loan, revnetId: revnetId, collateralCount: newCollateralCount});
+
+        // Make sure the borrow amount is not less than the original loan's amount.
+        if (borrowAmount < loan.amount) {
+            revert REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(borrowAmount, loan.amount);
         }
 
-        // Get a reference to the balance before receiving tokens.
-        uint256 balanceBefore = _balanceOf(token);
+        // Get a reference to the replacement loan ID.
+        reallocatedLoanId = _generateLoanId({revnetId: revnetId, loanNumber: ++totalLoansBorrowedFor[revnetId]});
 
-        // Transfer tokens to this terminal from the msg sender.
-        _transferFrom({from: _msgSender(), to: payable(address(this)), token: token, amount: amount});
+        // Get a reference to the loan being created.
+        reallocatedLoan = _loanOf[reallocatedLoanId];
 
-        // The amount should reflect the change in balance.
-        return _balanceOf(token) - balanceBefore;
+        // Set the reallocated loan's values the same as the original loan.
+        reallocatedLoan.amount = loan.amount;
+        reallocatedLoan.collateral = loan.collateral;
+        reallocatedLoan.createdAt = loan.createdAt;
+        reallocatedLoan.prepaidFeePercent = loan.prepaidFeePercent;
+        reallocatedLoan.prepaidDuration = loan.prepaidDuration;
+        reallocatedLoan.source = loan.source;
+
+        // Reduce the collateral of the reallocated loan.
+        _adjust({
+            loan: reallocatedLoan,
+            revnetId: revnetId,
+            newBorrowAmount: reallocatedLoan.amount, // Don't change the borrow amount.
+            newCollateralCount: newCollateralCount,
+            sourceFeeAmount: 0,
+            beneficiary: payable(_msgSender()) // use the msgSender as the beneficiary, who will have the returned
+            // collateral tokens debited from their balance for the new loan.
+        });
+
+        // Mint the replacement loan.
+        _mint({to: _msgSender(), tokenId: reallocatedLoanId});
+
+        // Clear stale loan data for gas refund.
+        delete _loanOf[loanId];
+
+        emit ReallocateCollateral({
+            loanId: loanId,
+            revnetId: revnetId,
+            reallocatedLoanId: reallocatedLoanId,
+            reallocatedLoan: reallocatedLoan,
+            removedCollateralCount: collateralCountToRemove,
+            caller: _msgSender()
+        });
     }
 
-    /// @notice Logic to be triggered before transferring tokens from this contract.
-    /// @param to The address the transfer is going to.
-    /// @param token The token being transferred.
-    /// @param amount The number of tokens being transferred, as a fixed point number with the same number of decimals
-    /// as the token specifies.
-    /// @return payValue The value to attach to the transaction being sent.
-    function _beforeTransferTo(address to, address token, uint256 amount) internal returns (uint256) {
-        // If the token is the native token, no allowance needed.
-        if (token == JBConstants.NATIVE_TOKEN) return amount;
-        IERC20(token).safeIncreaseAllowance(to, amount);
-        return 0;
+    /// @notice Pays off a loan.
+    /// @param loan The loan being paid off.
+    /// @param revnetId The ID of the revnet the loan is being paid off in.
+    /// @param repaidBorrowAmount The amount being paid off, denominated in the token of the source's accounting
+    /// context.
+    function _removeFrom(REVLoan memory loan, uint256 revnetId, uint256 repaidBorrowAmount) internal {
+        // Decrement the total amount of a token being loaned out by the revnet from its terminal.
+        totalBorrowedFrom[revnetId][loan.source.terminal][loan.source.token] -= repaidBorrowAmount;
+
+        // Increase the allowance for the beneficiary.
+        uint256 payValue = _beforeTransferTo({
+            to: address(loan.source.terminal), token: loan.source.token, amount: repaidBorrowAmount
+        });
+
+        // Add the loaned amount back to the revnet.
+        // slither-disable-next-line arbitrary-send-eth
+        loan.source.terminal.addToBalanceOf{value: payValue}({
+            projectId: revnetId,
+            token: loan.source.token,
+            amount: repaidBorrowAmount,
+            shouldReturnHeldFees: false,
+            memo: "Paying off loan",
+            metadata: bytes(abi.encodePacked(REV_ID))
+        });
     }
 
     /// @notice Pays down a loan.
@@ -1117,6 +1224,9 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         // If the loan will carry no more amount or collateral, store its changes directly.
         // slither-disable-next-line incorrect-equality
         if (collateralCountToReturn == loan.collateral) {
+            // Snapshot the loan to memory BEFORE _adjust zeroes the storage pointer.
+            REVLoan memory loanSnapshot = loan;
+
             // Borrow in.
             _adjust({
                 loan: loan,
@@ -1127,15 +1237,15 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
                 beneficiary: beneficiary
             });
 
-            // Snapshot the loan to memory before deleting storage.
-            REVLoan memory loanSnapshot = loan;
+            // Snapshot the zeroed loan for the return value (reflects post-repay state).
+            REVLoan memory paidOffSnapshot = loan;
 
             emit RepayLoan({
                 loanId: loanId,
                 revnetId: revnetId,
                 paidOffLoanId: loanId,
                 loan: loanSnapshot,
-                paidOffLoan: loanSnapshot,
+                paidOffLoan: paidOffSnapshot,
                 repayBorrowAmount: repayBorrowAmount,
                 sourceFeeAmount: sourceFeeAmount,
                 collateralCountToReturn: collateralCountToReturn,
@@ -1146,7 +1256,7 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
             // Clear stale loan data for gas refund.
             delete _loanOf[loanId];
 
-            return (loanId, loanSnapshot);
+            return (loanId, paidOffSnapshot);
         } else {
             // Make a new loan with the remaining amount and collateral.
             // Get a reference to the replacement loan ID.
@@ -1196,107 +1306,6 @@ contract REVLoans is ERC721, ERC2771Context, Ownable, IREVLoans {
         }
     }
 
-    /// @notice Reallocates collateral from a loan by making a new loan based on the original, with reduced collateral.
-    /// @param loanId The ID of the loan to reallocate collateral from.
-    /// @param revnetId The ID of the revnet the loan is from.
-    /// @param collateralCountToRemove The amount of collateral to remove from the loan.
-    /// @return reallocatedLoanId The ID of the loan.
-    /// @return reallocatedLoan The reallocated loan.
-    function _reallocateCollateralFromLoan(
-        uint256 loanId,
-        uint256 revnetId,
-        uint256 collateralCountToRemove
-    )
-        internal
-        returns (uint256 reallocatedLoanId, REVLoan storage reallocatedLoan)
-    {
-        // Burn the original loan.
-        _burn(loanId);
-
-        // Keep a reference to loan having its collateral reduced.
-        REVLoan storage loan = _loanOf[loanId];
-
-        // Make sure there is enough collateral to transfer.
-        if (collateralCountToRemove > loan.collateral) revert REVLoans_NotEnoughCollateral();
-
-        // Keep a reference to the new collateral amount.
-        uint256 newCollateralCount = loan.collateral - collateralCountToRemove;
-
-        // Keep a reference to the new borrow amount.
-        uint256 borrowAmount = _borrowAmountFrom({loan: loan, revnetId: revnetId, collateralCount: newCollateralCount});
-
-        // Make sure the borrow amount is not less than the original loan's amount.
-        if (borrowAmount < loan.amount) {
-            revert REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(borrowAmount, loan.amount);
-        }
-
-        // Get a reference to the replacement loan ID.
-        reallocatedLoanId = _generateLoanId({revnetId: revnetId, loanNumber: ++totalLoansBorrowedFor[revnetId]});
-
-        // Get a reference to the loan being created.
-        reallocatedLoan = _loanOf[reallocatedLoanId];
-
-        // Set the reallocated loan's values the same as the original loan.
-        reallocatedLoan.amount = loan.amount;
-        reallocatedLoan.collateral = loan.collateral;
-        reallocatedLoan.createdAt = loan.createdAt;
-        reallocatedLoan.prepaidFeePercent = loan.prepaidFeePercent;
-        reallocatedLoan.prepaidDuration = loan.prepaidDuration;
-        reallocatedLoan.source = loan.source;
-
-        // Reduce the collateral of the reallocated loan.
-        _adjust({
-            loan: reallocatedLoan,
-            revnetId: revnetId,
-            newBorrowAmount: reallocatedLoan.amount, // Don't change the borrow amount.
-            newCollateralCount: newCollateralCount,
-            sourceFeeAmount: 0,
-            beneficiary: payable(_msgSender()) // use the msgSender as the beneficiary, who will have the returned
-            // collateral tokens debited from their balance for the new loan.
-        });
-
-        // Mint the replacement loan.
-        _mint({to: _msgSender(), tokenId: reallocatedLoanId});
-
-        // Clear stale loan data for gas refund.
-        delete _loanOf[loanId];
-
-        emit ReallocateCollateral({
-            loanId: loanId,
-            revnetId: revnetId,
-            reallocatedLoanId: reallocatedLoanId,
-            reallocatedLoan: reallocatedLoan,
-            removedCollateralCount: collateralCountToRemove,
-            caller: _msgSender()
-        });
-    }
-
-    /// @notice Pays off a loan.
-    /// @param loan The loan being paid off.
-    /// @param revnetId The ID of the revnet the loan is being paid off in.
-    /// @param repaidBorrowAmount The amount being paid off, denominated in the token of the source's accounting
-    /// context.
-    function _removeFrom(REVLoan memory loan, uint256 revnetId, uint256 repaidBorrowAmount) internal {
-        // Decrement the total amount of a token being loaned out by the revnet from its terminal.
-        totalBorrowedFrom[revnetId][loan.source.terminal][loan.source.token] -= repaidBorrowAmount;
-
-        // Increase the allowance for the beneficiary.
-        uint256 payValue = _beforeTransferTo({
-            to: address(loan.source.terminal), token: loan.source.token, amount: repaidBorrowAmount
-        });
-
-        // Add the loaned amount back to the revnet.
-        // slither-disable-next-line arbitrary-send-eth
-        loan.source.terminal.addToBalanceOf{value: payValue}({
-            projectId: revnetId,
-            token: loan.source.token,
-            amount: repaidBorrowAmount,
-            shouldReturnHeldFees: false,
-            memo: "Paying off loan",
-            metadata: bytes(abi.encodePacked(REV_ID))
-        });
-    }
-
     /// @notice Returns collateral from a loan.
     /// @param revnetId The ID of the revnet the loan is being returned in.
     /// @param collateralCount The amount of collateral being returned from the loan.