Staking1155Upgradeable

Methods

claimRewards

function claimRewards(uint256 _tokenId) external nonpayable

Claim accumulated rewards.

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

Parameters

Name	Type	Description
_tokenId	uint256	Staked token Id.

getDefaultRewardsPerUnitTime

function getDefaultRewardsPerUnitTime() external view returns (uint256 _rewardsPerUnitTime)

Returns

Name	Type	Description
_rewardsPerUnitTime	uint256	undefined

getDefaultTimeUnit

function getDefaultTimeUnit() external view returns (uint256 _timeUnit)

Returns

Name	Type	Description
_timeUnit	uint256	undefined

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(uint256 _tokenId) external view returns (uint256 _rewardsPerUnitTime)

Parameters

Name	Type	Description
_tokenId	uint256	undefined

Returns

Name	Type	Description
_rewardsPerUnitTime	uint256	undefined

getStakeInfo

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

View all tokens 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.
_tokenAmounts	uint256[]	Amount of each token-id staked.
_totalRewards	uint256	Total rewards available.

getStakeInfoForToken

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

View amount staked and rewards for a user, for a given token-id.

Parameters

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

Returns

Name	Type	Description
_tokensStaked	uint256	Amount of tokens staked for given token-id.
_rewards	uint256	Available reward amount.

getTimeUnit

function getTimeUnit(uint256 _tokenId) external view returns (uint256 _timeUnit)

Parameters

Name	Type	Description
_tokenId	uint256	undefined

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

setDefaultRewardsPerUnitTime

function setDefaultRewardsPerUnitTime(uint256 _defaultRewardsPerUnitTime) 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
_defaultRewardsPerUnitTime	uint256	New rewards per unit time.

setDefaultTimeUnit

function setDefaultTimeUnit(uint256 _defaultTimeUnit) 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
_defaultTimeUnit	uint256	New time unit.

setRewardsPerUnitTime

function setRewardsPerUnitTime(uint256 _tokenId, 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
_tokenId	uint256	ERC1155 token Id.
_rewardsPerUnitTime	uint256	New rewards per unit time.

setTimeUnit

function setTimeUnit(uint256 _tokenId, 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
_tokenId	uint256	ERC1155 token Id.
_timeUnit	uint256	New time unit.

stake

function stake(uint256 _tokenId, uint256 _amount) external nonpayable

Stake ERC721 Tokens.

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

Parameters

Name	Type	Description
_tokenId	uint256	ERC1155 token-id to stake.
_amount	uint256	Amount to stake.

stakers

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

Mapping from token-id and staker address to Staker struct. See {struct IStaking1155.Staker}.

Parameters

Name	Type	Description
_0	uint256	undefined
_1	address	undefined

Returns

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

stakersArray

function stakersArray(uint256, uint256) external view returns (address)

Mapping from token-id to list of accounts that have staked that token-id.

Parameters

Name	Type	Description
_0	uint256	undefined
_1	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

stakingToken

function stakingToken() external view returns (address)

Address of ERC1155 contract -- staked tokens belong to this contract.

Returns

Name	Type	Description
_0	address	undefined

withdraw

function withdraw(uint256 _tokenId, uint256 _amount) external nonpayable

Withdraw staked tokens.

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

Parameters

Name	Type	Description
_tokenId	uint256	ERC1155 token-id to withdraw.
_amount	uint256	Amount 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 tokenId, uint256 amount)

Parameters

Name	Type	Description
staker indexed	address	undefined
tokenId indexed	uint256	undefined
amount	uint256	undefined

TokensWithdrawn

event TokensWithdrawn(address indexed staker, uint256 indexed tokenId, uint256 amount)

Parameters

Name	Type	Description
staker indexed	address	undefined
tokenId indexed	uint256	undefined
amount	uint256	undefined

UpdatedDefaultRewardsPerUnitTime

event UpdatedDefaultRewardsPerUnitTime(uint256 oldRewardsPerUnitTime, uint256 newRewardsPerUnitTime)

Parameters

Name	Type	Description
oldRewardsPerUnitTime	uint256	undefined
newRewardsPerUnitTime	uint256	undefined

UpdatedDefaultTimeUnit

event UpdatedDefaultTimeUnit(uint256 oldTimeUnit, uint256 newTimeUnit)

Parameters

Name	Type	Description
oldTimeUnit	uint256	undefined
newTimeUnit	uint256	undefined

UpdatedRewardsPerUnitTime

event UpdatedRewardsPerUnitTime(uint256 indexed _tokenId, uint256 oldRewardsPerUnitTime, uint256 newRewardsPerUnitTime)

Parameters

Name	Type	Description
_tokenId indexed	uint256	undefined
oldRewardsPerUnitTime	uint256	undefined
newRewardsPerUnitTime	uint256	undefined

UpdatedTimeUnit

event UpdatedTimeUnit(uint256 indexed _tokenId, uint256 oldTimeUnit, uint256 newTimeUnit)

Parameters

Name	Type	Description
_tokenId indexed	uint256	undefined
oldTimeUnit	uint256	undefined
newTimeUnit	uint256	undefined