Synthetix PQ

1// https://docs.synthetix.io/contracts/FeePool
2contract FeePool is Owned, Proxyable, SelfDestructible, LimitedSetup, MixinResolver, IFeePool {
3    using SafeMath for uint;
4    using SafeDecimalMath for uint;
5​
6    // Exchange fee may not exceed 10%.
7    uint public constant MAX_EXCHANGE_FEE_RATE = 1e18 / 10;
8​
9    // Where fees are pooled in sUSD.
10    address public constant FEE_ADDRESS = 0xfeEFEEfeefEeFeefEEFEEfEeFeefEEFeeFEEFEeF;
11​
12    // sUSD currencyKey. Fees stored and paid in sUSD
13    bytes32 private sUSD = "sUSD";
14​
15    // This struct represents the issuance activity that's happened in a fee period.
16    struct FeePeriod {
17        uint64 feePeriodId;
18        uint64 startingDebtIndex;
19        uint64 startTime;
20        uint feesToDistribute;
21        uint feesClaimed;
22        uint rewardsToDistribute;
23        uint rewardsClaimed;
24    }
25​
26    // A staker(mintr) can claim from the previous fee period (7 days) only.
27    // Fee Periods stored and managed from [0], such that [0] is always
28    // the current active fee period which is not claimable until the
29    // public function closeCurrentFeePeriod() is called closing the
30    // current weeks collected fees. [1] is last weeks feeperiod
31    uint8 public constant FEE_PERIOD_LENGTH = 2;
32​
33    FeePeriod[FEE_PERIOD_LENGTH] private _recentFeePeriods;
34    uint256 private _currentFeePeriod;
35​
36    // How long a fee period lasts at a minimum. It is required for
37    // anyone to roll over the periods, so they are not guaranteed
38    // to roll over at exactly this duration, but the contract enforces
39    // that they cannot roll over any quicker than this duration.
40    uint public feePeriodDuration = 1 weeks;
41    / The fee period must be between 1 day and 60 days.
42    uint public constant MIN_FEE_PERIOD_DURATION = 1 days;
43    uint public constant MAX_FEE_PERIOD_DURATION = 60 days;
44​
45    / Users are unable to claim fees if their collateralisation ratio drifts out of target treshold
46    uint public targetThreshold = (1 * SafeDecimalMath.unit()) / 100;
47​
48       /* ========== MUTATIVE FUNCTIONS ========== */
49​
50    /**
51     * @notice Logs an accounts issuance data per fee period
52     * @param account Message.Senders account address
53     * @param debtRatio Debt percentage this account has locked after minting or burning their synth
54     * @param debtEntryIndex The index in the global debt ledger. synthetixState.issuanceData(account)
55     * @dev onlyIssuer to call me on synthetix.issue() & synthetix.burn() calls to store the locked SNX
56     * per fee period so we know to allocate the correct proportions of fees and rewards per period
57     */
58    function appendAccountIssuanceRecord(
59        address account,
60        uint debtRatio,
61        uint debtEntryIndex
62    ) external onlyIssuer {
63        feePoolState().appendAccountIssuanceRecord(
64            account,
65            debtRatio,
66            debtEntryIndex,
67            _recentFeePeriodsStorage(0).startingDebtIndex
68        );
69​
70        emitIssuanceDebtRatioEntry(account, debtRatio, debtEntryIndex, _recentFeePeriodsStorage(0).startingDebtIndex);
71    }
72​
73    /**
74     * @notice Set the fee period duration
75     */
76    function setFeePeriodDuration(uint _feePeriodDuration) external optionalProxy_onlyOwner {
77        require(_feePeriodDuration >= MIN_FEE_PERIOD_DURATION, "value < MIN_FEE_PERIOD_DURATION");
78        require(_feePeriodDuration <= MAX_FEE_PERIOD_DURATION, "value > MAX_FEE_PERIOD_DURATION");
79​
80        feePeriodDuration = _feePeriodDuration;
81​
82        emitFeePeriodDurationUpdated(_feePeriodDuration);
83    }

Solidity Contracts

JavaScript Tests