FundingRateApplier
FundingRateApplier contract.
nonReentrant() modifier
Prevents a contract from calling itself, directly or indirectly.
Calling a nonReentrant function from another nonReentrant
function is not supported. It is possible to prevent this from happening
by making the nonReentrant function external, and make it call a
private function that does the actual work.
nonReentrantView() modifier
Designed to prevent a view-only method from being re-entered during a call to a nonReentrant() state-changing method.
constructor(bytes32 _fundingRateIdentifier, address _collateralAddress, address _finderAddress, address _configStoreAddress, struct FixedPoint.Unsigned _tokenScaling, address _timerAddress) public
Constructs the FundingRateApplier contract. Called by child contracts.
Parameters:
-
_fundingRateIdentifier: identifier that tracks the funding rate of this contract. -
_collateralAddress: address of the collateral token. -
_finderAddress: Finder used to discover financial-product-related contracts. -
_configStoreAddress: address of the remote configuration store managed by an external owner. -
_tokenScaling: initial scaling to apply to the token value (i.e. scales the tracking index). -
_timerAddress: address of the timer contract in test envs, otherwise 0x0.
applyFundingRate() public
This method takes 3 distinct actions: 1. Pays out regular fees. 2. If possible, resolves the outstanding funding rate proposal, pulling the result in and paying out the rewards. 3. Applies the prevailing funding rate over the most recent period.
proposeFundingRate(struct FixedPoint.Signed rate, uint256 timestamp) → struct FixedPoint.Unsigned totalBond external
Proposes a new funding rate. Proposer receives a reward if correct.
Parameters:
-
rate: funding rate being proposed. -
timestamp: time at which the funding rate was computed.
_getFundingRateAppliedTokenDebt(struct FixedPoint.Unsigned rawTokenDebt) → struct FixedPoint.Unsigned tokenDebt internal
_calculateEffectiveFundingRate(uint256 paymentPeriodSeconds, struct FixedPoint.Signed fundingRatePerSecond, struct FixedPoint.Unsigned currentCumulativeFundingRateMultiplier) → struct FixedPoint.Unsigned newCumulativeFundingRateMultiplier internal
payRegularFees() → struct FixedPoint.Unsigned public
Pays UMA DVM regular fees (as a % of the collateral pool) to the Store contract.
These must be paid periodically for the life of the contract. If the contract has not paid its regular fee in a week or more then a late penalty is applied which is sent to the caller. If the amount of fees owed are greater than the pfc, then this will pay as much as possible from the available collateral. An event is only fired if the fees charged are greater than 0.
getOutstandingRegularFees(uint256 time) → struct FixedPoint.Unsigned regularFee, struct FixedPoint.Unsigned latePenalty, struct FixedPoint.Unsigned totalPaid public
Fetch any regular fees that the contract has pending but has not yet paid. If the fees to be paid are more than the total collateral within the contract then the totalPaid returned is full contract collateral amount.
This returns 0 and exit early if there is no pfc, fees were already paid during the current block, or the fee rate is 0.
pfc() → struct FixedPoint.Unsigned external
Gets the current profit from corruption for this contract in terms of the collateral currency.
This is equivalent to the collateral pool available from which to pay fees. Therefore, derived contracts are expected to implement this so that pay-fee methods can correctly compute the owed fees as a % of PfC.
gulp() external
Removes excess collateral balance not counted in the PfC by distributing it out pro-rata to all sponsors.
- Multiplying the
cumulativeFeeMultiplierby the ratio of non-PfC-collateral -
PfC-collateral effectively pays all sponsors a pro-rata portion of the excess collateral. This will revert if PfC is 0 and this contract’s collateral balance > 0.
_getFeeAdjustedCollateral(struct FixedPoint.Unsigned rawCollateral) → struct FixedPoint.Unsigned collateral internal
_getPendingRegularFeeAdjustedCollateral(struct FixedPoint.Unsigned rawCollateral) → struct FixedPoint.Unsigned internal
_convertToRawCollateral(struct FixedPoint.Unsigned collateral) → struct FixedPoint.Unsigned rawCollateral internal
_removeCollateral(struct FixedPoint.Unsigned rawCollateral, struct FixedPoint.Unsigned collateralToRemove) → struct FixedPoint.Unsigned removedCollateral internal
_addCollateral(struct FixedPoint.Unsigned rawCollateral, struct FixedPoint.Unsigned collateralToAdd) → struct FixedPoint.Unsigned addedCollateral internal
_adjustCumulativeFeeMultiplier(struct FixedPoint.Unsigned amount, struct FixedPoint.Unsigned currentPfc) internal
setCurrentTime(uint256 time) external
Sets the current time.
Will revert if not running in test mode.
Parameters:
-
time: timestamp to set current Testable time to.
getCurrentTime() → uint256 public
Gets the current time. Will return the last time set in setCurrentTime if running in test mode.
Otherwise, it will return the block timestamp.