CheckCandidate

Documentation for eth_defi.vault_report.vault_checks.CheckCandidate Python class.

class CheckCandidate

Bases: object

A vault that would appear in one of the report’s top lists.

Written to the round’s candidates file for the agent, and used to render the excluded vaults Markdown record. Built from a top list row by build_check_candidates().

Attributes summary

vault_id	{chain_id}-{address}
name	Vault name
chain	Chain name
address	Vault address
protocol	Protocol name
protocol_slug	Protocol slug
curator	Curator name, if any
features	ERC-4626 feature names
tvl_usd	Current TVL in US dollars
one_month_return	Annualised one-month and three-month returns
three_months_return
three_months_volatility	Annualised three-month volatility
link	Vault page on the website
protocol_link	Protocol's own page for the vault
lists	Lists the vault would appear in, with its rank, e.g.
in_scope	Whether version 1 checks this vault.

Methods summary

__init__(vault_id, name, chain, address, ...)

vault_id: str

{chain_id}-{address}

name: str

Vault name

chain: str

Chain name

address: eth_typing.evm.HexAddress

Vault address

protocol: str

Protocol name

protocol_slug: str

Protocol slug

curator: Optional[str]

Curator name, if any

features: list[str]

ERC-4626 feature names

tvl_usd: float

Current TVL in US dollars

one_month_return: Optional[float]

Annualised one-month and three-month returns

three_months_volatility: Optional[float]

Annualised three-month volatility

link: Optional[str]

Vault page on the website

protocol_link: Optional[str]

Protocol’s own page for the vault

lists: list[str]

Lists the vault would appear in, with its rank, e.g. table:lending#3

property in_scope: bool

Whether version 1 checks this vault.

__init__(vault_id, name, chain, address, protocol, protocol_slug, curator, features, tvl_usd, one_month_return, three_months_return, three_months_volatility, link, protocol_link, lists=<factory>)

Parameters

• vault_id (str) –

• name (str) –

• chain (str) –

• address (eth_typing.evm.HexAddress) –

• protocol (str) –

• protocol_slug (str) –

• curator (Optional[str]) –

• features (list[str]) –

• tvl_usd (float) –

• one_month_return (Optional[float]) –

• three_months_return (Optional[float]) –

• three_months_volatility (Optional[float]) –

• link (Optional[str]) –

• protocol_link (Optional[str]) –

• lists (list[str]) –

Return type

None