vault.fee

Documentation for eth_defi.vault.fee Python module.

Vault fee modes.

Functions

get_vault_fee_mode(vault_protocol_name, address)

Get vault fee mode by protocol name.

Classes

FeeData	Track vault fee parameters
VaultFeeMode	How vault protocol account its fees.

class FeeData

Bases: object

Track vault fee parameters

• Offer methods to calculate gross/net fees based on the vault fee mode

• None means fee unknown: protocol not recognized, or fee data not available

How fees are presented:

• Gross fees are what vaults track internally. They are not exposed to an investor, and only useful for internal profit calculations of the vault. Gross fees have already been deducted when the vault share price is updated.

• Net fees are deduced at a redemption. A vault investor receives less than the value of their shares back.

• For comparing the profitability of vaults, you need to reduce the net fees of an investment period from the vault share price.

• Common vault fee mechanisms implementations are: externalised (net fees, deducted from an investor at a redemption),

  skimming (redirected from profits at the time of trade) and minting (new shares minted to the vault owner at the time of trade).

__init__(fee_mode, management, performance, deposit, withdraw)

Parameters

• fee_mode (Optional[eth_defi.vault.fee.VaultFeeMode]) –

• management (Optional[float]) –

• performance (Optional[float]) –

• deposit (Optional[float]) –

• withdraw (Optional[float]) –

Return type

None

get_net_fees()

Get net fees paid by the user on deposit/withdraw.

• Determined by the vault fee mode

Return type

eth_defi.vault.fee.FeeData

class VaultFeeMode

Bases: enum.Enum

How vault protocol account its fees.

• Externalised fees: fees are deducted from the redemption amount when user withdraws.

• Internalised fees: fees are baked into the share price (asset amount) and continuously taken from the profit. There are no fees on withdraw.

is_internalised()

Are the fees internalised in the share price?

Return type

bool

get_vault_fee_mode(vault_protocol_name, address)

Get vault fee mode by protocol name.

Returns

None if unknown

Parameters

• vault_protocol_name (str) –

• address (Union[eth_typing.evm.HexAddress, str]) –

Return type

Optional[eth_defi.vault.fee.VaultFeeMode]