Staking721Upgradeable

Methods

claimRewards

function claimRewards() external nonpayable

Claim accumulated rewards.

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

getRewardTokenBalance

function getRewardTokenBalance() external view returns (uint256 _rewardsAvailableInContract)

View total rewards available in the staking contract.

Returns

Name	Type	Description
_rewardsAvailableInContract	uint256	undefined

getRewardsPerUnitTime

function getRewardsPerUnitTime() external view returns (uint256 _rewardsPerUnitTime)

Returns

Name	Type	Description
_rewardsPerUnitTime	uint256	undefined

getStakeInfo

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

View amount staked and total rewards for a user.

Parameters

Name	Type	Description
_staker	address	Address for which to calculated rewards.

Returns

Name	Type	Description
_tokensStaked	uint256[]	List of token-ids staked by staker.
_rewards	uint256	Available reward amount.

getTimeUnit

function getTimeUnit() external view returns (uint256 _timeUnit)

Returns

Name	Type	Description
_timeUnit	uint256	undefined

indexedTokens

function indexedTokens(uint256) external view returns (uint256)

List of token-ids ever staked.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

isIndexed

function isIndexed(uint256) external view returns (bool)

Mapping from token-id to whether it is indexed or not.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	bool	undefined

setRewardsPerUnitTime

function setRewardsPerUnitTime(uint256 _rewardsPerUnitTime) external nonpayable

Set rewards per unit of time. Interpreted as x rewards per second/per day/etc based on time-unit.

Only admin/authorized-account can call it.

Parameters

Name	Type	Description
_rewardsPerUnitTime	uint256	New rewards per unit time.

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

Name	Type	Description
_timeUnit	uint256	New time unit.

stake

function stake(uint256[] _tokenIds) external nonpayable

Stake ERC721 Tokens.

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

Parameters

Name	Type	Description
_tokenIds	uint256[]	List of tokens to stake.

stakerAddress

function stakerAddress(uint256) external view returns (address)

Mapping from staked token-id to staker address.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

stakers

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

Mapping from staker address to Staker struct. See {struct IStaking721.Staker}.

Parameters

Name	Type	Description
_0	address	undefined

Returns

Name	Type	Description
amountStaked	uint256	undefined
timeOfLastUpdate	uint256	undefined
unclaimedRewards	uint256	undefined
conditionIdOflastUpdate	uint256	undefined

stakersArray

function stakersArray(uint256) external view returns (address)

List of accounts that have staked their NFTs.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

stakingToken

function stakingToken() external view returns (address)

Address of ERC721 NFT contract -- staked tokens belong to this contract.

Returns

Name	Type	Description
_0	address	undefined

withdraw

function withdraw(uint256[] _tokenIds) external nonpayable

Withdraw staked tokens.

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

Parameters

Name	Type	Description
_tokenIds	uint256[]	List of tokens to withdraw.

Events

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

RewardsClaimed

event RewardsClaimed(address indexed staker, uint256 rewardAmount)

Parameters

Name	Type	Description
staker indexed	address	undefined
rewardAmount	uint256	undefined

TokensStaked

event TokensStaked(address indexed staker, uint256[] indexed tokenIds)

Parameters

Name	Type	Description
staker indexed	address	undefined
tokenIds indexed	uint256[]	undefined

TokensWithdrawn

event TokensWithdrawn(address indexed staker, uint256[] indexed tokenIds)

Parameters

Name	Type	Description
staker indexed	address	undefined
tokenIds indexed	uint256[]	undefined

UpdatedRewardsPerUnitTime

event UpdatedRewardsPerUnitTime(uint256 oldRewardsPerUnitTime, uint256 newRewardsPerUnitTime)

Parameters

Name	Type	Description
oldRewardsPerUnitTime	uint256	undefined
newRewardsPerUnitTime	uint256	undefined

UpdatedTimeUnit

event UpdatedTimeUnit(uint256 oldTimeUnit, uint256 newTimeUnit)

Parameters

Name	Type	Description
oldTimeUnit	uint256	undefined
newTimeUnit	uint256	undefined