Skip to main content

Staking20Base

EXTENSION: Staking20 The Staking20Base smart contract implements Token staking mechanism. Allows users to stake their ERC-20 Tokens and earn rewards in form of another ERC-20 tokens. Following features and implementation setup must be noted: - ERC-20 Tokens from only one contract can be staked. - Contract admin can choose to give out rewards by either transferring or minting the rewardToken, which is ideally a different ERC20 token. See {_mintRewards}. - To implement custom logic for staking, reward calculation, etc. corresponding functions can be overridden from the extension Staking20. - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically.

Methods

claimRewards

function claimRewards() external nonpayable

Claim accumulated rewards.

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

contractURI

function contractURI() external view returns (string)

Returns the contract metadata URI.

Returns

NameTypeDescription
_0stringundefined

getRewardRatio

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

Returns

NameTypeDescription
_numeratoruint256undefined
_denominatoruint256undefined

getRewardTokenBalance

function getRewardTokenBalance() external view returns (uint256 _rewardsAvailableInContract)

View total rewards available in the staking contract.

Returns

NameTypeDescription
_rewardsAvailableInContractuint256undefined

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

multicall

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

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

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

Parameters

NameTypeDescription
databytes[]The bytes data that makes up the batch of function calls to execute.

Returns

NameTypeDescription
resultsbytes[]The bytes data that makes up the result of the batch of function calls executed.

owner

function owner() external view returns (address)

Returns the owner of the contract.

Returns

NameTypeDescription
_0addressundefined

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")

setOwner

function setOwner(address _newOwner) external nonpayable

Lets an authorized wallet set a new owner for the contract.

Parameters

NameTypeDescription
_newOwneraddressThe address to set as the new owner of the contract.

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.

Events

ContractURIUpdated

event ContractURIUpdated(string prevURI, string newURI)

Parameters

NameTypeDescription
prevURIstringundefined
newURIstringundefined

OwnerUpdated

event OwnerUpdated(address indexed prevOwner, address indexed newOwner)

Parameters

NameTypeDescription
prevOwner indexedaddressundefined
newOwner indexedaddressundefined

RewardsClaimed

event RewardsClaimed(address indexed staker, uint256 rewardAmount)

Parameters

NameTypeDescription
staker indexedaddressundefined
rewardAmountuint256undefined

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