IFuture.sol

Main future functions this could be extended for further implementations.

interface IFuture {
    // Returns the expiry timestamp for a future
    function expiry() external returns (uint256);

    // Returns the protocol for the future e.g. AAVE/COMP
    function protocol() external returns (bytes32);

    // Returns the underlying Address
    function underlying() external returns (address);

    // Returns the address of YT token
    function getYT() external view returns (address);

    // Returns the total supply of YT tokens
    function totalSupplyYT() external view returns (uint256);

    // Returns the address of OT token
    function getOT() external view returns (address);

    // Returns the total supply of OT tokens
    function totalSupplyOT() external view returns (uint256);

    // Returns the total balance underlying this epoch would have at an instance 
    // if redeem is called.
    function totalBalanceUnderlying() external view returns (uint256);

    // Returns the principal added by the users in this epoch. 
    function initialCapitalInUnderlying() external view returns (uint256);

    // Returns the vault or yield bearing token address.
    function getInterestBearingToken() external view returns (address);

    // Returns the yield generated in underlying.
    function yield() external view returns (uint256);
}