Maple
Search…
⌃K

MPL Rewards

MplRewards Synthetix farming contract fork for liquidity mining.

Constructor

constructor(
address _rewardsToken,
address _stakingToken,
address _owner
);

Parameters:

Index
Name
Type
Internal Type
Description
0
_rewardsToken
address
address
1
_stakingToken
address
address
2
_owner
address
address

Functions

balanceOf

Returns the amount of tokens owned by `account`.
function balanceOf(
address account
)
view
returns (
uint256
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of an account.

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The balance of `account`.

earned

function earned(
address account
)
view
returns (
uint256
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of an account.

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The rewards earned of `account`.

exit

Withdraw the entire balance and get the reward.
function exit()
nonpayable;

getReward

It emits a `RewardPaid` event if any rewards are received.
function getReward()
nonpayable;

getRewardForDuration

function getRewardForDuration()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The reward for a duration.

lastPauseTime [state variable]

The last pause time.
function lastPauseTime()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

lastTimeRewardApplicable

function lastTimeRewardApplicable()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The last time rewards were applicable.

lastUpdateTime [state variable]

The last update time.
function lastUpdateTime()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

notifyRewardAmount

Only the contract Owner may call this. It emits a `RewardAdded` event.
function notifyRewardAmount(
uint256 reward
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
reward
uint256
uint256
A reward amount.

paused [state variable]

Whether the contract is paused.
function paused()
view
returns (
bool
);

Return Values:

Index
Name
Type
Internal Type
Description
0
bool
bool

periodFinish [state variable]

The period finish.
function periodFinish()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

recoverERC20

Added to support recovering tokens unintentionally sent to this contract. Only the contract Owner may call this. It emits a `Recovered` event.
function recoverERC20(
address tokenAddress,
uint256 tokenAmount
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
tokenAddress
address
address
The address of a token to recover.
1
tokenAmount
uint256
uint256
The amount to recover.

rewardPerToken

function rewardPerToken()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The reward per token.

rewardPerTokenStored [state variable]

The reward per token stored.
function rewardPerTokenStored()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

rewardRate [state variable]

The rewards rate.
function rewardRate()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

rewards [state variable]

function rewards(
address account
)
view
returns (
uint256
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of an account.

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The rewards `account`.

rewardsDuration [state variable]

The rewards duration.
function rewardsDuration()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256

rewardsToken [state variable]

The rewards token.
function rewardsToken()
view
returns (
address
);

Return Values:

Index
Name
Type
Internal Type
Description
0
address
address

setPaused

Change the paused state of the contract. Only the contract Owner may call this. It emits a `PauseChanged` event.
function setPaused(
bool _paused
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
_paused
bool
bool
Whether to pause the contract.

setRewardsDuration

Only the contract Owner may call this. It emits a `RewardsDurationUpdated` event.
function setRewardsDuration(
uint256 _rewardsDuration
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
_rewardsDuration
uint256
uint256
The new duration for rewards.

stake

It emits a `Staked` event.
function stake(
uint256 amount
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
amount
uint256
uint256
An amount to stake.

stakingToken [state variable]

The staking token.
function stakingToken()
view
returns (
address
);

Return Values:

Index
Name
Type
Internal Type
Description
0
address
address

totalSupply

Returns the amount of tokens in existence.
function totalSupply()
view
returns (
uint256
);

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The total supply.

updatePeriodFinish

End rewards emission earlier. Only the contract Owner may call this.
function updatePeriodFinish(
uint256 timestamp
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
timestamp
uint256
uint256
A unix timestamp to finish rewards.

userRewardPerTokenPaid [state variable]

function userRewardPerTokenPaid(
address account
)
view
returns (
uint256
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of an account.

Return Values:

Index
Name
Type
Internal Type
Description
0
uint256
uint256
The reward per token paid for `account`.

withdraw

It emits a `Withdrawn` event.
function withdraw(
uint256 amount
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
amount
uint256
uint256
An amount to withdraw.

owner

Returns the address of the current owner.
function owner()
view
returns (
address
);

Return Values:

Index
Name
Type
Internal Type
Description
0
address
address

renounceOwnership

Leaves the contract without owner. It will not be possible to call `onlyOwner` functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.
function renounceOwnership()
nonpayable;

transferOwnership

Transfers ownership of the contract to a new account (`newOwner`). Can only be called by the current owner.
function transferOwnership(
address newOwner
)
nonpayable;

Parameters:

Index
Name
Type
Internal Type
Description
0
newOwner
address
address

Events

PauseChanged

Emits an event indicating that pause state has changed.
event PauseChanged(
bool isPaused
);

Parameters:

Index
Name
Type
Internal Type
Description
0
isPaused
bool
bool
Whether the contract is paused.

Recovered

Emits an event indicating that some token was recovered.
event Recovered(
address token,
uint256 amount
);

Parameters:

Index
Name
Type
Internal Type
Description
0
token
address
address
The address of the token recovered.
1
amount
uint256
uint256
The amount recovered.

RewardAdded

Emits an event indicating that a reward was added.
event RewardAdded(
uint256 reward
);

Parameters:

Index
Name
Type
Internal Type
Description
0
reward
uint256
uint256
The amount of the added reward.

RewardPaid

Emits an event indicating that some reward was paid to an account.
event RewardPaid(
address account,
uint256 reward
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of the account rewarded.
1
reward
uint256
uint256
The amount rewarded to `account`.

RewardsDurationUpdated

Emits an event indicating that the duration of the ward period has updated.
event RewardsDurationUpdated(
uint256 newDuration
);

Parameters:

Index
Name
Type
Internal Type
Description
0
newDuration
uint256
uint256
The new duration of the rewards.

Staked

Emits an event indicating that an account has staked.
event Staked(
address account,
uint256 amount
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of the account.
1
amount
uint256
uint256
The amount staked.

Withdrawn

Emits an event indicating that reward was withdrawn.
event Withdrawn(
address account,
uint256 amount
);

Parameters:

Index
Name
Type
Internal Type
Description
0
account
address
address
The address of the account.
1
amount
uint256
uint256
The amount withdrawn.

OwnershipTransferred

event OwnershipTransferred(
address previousOwner,
address newOwner
);

Parameters:

Index
Name
Type
Internal Type
Description
0
previousOwner
address
address
1
newOwner
address
address