IEthFoxVault

Git Source

Inherits: IVaultAdmin, IVaultVersion, IVaultFee, IVaultState, IVaultValidators, IVaultEnterExit, IVaultMev, IVaultEthStaking, IVaultBlocklist, IMulticall

Author: StakeWise

Defines the interface for the EthFoxVault contract

Functions

initialize

Initializes or upgrades the EthFoxVault contract. Must transfer security deposit during the deployment.

function initialize(bytes calldata params) external payable;

Parameters

Name	Type	Description
params	bytes	The encoded parameters for initializing the EthFoxVault contract

ejectUser

Ejects user from the Vault. Can only be called by the blocklist manager. The ejected user will be added to the blocklist and all his shares will be sent to the exit queue.

function ejectUser(address user) external;

Parameters

Name	Type	Description
user	address	The address of the user to eject

Events

UserEjected

Event emitted when a user is ejected from the Vault

event UserEjected(address user, uint256 shares);

Parameters

Name	Type	Description
user	address	The address of the user
shares	uint256	The amount of shares ejected

EthFoxVaultCreated

Event emitted on EthFoxVault creation

event EthFoxVaultCreated(
    address admin, address ownMevEscrow, uint256 capacity, uint16 feePercent, string metadataIpfsHash
);

Parameters

Name	Type	Description
admin	address	The address of the Vault admin
ownMevEscrow	address	The address of the MEV escrow contract
capacity	uint256	The capacity of the Vault
feePercent	uint16	The fee percent of the Vault
metadataIpfsHash	string	The IPFS hash of the Vault metadata

Structs

EthFoxVaultInitParams

Struct for initializing the EthFoxVault contract

struct EthFoxVaultInitParams {
    address admin;
    address ownMevEscrow;
    uint256 capacity;
    uint16 feePercent;
    string metadataIpfsHash;
}

Properties

Name	Type	Description
admin	address	The address of the Vault admin
ownMevEscrow	address	The address of the MEV escrow contract
capacity	uint256	The Vault stops accepting deposits after exceeding the capacity
feePercent	uint16	The fee percent that is charged by the Vault
metadataIpfsHash	string	The IPFS hash of the Vault's metadata file