# GoodCompoundStaking V2 (DAI) ### Events #### Staked Emitted when `staker` stake `value` tokens of `token`.
Parameter nameAnnotation
stakerThe address of the staker.
tokenThe address of the staking token.
valueThe value to be staked.
``` event Staked(address indexed staker, address token, uint256 value); ``` #### StakeWithdraw Emitted when `staker` withdraws their stake `value` tokens of `token`.
Parameter nameAnnotation
stakerThe address of the staker.
tokenThe address of the staking token that beign withdrawn.
valueThe value to be withdrawn.
``` event StakeWithdraw(address indexed staker, address token, uint256 value); ``` #### InterestCollected Emitted when fundmanager transfers interest collected from DeFi protrocol.
Parameter nameAnnotation
recipientThe recipient address of the interest
iTokenGainsThe amount of intereset accrued.
tokenGainsThe amount of interest worth in underlying token value.
actualTokenRedeemedActual token redeemed in Uniswap V2 (max 0.3% of liquidity) to token (in this case DAI).
actualRewardTokenEarnedActual amount of reward tokens earned.
interestCollectedInDAIActual DAI amount sent to the reserve as interest from converting token and optionally reward token in Uniswap V2.
``` event InterestCollected( address recipient, uint256 iTokenGains, uint256 tokenGains, uint256 actualTokenRedeemed, uint256 actualRewardTokenEarned, uint256 interestCollectedInDAI ); ``` ### getSettings View function to get protocol management fees. Returns: a tuple of `_collectInterestGasCost` and `_compCollectGasCost` which represents the gas cost fee for collecting interest from the contract and gas cost fee for collecting COMP rewards. ``` function getSettings() external view returns (uint32 _collectInterestGasCost, uint32 _compCollectGasCost); ``` ### currentGains Function that calculates current interest gains of this staking contract.
Parameter nameAnnotation
_returnTokenBalanceInUSDDetermine return token balance of staking contract in USD.
_returnTokenGainsInUSDDetermine return token gains of staking contract in USD.
Return parameter nameAnnotation
iTokenGainsGains in iToken (in this case cDAI).
tokenGainsGains in token (in this case DAI).
tokenBalanceTotal tokens locked.
balanceInUSDLocked tokens worth in USD.
tokenGainsInUSDGains in USD.
``` function currentGains( bool _returnTokenBalanceInUSD, bool _returnTokenGainsInUSD ) public view override returns ( uint256 iTokenGains, uint256 tokenGains, uint256 tokenBalance, uint256 balanceInUSD, uint256 tokenGainsInUSD ); ``` ### stake Allows a staker to deposit Tokens (in this case DAI). Notice that `approve` is needed to be executed before the execution of this method.
Parameter nameAnnotation
_amountThe amount of Token (in this case DAI) or iToken (in this case cDAI) to stake (it depends on _inInterestToken parameter).
_donationPerThe % of interest staker want to donate.
_inInterestTokenSpecificy if stake in iToken (in this case cDAI) or Token (in this case DAI).
Can be executed only when the contract is not paused. ``` function stake( uint256 _amount, uint256 _donationPer, bool _inInterestToken ) external virtual; ``` ### withdrawStake Withdraws the sender staked Token (in this case DAI).
Parameter nameAnnotation
_amountAmount to withdraw in Token (in this case DAI) or iToken (in this case cDAI).
_inInterestTokenIf true _amount is in iToken (in this case cDAI) and also returned in iToken otherwise use Token (in this case DAI).
Can be executed only when the contract is not paused. ``` function withdrawStake(uint256 _amount, bool _inInterestToken) external virtual; ``` ### withdrawRewards Withdraw staker G$ rewards + GDAO (GOOD) rewards to the caller (staker). ``` function withdrawRewards() external; ``` ### claimReputation Withdraw staker GDAO (GOOD) rewards to the caller (staker). ``` function claimReputation() public; ``` ### collectUBIInterest Collects gained interest (in G$) by fundmanager.
Parameter nameAnnotation
_recipientThe recipient of iToken (in this case cDAI) gains.
Return parameter nameAnnotation
actualTokensRedeemedCollected interest from token.
actualRewardTokenRedeemedCollected interest from reward token.
actualDaiTotal Token (in this case DAI) received from swapping token + reward token.
``` function collectUBIInterest(address _recipient) public virtual returns ( uint256 actualTokenRedeemed, uint256 actualRewardTokenRedeemed, uint256 actualDai ); ``` ### getTokenValueInUSD The function is to calculate Token (in this case DAI) price in USD.
Parameter nameAnnotation
_oracleChainlink oracle usd/token oralce.
_amountAmount of Token to calculate worth of it.
_decimalsDecimals of Token.
Returns: worth of Tokens in USD, the decimals are 8. ``` function getTokenValueInUSD( address _oracle, uint256 _amount, uint256 _decimals ) public view returns (uint256); ``` ### getUserMintedAndPending The function that can provide information about minted and pending rewards in G$ of the `_staker`.
Parameter nameAnnotation
_stakerAccount to get rewards status for.
Returns: The first element of the tuple is Minted value and the second is Pending value in G$; 2 decimals. ``` function getUserMintedAndPending(address _staker) external view returns (uint256, uint256); ```