PCOLicenseParamsFacet
Documentation for the PCOLicenseParamsFacet contract.
The
PCOLicenseParamsFacet
sets global parameters for the Geo Web land market.Parameters include:
- Beneficiary address for network fees, claim payments, & penalty fees
- Payment token
- Minimum
For Sale Price
- Network fee rate
- Bid rejection penalty rate
- Bid review period rate
- Reclaim Dutch auction length
This contract is upgradeable so that parameters can be updated via governance when appropriate.
modifier onlyOwner()
function initializeParams(contract ICFABeneficiary beneficiary, contract ISuperToken paymentToken, contract ISuperfluid host, uint256 perSecondFeeNumerator, uint256 perSecondFeeDenominator, uint256 penaltyNumerator, uint256 penaltyDenominator, uint256 bidPeriodLengthInSeconds, uint256 reclaimAuctionLength, uint256 minForSalePrice) external
Initialize. - Must be the contract owner
Parameters
Name | Type | Description |
---|---|---|
beneficiary | contract ICFABeneficiary | Beneficiary of funds. |
paymentToken | contract ISuperToken | Payment token. |
host | contract ISuperfluid | Superfluid host |
perSecondFeeNumerator | uint256 | The numerator of the network-wide per second contribution fee. |
perSecondFeeDenominator | uint256 | The denominator of the network-wide per second contribution fee. |
penaltyNumerator | uint256 | The numerator of the penalty to pay to reject a bid. |
penaltyDenominator | uint256 | The denominator of the penalty to pay to reject a bid. |
bidPeriodLengthInSeconds | uint256 | Bid period length in seconds |
reclaimAuctionLength | uint256 | when the required bid amount reaches its minimum value. |
minForSalePrice | uint256 | |
function getHost() external view returns (contract ISuperfluid)
Superfluid Host
function setHost(contract ISuperfluid host) external
Set Superfluid Host
function getPaymentToken() external view returns (contract ISuperToken)
Payment token
function setPaymentToken(contract ISuperToken paymentToken) external
Set Payment Token
function getBeneficiary() external view returns (contract ICFABeneficiary)
Beneficiary
function setBeneficiary(contract ICFABeneficiary beneficiary) external
Set Beneficiary
function getPerSecondFeeNumerator() external view returns (uint256)
The numerator of the network-wide per second contribution fee.
function setPerSecondFeeNumerator(uint256 perSecondFeeNumerator) external
Set Per Second Fee Numerator
function getPerSecondFeeDenominator() external view returns (uint256)
The denominator of the network-wide per second contribution fee.
function setPerSecondFeeDenominator(uint256 perSecondFeeDenominator) external
Set Per Second Fee Denominator
function getPenaltyNumerator() external view returns (uint256)
The numerator of the penalty rate.
function setPenaltyNumerator(uint256 penaltyNumerator) external
Set Penalty Numerator
function getPenaltyDenominator() external view returns (uint256)
The denominator of the penalty rate.
function setPenaltyDenominator(uint256 penaltyDenominator) external
Set Penalty Denominator
function getReclaimAuctionLength() external view returns (uint256)
the final/minimum required bid reached and maintained at the end of the auction.
function setReclaimAuctionLength(uint256 reclaimAuctionLength) external
Set Reclaim Auction Length
function getBidPeriodLengthInSeconds() external view returns (uint256)
Bid period length in seconds
function setBidPeriodLengthInSeconds(uint256 bidPeriodLengthInSeconds) external
Set Bid Period Length in seconds
function getMinForSalePrice() external view returns (uint256)
Minimum for sale price
function setMinForSalePrice(uint256 minForSalePrice) external
Set minimum for sale price
bytes32 STORAGE_POSITION
struct DiamondStorage {
contract ICFABeneficiary beneficiary;
contract ISuperToken paymentToken;
contract ISuperfluid host;
uint256 perSecondFeeNumerator;
uint256 perSecondFeeDenominator;
uint256 penaltyNumerator;
uint256 penaltyDenominator;
uint256 bidPeriodLengthInSeconds;
uint256 reclaimAuctionLength;
uint256 minForSalePrice;
}
function diamondStorage() internal pure returns (struct LibPCOLicenseParams.DiamondStorage ds)
function getHost() external view returns (contract ISuperfluid)
Superfluid Host
function getPaymentToken() external view returns (contract ISuperToken)
Payment token
function getBeneficiary() external view returns (contract ICFABeneficiary)
Beneficiary
function getPerSecondFeeNumerator() external view returns (uint256)
The numerator of the network-wide per second contribution fee.
function getPerSecondFeeDenominator() external view returns (uint256)
The denominator of the network-wide per second contribution fee.
function getPenaltyNumerator() external view returns (uint256)
The numerator of the penalty rate.
function getPenaltyDenominator() external view returns (uint256)
The denominator of the penalty rate.
function getReclaimAuctionLength() external view returns (uint256)
when the required bid amount reaches its minimum value.
function getBidPeriodLengthInSeconds() external view returns (uint256)
Bid period length in seconds
function getMinForSalePrice() external view returns (uint256)
Minimum for sale price
Last modified 6mo ago