Interfaces

TipRulePublic Variables

interface TipRule {
    /* ========== VIEW FUNCTIONS ========== */
    function getRollOverTimestamps() external view returns (uint[] memory);
    function getDailyCombinedAllowance(uint fid) external view returns (uint);
    function getDailyAllowance(uint fid) external view returns (uint);
    function getTimestamp(uint index) external view returns (uint);
    function seasonId() external view returns (uint);
    function dailyMaxDistribution() external view returns (uint);
    function maxUserDailyAllowance() external view returns (uint);
    function rollOverDays() external view returns (uint);
    /* ========== MUTATIVE FUNCTIONS ========== */
    function setTipState(address _tipState) external;
    function setNextTimestamp(uint _timestamp) external;
    function setDailyMaxDistribution(uint _maxDailyDistribution) external;
    function setMaxUserDailyAllowance(uint _maxUserDailyAllowance) external;
    function setRollOverDays(uint _rollOverDays) external;
    function setSeasonId(uint _seasonId) external;
    function giveTipBulk(ITipState.GiveTipData[] memory tipData) external;
    function setDailyAllowanceBulk(uint[] memory fids, uint[] memory allowances, uint timestamp) external;
    function downVote(bytes memory castHash) external;
    function setHookTarget(uint fid, address target) external;
    function setDownVoteDue(uint downVoteDue) external;
}

TipState

interface TipState {
    /* ========== STRUCT ========== */
    struct Allowance {
        uint dailyAllowance;
        uint remainAllowance;
        uint receivedPoint;
    }
    struct Cast {
        uint toFid;
        uint fromFid;
        uint amount;
        uint seasonId;
        uint castTimestamp;
        uint eventTimestamp;
        State state;
    }
    struct GiveTipData {
        uint toFid;
        uint fromFid;
        uint amount;
        bytes castHash;
        uint castTimestamp;
        State state;
        string message;
    }
    enum State {
        UnArrived,
        Valid,
        Invalid,
        DownVote
    }
    /* ========== VIEW FUNCTIONS ========== */
    function getAllowanceInfo(uint fid, uint timestamp) external view returns (Allowance memory);
    function getSeasonPoint(uint fid, uint seasonId) external view returns (uint);
    function getCastInfo(bytes memory castHash) external view returns (Cast memory);
    function getTotalSeasonTipDistribution(uint seasonId) external view returns (uint);
    function getTotalDailyTipDistribution(uint timestamp) external view returns (uint);
    function getHookTarget(uint fid) external view returns (address);
    function isAbused(bytes memory castHash) external view returns (bool);
    function isActiveUser(uint fid) external view returns (bool);
    function downVoteDue() external view returns (uint);
    /* ========== MUTATIVE FUNCTIONS ========== */
    function setTipRule(address _tipRule) external;
    function giveTipBulk(GiveTipData[] memory tipData) external;
    function setDailyAllowanceBulk(uint[] memory fids, uint[] memory allowances, uint timestamp) external;
    function downVote(bytes memory castHash) external;
    function setHookTarget(uint fid, address target) external;
    function setDownVoteDue(uint downVoteDue) external;
}