Skip to content
Venus Protocol

VenusERC4626Factory

VenusERC4626Factory

Section titled “VenusERC4626Factory”

Overview

Section titled “Overview”

VenusERC4626Factory is a factory contract for deploying upgradeable VenusERC4626 vaults as BeaconProxy instances. It manages the deployment, registry, and configuration of vaults, and controls access to sensitive operations via the AccessControlManager (ACM).

Solidity API

Section titled “Solidity API”

State Variables

Section titled “State Variables”

  • SALT (bytes32, public constant):
    A constant salt value used for deterministic contract deployment.

  • beacon (UpgradeableBeacon, public):
    The beacon contract for VenusERC4626 proxies.

  • poolRegistry (PoolRegistryInterface, public):
    The Pool Registry contract.

  • rewardRecipient (address, public):
    The address that receives the liquidity mining rewards.

  • createdVaults (mapping(address vToken => ERC4626Upgradeable vault), public):
    Mapping of vaults created by this factory.

Events

Section titled “Events”

  • CreateERC4626(VTokenInterface indexed vToken, ERC4626Upgradeable indexed vault)
    Emitted when a new ERC4626 vault is created.

    • vToken: The vToken used by the vault.
    • vault: The vault that was created.

  • RewardRecipientUpdated(address indexed oldRecipient, address indexed newRecipient)
    Emitted when the reward recipient address is updated.

    • oldRecipient: The previous reward recipient address.
    • newRecipient: The new reward recipient address.

Errors

Section titled “Errors”

  • VenusERC4626Factory__InvalidVToken()
    Thrown when the provided vToken is not registered in the PoolRegistry.

  • VenusERC4626Factory__ERC4626AlreadyExists()
    Thrown when a VenusERC4626 vault already exists for the specified vToken.

Constructor
Section titled “Constructor”

@custom:oz-upgrades-unsafe-allow constructor
Disables initializers for the upgradeable contract pattern.

Functions

Section titled “Functions”

initialize

Section titled “initialize”

Initializes the VenusERC4626Factory contract with the required configuration parameters.

function initialize(
    address accessControlManager,
    address poolRegistryAddress,
    address rewardRecipientAddress,
    address venusERC4626Implementation,
    uint256 loopsLimitNumber
) external initializer
Parameters
Section titled “Parameters”
NameTypeDescription
accessControlManageraddressAddress of the Access Control Manager (ACM) contract.
poolRegistryAddressaddressAddress of the Pool Registry contract.
rewardRecipientAddressaddressAddress that receives liquidity mining rewards.
venusERC4626ImplementationaddressAddress of the VenusERC4626 implementation contract.
loopsLimitNumberuint256The maximum number of loops for the MaxLoopsLimit helper.
Notes
Section titled “Notes”
  • Can only be called once.
  • Disables initializers for the upgradeable contract pattern.

setRewardRecipient

Section titled “setRewardRecipient”

Sets the reward recipient address.

function setRewardRecipient(address newRecipient) external
Parameters
Section titled “Parameters”
NameTypeDescription
newRecipientaddressThe address of the new reward recipient.
Notes
Section titled “Notes”
  • Controlled by the ACM.
  • Reverts with ZeroAddressNotAllowed if the new recipient address is zero.
  • Emits the RewardRecipientUpdated event on update.

setMaxLoopsLimit

Section titled “setMaxLoopsLimit”

Sets the maximum loops limit for internal operations.

function setMaxLoopsLimit(uint256 loopsLimit) external
Parameters
Section titled “Parameters”
NameTypeDescription
loopsLimituint256The new maximum number of loops allowed.
Notes
Section titled “Notes”
  • Controlled by the ACM.
  • Emits the MaxLoopsLimitUpdated event on success.

createERC4626

Section titled “createERC4626”

Creates a new ERC4626 vault for the specified vToken.

function createERC4626(address vToken) external returns (ERC4626Upgradeable vault)
Parameters
Section titled “Parameters”
NameTypeDescription
vTokenaddressThe vToken for which the vault is created.
Returns
Section titled “Returns”
NameTypeDescription
vaultERC4626UpgradeableThe deployed VenusERC4626 vault.
Notes
Section titled “Notes”
  • Reverts with ZeroAddressNotAllowed if the vToken address is zero.
  • Reverts with VenusERC4626Factory__InvalidVToken if the vToken is not valid.
  • Reverts with VenusERC4626Factory__ERC4626AlreadyExists if the vault already exists.
  • Emits the CreateERC4626 event on successful creation.

computeVaultAddress

Section titled “computeVaultAddress”

Computes the deterministic address of the vault for a specified vToken.

function computeVaultAddress(address vToken) public view returns (address)
Parameters
Section titled “Parameters”
NameTypeDescription
vTokenaddressThe vToken for which to compute the address.
Returns
Section titled “Returns”
NameTypeDescription
addressaddressThe computed vault address.