Vault

Documentation for eth_defi.enzyme.vault.Vault Python class.

Enzyme vault wrapper.

Vaults are Enzyme Protocol “funds” where you have investors and assets
Investors have ownership of vault assets with a share token
Each vault has its denomiation asset, e.g. USDC that you use for the buy in
You buy-in to a vault using buyShares
Redemption is “in-kind” and you swap your share tokens to the tokens of underlying open positions and other assets
A separate vault owner (fund owner) can make the vault to perform trades

Vault in Enzyme are presented by two smart contracts

Vault contract
Comptroller contract
Vaults are upgradeable
See Enzyme documentation for general information about vaults.
See Enzyme spec for technical information about vaults.

Example:

vault = Vault(vault_contract, comptroller_contract, deployment)
print(f"Vault name: {vault.get_name()}")
print(f"Denominated in: {vault.denomination_token}")
raw_gross_asset_value = vault.get_gross_asset_value()
print(f"Gross asset value: {vault.denomination_token.convert_to_decimals(raw_gross_asset_value):.2f} {vault.denomination_token.symbol}")

Attributes summary

`address`	The address of the vault contract.
`denomination_token`	Get the denominator token for withdrawal/deposit.
`generic_adapter`
`payment_forwarder`	Our custom EIP-3009 payment forwarder for the vault
`shares_token`	Get the shares token for withdrawal/deposit.
`web3`	Web3 connection.
`vault`	Vault smart contract
`comptroller`	Comptroller smart contract
`deployment`	Enzyme deployment reference

Methods summary

`__init__`(vault, comptroller, deployment[, ...])
`fetch`(web3, vault_address[, ...])	Fetch Enzyme vault and deployment information based only on the vault address.
`fetch_denomination_token_usd_exchange_rate`()	Get the exchange rate between token/USD.
`fetch_deployment_event`(reader[, start_block])	Get when the vault was deployed.
`get_decimals`()	Get the ERC-20 decimals of the shares.
`get_denomination_asset`()	Get the reserve ERC-20 asset for this vault.
`get_gross_asset_value`()	Calculate the gross asset value (GAV) of the fund.
`get_name`()	Get the name of the share token.
`get_owner`()	Who is the vault owner.
`get_share_count_for_user`(user)	How mayn shares a user has.
`get_share_gross_asset_value`()	Calculate the one share unit gross asset value (GAV) on the smart contract side.
`get_shares_asset`()	Get the shares ERC-20 token for this vault.
`get_symbol`()	Get the symbol of share tokens.
`get_total_supply`()	Get the number of share tokens.
`get_tracked_assets`()	Get the list of assets this vault tracks.

vault: web3.contract.contract.Contract

Vault smart contract

The VaultLib contract contains the storage layout, event signatures, and logic for VaultProxy instances that are attached to this release.

comptroller: web3.contract.contract.Contract

Comptroller smart contract

A ComptrollerProxy is deployed per-fund, and it is the canonical contract for interacting with a fund in this release. It stores core release-level configuration and is attached to a VaultProxy via the latter’s accessor role.

Emits important events like SharesBought, SharesRedeemed

deployment: eth_defi.enzyme.deployment.EnzymeDeployment: Enzyme deployment reference

generic_adapter: Optional[web3.contract.contract.Contract] = None

payment_forwarder: Optional[web3.contract.contract.Contract] = None

Our custom EIP-3009 payment forwarder for the vault

See :py:mod:`~eth_defi.usdc.transfer_with_authorization.

Allows single click buy ins if there is no USDC in the vallet.

property web3: web3.main.Web3

Web3 connection.

Used for reading JSON-RPC calls

property address: eth_typing.evm.HexAddress: The address of the vault contract.

property denomination_token: eth_defi.token.TokenDetails

Get the denominator token for withdrawal/deposit.

Read the token on-chain details.
Cache the results for the future calls

Returns: Usually ERC-20 details for USDC

property shares_token: eth_defi.token.TokenDetails

Get the shares token for withdrawal/deposit.

Read the token on-chain details.
Cache the results for the future calls

Returns: ERC-20 details for a token with the fund name/symbol and 18 decimals.

get_owner()[source]

Who is the vault owner.

Vault owner has special priviledges like calling the adapters.

See IVaultCore.sol.

Return type: eth_typing.evm.HexAddress

get_name()[source]

Get the name of the share token.

See SharesTokenBase.sol.

Return type: str

get_symbol()[source]

Get the symbol of share tokens.

See SharesTokenBase.sol.

Return type: str

get_total_supply()[source]

Get the number of share tokens.

See SharesTokenBase.sol.

Return type: int

get_decimals()[source]

Get the ERC-20 decimals of the shares.

See SharesTokenBase.sol.

Return type: int

get_denomination_asset()[source]

Get the reserve ERC-20 asset for this vault.

Return type: eth_typing.evm.HexAddress

get_shares_asset()[source]

Get the shares ERC-20 token for this vault.

Enzyme vault acts as ERC-20 contract as well.

Return type: eth_typing.evm.HexAddress

get_tracked_assets()[source]

Get the list of assets this vault tracks.

Returns: List of ERC-20 addresses
Return type: Collection[eth_typing.evm.HexAddress]

get_gross_asset_value()[source]

Calculate the gross asset value (GAV) of the fund.

Call the Solidity function that does this on the smart contract side.

See ComptrollerLib.sol.

Returns: TODO - no idea
Return type: int

get_share_gross_asset_value()[source]

Calculate the one share unit gross asset value (GAV) on the smart contract side.

Call the Solidity function that does this on the smart contract side.

See ComptrollerLib.sol.

Returns: TODO - no idea
Return type: int

get_share_count_for_user(user)[source]

How mayn shares a user has.

Returns: Raw token amount
Parameters: user (eth_typing.evm.HexAddress) –
Return type: int

fetch_deployment_event(reader, start_block=1)[source]

Get when the vault was deployed.

Warning

Because Ethereum nodes do not have indexes to get events per contract, this scan is going to take forever.

Parameters

start_block – The first block to scan
reader (eth_defi.event_reader.reader.Web3EventReader) – Event reader method used

Returns

Event log details

Raises

AssertionError – If blockchain does not have an event for the deplyoed vault

Return type

dict

fetch_denomination_token_usd_exchange_rate()[source]

Get the exchange rate between token/USD.

Read the exchange rate using the configured Enzyme’s VaultInterpreter and its Chainlink aggregators.

Returns: USD exchange rate
Return type: decimal.Decimal

static fetch(web3, vault_address, generic_adapter_address=None, payment_forwarder=None)[source]

Fetch Enzyme vault and deployment information based only on the vault address.

Parameters

web3 (web3.main.Web3) –
vault_address (Union[str, eth_typing.evm.HexAddress]) –
generic_adapter_address (Optional[Union[str, eth_typing.evm.HexAddress]]) –
payment_forwarder (Optional[Union[str, eth_typing.evm.HexAddress]]) –

Return type

eth_defi.enzyme.vault.Vault

__init__(vault, comptroller, deployment, generic_adapter=None, payment_forwarder=None)

Parameters

vault (web3.contract.contract.Contract) –
comptroller (web3.contract.contract.Contract) –
deployment (eth_defi.enzyme.deployment.EnzymeDeployment) –
generic_adapter (Optional[web3.contract.contract.Contract]) –
payment_forwarder (Optional[web3.contract.contract.Contract]) –

Return type

None