PricelessPositionManager

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.

Designed to prevent a view-only method from being re-entered during a call to a nonReentrant() state-changing method.

Reverts if not running in test mode.

Construct the PricelessPositionManager

Deployer of this contract should consider carefully which parties have ability to mint and burn the synthetic tokens referenced by _tokenAddress. This contract’s security assumes that no external accounts can mint new tokens, which could be used to steal all of this contract’s locked collateral. We recommend to only use synthetic token contracts whose sole Owner role (the role capable of adding & removing roles) is assigned to this contract, whose sole Minter role is assigned to this contract, and whose total supply is 0 prior to construction of this contract.

Parameters:

Requests to transfer ownership of the caller’s current position to a new sponsor address. Once the request liveness is passed, the sponsor can execute the transfer and specify the new sponsor.

The liveness length is the same as the withdrawal liveness.

After a passed transfer position request (i.e., by a call to requestTransferPosition and waiting withdrawalLiveness), transfers ownership of the caller’s current position to newSponsorAddress.

Transferring positions can only occur if the recipient does not already have a position.

Parameters:

Cancels a pending transfer position request.

Transfers collateralAmount of collateralCurrency into the specified sponsor’s position.

Increases the collateralization level of a position after creation. This contract must be approved to spend at least collateralAmount of collateralCurrency.

Parameters:

Transfers collateralAmount of collateralCurrency into the caller’s position.

Increases the collateralization level of a position after creation. This contract must be approved to spend at least collateralAmount of collateralCurrency.

Parameters:

Transfers collateralAmount of collateralCurrency from the sponsor’s position to the sponsor.

Reverts if the withdrawal puts this position’s collateralization ratio below the global collateralization ratio. In that case, use requestWithdrawal. Might not withdraw the full requested amount to account for precision loss.

Parameters:

Starts a withdrawal request that, if passed, allows the sponsor to withdraw` from their position.

The request will be pending for withdrawalLiveness, during which the position can be liquidated.

Parameters:

After a passed withdrawal request (i.e., by a call to requestWithdrawal and waiting withdrawalLiveness), withdraws positionData.withdrawalRequestAmount of collateral currency.

Might not withdraw the full requested amount in order to account for precision loss or if the full requested amount exceeds the collateral in the position (due to paying fees).

Cancels a pending withdrawal request.

Creates tokens by creating a new position or by augmenting an existing position. Pulls collateralAmount into the sponsor’s position and mints numTokens of tokenCurrency.

Reverts if minting these tokens would put the position’s collateralization ratio below the global collateralization ratio. This contract must be approved to spend at least collateralAmount of collateralCurrency. This contract must have the Minter role for the tokenCurrency.

Parameters:

Burns numTokens of tokenCurrency to decrease sponsors position size, without sending back collateralCurrency. This is done by a sponsor to increase position CR. Resulting size is bounded by minSponsorTokens.

Can only be called by token sponsor. This contract must be approved to spend numTokens of tokenCurrency. This contract must have the Burner role for the tokenCurrency.

Parameters:

Burns numTokens of tokenCurrency and sends back the proportional amount of collateralCurrency.

Can only be called by a token sponsor. Might not redeem the full proportional amount of collateral in order to account for precision loss. This contract must be approved to spend at least numTokens of tokenCurrency. This contract must have the Burner role for the tokenCurrency.

Parameters:

After a contract has passed expiry all token holders can redeem their tokens for underlying at the prevailing price defined by the DVM from the expire function.

This burns all tokens from the caller of tokenCurrency and sends back the proportional amount of collateralCurrency. Might not redeem the full proportional amount of collateral in order to account for precision loss. This contract must be approved to spend tokenCurrency at least up to the caller’s full balance. This contract must have the Burner role for the tokenCurrency.

Locks contract state in expired and requests oracle price.

this function can only be called once the contract is expired and can’t be re-called.

Premature contract settlement under emergency circumstances.

Only the governor can call this function as they are permissioned within the FinancialContractAdmin. Upon emergency shutdown, the contract settlement time is set to the shutdown time. This enables withdrawal to occur via the standard settleExpired function. Contract state is set to ExpiredPriceRequested which prevents re-entry into this function or the expire function. No fees are paid when calling emergencyShutdown as the governor who would call the function would also receive the fees.

Theoretically supposed to pay fees and move money between margin accounts to make sure they reflect the NAV of the contract. However, this functionality doesn’t apply to this contract.

This is supposed to be implemented by any contract that inherits AdministrateeInterface and callable only by the Governor contract. This method is therefore minimally implemented in this contract and does nothing.

Accessor method for a sponsor’s collateral.

This is necessary because the struct returned by the positions() method shows rawCollateral, which isn’t a user-readable value. This method accounts for pending regular fees that have not yet been withdrawn from this contract, for example if the lastPaymentTime != currentTime.

Parameters:

Accessor method for the total collateral stored within the PricelessPositionManager.

This method accounts for pending regular fees that have not yet been withdrawn from this contract, for example if the lastPaymentTime != currentTime.

Accessor method to compute a transformed price using the finanicalProductLibrary specified at contract deployment. If no library was provided then no modification to the price is done.

This method should never revert.

Parameters:

Accessor method to compute a transformed price identifier using the finanicalProductLibrary specified at contract deployment. If no library was provided then no modification to the identifier is done.

This method should never revert.

Parameters:

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.

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.

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.

Removes excess collateral balance not counted in the PfC by distributing it out pro-rata to all sponsors.

Sets the current time.

Will revert if not running in test mode.

Parameters:

Gets the current time. Will return the last time set in setCurrentTime if running in test mode. Otherwise, it will return the block timestamp.