Skip to content

Latest commit

 

History

History
156 lines (107 loc) · 4.51 KB

FutureValueVault.md

File metadata and controls

156 lines (107 loc) · 4.51 KB
Raw

Solidity API

FutureValueVault

Implements the management of the future value as an amount for Lending deals in each currency.

initialize

function initialize(address _resolver) external

Initializes the contract.

Function is invoked by the proxy contract when the contract is added to the ProxyController.

Name Type Description
_resolver address The address of the Address Resolver contract

requiredContracts

function requiredContracts() public pure returns (bytes32[] contracts)

Returns the contract names used in this contract.

The contract name list is in ./libraries/Contracts.sol.

acceptedContracts

function acceptedContracts() public pure returns (bytes32[] contracts)

Returns contract names that can call this contract.

The contact name listed in this method is also needed to be listed requiredContracts method.

getTotalSupply

function getTotalSupply(uint256 _maturity) external view returns (uint256)

Gets the total supply.

Name Type Description
_maturity uint256 The maturity of the market

getFutureValue

function getFutureValue(address _user) public view returns (int256 futureValue, uint256 maturity)

Gets the future value of the account.

Name Type Description
_user address User's address
Name Type Description
futureValue int256 The future value
maturity uint256 The maturity of the market that the future value was added

hasFutureValueInPastMaturity

function hasFutureValueInPastMaturity(address _user, uint256 _maturity) public view returns (bool)

Gets if the account has the future value amount in the selected maturity.

Name Type Description
_user address User's address
_maturity uint256 The maturity of the market
Name Type Description
[0] bool The boolean if the lending market is initialized or not

addLendFutureValue

function addLendFutureValue(address _user, uint256 _amount, uint256 _maturity, bool _isTaker) public returns (bool)

Adds the future value amount for lending deals.

Since the total supply can be determined by totaling only the amounts on one side of the order when the order is fulfilled, the total supply is incremented only when the executor of the original order is the taker.

Name Type Description
_user address User's address
_amount uint256 The amount to add
_maturity uint256 The maturity of the market
_isTaker bool The boolean if the original order is created by a taker

addBorrowFutureValue

function addBorrowFutureValue(address _user, uint256 _amount, uint256 _maturity, bool _isTaker) public returns (bool)

Adds the future value amount for borrowing deals.

Since the total supply can be determined by totaling only the amounts on one side of the order when the order is fulfilled, the total supply is incremented only when the executor of the original order is the taker.

Name Type Description
_user address User's address
_amount uint256 The amount to add
_maturity uint256 The maturity of the market
_isTaker bool The boolean if the original order is created by a taker

offsetFutureValue

function offsetFutureValue(address _lender, address _borrower, uint256 _maximumFVAmount) external returns (uint256 offsetAmount)

removeFutureValue

function removeFutureValue(address _user, uint256 _activeMaturity) external returns (int256 removedAmount, int256 currentAmount, uint256 maturity, bool isAllRemoved)

Remove all future values if there is an amount in the past maturity.

Name Type Description
_user address User's address
_activeMaturity uint256
Name Type Description
removedAmount int256 Removed future value amount
currentAmount int256 Current future value amount after update
maturity uint256 Maturity of future value
isAllRemoved bool The boolean if the all future value amount in the selected maturity is removed

_updateTotalSupply

function _updateTotalSupply(uint256 _maturity, int256 _previous, int256 _current) private