@rev-net/core-v6 0.0.1

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

@@ -0,0 +1,243 @@
+# IREVDeployer
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/interfaces/IREVDeployer.sol)
+
+
+## Functions
+### CASH_OUT_DELAY
+
+
+```solidity
+function CASH_OUT_DELAY() external view returns (uint256);
+```
+
+### CONTROLLER
+
+
+```solidity
+function CONTROLLER() external view returns (IJBController);
+```
+
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### PERMISSIONS
+
+
+```solidity
+function PERMISSIONS() external view returns (IJBPermissions);
+```
+
+### FEE
+
+
+```solidity
+function FEE() external view returns (uint256);
+```
+
+### SUCKER_REGISTRY
+
+
+```solidity
+function SUCKER_REGISTRY() external view returns (IJBSuckerRegistry);
+```
+
+### FEE_REVNET_ID
+
+
+```solidity
+function FEE_REVNET_ID() external view returns (uint256);
+```
+
+### PUBLISHER
+
+
+```solidity
+function PUBLISHER() external view returns (CTPublisher);
+```
+
+### HOOK_DEPLOYER
+
+
+```solidity
+function HOOK_DEPLOYER() external view returns (IJB721TiersHookDeployer);
+```
+
+### amountToAutoIssue
+
+
+```solidity
+function amountToAutoIssue(uint256 revnetId, uint256 stageId, address beneficiary) external view returns (uint256);
+```
+
+### buybackHookOf
+
+
+```solidity
+function buybackHookOf(uint256 revnetId) external view returns (IJBRulesetDataHook);
+```
+
+### cashOutDelayOf
+
+
+```solidity
+function cashOutDelayOf(uint256 revnetId) external view returns (uint256);
+```
+
+### deploySuckersFor
+
+
+```solidity
+function deploySuckersFor(
+    uint256 revnetId,
+    REVSuckerDeploymentConfig calldata suckerDeploymentConfiguration
+)
+    external
+    returns (address[] memory suckers);
+```
+
+### hashedEncodedConfigurationOf
+
+
+```solidity
+function hashedEncodedConfigurationOf(uint256 revnetId) external view returns (bytes32);
+```
+
+### isSplitOperatorOf
+
+
+```solidity
+function isSplitOperatorOf(uint256 revnetId, address addr) external view returns (bool);
+```
+
+### loansOf
+
+
+```solidity
+function loansOf(uint256 revnetId) external view returns (address);
+```
+
+### tiered721HookOf
+
+
+```solidity
+function tiered721HookOf(uint256 revnetId) external view returns (IJB721TiersHook);
+```
+
+### autoIssueFor
+
+
+```solidity
+function autoIssueFor(uint256 revnetId, uint256 stageId, address beneficiary) external;
+```
+
+### deployFor
+
+
+```solidity
+function deployFor(
+    uint256 revnetId,
+    REVConfig memory configuration,
+    JBTerminalConfig[] memory terminalConfigurations,
+    REVBuybackHookConfig memory buybackHookConfiguration,
+    REVSuckerDeploymentConfig memory suckerDeploymentConfiguration
+)
+    external
+    returns (uint256);
+```
+
+### deployWith721sFor
+
+
+```solidity
+function deployWith721sFor(
+    uint256 revnetId,
+    REVConfig calldata configuration,
+    JBTerminalConfig[] memory terminalConfigurations,
+    REVBuybackHookConfig memory buybackHookConfiguration,
+    REVSuckerDeploymentConfig memory suckerDeploymentConfiguration,
+    REVDeploy721TiersHookConfig memory tiered721HookConfiguration,
+    REVCroptopAllowedPost[] memory allowedPosts
+)
+    external
+    returns (uint256, IJB721TiersHook hook);
+```
+
+### setSplitOperatorOf
+
+
+```solidity
+function setSplitOperatorOf(uint256 revnetId, address newSplitOperator) external;
+```
+
+## Events
+### ReplaceSplitOperator
+
+```solidity
+event ReplaceSplitOperator(uint256 indexed revnetId, address indexed newSplitOperator, address caller);
+```
+
+### DeploySuckers
+
+```solidity
+event DeploySuckers(
+    uint256 indexed revnetId,
+    bytes32 encodedConfigurationHash,
+    REVSuckerDeploymentConfig suckerDeploymentConfiguration,
+    address caller
+);
+```
+
+### DeployRevnet
+
+```solidity
+event DeployRevnet(
+    uint256 indexed revnetId,
+    REVConfig configuration,
+    JBTerminalConfig[] terminalConfigurations,
+    REVBuybackHookConfig buybackHookConfiguration,
+    REVSuckerDeploymentConfig suckerDeploymentConfiguration,
+    JBRulesetConfig[] rulesetConfigurations,
+    bytes32 encodedConfigurationHash,
+    address caller
+);
+```
+
+### SetCashOutDelay
+
+```solidity
+event SetCashOutDelay(uint256 indexed revnetId, uint256 cashOutDelay, address caller);
+```
+
+### AutoIssue
+
+```solidity
+event AutoIssue(
+    uint256 indexed revnetId, uint256 indexed stageId, address indexed beneficiary, uint256 count, address caller
+);
+```
+
+### StoreAutoIssuanceAmount
+
+```solidity
+event StoreAutoIssuanceAmount(
+    uint256 indexed revnetId, uint256 indexed stageId, address indexed beneficiary, uint256 count, address caller
+);
+```
+
+### SetAdditionalOperator
+
+```solidity
+event SetAdditionalOperator(uint256 revnetId, address additionalOperator, uint256[] permissionIds, address caller);
+```
+

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

@@ -0,0 +1,296 @@
+# IREVLoans
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/interfaces/IREVLoans.sol)
+
+
+## Functions
+### LOAN_LIQUIDATION_DURATION
+
+
+```solidity
+function LOAN_LIQUIDATION_DURATION() external view returns (uint256);
+```
+
+### PERMIT2
+
+
+```solidity
+function PERMIT2() external view returns (IPermit2);
+```
+
+### CONTROLLER
+
+
+```solidity
+function CONTROLLER() external view returns (IJBController);
+```
+
+### REVNETS
+
+
+```solidity
+function REVNETS() external view returns (IREVDeployer);
+```
+
+### DIRECTORY
+
+
+```solidity
+function DIRECTORY() external view returns (IJBDirectory);
+```
+
+### PRICES
+
+
+```solidity
+function PRICES() external view returns (IJBPrices);
+```
+
+### PROJECTS
+
+
+```solidity
+function PROJECTS() external view returns (IJBProjects);
+```
+
+### REV_ID
+
+
+```solidity
+function REV_ID() external view returns (uint256);
+```
+
+### REV_PREPAID_FEE_PERCENT
+
+
+```solidity
+function REV_PREPAID_FEE_PERCENT() external view returns (uint256);
+```
+
+### MIN_PREPAID_FEE_PERCENT
+
+
+```solidity
+function MIN_PREPAID_FEE_PERCENT() external view returns (uint256);
+```
+
+### MAX_PREPAID_FEE_PERCENT
+
+
+```solidity
+function MAX_PREPAID_FEE_PERCENT() external view returns (uint256);
+```
+
+### borrowableAmountFrom
+
+
+```solidity
+function borrowableAmountFrom(
+    uint256 revnetId,
+    uint256 collateral,
+    uint256 decimals,
+    uint256 currency
+)
+    external
+    view
+    returns (uint256);
+```
+
+### determineSourceFeeAmount
+
+
+```solidity
+function determineSourceFeeAmount(
+    REVLoan memory loan,
+    uint256 amount
+)
+    external
+    view
+    returns (uint256 sourceFeeAmount);
+```
+
+### isLoanSourceOf
+
+
+```solidity
+function isLoanSourceOf(uint256 revnetId, IJBPayoutTerminal terminal, address token) external view returns (bool);
+```
+
+### loanOf
+
+
+```solidity
+function loanOf(uint256 loanId) external view returns (REVLoan memory);
+```
+
+### loanSourcesOf
+
+
+```solidity
+function loanSourcesOf(uint256 revnetId) external view returns (REVLoanSource[] memory);
+```
+
+### numberOfLoansFor
+
+
+```solidity
+function numberOfLoansFor(uint256 revnetId) external view returns (uint256);
+```
+
+### revnetIdOfLoanWith
+
+
+```solidity
+function revnetIdOfLoanWith(uint256 loanId) external view returns (uint256);
+```
+
+### tokenUriResolver
+
+
+```solidity
+function tokenUriResolver() external view returns (IJBTokenUriResolver);
+```
+
+### totalBorrowedFrom
+
+
+```solidity
+function totalBorrowedFrom(
+    uint256 revnetId,
+    IJBPayoutTerminal terminal,
+    address token
+)
+    external
+    view
+    returns (uint256);
+```
+
+### totalCollateralOf
+
+
+```solidity
+function totalCollateralOf(uint256 revnetId) external view returns (uint256);
+```
+
+### borrowFrom
+
+
+```solidity
+function borrowFrom(
+    uint256 revnetId,
+    REVLoanSource calldata source,
+    uint256 minBorrowAmount,
+    uint256 collateral,
+    address payable beneficiary,
+    uint256 prepaidFeePercent
+)
+    external
+    returns (uint256 loanId, REVLoan memory loan);
+```
+
+### liquidateExpiredLoansFrom
+
+
+```solidity
+function liquidateExpiredLoansFrom(uint256 revnetId, uint256 startingLoanId, uint256 count) external;
+```
+
+### repayLoan
+
+
+```solidity
+function repayLoan(
+    uint256 loanId,
+    uint256 maxRepayBorrowAmount,
+    uint256 collateralCountToReturn,
+    address payable beneficiary,
+    JBSingleAllowance calldata allowance
+)
+    external
+    payable
+    returns (uint256 paidOffLoanId, REVLoan memory loan);
+```
+
+### reallocateCollateralFromLoan
+
+
+```solidity
+function reallocateCollateralFromLoan(
+    uint256 loanId,
+    uint256 collateralToTransfer,
+    REVLoanSource calldata source,
+    uint256 minBorrowAmount,
+    uint256 collateralToAdd,
+    address payable beneficiary,
+    uint256 prepaidFeePercent
+)
+    external
+    payable
+    returns (uint256 reallocatedLoanId, uint256 newLoanId, REVLoan memory reallocatedLoan, REVLoan memory newLoan);
+```
+
+### setTokenUriResolver
+
+
+```solidity
+function setTokenUriResolver(IJBTokenUriResolver resolver) external;
+```
+
+## Events
+### Borrow
+
+```solidity
+event Borrow(
+    uint256 indexed loanId,
+    uint256 indexed revnetId,
+    REVLoan loan,
+    REVLoanSource source,
+    uint256 borrowAmount,
+    uint256 collateralCount,
+    uint256 sourceFeeAmount,
+    address payable beneficiary,
+    address caller
+);
+```
+
+### Liquidate
+
+```solidity
+event Liquidate(uint256 indexed loanId, uint256 indexed revnetId, REVLoan loan, address caller);
+```
+
+### RepayLoan
+
+```solidity
+event RepayLoan(
+    uint256 indexed loanId,
+    uint256 indexed revnetId,
+    uint256 indexed paidOffLoanId,
+    REVLoan loan,
+    REVLoan paidOffLoan,
+    uint256 repayBorrowAmount,
+    uint256 sourceFeeAmount,
+    uint256 collateralCountToReturn,
+    address payable beneficiary,
+    address caller
+);
+```
+
+### ReallocateCollateral
+
+```solidity
+event ReallocateCollateral(
+    uint256 indexed loanId,
+    uint256 indexed revnetId,
+    uint256 indexed reallocatedLoanId,
+    REVLoan reallocatedLoan,
+    uint256 removedcollateralCount,
+    address caller
+);
+```
+
+### SetTokenUriResolver
+
+```solidity
+event SetTokenUriResolver(IJBTokenUriResolver indexed resolver, address caller);
+```
+

package/docs/src/src/interfaces/README.md

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [IREVDeployer](IREVDeployer.sol/interface.IREVDeployer.md)
+- [IREVLoans](IREVLoans.sol/interface.IREVLoans.md)

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

@@ -0,0 +1,14 @@
+
+
+# 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)
+- [REVDescription](REVDescription.sol/struct.REVDescription.md)
+- [REVLoan](REVLoan.sol/struct.REVLoan.md)
+- [REVLoanSource](REVLoanSource.sol/struct.REVLoanSource.md)
+- [REVStageConfig](REVStageConfig.sol/struct.REVStageConfig.md)
+- [REVSuckerDeploymentConfig](REVSuckerDeploymentConfig.sol/struct.REVSuckerDeploymentConfig.md)

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

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

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

@@ -0,0 +1,19 @@
+# REVBuybackHookConfig
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVBuybackHookConfig.sol)
+
+**Notes:**
+- member: dataHook The data hook to use.
+
+- member: hookToConfigure The buyback hook to configure.
+
+- member: poolConfigurations The pools to setup on the given buyback contract.
+
+
+```solidity
+struct REVBuybackHookConfig {
+    IJBRulesetDataHook dataHook;
+    IJBBuybackHook hookToConfigure;
+    REVBuybackPoolConfig[] poolConfigurations;
+}
+```
+

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

@@ -0,0 +1,21 @@
+# REVBuybackPoolConfig
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVBuybackPoolConfig.sol)
+
+**Notes:**
+- member: token The token to setup a pool for.
+
+- member: poolFee The fee of the pool in which swaps occur when seeking the best price for a new participant.
+This incentivizes liquidity providers. Out of 1_000_000. A common value is 1%, or 10_000. Other passible values are
+0.3% and 0.1%.
+
+- member: twapWindow The time window to take into account when quoting a price based on TWAP.
+
+
+```solidity
+struct REVBuybackPoolConfig {
+    address token;
+    uint24 fee;
+    uint32 twapWindow;
+}
+```
+

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

@@ -0,0 +1,35 @@
+# REVConfig
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/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;
+}
+```
+

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

@@ -0,0 +1,28 @@
+# REVCroptopAllowedPost
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVCroptopAllowedPost.sol)
+
+Criteria for allowed posts.
+
+**Notes:**
+- member: category A category that should allow posts.
+
+- member: minimumPrice The minimum price that a post to the specified category should cost.
+
+- member: minimumTotalSupply The minimum total supply of NFTs that can be made available when minting.
+
+- member: maxTotalSupply The max total supply of NFTs that can be made available when minting. Leave as 0 for
+max.
+
+- 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;
+}
+```
+

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

@@ -0,0 +1,34 @@
+# REVDeploy721TiersHookConfig
+[Git Source](https://github.com/rev-net/revnet-core-v5/blob/364afaae78a8f60af2b98252dc96af1c2e4760d3/src/structs/REVDeploy721TiersHookConfig.sol)
+
+**Notes:**
+- member: baseline721HookConfiguration The baseline config.
+
+- member: salt The salt to base the collection's address on.
+
+- member: splitOperatorCanAdjustTiers A flag indicating if the revnet's split operator can add tiers and remove
+tiers if
+the tier is allowed to be removed
+
+- member: splitOperatorCanUpdateMetadata A flag indicating if the revnet's split operator can update the 721's
+metadata.
+
+- member: splitOperatorCanMint A flag indicating if the revnet's split operator can mint 721's from tiers that
+allow it.
+
+- member: splitOperatorCanIncreaseDiscountPercent A flag indicating if the revnet's split operator can increase
+the
+discount of a tier.
+
+
+```solidity
+struct REVDeploy721TiersHookConfig {
+    JBDeploy721TiersHookConfig baseline721HookConfiguration;
+    bytes32 salt;
+    bool splitOperatorCanAdjustTiers;
+    bool splitOperatorCanUpdateMetadata;
+    bool splitOperatorCanMint;
+    bool splitOperatorCanIncreaseDiscountPercent;
+}
+```
+