Skip to main content

ITribalChief

Functions

rewardMultipliers

function rewardMultipliers(
uint256 _pid,
uint128 _blocksLocked
) external returns (uint128)

view only functions that return data on pools, user deposit(s), tribe distributed per block, and other constants

Parameters

NameTypeDescription
_piduint256
_blocksLockeduint128

stakedToken

function stakedToken(
uint256 _index
) external returns (contract IERC20)

Parameters

NameTypeDescription
_indexuint256

poolInfo

function poolInfo(
uint256 _index
) external returns (uint256, uint256, uint128, uint120, bool)

Parameters

NameTypeDescription
_indexuint256

tribePerBlock

function tribePerBlock() external returns (uint256)

pendingRewards

function pendingRewards(
uint256 _pid,
address _user
) external returns (uint256)

Parameters

NameTypeDescription
_piduint256
_useraddress

getTotalStakedInPool

function getTotalStakedInPool(
uint256 pid,
address user
) external returns (uint256)

Parameters

NameTypeDescription
piduint256
useraddress

openUserDeposits

function openUserDeposits(
uint256 pid,
address user
) external returns (uint256)

Parameters

NameTypeDescription
piduint256
useraddress

numPools

function numPools() external returns (uint256)

totalAllocPoint

function totalAllocPoint() external returns (uint256)

SCALE_FACTOR

function SCALE_FACTOR() external returns (uint256)

deposit

function deposit(
uint256 _pid,
uint256 _amount,
uint64 _lockLength
) external

functions for users to deposit, withdraw and get rewards from our contracts

Parameters

NameTypeDescription
_piduint256
_amountuint256
_lockLengthuint64

harvest

function harvest(
uint256 pid,
address to
) external

Parameters

NameTypeDescription
piduint256
toaddress

withdrawAllAndHarvest

function withdrawAllAndHarvest(
uint256 pid,
address to
) external

Parameters

NameTypeDescription
piduint256
toaddress

withdrawFromDeposit

function withdrawFromDeposit(
uint256 pid,
uint256 amount,
address to,
uint256 index
) external

Parameters

NameTypeDescription
piduint256
amountuint256
toaddress
indexuint256

emergencyWithdraw

function emergencyWithdraw(
uint256 pid,
address to
) external

Parameters

NameTypeDescription
piduint256
toaddress

updatePool

function updatePool(
uint256 pid
) external

functions to update pools that can be called by anyone

Parameters

NameTypeDescription
piduint256

massUpdatePools

function massUpdatePools(
uint256[] pids
) external

Parameters

NameTypeDescription
pidsuint256[]

resetRewards

function resetRewards(
uint256 _pid
) external

functions to change and add pools and multipliers that can only be called by governor, guardian, or TribalChiefAdmin

Parameters

NameTypeDescription
_piduint256

set

function set(
uint256 _pid,
uint120 _allocPoint,
contract IRewarder _rewarder,
bool overwrite
) external

Parameters

NameTypeDescription
_piduint256
_allocPointuint120
_rewardercontract IRewarder
overwritebool

add

function add(
uint120 allocPoint,
contract IERC20 _stakedToken,
contract IRewarder _rewarder,
struct ITribalChief.RewardData[] rewardData
) external

Parameters

NameTypeDescription
allocPointuint120
_stakedTokencontract IERC20
_rewardercontract IRewarder
rewardDatastruct ITribalChief.RewardData[]

governorWithdrawTribe

function governorWithdrawTribe(
uint256 amount
) external

Parameters

NameTypeDescription
amountuint256

governorAddPoolMultiplier

function governorAddPoolMultiplier(
uint256 _pid,
uint64 lockLength,
uint64 newRewardsMultiplier
) external

Parameters

NameTypeDescription
_piduint256
lockLengthuint64
newRewardsMultiplieruint64

unlockPool

function unlockPool(
uint256 _pid
) external

Parameters

NameTypeDescription
_piduint256

lockPool

function lockPool(
uint256 _pid
) external

Parameters

NameTypeDescription
_piduint256

updateBlockReward

function updateBlockReward(
uint256 newBlockReward
) external

Parameters

NameTypeDescription
newBlockRewarduint256