erc_4626.classification

Documentation for eth_defi.erc_4626.classification Python module.

ERC-4626 vault type classification.

  • Used in vault discovery to figure out what kind of vaults we have autodetected

  • Use multicall based apporach to probe contracts

Functions

create_probe_calls(addresses[, ...])

Create calls that call each vault address using multicall.

create_vault_instance(web3, address[, ...])

Create a new vault instance class based on the detected features.

create_vault_instance_autodetect(web3, ...)

Create any vault instance.

detect_vault_features(web3, address[, verbose])

Detect the ERC-4626 features of a vault smart contract.

identify_vault_features(address, calls, ...)

Based on multicall results, create the feature flags for the vault..

probe_vaults(chain_id, web3factory, ...[, ...])

Perform multicalls against each vault address to extract the features of the vault smart contract.

Classes

VaultFeatureProbe

Results of a multicall probing to a vault address.
class VaultFeatureProbe

Bases: object

Results of a multicall probing to a vault address.

Method generated by attrs for class VaultFeatureProbe.

__init__(address, features)

Method generated by attrs for class VaultFeatureProbe.

Parameters
Return type

None

create_probe_calls(addresses, share_probe_amount=1000000, chain_id=None)

Create calls that call each vault address using multicall.

  • Because ERC standards are such a shit show, and nobody is using good interface standard, we figure out the vault type by probing it with various calls

  • Skips protocol-specific probes for protocols only deployed on certain chains (see CHAIN_RESTRICTED_PROBES for the list)

Parameters

  • addresses (collections.abc.Iterable[eth_typing.evm.HexAddress]) – Iterable of vault contract addresses to probe.

  • share_probe_amount – Amount used for convertToShares() probe call.

  • chain_id (Optional[int]) – If provided, filters out probe calls for protocols that are not deployed on this chain. This reduces unnecessary RPC calls when scanning chains where certain protocols don’t exist. Protocols deployed on 3 or fewer chains have their probes skipped on other chains. If None, all probes are generated (no filtering).

Return type

collections.abc.Iterable[eth_defi.event_reader.multicall_batcher.EncodedCall]

create_vault_instance(web3, address, features=None, token_cache=None, auto_detect=False, default_block_identifier=None, require_denomination_token=False)

Create a new vault instance class based on the detected features.

  • Get a protocol-specific Python instance that can e.g. read the fees of the vault (not standardised).

See also - detect_vault_features() to determine features for a vault address

Parameters

  • features (Optional[set[eth_defi.erc_4626.core.ERC4626Feature]]) –

    Previously/manually extracted vault feature flags for the type.

    Give empty set for generic ERC-4626 vault class.

  • auto_detect (bool) –

    Auto-detect the vault protocol.

    Very slow, do not use except in tutorials and scripts. Prefer to manually pass feature.

  • default_block_identifier (Optional[Union[Literal['latest', 'earliest', 'pending', 'safe', 'finalized'], eth_typing.evm.BlockNumber, eth_typing.evm.Hash32, eth_typing.encoding.HexStr, hexbytes.main.HexBytes, int]]) –

    Override block identifier for on-chain metadata reads.

    Set to "latest" for freshly deployed vaults whose contracts do not exist at the safe-cached block number.

  • require_denomination_token (bool) – If True, accessing denomination_token will raise RuntimeError when the on-chain lookup returns None.

  • web3 (web3.main.Web3) –

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

  • token_cache (Optional[dict]) –

Returns

None if the vault creation is not supported

Return type

Optional[eth_defi.vault.base.VaultBase]

create_vault_instance_autodetect(web3, vault_address, token_cache=None)

Create any vault instance.

  • Probes smart contract call first to identify what kind of vault we are dealing with

Parameters
Return type

eth_defi.vault.base.VaultBase

detect_vault_features(web3, address, verbose=True)

Detect the ERC-4626 features of a vault smart contract.

  • Protocols: Harvest, Lagoon, etc.

  • Does support ERC-7540

  • Very slow, only use in scripts and tutorials.

  • Use to pass to create_vault_instance() to get a correct Python proxy class for the vault institated.

Example:

features = detect_vault_features(web3, spec.vault_address, verbose=False)
logger.info("Detected vault features: %s", features)

vault = create_vault_instance(
    web3,
    spec.vault_address,
    features=features,
)
Parameters
Return type

set[eth_defi.erc_4626.core.ERC4626Feature]

identify_vault_features(address, calls, debug_text)

Based on multicall results, create the feature flags for the vault..

Parameters
Return type

set[eth_defi.erc_4626.core.ERC4626Feature]

probe_vaults(chain_id, web3factory, addresses, block_identifier, max_workers=8, progress_bar_desc=None)

Perform multicalls against each vault address to extract the features of the vault smart contract.

Returns

Iterator of what vault smart contract features we detected for each potential vault address

Parameters
Return type

collections.abc.Iterable[eth_defi.erc_4626.classification.VaultFeatureProbe]