Skip to main content

TokenStake

Methods​

DEFAULT_ADMIN_ROLE​

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns​

NameTypeDescription
_0bytes32undefined

claimRewards​

function claimRewards() external nonpayable

Claim accumulated rewards.

See {_claimRewards}. Override that to implement custom logic. See {_calculateRewards} for reward-calculation logic.

contractType​

function contractType() external pure returns (bytes32)

Returns the module type of the contract.

Returns​

NameTypeDescription
_0bytes32undefined

contractURI​

function contractURI() external view returns (string)

Returns the contract metadata URI.

Returns​

NameTypeDescription
_0stringundefined

contractVersion​

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

Returns​

NameTypeDescription
_0uint8undefined

depositRewardTokens​

function depositRewardTokens(uint256 _amount) external payable

Admin deposits reward tokens.

Parameters​

NameTypeDescription
_amountuint256undefined

getRewardRatio​

function getRewardRatio() external view returns (uint256 _numerator, uint256 _denominator)

Returns​

NameTypeDescription
_numeratoruint256undefined
_denominatoruint256undefined

getRewardTokenBalance​

function getRewardTokenBalance() external view returns (uint256)

View total rewards available in the staking contract.

Returns​

NameTypeDescription
_0uint256undefined

getRoleAdmin​

function getRoleAdmin(bytes32 role) external view returns (bytes32)

Returns the admin role that controls the specified role.

See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")

Returns​

NameTypeDescription
_0bytes32undefined

getRoleMember​

function getRoleMember(bytes32 role, uint256 index) external view returns (address member)

Returns the role-member from a list of members for a role, at a given index.

Returns member who has role, at index of role-members list. See struct {RoleMembers}, and mapping {roleMembers}

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
indexuint256Index in list of current members for the role.

Returns​

NameTypeDescription
memberaddressAddress of account that has role

getRoleMemberCount​

function getRoleMemberCount(bytes32 role) external view returns (uint256 count)

Returns total number of accounts that have a role.

Returns count of accounts that have role. See struct {RoleMembers}, and mapping {roleMembers}

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")

Returns​

NameTypeDescription
countuint256Total number of accounts that have role

getStakeInfo​

function getStakeInfo(address _staker) external view returns (uint256 _tokensStaked, uint256 _rewards)

View amount staked and rewards for a user.

Parameters​

NameTypeDescription
_stakeraddressAddress for which to calculated rewards.

Returns​

NameTypeDescription
_tokensStakeduint256Amount of tokens staked.
_rewardsuint256Available reward amount.

getTimeUnit​

function getTimeUnit() external view returns (uint256 _timeUnit)

Returns​

NameTypeDescription
_timeUnituint256undefined

grantRole​

function grantRole(bytes32 role, address account) external nonpayable

Grants a role to an account, if not previously granted.

Caller must have admin role for the role. Emits {RoleGranted Event}.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
accountaddressAddress of the account to which the role is being granted.

hasRole​

function hasRole(bytes32 role, address account) external view returns (bool)

Checks whether an account has a particular role.

Returns true if account has been granted role.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
accountaddressAddress of the account for which the role is being checked.

Returns​

NameTypeDescription
_0boolundefined

hasRoleWithSwitch​

function hasRoleWithSwitch(bytes32 role, address account) external view returns (bool)

Checks whether an account has a particular role; role restrictions can be swtiched on and off.

Returns true if account has been granted role. Role restrictions can be swtiched on and off: - If address(0) has ROLE, then the ROLE restrictions don't apply. - If address(0) does not have ROLE, then the ROLE restrictions will apply.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
accountaddressAddress of the account for which the role is being checked.

Returns​

NameTypeDescription
_0boolundefined

initialize​

function initialize(address _defaultAdmin, string _contractURI, address[] _trustedForwarders, address _rewardToken, address _stakingToken, uint256 _timeUnit, uint256 _rewardRatioNumerator, uint256 _rewardRatioDenominator) external nonpayable

Initiliazes the contract, like a constructor.

Parameters​

NameTypeDescription
_defaultAdminaddressundefined
_contractURIstringundefined
_trustedForwardersaddress[]undefined
_rewardTokenaddressundefined
_stakingTokenaddressundefined
_timeUnituint256undefined
_rewardRatioNumeratoruint256undefined
_rewardRatioDenominatoruint256undefined

isTrustedForwarder​

function isTrustedForwarder(address forwarder) external view returns (bool)

Parameters​

NameTypeDescription
forwarderaddressundefined

Returns​

NameTypeDescription
_0boolundefined

multicall​

function multicall(bytes[] data) external nonpayable returns (bytes[] results)

Receives and executes a batch of function calls on this contract.

Parameters​

NameTypeDescription
databytes[]undefined

Returns​

NameTypeDescription
resultsbytes[]undefined

renounceRole​

function renounceRole(bytes32 role, address account) external nonpayable

Revokes role from the account.

Caller must have the role, with caller being the same as account. Emits {RoleRevoked Event}.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
accountaddressAddress of the account from which the role is being revoked.

revokeRole​

function revokeRole(bytes32 role, address account) external nonpayable

Revokes role from an account.

Caller must have admin role for the role. Emits {RoleRevoked Event}.

Parameters​

NameTypeDescription
rolebytes32keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
accountaddressAddress of the account from which the role is being revoked.

rewardToken​

function rewardToken() external view returns (address)

ERC20 Reward Token address. See {_mintRewards} below.

Returns​

NameTypeDescription
_0addressundefined

rewardTokenDecimals​

function rewardTokenDecimals() external view returns (uint256)

Returns​

NameTypeDescription
_0uint256undefined

setContractURI​

function setContractURI(string _uri) external nonpayable

Lets a contract admin set the URI for contract-level metadata.

Caller should be authorized to setup contractURI, e.g. contract admin. See {_canSetContractURI}. Emits {ContractURIUpdated Event}.

Parameters​

NameTypeDescription
_uristringkeccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")

setRewardRatio​

function setRewardRatio(uint256 _numerator, uint256 _denominator) external nonpayable

Set rewards per unit of time. Interpreted as (numerator/denominator) rewards per second/per day/etc based on time-unit. For e.g., ratio of 1/20 would mean 1 reward token for every 20 tokens staked.

Only admin/authorized-account can call it.

Parameters​

NameTypeDescription
_numeratoruint256Reward ratio numerator.
_denominatoruint256Reward ratio denominator.

setTimeUnit​

function setTimeUnit(uint256 _timeUnit) external nonpayable

Set time unit. Set as a number of seconds. Could be specified as -- x 1 hours, x 1 days, etc.

Only admin/authorized-account can call it.

Parameters​

NameTypeDescription
_timeUnituint256New time unit.

stake​

function stake(uint256 _amount) external payable

Stake ERC20 Tokens.

See {_stake}. Override that to implement custom logic.

Parameters​

NameTypeDescription
_amountuint256Amount to stake.

stakers​

function stakers(address) external view returns (uint256 amountStaked, uint256 timeOfLastUpdate, uint256 unclaimedRewards, uint256 conditionIdOflastUpdate)

Parameters​

NameTypeDescription
_0addressundefined

Returns​

NameTypeDescription
amountStakeduint256undefined
timeOfLastUpdateuint256undefined
unclaimedRewardsuint256undefined
conditionIdOflastUpdateuint256undefined

stakersArray​

function stakersArray(uint256) external view returns (address)

Parameters​

NameTypeDescription
_0uint256undefined

Returns​

NameTypeDescription
_0addressundefined

stakingToken​

function stakingToken() external view returns (address)

Returns​

NameTypeDescription
_0addressundefined

stakingTokenBalance​

function stakingTokenBalance() external view returns (uint256)

Returns​

NameTypeDescription
_0uint256undefined

stakingTokenDecimals​

function stakingTokenDecimals() external view returns (uint256)

Returns​

NameTypeDescription
_0uint256undefined

withdraw​

function withdraw(uint256 _amount) external nonpayable

Withdraw staked ERC20 tokens.

See {_withdraw}. Override that to implement custom logic.

Parameters​

NameTypeDescription
_amountuint256Amount to withdraw.

withdrawRewardTokens​

function withdrawRewardTokens(uint256 _amount) external nonpayable

Admin can withdraw excess reward tokens.

Parameters​

NameTypeDescription
_amountuint256undefined

Events​

ContractURIUpdated​

event ContractURIUpdated(string prevURI, string newURI)

Parameters​

NameTypeDescription
prevURIstringundefined
newURIstringundefined

Initialized​

event Initialized(uint8 version)

Parameters​

NameTypeDescription
versionuint8undefined

RewardTokensDepositedByAdmin​

event RewardTokensDepositedByAdmin(uint256 _amount)

Parameters​

NameTypeDescription
_amountuint256undefined

RewardTokensWithdrawnByAdmin​

event RewardTokensWithdrawnByAdmin(uint256 _amount)

Parameters​

NameTypeDescription
_amountuint256undefined

RewardsClaimed​

event RewardsClaimed(address indexed staker, uint256 rewardAmount)

Parameters​

NameTypeDescription
staker indexedaddressundefined
rewardAmountuint256undefined

RoleAdminChanged​

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Parameters​

NameTypeDescription
role indexedbytes32undefined
previousAdminRole indexedbytes32undefined
newAdminRole indexedbytes32undefined

RoleGranted​

event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)

Parameters​

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

RoleRevoked​

event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)

Parameters​

NameTypeDescription
role indexedbytes32undefined
account indexedaddressundefined
sender indexedaddressundefined

TokensStaked​

event TokensStaked(address indexed staker, uint256 amount)

Parameters​

NameTypeDescription
staker indexedaddressundefined
amountuint256undefined

TokensWithdrawn​

event TokensWithdrawn(address indexed staker, uint256 amount)

Parameters​

NameTypeDescription
staker indexedaddressundefined
amountuint256undefined

UpdatedMinStakeAmount​

event UpdatedMinStakeAmount(uint256 oldAmount, uint256 newAmount)

Parameters​

NameTypeDescription
oldAmountuint256undefined
newAmountuint256undefined

UpdatedRewardRatio​

event UpdatedRewardRatio(uint256 oldNumerator, uint256 newNumerator, uint256 oldDenominator, uint256 newDenominator)

Parameters​

NameTypeDescription
oldNumeratoruint256undefined
newNumeratoruint256undefined
oldDenominatoruint256undefined
newDenominatoruint256undefined

UpdatedTimeUnit​

event UpdatedTimeUnit(uint256 oldTimeUnit, uint256 newTimeUnit)

Parameters​

NameTypeDescription
oldTimeUnituint256undefined
newTimeUnituint256undefined