Skip to main content

Booster

Functions​

listPools​

  function listPools(
) external returns (uint256[])

List of avialable pools

Return Values:​

NameTypeDescription
pidspids of pools

setFeeManager​

  function setFeeManager(
address _feeM
) external

Parameters:​

NameTypeDescription
_feeMaddressnew fee manager

setFees​

  function setFees(
uint256 _ecdLockedIncentive,
uint256 _callerFees,
uint256 _platform
) external

Total fees are capped to 20%.

Parameters:​

NameTypeDescription
_ecdLockedIncentiveuint256Amount of incentives to distribute to veECD holders
_callerFeesuint256Amount of incentives to disitribute to function caller.
_platformuint256Amount of incentives to disitribute to the platform.

setVeEcdRewardPool​

  function setVeEcdRewardPool(
address _veEcdRewardPool
) external

Parameters:​

NameTypeDescription
_veEcdRewardPooladdressThe VeEcdRewardPool contract address

setEcdPtpRewardPool​

  function setEcdPtpRewardPool(
address _ecdPtpRewardPool
) external

Parameters:​

NameTypeDescription
_ecdPtpRewardPooladdressEcdPtpRewardPool contract address

setTreasury​

  function setTreasury(
address _treasury
) external

Parameters:​

NameTypeDescription
_treasuryaddressaddress of treasury

setRewardFactory​

  function setRewardFactory(
address _rewardFactory
) external

Parameters:​

NameTypeDescription
_rewardFactoryaddressRewardFactory contract address

deposit​

  function deposit(
uint256 _pid,
uint256 _amount
) external

Deposits _amount tokens into a pool _pid.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id
_amountuint256Amount of LP to deposit

depositFor​

  function depositFor(
uint256 _pid,
uint256 _amount,
address account
) external

Deposit _amount of tokens into a pool _pid, issuing shares to account.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id
_amountuint256Amount of LP to deposit
accountaddressBeneficiary

withdraw​

  function withdraw(
uint256 _pid,
uint256 _amount,
bool _claim
) external

Withdraw LPs from platypus to the user.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id
_amountuint256Amount of LP to deposit
_claimboolclaim benefits with the call

withdrawAll​

  function withdrawAll(
uint256 _pid,
bool _claim
) external

Withdraw all LPs from platypus to the user.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id
_claimboolclaim benefits with the call

claimRewards​

  function claimRewards(
uint256[] _pids
) external

claimRewards on multiple pools at once. This function claim rewards for the system. Rewards are then sent to multiple reward pools. This call is incentives, it will distribute some of the rewards to the caller.

Parameters:​

NameTypeDescription
_pidsuint256[]pool ids

setAllowance​

  function setAllowance(
address token
) external

Increase allowance of booster on PlatypusProxy

Parameters:​

NameTypeDescription
tokenaddressToken to increase allowance

addNewPool​

  function addNewPool(
uint256 _pid
) external

Add a new pool into the system. It will create a new RewardPool associated with the pid of the MasterPlatypus pool.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id.

shutdownPool​

  function shutdownPool(
uint256 _pid,
bool distributeRewards
) external returns (bool)

Shutdown a pool, funds are transfered from platypus to Booster for user to withdraw.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id.
distributeRewardsboolDistribute earned rewards.

setExtraRewardPool​

  function setExtraRewardPool(
uint256 _pid,
uint256 amount
) external

Add extra reward to a pool that already exists.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id.
amountuint256Send an amount of extra rewards to the extra reward pool.

removeExtraRewardPool​

  function removeExtraRewardPool(
uint256 _pid
) external

Remove extra reward pool when removed from platypus.

Parameters:​

NameTypeDescription
_piduint256Platypus pool id.

clearExtraRewards​

  function clearExtraRewards(
address rewardPool
) external

Clear extra rewardPool on a RewardPool

Parameters:​

NameTypeDescription
rewardPooladdressthe reward pool address.

createTokenRewards​

  function createTokenRewards(
address _tokenRewards,
address _mainRewards
) external returns (address)

Add extra rewards to a pool, it doesn't have to be platypus rewards.

Parameters:​

NameTypeDescription
_tokenRewardsaddresstoken to be distributed.
_mainRewardsaddressthe rewardPool that recive aditional rewards

Events​