FactorLeverageVault.sol
Last updated
Was this helpful?
Last updated
Was this helpful?
FEE_SCALE
uint256
public; constant
The scale denominator for the fees. Default is 1e18.
leverageFee
uint256
public
The fee that is charged on the leverage portion whenever a position's leverage is changed.
claimRewardFee
uint256
public
The fee that is charged on the harvested rewards whenever the accrued position rewards are claimed.
feeRecipient
address
public
The address of the fee recipient.
strategyImplementation
address
public
The address of the strategy contract that is implemented for this leverage vault.
factorLeverageDescriptor
address
public
The address of the leverage vault descriptor which facilitates sharing of encoded leverage vault token data (i.e. URI).
currentPositionId
uint256
public
An integer which is used to track the positions created via this Leverage Vault. Incremented by 1 with every new position created (i.e. always 1 more than the last created positionId).
positions
mapping(uint256 => address)
public
Maps the position to their implemented strategy contract address.
assets
mapping(address => address)
public
Maps the asset to the corresponding lending pool contract address.
debts
mapping(address => address)
public
Maps the debt to the corresponding lending pool contract address.
isUpgrade
mapping(address => mapping(address => bool))
internal
A nested mapping of strategy contracts which have been registered as eligible by the Vault Manager owner. Enables registered proposed strategies to be implemented.
Emitted when a new position is created on the Leverage Vault.
id
uint256
The identifier of the new position that was created.
vault
address
The address of the strategy implementation that was deployed with the newly created position.
Emitted when the lending pool tied to the Leverage Vault asset is changed by the owner of the vault.
token
address
The address of the Leverage Vault asset.
pool
address
The address of the newly configured lending pool tied to the Leverage Vault's asset.
Emitted when the lending pool tied to the Leverage Vault debt is changed by the owner of the vault.
token
address
The address of the Leverage Vault debt.
pool
address
The address of the newly configured lending pool tied to the Leverage Vault's debt.
Emitted when a proposed strategy implementation address is registered by the Leverage Vault owner.
baseImpl
address
The address of the existing strategy contract that is implemented by the vault.
upgradeImpl
address
The address of the proposed strategy contract to be implemented.
Emitted when a proposed strategy implementation is removed (i.e. deregistered) from isUpgrade by the Leverage Vault owner.
baseImpl
address
The address of the existing strategy contract that is implemented by the vault.
upgradeImpl
address
The address of the proposed strategy contract to be implemented.
Emitted when the leverage descriptor contract address is changed by the Leverage Vault owner.
descriptor
address
The address of the msg.sender (i.e. depositor) that deposited into the vault.
public initializer The contract initialization function which initializes the contract with the vault params and initial fee scale. Defaults the fee recipient to the msg.sender (i.e. leverage vault creator).
_strategyImplementation
address
The address of the strategy contract to be implemented for this leverage vault.
_factorLeverageDescriptor
address
The address of the leverage vault descriptor that will describe the leverage vault token.
_name
string
The name of the leverage vault collection. Used as the NFT collection name.
_symbol
string
The symbol of the leverage vault collection. Used as the NFT collection symbol.
external returnsCreates a new position representing the configurations of a depositor's position in the leverage vault (only consists of the position structure and not actual liquidity).
To create the position, a new instance of the strategyImplementation contract is initalized with every newly created position ID for this vault.
The newly created position NFT is sent to the msg.sender.
asset
address
The address of the token used to collateralize the position.
debt
address
The address of the debt token to be borrowed for leverage purposes.
uint256
The new currentPositionId after a position is created (i.e. newly created position ID plus 1).
address
The address of the newly deployed strategy contract which was implemented for the position.
Emits the currentPositionId and the implemented strategy address.
Allows the owner of the leverage vault contract to change the address of the lending pool tied to the vault's asset.
asset
address
The address of the token used to collateralize the position.
pool
address
The address of the asset lending pool to be changed to.
Emits the address of the newly configured lending pool tied to the Leverage Vault's asset.
Allows the owner of the leverage vault contract to change the address of the lending pool tied to the vault's debt.
debt
address
The address of the debt token to be borrowed for leverage purposes.
pool
address
The address of the debt lending pool to be changed to.
Emits the address of the newly configured lending pool tied to the Leverage Vault's debt.
externalAllows the owner of the position to burn (i.e. removes) their zero balance positions.
positionId
The ID of the position to be burned.
public view override returnsReturns the encoded Uniform Resource Identifier (URI) of the position id that is being queried.
id
uint256
The positionId of the position whose URI data is being queried.
string
The encoded URI for the token representing the position in the leverage vault.
Allows the owner of the leverage vault to change the address of the factorLeverageDescriptor.
Emits the address of the new leverage vault descriptor.
external view returnsChecks whether the upgrade from baseImplementation to upgradeImplementation has been registered by the Leverage Vault owner.
baseImplementation
address
The address of the previous strategy contract.
upgradeImplementation
address
The address of the proposed updated strategy contract.
bool
true = Proposed strategy has been registered by owner.
false = Proposed strategy has not been registered by owner.
Allows the Leverage Vault owner to register a strategy upgrade from baseImplementation to upgradeImplementation. Proposed strategies must be registered before it can be implemented.
baseImplementation
address
The address of the previous strategy contract.
upgradeImplementation
address
The address of the proposed updated strategy contract.
Emits the registered strategy upgrade proposal.
Allows the Leverage Vault owner to remove a previously registered strategy upgrade proposal from isUpgrade.
baseImplementation
address
The address of the previous strategy contract.
upgradeImplementation
address
The address of the proposed updated strategy contract.
Emits the strategy upgrade proposal that was removed.
Allows the Leverage Vault owner to update the strategyImplementation with a newly provided address.
_strategyImplementation
address
The address of the new strategy implementation contract.
Allows the Leverage Vault owner to update the feeRecipient with a newly provided address.
recipient
address
The address that receives the leverage fees.
Allows the Leverage Vault owner to update the leverageFee that is charged on the leverage portion whenever a position's leverage is changed.
The newFee provided is scaled by the Leverage Vault contract's FEE_SCALE which is defaulted to 1e18 on vault initialization. That is, a newFee of 1e16 is equivalent to 1% fee (i.e. 1e16/1e18).
newFee
uint256
The amount of leverage fee to charge.
Allows the Leverage Vault owner to update the claimRewardFee that is charged on the harvested rewards whenever the accrued position rewards are claimed.
The newFee provided is scaled by the Leverage Vault contract's FEE_SCALE which is defaulted to 1e18 on vault initialization. That is, a newFee of 1e16 is equivalent to 1% fee (i.e. 1e16/1e18).
newFee
uint256
The amount of claim reward fee to charge.
external pure returnsReturns the Leverage Vault version which is hardcoded based on contract deployment.
string
The Leverage Vault version.
internal virtual overrideaccount
address
The address of the position holder.
amount
uint128
The amount of Leverage Vault token count to be added to the existing account balances.
internal virtual override returnsto
address
The address to transfer ownership of tokenId to. Mints (or burns) the position NFT if the current owner (or to) is the zero address.
tokenId
uint128
The identifier for the Leverage Vault NFT to be updated.
auth
address
An optional params where passing in a non-zero value checks if the provided address has the rights to transfer the token (i.e. owner or approved).
address
The address of the LP Vault NFT (representing the position) before the update.
public view override returnsinterfaceId
bytes4
The encoded bytes data representing the interface being queried.
bool
true = interfaceId is supported by the Leverage Vault contract
false = interfaceId is not supported by the Leverage Vault contract
Factor Vault contracts implements OpenZeppelin's upgradeable contracts design and locks the Vault contract upon initialization to avoid contract takeover by an attacker. More info can be found on .
An internal function that overrides the ERC721 function meant to increase the number of NFT collection tokens held by the account.
An internal function that overrides the ERC721 function meant to update the owner of the tokenId.
An internal function that overrides the ERC721 function that returns true if this Leverage Vault contract implements the interface defined by interfaceId.