YearnDetectedVaultMetadataMixin

Documentation for eth_defi.erc_4626.vault_protocol.yearn.vault.YearnDetectedVaultMetadataMixin Python class.

class YearnDetectedVaultMetadataMixin

Bases: object

Expose positive Yearn website metadata for supported Yearn adapters.

The public detected-vault endpoint is not an exhaustive adapter registry. It may confirm a page and provide its description, but its absence must never mark a vault as unofficial.

Attributes summary

`description`	Return the Yearn website description when it is safely exportable.
`short_description`	Return the first bounded sentence of the Yearn website description.
`yearn_detected_metadata`	Get positive public Yearn metadata for this vault when it is listed.
`yearn_detected_vaults`	Fetch the public Yearn catalogue while preserving outage state.

Methods summary

`__init__`()
`get_link`([referral])	Return a Yearn link unless attribution is explicitly excluded.

property yearn_detected_vaults: Optional[eth_defi.erc_4626.vault_protocol.yearn.offchain_metadata.YearnDetectedVaultCatalogue]

Fetch the public Yearn catalogue while preserving outage state.

Returns: Fetched catalogue, or None when temporarily unavailable.

property yearn_detected_metadata: Optional[eth_defi.erc_4626.vault_protocol.yearn.offchain_metadata.YearnDetectedVaultMetadata]

Get positive public Yearn metadata for this vault when it is listed.

Returns: Public-page metadata, or None when the vault is absent or the catalogue is temporarily unavailable.

property description: Optional[str]

Return the Yearn website description when it is safely exportable.

Returns: Yearn-authored description, or None when unavailable or unusable.

property short_description: Optional[str]

Return the first bounded sentence of the Yearn website description.

Returns: Compact Yearn-authored description, or None when unavailable.

get_link(referral=None)

Return a Yearn link unless attribution is explicitly excluded.

Parameters: referral (Optional[str]) – Ignored legacy referral parameter retained for compatibility.
Returns: Canonical Yearn vault-page or generic explorer URL.
Return type: str