This staking reward contract follows a typical staking reward system but has a unique feature called the refund option. The refund option is a selectable value for the percentage of the deposit to be refunded after the staking period ends. Setting the refund option lower allows users to receive additional bonus rewards in addition to the rewards allocated to the staking pool. The refund option for an already deposited contract can only be changed to a lower percentage. Claiming rewards can be done after users withdraw their deposits following the end of the staking period, and rewards can be received divided into a total of 10 cycles, each defined cycle.
User's Withdrawal status.
Copy modifier updateReward ( address stakingToken , uint8 refundOption) The modifier to run when executing deposit and withdraw functions. It must be run whenever the staking pool's deposit information changes.
The address of staking token.
The refund option for update.
Copy modifier checkActive ( address stakingToken) Checking staking pool is active.
The address of staking token.
Copy constructor ( address rewardToken_ , address collector_) public Deposit to staking pool.
struct ILaunchpadStaking.Depositparams
Adjust return options on user's deposit info. It must adjust refund option to downward.
struct ILaunchpadStaking.AdjustDepositParams
Parameters for adjust deposit.
Withdraw from all refund options of specific staking token pool when claimable.
Token address for withdraw.
emergencyWithdrawRefund
Emergency withdraw from all refund options of specific staking pool deposited by account. should be execute when paused.
Token address for withdraw.
Withdraw reward token by owner.
emergenctWithdrawReward
Emergency withdraw reward token by owner. Should be execute when paused.
Claim rewards. Should be execute after {withdrawRefund}.
Initialize configuration for mining protocol.
struct ILaunchpadStaking.InitializeParams
Pause mining protocol
Unpause mining protocol
Set staking pool. Only execute before start mining.
struct ILaunchpadStaking.PoolConfig
setBonusRewardSupply
Set {bonusRewardSupply}.
Amount of bonus reward supply.
setMiningPeriod
Set staking period.
setClaimSchedule
setBonusMiningMultiplier
Set {bonusMiningMultipliers}.
struct ILaunchpadStaking.MiningMultiplierParams
{MiningMultiplierParams}. refundOption: Refund option. multiplier: Bonus mining multiplier. If mining power is 100.0 %, multiplier is 1000.
setBonusMiningMultiplierBatch
Set batch {bonusMiningMultipliers}.
struct ILaunchpadStaking.MiningMultiplierParams[]
Batch of bonus mining multipliers. If mining power is 100.0 %, multiplier is 1000.
Return user's rewards for a specific refund option in the staking pool.
earnedForAllOptions
Return user's rewards for all refund options in the staking pool.
lastBlockRewardApplicable
If current block number greater than or equal to {stakingEndBlock}, return {stakingEndBlock}. Else return current block number.
Return reward per token deposited pool.
totalMiningRewards
Return total mining rewards.
totalMiningRewards total minting reward.
poolInfoListByTokens
Return poolInfo list.
Array of token address getting {PoolInfoResponse}.
depositedPoolsByAccount
Return user's deposited pools.
depositInfoListByToken
Return user's deposited pool info for a specific refund option.
calculateRefund
Return refund.
Refund calculated by returnOption.
Call transfer() function to ERC20 Contract.
Token address for transfer.
_transferFromERC20
Call transferFrom() function to ERC20 Contract.
Token address for transfer.
Call send ETH.
_withdrawRefund
Withdraw token to account.
Token address for transfer.
Update information related to reward.
User's address for update.
Token address for update.
Refund option for update.
_verifyDeadline
The reward token address.
The address for collect non-refund amount.
totalAllocationPerBlock
The reward allocation per block for all pool.
bonusRewardSupply
Total bonus rewards for refund option.
stakingStartBlock
The Staking start block number.
stakingEndBlock
The Staking end block number.
The claim limit.
Pool token address => Pool Info.
User's refund by staking token (user address => staking token => refund).
bonusMiningMultipliers
Bonus mining multipliers each refundOption.
Deposit info by account, staking token address, refund option.
User's claim count(account => count).
Block number per count(count => block number).
totalUserRewards
User's total reward amount(account => amount).
User's claimable status.
