@rev-net/core-v6 0.0.13 → 0.0.15

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

@@ -1,32 +0,0 @@
-# REVCroptopAllowedPost
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/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: 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;
-uint32 maximumSplitPercent;
-address[] allowedAddresses;
-}
-```
-

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

@@ -1,34 +0,0 @@
-# REVDeploy721TiersHookConfig
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/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;
-}
-```
-

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

@@ -1,23 +0,0 @@
-# REVDescription
-[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.
-
-- member: ticker The ticker of the ERC-20 token being created for the revnet.
-
-- member: uri The metadata URI containing revnet's info.
-
-- member: salt Revnets deployed across chains by the same address with the same salt will have the same
-address.
-
-
-```solidity
-struct REVDescription {
-string name;
-string ticker;
-string uri;
-bytes32 salt;
-}
-```
-

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

@@ -1,28 +0,0 @@
-# REVLoan
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVLoan.sol)
-
-**Notes:**
-- member: borrowedAmount The amount that is being borrowed.
-
-- member: collateralTokenCount The number of collateral tokens currently accounted for.
-
-- member: createdAt The timestamp when the loan was created.
-
-- member: prepaidFeePercent The percentage of the loan's fees that were prepaid.
-
-- member: prepaidDuration The duration that the loan was prepaid for.
-
-- member: source The source of the loan.
-
-
-```solidity
-struct REVLoan {
-uint112 amount;
-uint112 collateral;
-uint48 createdAt;
-uint16 prepaidFeePercent;
-uint32 prepaidDuration;
-REVLoanSource source;
-}
-```
-

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

@@ -1,16 +0,0 @@
-# REVLoanSource
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVLoanSource.sol)
-
-**Notes:**
-- member: token The token that is being loaned.
-
-- member: terminal The terminal that the loan is being made from.
-
-
-```solidity
-struct REVLoanSource {
-address token;
-IJBPayoutTerminal terminal;
-}
-```
-

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

@@ -1,44 +0,0 @@
-# REVStageConfig
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVStageConfig.sol)
-
-**Notes:**
-- member: startsAtOrAfter The timestamp to start a stage at the given rate at or after.
-
-- member: autoIssuances The configurations of mints during this stage.
-
-- member: splitPercent The percentage of newly issued tokens that should be split with the operator, out
-of 10_000 (JBConstants.MAX_RESERVED_PERCENT).
-
-- member: splits The splits for the revnet.
-
-- member: initialIssuance The number of revnet tokens that one unit of the revnet's base currency will buy, as
-a fixed point number
-with 18 decimals.
-
-- member: issuanceCutFrequency The number of seconds between applied issuance decreases. This
-should be at least 24 hours.
-
-- member: issuanceCutPercent The percent that issuance should decrease over time. This percentage is out
-of 1_000_000_000 (JBConstants.MAX_CUT_PERCENT). 0% corresponds to no issuance increase.
-
-- member: cashOutTaxRate The factor determining how much each token can cash out from the revnet once
-cashed out. This rate is out of 10_000 (JBConstants.MAX_CASH_OUT_TAX_RATE). 0% corresponds to no tax when cashing
-out.
-
-- member: extraMetadata Extra info to attach set into this stage that may affect hooks.
-
-
-```solidity
-struct REVStageConfig {
-uint48 startsAtOrAfter;
-REVAutoIssuance[] autoIssuances;
-uint16 splitPercent;
-JBSplit[] splits;
-uint112 initialIssuance;
-uint32 issuanceCutFrequency;
-uint32 issuanceCutPercent;
-uint16 cashOutTaxRate;
-uint16 extraMetadata;
-}
-```
-

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

@@ -1,16 +0,0 @@
-# REVSuckerDeploymentConfig
-[Git Source](https://github.com/rev-net/revnet-core-v6/blob/94c003a3a16de2bd012d63cccedd6bd38d21f6e7/src/structs/REVSuckerDeploymentConfig.sol)
-
-**Notes:**
-- member: deployerConfigurations The information for how to suck tokens to other chains.
-
-- member: salt The salt to use for creating suckers so that they use the same address across chains.
-
-
-```solidity
-struct REVSuckerDeploymentConfig {
-JBSuckerDeployerConfig[] deployerConfigurations;
-bytes32 salt;
-}
-```
-