@rev-net/core-v6 0.0.13 → 0.0.15

package/docs/src/src/REVLoans.sol/contract.REVLoans.md

@@ -1,1108 +0,0 @@
-# REVLoans
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/REVLoans.sol)
-
-**Inherits:**
-ERC721, ERC2771Context, Ownable, [IREVLoans](/src/interfaces/IREVLoans.sol/interface.IREVLoans.md)
-
-A contract for borrowing from revnets.
-
-Tokens used as collateral are burned, and reminted when the loan is paid off. This keeps the revnet's token
-structure orderly.
-
-The borrowable amount is the same as the cash out amount.
-
-An upfront fee is taken when a loan is created. 2.5% is charged by the underlying protocol, 2.5% is charged
-by the
-revnet issuing the loan, and a variable amount charged by the revnet that receives the fees. This variable amount is
-chosen by the borrower, the more paid upfront, the longer the prepaid duration. The loan can be repaid anytime
-within the prepaid duration without additional fees.
-After the prepaid duration, the loan will increasingly cost more to pay off. After 10 years, the loan collateral
-cannot be
-recouped.
-
-The loaned amounts include the fees taken, meaning the amount paid back is the amount borrowed plus the fees.
-
-
-## State Variables
-### LOAN_LIQUIDATION_DURATION
-After the prepaid duration, the loan will cost more to pay off. After 10 years, the loan
-collateral cannot be recouped. This means paying 50% of the loan amount upfront will pay for having access to
-the remaining 50% for 10 years,
-whereas paying 0% of the loan upfront will cost 100% of the loan amount to be paid off after 10 years. After 10
-years with repayment, both loans cost 100% and are liquidated.
-
-
-```solidity
-uint256 public constant override LOAN_LIQUIDATION_DURATION = 3650 days
-```
-
-
-### MAX_PREPAID_FEE_PERCENT
-The maximum amount of a loan that can be prepaid at the time of borrowing, in terms of JBConstants.MAX_FEE.
-
-
-```solidity
-uint256 public constant override MAX_PREPAID_FEE_PERCENT = 500
-```
-
-
-### REV_PREPAID_FEE_PERCENT
-A fee of 1% is charged by the $REV revnet.
-
-
-```solidity
-uint256 public constant override REV_PREPAID_FEE_PERCENT = 10
-```
-
-
-### MIN_PREPAID_FEE_PERCENT
-A fee of 2.5% is charged by the loan's source upfront.
-
-
-```solidity
-uint256 public constant override MIN_PREPAID_FEE_PERCENT = 25
-```
-
-
-### _ONE_TRILLION
-Just a kind reminder to our readers.
-
-Used in loan token ID generation.
-
-
-```solidity
-uint256 private constant _ONE_TRILLION = 1_000_000_000_000
-```
-
-
-### PERMIT2
-The permit2 utility.
-
-
-```solidity
-IPermit2 public immutable override PERMIT2
-```
-
-
-### CONTROLLER
-The controller of revnets that use this loans contract.
-
-
-```solidity
-IJBController public immutable override CONTROLLER
-```
-
-
-### DIRECTORY
-The directory of terminals and controllers for revnets.
-
-
-```solidity
-IJBDirectory public immutable override DIRECTORY
-```
-
-
-### PRICES
-A contract that stores prices for each revnet.
-
-
-```solidity
-IJBPrices public immutable override PRICES
-```
-
-
-### PROJECTS
-Mints ERC-721s that represent revnet ownership and transfers.
-
-
-```solidity
-IJBProjects public immutable override PROJECTS
-```
-
-
-### REV_ID
-The ID of the REV revnet that will receive the fees.
-
-
-```solidity
-uint256 public immutable override REV_ID
-```
-
-
-### isLoanSourceOf
-An indication if a revnet currently has outstanding loans from the specified terminal in the specified
-token.
-
-
-```solidity
-mapping(uint256 revnetId => mapping(IJBPayoutTerminal terminal => mapping(address token => bool)))
-    public
-    override isLoanSourceOf
-```
-
-
-### totalLoansBorrowedFor
-The cumulative number of loans ever created for a revnet, used as a loan ID sequence counter.
-
-This counter only increments (on borrow, repay-with-new-loan, and reallocation) and never decrements.
-It does NOT represent the number of currently active loans. Repaid and liquidated loans leave permanent gaps
-in the ID sequence. Integrators should not use this to count active loans.
-
-
-```solidity
-mapping(uint256 revnetId => uint256) public override totalLoansBorrowedFor
-```
-
-
-### tokenUriResolver
-The contract resolving each project ID to its ERC721 URI.
-
-
-```solidity
-IJBTokenUriResolver public override tokenUriResolver
-```
-
-
-### totalBorrowedFrom
-The total amount loaned out by a revnet from a specified terminal in a specified token.
-
-
-```solidity
-mapping(uint256 revnetId => mapping(IJBPayoutTerminal terminal => mapping(address token => uint256)))
-    public
-    override totalBorrowedFrom
-```
-
-
-### totalCollateralOf
-The total amount of collateral supporting a revnet's loans.
-
-
-```solidity
-mapping(uint256 revnetId => uint256) public override totalCollateralOf
-```
-
-
-### _loanSourcesOf
-The sources of each revnet's loan.
-
-This array grows monotonically -- entries are appended when a new (terminal, token) pair is first used for
-borrowing, but are never removed. The `isLoanSourceOf` mapping tracks whether a source has been registered.
-Since the number of distinct (terminal, token) pairs per revnet is practically bounded (typically < 10),
-the gas cost of iterating this array in `loanSourcesOf` remains manageable.
-
-**Note:**
-member: revnetId The ID of the revnet issuing the loan.
-
-
-```solidity
-mapping(uint256 revnetId => REVLoanSource[]) internal _loanSourcesOf
-```
-
-
-### _loanOf
-The loans.
-
-**Note:**
-member: The ID of the loan.
-
-
-```solidity
-mapping(uint256 loanId => REVLoan) internal _loanOf
-```
-
-
-## Functions
-### constructor
-
-
-```solidity
-constructor(
-    IJBController controller,
-    IJBProjects projects,
-    uint256 revId,
-    address owner,
-    IPermit2 permit2,
-    address trustedForwarder
-)
-    ERC721("REV Loans", "$REVLOAN")
-    ERC2771Context(trustedForwarder)
-    Ownable(owner);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`controller`|`IJBController`|The controller that manages revnets using this loans contract.|
-|`projects`|`IJBProjects`|The contract that mints ERC-721s representing project ownership.|
-|`revId`|`uint256`|The ID of the REV revnet that will receive the fees.|
-|`owner`|`address`|The owner of the contract that can set the URI resolver.|
-|`permit2`|`IPermit2`|A permit2 utility.|
-|`trustedForwarder`|`address`|A trusted forwarder of transactions to this contract.|
-
-
-### borrowableAmountFrom
-
-The amount that can be borrowed from a revnet.
-
-
-```solidity
-function borrowableAmountFrom(
-    uint256 revnetId,
-    uint256 collateralCount,
-    uint256 decimals,
-    uint256 currency
-)
-    external
-    view
-    returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet to check for borrowable assets from.|
-|`collateralCount`|`uint256`|The amount of collateral used to secure the loan.|
-|`decimals`|`uint256`|The decimals the resulting fixed point value will include.|
-|`currency`|`uint256`|The currency that the resulting amount should be in terms of.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|borrowableAmount The amount that can be borrowed from the revnet.|
-
-
-### loanOf
-
-Get a loan.
-
-**Note:**
-member: The ID of the loan.
-
-
-```solidity
-function loanOf(uint256 loanId) external view override returns (REVLoan memory);
-```
-
-### loanSourcesOf
-
-The sources of each revnet's loan.
-
-This array only grows -- sources are never removed. The number of distinct sources is practically bounded
-by the number of unique (terminal, token) pairs used for borrowing, which is typically small.
-
-**Note:**
-member: revnetId The ID of the revnet issuing the loan.
-
-
-```solidity
-function loanSourcesOf(uint256 revnetId) external view override returns (REVLoanSource[] memory);
-```
-
-### determineSourceFeeAmount
-
-Determines the source fee amount for a loan being paid off a certain amount.
-
-
-```solidity
-function determineSourceFeeAmount(REVLoan memory loan, uint256 amount) public view returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan having its source fee amount determined.|
-|`amount`|`uint256`|The amount being paid off.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|sourceFeeAmount The source fee amount for the loan.|
-
-
-### tokenURI
-
-Returns the URI where the ERC-721 standard JSON of a loan is hosted.
-
-
-```solidity
-function tokenURI(uint256 loanId) public view override returns (string memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan to get a URI of.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`string`|The token URI to use for the provided `loanId`.|
-
-
-### revnetIdOfLoanWith
-
-The revnet ID for the loan with the provided loan ID.
-
-
-```solidity
-function revnetIdOfLoanWith(uint256 loanId) public pure override returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The loan ID of the loan to get the revnet ID of.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|The ID of the revnet.|
-
-
-### _balanceOf
-
-Checks this contract's balance of a specific token.
-
-
-```solidity
-function _balanceOf(address token) internal view returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`token`|`address`|The address of the token to get this contract's balance of.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|This contract's balance.|
-
-
-### _borrowableAmountFrom
-
-This function reads live surplus from the revnet's terminals. A potential concern is flash loan
-manipulation: an attacker could temporarily inflate surplus via `addToBalanceOf` or `pay`, borrow at the
-inflated rate, then repay the flash loan. However, this attack is economically irrational:
-- `addToBalanceOf` permanently donates funds to the project (no recovery mechanism). The attacker's extra
-borrowable amount equals `donation * (collateralCount / totalSupply)`, which is always less than the
-donation since `collateralCount < totalSupply`. The attacker loses more than they gain.
-- `pay` increases both surplus AND totalSupply (via newly minted tokens), so the net effect on the
-borrowable-amount-per-token ratio is neutral — the increased surplus is offset by supply dilution.
-- With non-zero `cashOutTaxRate`, the bonding curve is concave, making the attack even less profitable.
-- Refinancing during inflated surplus (`reallocateCollateralFromLoan`) does not help either: the freed
-collateral can only borrow a fraction of the donated amount, keeping the attack net-negative.
-In summary, any attempt to inflate surplus to increase borrowing power costs the attacker more than it yields,
-because the bonding curve ensures no individual can extract more than their proportional share of surplus.
-
-The amount that can be borrowed from a revnet given a certain amount of collateral.
-
-The system intentionally allows up to 100% LTV (loan-to-value) by design. The borrowable amount equals
-what the collateral tokens would receive if cashed out, computed via the bonding curve formula in
-`JBCashOuts.cashOutFrom`. The `cashOutTaxRate` configured for the current stage serves as an implicit margin
-buffer: a non-zero tax rate reduces the cash-out value below the pro-rata share of surplus, creating an
-effective collateralization margin. For example, a 20% `cashOutTaxRate` means borrowers can only extract ~80%
-of their pro-rata surplus, providing a ~20% buffer against collateral depreciation before liquidation.
-A `cashOutTaxRate` of 0 means the full pro-rata amount is borrowable (true 100% LTV with no margin).
-
-
-```solidity
-function _borrowableAmountFrom(
-    uint256 revnetId,
-    uint256 collateralCount,
-    uint256 decimals,
-    uint256 currency,
-    IJBTerminal[] memory terminals
-)
-    internal
-    view
-    returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet to check for borrowable assets from.|
-|`collateralCount`|`uint256`|The amount of collateral that the loan will be collateralized with.|
-|`decimals`|`uint256`|The decimals the resulting fixed point value will include.|
-|`currency`|`uint256`|The currency that the resulting amount should be in terms of.|
-|`terminals`|`IJBTerminal[]`|The terminals that the funds are being borrowed from.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|borrowableAmount The amount that can be borrowed from the revnet.|
-
-
-### _borrowAmountFrom
-
-The amount of the loan that should be borrowed for the given collateral amount.
-
-
-```solidity
-function _borrowAmountFrom(
-    REVLoan storage loan,
-    uint256 revnetId,
-    uint256 collateralCount
-)
-    internal
-    view
-    returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan having its borrow amount determined.|
-|`revnetId`|`uint256`|The ID of the revnet to check for borrowable assets from.|
-|`collateralCount`|`uint256`|The amount of collateral that the loan will be collateralized with.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|borrowAmount The amount of the loan that should be borrowed.|
-
-
-### _contextSuffixLength
-
-`ERC-2771` specifies the context as being a single address (20 bytes).
-
-
-```solidity
-function _contextSuffixLength() internal view override(ERC2771Context, Context) returns (uint256);
-```
-
-### _determineSourceFeeAmount
-
-Determines the source fee amount for a loan being paid off a certain amount.
-
-
-```solidity
-function _determineSourceFeeAmount(REVLoan memory loan, uint256 amount) internal view returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan having its source fee amount determined.|
-|`amount`|`uint256`|The amount being paid off.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|The source fee amount for the loan.|
-
-
-### _generateLoanId
-
-Generate a ID for a loan given a revnet ID and a loan number within that revnet.
-
-
-```solidity
-function _generateLoanId(uint256 revnetId, uint256 loanNumber) internal pure returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet to generate a loan ID for.|
-|`loanNumber`|`uint256`|The loan number of the loan within the revnet.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|The token ID of the 721.|
-
-
-### _msgData
-
-The calldata. Preferred to use over `msg.data`.
-
-
-```solidity
-function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata);
-```
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|calldata The `msg.data` of this call.|
-
-
-### _msgSender
-
-The message's sender. Preferred to use over `msg.sender`.
-
-
-```solidity
-function _msgSender() internal view override(ERC2771Context, Context) returns (address sender);
-```
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`sender`|`address`|The address which sent this call.|
-
-
-### _totalBorrowedFrom
-
-The total borrowed amount from a revnet, aggregated across all loan sources.
-
-Each source's `totalBorrowedFrom` is stored in the source token's native decimals (e.g. 6 for USDC,
-18 for ETH). Before aggregation, each amount is normalized to the target `decimals` to prevent mixed-decimal
-arithmetic errors. For cross-currency sources, the normalized amount is then converted via the price feed.
-
-Callers should ensure the price feed has sufficient precision for the target `decimals`. Inverse price
-feeds may truncate to zero at low decimal counts (e.g. a feed returning 1e21 at 6 decimals inverts to
-mulDiv(1e6, 1e6, 1e21) = 0), which would cause a division-by-zero in the price conversion.
-
-
-```solidity
-function _totalBorrowedFrom(
-    uint256 revnetId,
-    uint256 decimals,
-    uint256 currency
-)
-    internal
-    view
-    returns (uint256 borrowedAmount);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet to check for borrowed assets from.|
-|`decimals`|`uint256`|The decimals the resulting fixed point value will include.|
-|`currency`|`uint256`|The currency the resulting value will be in terms of.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`borrowedAmount`|`uint256`|The total amount borrowed.|
-
-
-### borrowFrom
-
-Open a loan by borrowing from a revnet.
-
-Collateral tokens are permanently burned when the loan is created. They are re-minted to the borrower
-only upon repayment. If the loan expires (after LOAN_LIQUIDATION_DURATION), the collateral is permanently
-lost and cannot be recovered.
-
-
-```solidity
-function borrowFrom(
-    uint256 revnetId,
-    REVLoanSource calldata source,
-    uint256 minBorrowAmount,
-    uint256 collateralCount,
-    address payable beneficiary,
-    uint256 prepaidFeePercent
-)
-    public
-    override
-    returns (uint256 loanId, REVLoan memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet being borrowed from.|
-|`source`|`REVLoanSource`|The source of the loan being borrowed.|
-|`minBorrowAmount`|`uint256`|The minimum amount being borrowed, denominated in the token of the source's accounting context.|
-|`collateralCount`|`uint256`|The amount of tokens to use as collateral for the loan.|
-|`beneficiary`|`address payable`|The address that'll receive the borrowed funds and the tokens resulting from fee payments.|
-|`prepaidFeePercent`|`uint256`|The fee percent that will be charged upfront from the revnet being borrowed from. Prepaying a fee is cheaper than paying later.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan created from borrowing.|
-|`<none>`|`REVLoan`|loan The loan created from borrowing.|
-
-
-### liquidateExpiredLoansFrom
-
-Liquidates loans that have exceeded the 10-year liquidation duration.
-
-Liquidation permanently destroys the collateral backing expired loans. Since collateral tokens were burned
-at deposit time (not held in escrow), there is nothing to return upon liquidation -- the collateral count is
-simply removed from tracking. The borrower retains whatever funds they received from the loan, but the
-collateral tokens that were burned to secure the loan are permanently lost.
-
-This is an intentional design choice to keep the protocol simple and to incentivize timely repayment or
-refinancing. Borrowers have the full LOAN_LIQUIDATION_DURATION (10 years) to repay their loan and recover
-their collateral via re-minting.
-
-Since some loans may be reallocated or paid off, loans within startingLoanId and startingLoanId + count
-may be skipped, so choose these parameters carefully to avoid extra gas usage.
-
-
-```solidity
-function liquidateExpiredLoansFrom(uint256 revnetId, uint256 startingLoanId, uint256 count) external override;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet to liquidate loans from.|
-|`startingLoanId`|`uint256`|The ID of the loan to start iterating from.|
-|`count`|`uint256`|The amount of loans iterate over since the last liquidated loan.|
-
-
-### reallocateCollateralFromLoan
-
-Refinances a loan by transferring extra collateral from an existing loan to a new loan.
-
-Useful if a loan's collateral has gone up in value since the loan was created.
-
-Refinancing a loan will burn the original and create two new loans.
-
-This function is intentionally not payable — it only moves existing collateral between loans and does
-not accept new funds. Any ETH sent with the call will be rejected by the EVM.
-
-
-```solidity
-function reallocateCollateralFromLoan(
-    uint256 loanId,
-    uint256 collateralCountToTransfer,
-    REVLoanSource calldata source,
-    uint256 minBorrowAmount,
-    uint256 collateralCountToAdd,
-    address payable beneficiary,
-    uint256 prepaidFeePercent
-)
-    external
-    override
-    returns (uint256 reallocatedLoanId, uint256 newLoanId, REVLoan memory reallocatedLoan, REVLoan memory newLoan);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan to reallocate collateral from.|
-|`collateralCountToTransfer`|`uint256`|The amount of collateral to transfer from the original loan.|
-|`source`|`REVLoanSource`|The source of the loan to create.|
-|`minBorrowAmount`|`uint256`|The minimum amount being borrowed, denominated in the token of the source's accounting context.|
-|`collateralCountToAdd`|`uint256`|The amount of collateral to add to the loan.|
-|`beneficiary`|`address payable`|The address that'll receive the borrowed funds and the tokens resulting from fee payments.|
-|`prepaidFeePercent`|`uint256`|The fee percent that will be charged upfront from the revnet being borrowed from.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`reallocatedLoanId`|`uint256`|The ID of the loan being reallocated.|
-|`newLoanId`|`uint256`|The ID of the new loan.|
-|`reallocatedLoan`|`REVLoan`|The loan being reallocated.|
-|`newLoan`|`REVLoan`|The new loan created from reallocating collateral.|
-
-
-### repayLoan
-
-Allows the owner of a loan to pay it back or receive returned collateral no longer necessary to support
-the loan.
-
-
-```solidity
-function repayLoan(
-    uint256 loanId,
-    uint256 maxRepayBorrowAmount,
-    uint256 collateralCountToReturn,
-    address payable beneficiary,
-    JBSingleAllowance calldata allowance
-)
-    external
-    payable
-    override
-    returns (uint256 paidOffLoanId, REVLoan memory paidOffloan);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan being adjusted.|
-|`maxRepayBorrowAmount`|`uint256`|The maximum amount being paid off, denominated in the token of the source's accounting context.|
-|`collateralCountToReturn`|`uint256`|The amount of collateral being returned from the loan.|
-|`beneficiary`|`address payable`|The address receiving the returned collateral and any tokens resulting from paying fees.|
-|`allowance`|`JBSingleAllowance`|An allowance to faciliate permit2 interactions.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`paidOffLoanId`|`uint256`|The ID of the loan after it's been paid off.|
-|`paidOffloan`|`REVLoan`|The loan after it's been paid off.|
-
-
-### setTokenUriResolver
-
-Sets the address of the resolver used to retrieve the tokenURI of loans.
-
-
-```solidity
-function setTokenUriResolver(IJBTokenUriResolver resolver) external override onlyOwner;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`resolver`|`IJBTokenUriResolver`|The address of the new resolver.|
-
-
-### _addCollateralTo
-
-Adds collateral to a loan by burning the collateral tokens permanently.
-
-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.
-
-
-```solidity
-function _addCollateralTo(uint256 revnetId, uint256 amount) internal;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet the loan is being added in.|
-|`amount`|`uint256`|The new amount of collateral being added to the loan.|
-
-
-### _addTo
-
-Add a new amount to the loan that is greater than the previous amount.
-
-
-```solidity
-function _addTo(
-    REVLoan memory loan,
-    uint256 revnetId,
-    uint256 addedBorrowAmount,
-    uint256 sourceFeeAmount,
-    address payable beneficiary
-)
-    internal;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan being added to.|
-|`revnetId`|`uint256`|The ID of the revnet the loan is being added in.|
-|`addedBorrowAmount`|`uint256`|The amount being added to the loan, denominated in the token of the source's accounting context.|
-|`sourceFeeAmount`|`uint256`|The amount of the fee being taken from the revnet acting as the source of the loan.|
-|`beneficiary`|`address payable`|The address receiving the returned collateral and any tokens resulting from paying fees.|
-
-
-### _adjust
-
-Allows the owner of a loan to pay it back, add more, or receive returned collateral no longer necessary
-to support the loan.
-
-
-```solidity
-function _adjust(
-    REVLoan storage loan,
-    uint256 revnetId,
-    uint256 newBorrowAmount,
-    uint256 newCollateralCount,
-    uint256 sourceFeeAmount,
-    address payable beneficiary
-)
-    internal;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan being adjusted.|
-|`revnetId`|`uint256`|The ID of the revnet the loan is being adjusted in.|
-|`newBorrowAmount`|`uint256`|The new amount of the loan, denominated in the token of the source's accounting context.|
-|`newCollateralCount`|`uint256`|The new amount of collateral backing the loan.|
-|`sourceFeeAmount`|`uint256`|The amount of the fee being taken from the revnet acting as the source of the loan.|
-|`beneficiary`|`address payable`|The address receiving the returned collateral and any tokens resulting from paying fees.|
-
-
-### _acceptFundsFor
-
-Accepts an incoming token.
-
-
-```solidity
-function _acceptFundsFor(
-    address token,
-    uint256 amount,
-    JBSingleAllowance memory allowance
-)
-    internal
-    returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`token`|`address`|The token being accepted.|
-|`amount`|`uint256`|The number of tokens being accepted.|
-|`allowance`|`JBSingleAllowance`|The permit2 context.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|amount The number of tokens which have been accepted.|
-
-
-### _beforeTransferTo
-
-Logic to be triggered before transferring tokens from this contract.
-
-
-```solidity
-function _beforeTransferTo(address to, address token, uint256 amount) internal returns (uint256);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`to`|`address`|The address the transfer is going to.|
-|`token`|`address`|The token being transferred.|
-|`amount`|`uint256`|The number of tokens being transferred, as a fixed point number with the same number of decimals as the token specifies.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`uint256`|payValue The value to attach to the transaction being sent.|
-
-
-### _repayLoan
-
-Pays down a loan.
-
-
-```solidity
-function _repayLoan(
-    uint256 loanId,
-    REVLoan storage loan,
-    uint256 revnetId,
-    uint256 repayBorrowAmount,
-    uint256 sourceFeeAmount,
-    uint256 collateralCountToReturn,
-    address payable beneficiary
-)
-    internal
-    returns (uint256, REVLoan memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan being paid down.|
-|`loan`|`REVLoan`|The loan being paid down.|
-|`revnetId`|`uint256`||
-|`repayBorrowAmount`|`uint256`|The amount being paid down from the loan, denominated in the token of the source's accounting context.|
-|`sourceFeeAmount`|`uint256`|The amount of the fee being taken from the revnet acting as the source of the loan.|
-|`collateralCountToReturn`|`uint256`|The amount of collateral being returned that the loan no longer requires.|
-|`beneficiary`|`address payable`|The address receiving the returned collateral and any tokens resulting from paying fees.|
-
-
-### _reallocateCollateralFromLoan
-
-Reallocates collateral from a loan by making a new loan based on the original, with reduced collateral.
-
-
-```solidity
-function _reallocateCollateralFromLoan(
-    uint256 loanId,
-    uint256 revnetId,
-    uint256 collateralCountToRemove
-)
-    internal
-    returns (uint256 reallocatedLoanId, REVLoan storage reallocatedLoan);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loanId`|`uint256`|The ID of the loan to reallocate collateral from.|
-|`revnetId`|`uint256`|The ID of the revnet the loan is from.|
-|`collateralCountToRemove`|`uint256`|The amount of collateral to remove from the loan.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`reallocatedLoanId`|`uint256`|The ID of the loan.|
-|`reallocatedLoan`|`REVLoan`|The reallocated loan.|
-
-
-### _removeFrom
-
-Pays off a loan.
-
-
-```solidity
-function _removeFrom(REVLoan memory loan, uint256 revnetId, uint256 repaidBorrowAmount) internal;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`loan`|`REVLoan`|The loan being paid off.|
-|`revnetId`|`uint256`|The ID of the revnet the loan is being paid off in.|
-|`repaidBorrowAmount`|`uint256`|The amount being paid off, denominated in the token of the source's accounting context.|
-
-
-### _returnCollateralFrom
-
-Returns collateral from a loan.
-
-
-```solidity
-function _returnCollateralFrom(uint256 revnetId, uint256 collateralCount, address payable beneficiary) internal;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`revnetId`|`uint256`|The ID of the revnet the loan is being returned in.|
-|`collateralCount`|`uint256`|The amount of collateral being returned from the loan.|
-|`beneficiary`|`address payable`|The address receiving the returned collateral.|
-
-
-### _transferFrom
-
-Transfers tokens.
-
-
-```solidity
-function _transferFrom(address from, address payable to, address token, uint256 amount) internal virtual;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`from`|`address`|The address to transfer tokens from.|
-|`to`|`address payable`|The address to transfer tokens to.|
-|`token`|`address`|The address of the token being transfered.|
-|`amount`|`uint256`|The amount of tokens to transfer, as a fixed point number with the same number of decimals as the token.|
-
-
-### fallback
-
-
-```solidity
-fallback() external payable;
-```
-
-### receive
-
-
-```solidity
-receive() external payable;
-```
-
-## Errors
-### REVLoans_CollateralExceedsLoan
-
-```solidity
-error REVLoans_CollateralExceedsLoan(uint256 collateralToReturn, uint256 loanCollateral);
-```
-
-### REVLoans_InvalidPrepaidFeePercent
-
-```solidity
-error REVLoans_InvalidPrepaidFeePercent(uint256 prepaidFeePercent, uint256 min, uint256 max);
-```
-
-### REVLoans_NotEnoughCollateral
-
-```solidity
-error REVLoans_NotEnoughCollateral();
-```
-
-### REVLoans_OverflowAlert
-
-```solidity
-error REVLoans_OverflowAlert(uint256 value, uint256 limit);
-```
-
-### REVLoans_OverMaxRepayBorrowAmount
-
-```solidity
-error REVLoans_OverMaxRepayBorrowAmount(uint256 maxRepayBorrowAmount, uint256 repayBorrowAmount);
-```
-
-### REVLoans_PermitAllowanceNotEnough
-
-```solidity
-error REVLoans_PermitAllowanceNotEnough(uint256 allowanceAmount, uint256 requiredAmount);
-```
-
-### REVLoans_NewBorrowAmountGreaterThanLoanAmount
-
-```solidity
-error REVLoans_NewBorrowAmountGreaterThanLoanAmount(uint256 newBorrowAmount, uint256 loanAmount);
-```
-
-### REVLoans_NoMsgValueAllowed
-
-```solidity
-error REVLoans_NoMsgValueAllowed();
-```
-
-### REVLoans_NothingToRepay
-
-```solidity
-error REVLoans_NothingToRepay();
-```
-
-### REVLoans_LoanExpired
-
-```solidity
-error REVLoans_LoanExpired(uint256 timeSinceLoanCreated, uint256 loanLiquidationDuration);
-```
-
-### REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows
-
-```solidity
-error REVLoans_ReallocatingMoreCollateralThanBorrowedAmountAllows(uint256 newBorrowAmount, uint256 loanAmount);
-```
-
-### REVLoans_SourceMismatch
-
-```solidity
-error REVLoans_SourceMismatch();
-```
-
-### REVLoans_Unauthorized
-
-```solidity
-error REVLoans_Unauthorized(address caller, address owner);
-```
-
-### REVLoans_UnderMinBorrowAmount
-
-```solidity
-error REVLoans_UnderMinBorrowAmount(uint256 minBorrowAmount, uint256 borrowAmount);
-```
-
-### REVLoans_ZeroCollateralLoanIsInvalid
-
-```solidity
-error REVLoans_ZeroCollateralLoanIsInvalid();
-```
-