@rev-net/core-v6 0.0.6 → 0.0.7

package/docs/src/src/interfaces/IREVLoans.sol/interface.IREVLoans.md

@@ -1,92 +1,167 @@
 # IREVLoans
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/interfaces/IREVLoans.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/interfaces/IREVLoans.sol)
 
 
 ## Functions
 ### LOAN_LIQUIDATION_DURATION
 
+The duration after which a loan expires and its collateral is permanently lost.
+
 
 ```solidity
 function LOAN_LIQUIDATION_DURATION() external view returns (uint256);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The loan liquidation duration in seconds.|
+
 
 ### PERMIT2
 
+The permit2 utility used for token transfers.
+
 
 ```solidity
 function PERMIT2() external view returns (IPermit2);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IPermit2`|The permit2 contract.|
+
 
 ### CONTROLLER
 
+The controller that manages revnets using this loans contract.
+
 
 ```solidity
 function CONTROLLER() external view returns (IJBController);
 ```
+**Returns**
 
-### REVNETS
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBController`|The controller contract.|
 
 
-```solidity
-function REVNETS() external view returns (IREVDeployer);
-```
-
 ### DIRECTORY
 
+The directory of terminals and controllers for revnets.
+
 
 ```solidity
 function DIRECTORY() external view returns (IJBDirectory);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBDirectory`|The directory contract.|
+
 
 ### PRICES
 
+The contract that stores prices for each revnet.
+
 
 ```solidity
 function PRICES() external view returns (IJBPrices);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBPrices`|The prices contract.|
+
 
 ### PROJECTS
 
+The contract that mints ERC-721s representing project ownership.
+
 
 ```solidity
 function PROJECTS() external view returns (IJBProjects);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBProjects`|The projects contract.|
+
 
 ### REV_ID
 
+The ID of the REV revnet that receives protocol fees from loans.
+
 
 ```solidity
 function REV_ID() external view returns (uint256);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The REV revnet ID.|
+
 
 ### REV_PREPAID_FEE_PERCENT
 
+The fee percent charged by the REV revnet on each loan, in terms of `JBConstants.MAX_FEE`.
+
 
 ```solidity
 function REV_PREPAID_FEE_PERCENT() external view returns (uint256);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The REV prepaid fee percent.|
+
 
 ### MIN_PREPAID_FEE_PERCENT
 
+The minimum fee percent that must be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
+
 
 ```solidity
 function MIN_PREPAID_FEE_PERCENT() external view returns (uint256);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The minimum prepaid fee percent.|
+
 
 ### MAX_PREPAID_FEE_PERCENT
 
+The maximum fee percent that can be prepaid when borrowing, in terms of `JBConstants.MAX_FEE`.
+
 
 ```solidity
 function MAX_PREPAID_FEE_PERCENT() external view returns (uint256);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The maximum prepaid fee percent.|
+
 
 ### borrowableAmountFrom
 
+The amount that can be borrowed from a revnet given a certain amount of collateral.
+
 
 ```solidity
 function borrowableAmountFrom(
     uint256 revnetId,
-    uint256 collateral,
+    uint256 collateralCount,
     uint256 decimals,
     uint256 currency
 )
@@ -94,9 +169,26 @@ function borrowableAmountFrom(
     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`|The amount that can be borrowed from the revnet.|
+
 
 ### determineSourceFeeAmount
 
+Determines the source fee amount for a loan being paid off a certain amount.
+
 
 ```solidity
 function determineSourceFeeAmount(
@@ -107,51 +199,154 @@ function determineSourceFeeAmount(
     view
     returns (uint256 sourceFeeAmount);
 ```
+**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|
+|----|----|-----------|
+|`sourceFeeAmount`|`uint256`|The source fee amount for the loan.|
+
 
 ### isLoanSourceOf
 
+Whether a revnet currently has outstanding loans from the specified terminal in the specified token.
+
 
 ```solidity
 function isLoanSourceOf(uint256 revnetId, IJBPayoutTerminal terminal, address token) external view returns (bool);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet issuing the loan.|
+|`terminal`|`IJBPayoutTerminal`|The terminal that the loan is issued from.|
+|`token`|`address`|The token being loaned.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|A flag indicating if the revnet has an active loan source.|
+
 
 ### loanOf
 
+Get a loan's details.
+
 
 ```solidity
 function loanOf(uint256 loanId) external view returns (REVLoan memory);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`loanId`|`uint256`|The ID of the loan to retrieve.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`REVLoan`|The loan data.|
+
 
 ### loanSourcesOf
 
+The sources of each revnet's loans.
+
+This array only grows -- sources are appended when a new (terminal, token) pair is first used for
+borrowing, but are never removed. Gas cost scales linearly with the number of distinct sources, though this is
+practically bounded to a small number of unique (terminal, token) pairs.
+
 
 ```solidity
 function loanSourcesOf(uint256 revnetId) external view returns (REVLoanSource[] memory);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet to get the loan sources for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`REVLoanSource[]`|The array of loan sources.|
+
+
+### totalLoansBorrowedFor
+
+The cumulative number of loans ever created for a revnet, used as a loan ID sequence counter.
 
-### numberOfLoansFor
+This counter only increments and never decrements. It does NOT represent the count of currently active
+loans -- repaid and liquidated loans leave permanent gaps in the sequence. Do not use this value to determine
+how many loans are currently outstanding.
 
 
 ```solidity
-function numberOfLoansFor(uint256 revnetId) external view returns (uint256);
+function totalLoansBorrowedFor(uint256 revnetId) external view returns (uint256);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet to get the cumulative loan count for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The cumulative number of loans ever created.|
+
 
 ### revnetIdOfLoanWith
 
+The revnet ID for the loan with the provided loan ID.
+
 
 ```solidity
 function revnetIdOfLoanWith(uint256 loanId) external view returns (uint256);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`loanId`|`uint256`|The loan ID to get the revnet ID of.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The ID of the revnet.|
+
 
 ### tokenUriResolver
 
+The contract resolving each loan ID to its ERC-721 URI.
+
 
 ```solidity
 function tokenUriResolver() external view returns (IJBTokenUriResolver);
 ```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IJBTokenUriResolver`|The token URI resolver.|
+
 
 ### totalBorrowedFrom
 
+The total amount loaned out by a revnet from a specified terminal in a specified token.
+
 
 ```solidity
 function totalBorrowedFrom(
@@ -163,39 +358,99 @@ function totalBorrowedFrom(
     view
     returns (uint256);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet issuing the loan.|
+|`terminal`|`IJBPayoutTerminal`|The terminal that the loan is issued from.|
+|`token`|`address`|The token being loaned.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The total amount borrowed.|
+
 
 ### totalCollateralOf
 
+The total amount of collateral supporting a revnet's loans.
+
 
 ```solidity
 function totalCollateralOf(uint256 revnetId) external view returns (uint256);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The total collateral count.|
+
 
 ### borrowFrom
 
+Open a loan by borrowing from a revnet. Collateral tokens are burned and only re-minted upon repayment.
+
 
 ```solidity
 function borrowFrom(
     uint256 revnetId,
     REVLoanSource calldata source,
     uint256 minBorrowAmount,
-    uint256 collateral,
+    uint256 collateralCount,
     address payable beneficiary,
     uint256 prepaidFeePercent
 )
     external
-    returns (uint256 loanId, REVLoan memory loan);
+    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 (terminal and token).|
+|`minBorrowAmount`|`uint256`|The minimum amount to borrow, denominated in the source's token.|
+|`collateralCount`|`uint256`|The amount of tokens to use as collateral for the loan.|
+|`beneficiary`|`address payable`|The address that will receive the borrowed funds and fee payment tokens.|
+|`prepaidFeePercent`|`uint256`|The fee percent to charge upfront, in terms of `JBConstants.MAX_FEE`.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`loanId`|`uint256`|The ID of the loan created from borrowing.|
+|`<none>`|`REVLoan`|The loan created from borrowing.|
+
 
 ### liquidateExpiredLoansFrom
 
+Liquidates loans that have exceeded the liquidation duration, permanently destroying their collateral.
+
 
 ```solidity
 function liquidateExpiredLoansFrom(uint256 revnetId, uint256 startingLoanId, uint256 count) external;
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`revnetId`|`uint256`|The ID of the revnet to liquidate loans from.|
+|`startingLoanId`|`uint256`|The loan number to start iterating from.|
+|`count`|`uint256`|The number of loans to iterate over.|
+
 
 ### repayLoan
 
+Repay a loan or return excess collateral no longer needed to support the loan.
+
 
 ```solidity
 function repayLoan(
@@ -207,33 +462,80 @@ function repayLoan(
 )
     external
     payable
-    returns (uint256 paidOffLoanId, REVLoan memory loan);
+    returns (uint256 paidOffLoanId, REVLoan memory paidOffloan);
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`loanId`|`uint256`|The ID of the loan being repaid.|
+|`maxRepayBorrowAmount`|`uint256`|The maximum amount to repay, denominated in the source's token.|
+|`collateralCountToReturn`|`uint256`|The amount of collateral to return from the loan.|
+|`beneficiary`|`address payable`|The address receiving the returned collateral and fee payment tokens.|
+|`allowance`|`JBSingleAllowance`|A permit2 allowance to facilitate the repayment transfer.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`paidOffLoanId`|`uint256`|The ID of the loan after it has been paid off.|
+|`paidOffloan`|`REVLoan`|The loan after it has been paid off.|
+
 
 ### reallocateCollateralFromLoan
 
+Refinance a loan by transferring extra collateral from an existing loan to a new loan.
+
 
 ```solidity
 function reallocateCollateralFromLoan(
     uint256 loanId,
-    uint256 collateralToTransfer,
+    uint256 collateralCountToTransfer,
     REVLoanSource calldata source,
     uint256 minBorrowAmount,
-    uint256 collateralToAdd,
+    uint256 collateralCountToAdd,
     address payable beneficiary,
     uint256 prepaidFeePercent
 )
     external
-    payable
     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 new loan (terminal and token). Must match the existing loan's source.|
+|`minBorrowAmount`|`uint256`|The minimum amount to borrow for the new loan.|
+|`collateralCountToAdd`|`uint256`|Additional collateral to add to the new loan from the caller's balance.|
+|`beneficiary`|`address payable`|The address that will receive the borrowed funds and fee payment tokens.|
+|`prepaidFeePercent`|`uint256`|The fee percent to charge upfront for the new loan.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`reallocatedLoanId`|`uint256`|The ID of the reallocated (reduced) loan.|
+|`newLoanId`|`uint256`|The ID of the newly created loan.|
+|`reallocatedLoan`|`REVLoan`|The reallocated loan data.|
+|`newLoan`|`REVLoan`|The new loan data.|
+
 
 ### setTokenUriResolver
 
+Sets the address of the resolver used to retrieve the token URI of loans.
+
 
 ```solidity
 function setTokenUriResolver(IJBTokenUriResolver resolver) external;
 ```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`resolver`|`IJBTokenUriResolver`|The new token URI resolver.|
+
 
 ## Events
 ### Borrow
@@ -283,7 +585,7 @@ event ReallocateCollateral(
     uint256 indexed revnetId,
     uint256 indexed reallocatedLoanId,
     REVLoan reallocatedLoan,
-    uint256 removedcollateralCount,
+    uint256 removedCollateralCount,
     address caller
 );
 ```

package/docs/src/src/structs/README.md

@@ -2,8 +2,6 @@
 
 # Contents
 - [REVAutoIssuance](REVAutoIssuance.sol/struct.REVAutoIssuance.md)
-- [REVBuybackHookConfig](REVBuybackHookConfig.sol/struct.REVBuybackHookConfig.md)
-- [REVBuybackPoolConfig](REVBuybackPoolConfig.sol/struct.REVBuybackPoolConfig.md)
 - [REVConfig](REVConfig.sol/struct.REVConfig.md)
 - [REVCroptopAllowedPost](REVCroptopAllowedPost.sol/struct.REVCroptopAllowedPost.md)
 - [REVDeploy721TiersHookConfig](REVDeploy721TiersHookConfig.sol/struct.REVDeploy721TiersHookConfig.md)

package/docs/src/src/structs/REVAutoIssuance.sol/struct.REVAutoIssuance.md

@@ -1,5 +1,5 @@
 # REVAutoIssuance
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVAutoIssuance.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVAutoIssuance.sol)
 
 **Notes:**
 - member: chainId The ID of the chain on which the mint should be honored.
@@ -11,9 +11,9 @@
 
 ```solidity
 struct REVAutoIssuance {
-    uint32 chainId;
-    uint104 count;
-    address beneficiary;
+uint32 chainId;
+uint104 count;
+address beneficiary;
 }
 ```
 

package/docs/src/src/structs/REVConfig.sol/struct.REVConfig.md

@@ -1,35 +1,23 @@
 # REVConfig
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVConfig.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVConfig.sol)
 
 **Notes:**
 - member: description The description of the revnet.
 
 - member: baseCurrency The currency that the issuance is based on.
 
-- member: premintTokenAmount The number of tokens that should be preminted to the initial operator.
-
-- member: premintChainId The ID of the chain on which the premint should be honored.
-
-- member: premintStage The stage during which the premint should be honored.
-
 - member: splitOperator The address that will receive the token premint and initial production split,
 and who is allowed to change who the operator is. Only the operator can replace itself after deployment.
 
 - member: stageConfigurations The periods of changing constraints.
 
-- member: loanSources The sources for loans.
-
-- member: loans The loans contract, which can mint the revnet's tokens and use the revnet's balance.
-
 
 ```solidity
 struct REVConfig {
-    REVDescription description;
-    uint32 baseCurrency;
-    address splitOperator;
-    REVStageConfig[] stageConfigurations;
-    REVLoanSource[] loanSources;
-    address loans;
+REVDescription description;
+uint32 baseCurrency;
+address splitOperator;
+REVStageConfig[] stageConfigurations;
 }
 ```
 

package/docs/src/src/structs/REVCroptopAllowedPost.sol/struct.REVCroptopAllowedPost.md

@@ -1,5 +1,5 @@
 # REVCroptopAllowedPost
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVCroptopAllowedPost.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVCroptopAllowedPost.sol)
 
 Criteria for allowed posts.
 
@@ -13,16 +13,20 @@ Criteria for allowed posts.
 - member: maxTotalSupply The max total supply of NFTs that can be made available when minting. Leave as 0 for
 max.
 
+- member: maximumSplitPercent The maximum split percent (out of JBConstants.SPLITS_TOTAL_PERCENT) that a
+poster can set. 0 means splits are not allowed.
+
 - member: allowedAddresses A list of addresses that are allowed to post on the category through Croptop.
 
 
 ```solidity
 struct REVCroptopAllowedPost {
-    uint24 category;
-    uint104 minimumPrice;
-    uint32 minimumTotalSupply;
-    uint32 maximumTotalSupply;
-    address[] allowedAddresses;
+uint24 category;
+uint104 minimumPrice;
+uint32 minimumTotalSupply;
+uint32 maximumTotalSupply;
+uint32 maximumSplitPercent;
+address[] allowedAddresses;
 }
 ```
 

package/docs/src/src/structs/REVDeploy721TiersHookConfig.sol/struct.REVDeploy721TiersHookConfig.md

@@ -1,5 +1,5 @@
 # REVDeploy721TiersHookConfig
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVDeploy721TiersHookConfig.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVDeploy721TiersHookConfig.sol)
 
 **Notes:**
 - member: baseline721HookConfiguration The baseline config.
@@ -23,12 +23,12 @@ discount of a tier.
 
 ```solidity
 struct REVDeploy721TiersHookConfig {
-    JBDeploy721TiersHookConfig baseline721HookConfiguration;
-    bytes32 salt;
-    bool splitOperatorCanAdjustTiers;
-    bool splitOperatorCanUpdateMetadata;
-    bool splitOperatorCanMint;
-    bool splitOperatorCanIncreaseDiscountPercent;
+JBDeploy721TiersHookConfig baseline721HookConfiguration;
+bytes32 salt;
+bool splitOperatorCanAdjustTiers;
+bool splitOperatorCanUpdateMetadata;
+bool splitOperatorCanMint;
+bool splitOperatorCanIncreaseDiscountPercent;
 }
 ```
 

package/docs/src/src/structs/REVDescription.sol/struct.REVDescription.md

@@ -1,5 +1,5 @@
 # REVDescription
-[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVDescription.sol)
+[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVDescription.sol)
 
 **Notes:**
 - member: name The name of the ERC-20 token being create for the revnet.
@@ -14,10 +14,10 @@ address.
 
 ```solidity
 struct REVDescription {
-    string name;
-    string ticker;
-    string uri;
-    bytes32 salt;
+string name;
+string ticker;
+string uri;
+bytes32 salt;
 }
 ```