IMinterV3
Parameter Structs
FarmInfo
Struct that contains all the information about the user`s farm/staking.
Fields description
Name | Type | Description |
multiplier | uint256 | Multiplier for minted tokens for farm/staking |
rewardPerBlock | uint256 | Amount of tokens minted for farm per block (4 secs) |
accDeposited | uint256 | Accumulated farms`s tokens deposited from all the users |
deposited | uint256 | Amount of token deposited by the specified user |
earned | uint256 | Amount of BLUES that user can claim |
totalReward | uint256 | Amount of BLUES minted, but locked and could be claimed after new TVL goal is reached (see whitepaper) |
token | address | Farm`s/staking`s stake token |
farm | address | Farm`s/staking`s contract address |
UserReferralInfo
Struct that holds user`s info about participating in the referral program.
Fields description
Name | Type | Description |
isReferrer | bool | Indicates whether the user is someone`s referrer or not |
referrer | address | Address of the user`s referrer. Zero address (0x000โฆ) if the user has no referrer |
referrals | address[] | Addresses of all the user`s referrals. Empty array if the user has no referrals |
earnedRef | uint256 | Amount of tokens that user has earned as referral |
receivedRef | uint256 | Amount of tokens that user has earned as referrer |
Functions
getStatusStaking
Returns _user`s info across all the protocol`s stakings at the time _timestamp.
getStatusFarms
Returns _user`s info across all the protocol`s farms at the time _timestamp.
getFarms
Returns all the protocol`s farms.
getStakings
Returns all the protocol`s stakings.
getTvlLevels
Returns protocol`s TVL goals.
getAprWeights
Returns protocol`s tokens minting among reward accounts (see whitepaper) distribution (multiplied by 1e4).
getUserReferralInfo
Returns info about _user`s participating in the referral program.
devPull
Mints BLUES that dev has earned to specified dev address.
earnsAsReferrer
Returns info on how much tokens _user earns as referrer.
Parameters
Name | Type | Description |
_user | address | Address of user |
_timestamp | uint256 | Timestamp to get info for |
Return values
Name | Type | Description |
earned | uint256 | Amount of tokens that _user has already earned as referrer |
pendingReward | uint256 | Amount of tokens earned as referrer that _user can claim |
referralsCnt | uint256 | Amount of _user`s referrals |
earnsAsReferral
Returns info on how much tokens _user earns as referral.
Parameters
Name | Type | Description |
_user | address | Address of user |
_timestamp | uint256 | Timestamp to get info for |
Return values
Name | Type | Description |
earned | uint256 | Amount of tokens that _user has already earned as referral |
pendingReward | uint256 | Amount of tokens earned as referral that _user can claim |
earnsFromReferralProgram
Returns info on how much tokens _user earns as referrer and referral summarized.
Parameters
Name | Type | Description |
_user | address | Address of user |
_timestamp | uint256 | Timestamp to get info for |
Return values
Name | Type | Description |
earned | uint256 | Amount of tokens that _user has already earned as referrer and referral summarized |
pendingReward | uint256 | Amount of tokens earned as referrer and referral that _user can claim |
referralsCnt | uint256 | Amount of _user`s referrals |
registerReferrer
Registers msg.sender as referrer.
registerReferral
Registers msg.sender as referral with refCode as address of the referrer. Referrer should be registered as referrer, otherwise the transaction is reverted.
isReferrer
Returns true if the user is registered as a referrer, false otherwise.
getUserReferrer
Returns the address of the user`s referrer. If the user has no referrer zero address (0x000โฆ) is returned.
untilNextDecrease
Time in seconds until the next decrease of BLUES minted amount.
getEpochsCount
Returns the count of TVL goals.
Last updated