Skip to content
stake.link

pol staking contracts

PolygonStrategy: POL Liquid Staking Strategy

PolygonStrategy is a staking strategy that manages multiple PolygonVault contracts by tracking the balance of each and moving tokens in and out of them.

View Functions

Section titled “View Functions”

token

Section titled “token”

Returns the address of the staking token (POL).

function token() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
token address POL token address

stakingPool

Section titled “stakingPool”

Returns the address of the staking pool that controls this strategy.

function stakingPool() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
stakingPool address Staking pool address

stakeManager

Section titled “stakeManager”

Returns the address of the Polygon stake manager contract.

function stakeManager() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
stakeManager address Stake manager address

fundFlowController

Section titled “fundFlowController”

Returns the address of the fund flow controller contract.

function fundFlowController() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
fundFlowController address Fund flow controller address

validatorMEVRewardsPool

Section titled “validatorMEVRewardsPool”

Returns the address of the MEV rewards pool contract.

function validatorMEVRewardsPool() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
validatorMEVRewardsPool address MEV rewards pool address

validatorMEVRewardsPercentage

Section titled “validatorMEVRewardsPercentage”

Returns the percentage of MEV rewards validators will receive (basis points).

function validatorMEVRewardsPercentage() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
validatorMEVRewardsPercentage uint256 Validator MEV rewards %

vaultImplementation

Section titled “vaultImplementation”

Returns the address of the vault implementation contract.

function vaultImplementation() public view returns (address)

Return Values

Section titled “Return Values”
Name Type Description
vaultImplementation address Vault implementation address

validatorRemoval

Section titled “validatorRemoval”

Returns the current validator removal state.

function validatorRemoval() public view returns (bool isActive, uint64 validatorId, uint128 queuedWithdrawals)

Return Values

Section titled “Return Values”
Name Type Description
isActive bool If removal is active
validatorId uint64 Validator ID
queuedWithdrawals uint128 Queued withdrawals

totalQueued

Section titled “totalQueued”

Returns the total number of tokens queued for deposit into vaults.

function totalQueued() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
totalQueued uint256 Total queued tokens

numVaultsUnbonding

Section titled “numVaultsUnbonding”

Returns the total number of vaults currently unbonding.

function numVaultsUnbonding() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
numVaultsUnbonding uint256 Number of vaults unbonding

validatorWithdrawalIndex

Section titled “validatorWithdrawalIndex”

Returns the index of validator to withdraw from on next withdrawal.

function validatorWithdrawalIndex() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
validatorWithdrawalIndex uint256 Validator withdrawal index

canDeposit

Section titled “canDeposit”

Returns the available deposit room for this strategy.

function canDeposit() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
canDeposit uint256 Available deposit room

canWithdraw

Section titled “canWithdraw”

Returns the available withdrawal room for this strategy.

function canWithdraw() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
canWithdraw uint256 Available withdrawal room

getTotalDeposits

Section titled “getTotalDeposits”

Returns the total amount of deposits in this strategy.

function getTotalDeposits() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
totalDeposits uint256 Total deposits

getMaxDeposits

Section titled “getMaxDeposits”

Returns the maximum that can be deposited into this strategy.

function getMaxDeposits() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
maxDeposits uint256 Maximum deposits

getMinDeposits

Section titled “getMinDeposits”

Returns the minimum that must remain in this strategy.

function getMinDeposits() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
minDeposits uint256 Minimum deposits

getValidators

Section titled “getValidators”

Returns a list of all validators.

function getValidators() external view returns (Validator[] memory)

Return Values

Section titled “Return Values”
Name Type Description
validators Validator[] List of validators

getVaults

Section titled “getVaults”

Returns a list of all vaults controlled by this contract.

function getVaults() external view returns (IPolygonVault[] memory)

Return Values

Section titled “Return Values”
Name Type Description
vaults IPolygonVault[] List of vaults

getDepositChange

Section titled “getDepositChange”

Returns the deposit change since deposits were last updated.

function getDepositChange() public view returns (int)

Return Values

Section titled “Return Values”
Name Type Description
depositChange int Change in total deposits

getFees

Section titled “getFees”

Returns a list of all fees and fee receivers.

function getFees() external view returns (Fee[] memory)

Return Values

Section titled “Return Values”
Name Type Description
fees Fee[] List of fees

staked

Section titled “staked”

Returns whether an account should receive validator rewards (used by the validator MEV rewards pool).

function staked(address _account) public view returns (uint256)

Parameters

Section titled “Parameters”
Name Type Description
_account address Account address

Return Values

Section titled “Return Values”
Name Type Description
staked uint256 1 if eligible, 0 otherwise

totalStaked

Section titled “totalStaked”

Returns the total number of active validators (used by the validator MEV rewards pool).

function totalStaked() public view returns (uint256)

Return Values

Section titled “Return Values”
Name Type Description
totalStaked uint256 Number of validators

Write Functions

Section titled “Write Functions”

deposit

Section titled “deposit”

Deposits tokens from the staking pool into this strategy.

function deposit(uint256 _amount, bytes calldata) external

Parameters

Section titled “Parameters”
Name Type Description
_amount uint256 Amount to deposit

withdraw

Section titled “withdraw”

Withdraws tokens from this strategy and sends them to staking pool.

function withdraw(uint256 _amount, bytes calldata) external

Parameters

Section titled “Parameters”
Name Type Description
_amount uint256 Amount to withdraw

depositQueuedTokens

Section titled “depositQueuedTokens”

Deposits queued tokens into vaults.

function depositQueuedTokens(uint256[] calldata _vaultIds, uint256[] calldata _amounts) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_amounts uint256[] Amounts to deposit per vault

unbond

Section titled “unbond”

Unbonds token deposits in vaults.

function unbond(uint256 _toUnbond) external

Parameters

Section titled “Parameters”
Name Type Description
_toUnbond uint256 Amount to unbond

forceUnbond

Section titled “forceUnbond”

Unbonds token deposits in vaults (used to rebalance between vaults).

function forceUnbond(uint256[] calldata _vaultIds, uint256[] calldata _amounts) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs
_amounts uint256[] Amounts to unbond per vault

unstakeClaim

Section titled “unstakeClaim”

Claims and withdraws tokens from vaults that are unbonded.

function unstakeClaim(uint256[] calldata _vaultIds) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs

updateDeposits

Section titled “updateDeposits”

Updates deposit accounting and calculates fees on newly earned rewards.

function updateDeposits(bytes calldata) external returns (int256 depositChange, address[] memory receivers, uint256[] memory amounts)

Return Values

Section titled “Return Values”
Name Type Description
depositChange int256 Change in deposits since last update
receivers address[] List of fee receivers
amounts uint256[] List of fee amounts

restakeRewards

Section titled “restakeRewards”

Restakes rewards in the polygon staking contract for given vaults.

function restakeRewards(uint256[] calldata _vaultIds) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultIds uint256[] List of vault IDs

addValidator

Section titled “addValidator”

Adds a new validator.

function addValidator(address _pool, address _rewardsReceiver) external

Parameters

Section titled “Parameters”
Name Type Description
_pool address Validator shares pool address
_rewardsReceiver address Validator MEV rewards receiver

queueValidatorRemoval

Section titled “queueValidatorRemoval”

Queues a validator for removal.

function queueValidatorRemoval(uint256 _validatorId) external

Parameters

Section titled “Parameters”
Name Type Description
_validatorId uint256 Validator ID

finalizeValidatorRemoval

Section titled “finalizeValidatorRemoval”

Finalizes a queued validator removal.

function finalizeValidatorRemoval() external

upgradeVaults

Section titled “upgradeVaults”

Upgrades vaults to a new implementation contract.

function upgradeVaults(address[] calldata _vaults, bytes[] memory _data) external

Parameters

Section titled “Parameters”
Name Type Description
_vaults address[] List of vault addresses
_data bytes[] Encoded function calls per vault

addFee

Section titled “addFee”

Adds a new fee.

function addFee(address _receiver, uint256 _feeBasisPoints) external

Parameters

Section titled “Parameters”
Name Type Description
_receiver address Fee receiver address
_feeBasisPoints uint256 Fee in basis points

updateFee

Section titled “updateFee”

Updates an existing fee.

function updateFee(uint256 _index, address _receiver, uint256 _feeBasisPoints) external

Parameters

Section titled “Parameters”
Name Type Description
_index uint256 Fee index
_receiver address Fee receiver address
_feeBasisPoints uint256 Fee in basis points

setValidatorMEVRewardsPool

Section titled “setValidatorMEVRewardsPool”

Sets the validator MEV rewards pool.

function setValidatorMEVRewardsPool(address _validatorMEVRewardsPool) external

Parameters

Section titled “Parameters”
Name Type Description
_validatorMEVRewardsPool address MEV rewards pool address

setValidatorMEVRewardsPercentage

Section titled “setValidatorMEVRewardsPercentage”

Sets the percentage of MEV rewards that validators receive.

function setValidatorMEVRewardsPercentage(uint256 _validatorMEVRewardsPercentage) external

Parameters

Section titled “Parameters”
Name Type Description
_validatorMEVRewardsPercentage uint256 Validator MEV rewards %

setVaultImplementation

Section titled “setVaultImplementation”

Sets a new vault implementation contract to be used when deploying/upgrading vaults.

function setVaultImplementation(address _vaultImplementation) external

Parameters

Section titled “Parameters”
Name Type Description
_vaultImplementation address Vault implementation address

setFundFlowController

Section titled “setFundFlowController”

Sets the fund flow controller.

function setFundFlowController(address _fundFlowController) external

Parameters

Section titled “Parameters”
Name Type Description
_fundFlowController address Fund flow controller address