get_notes

Documentation for eth_defi.vault.flag.get_notes function.

get_notes(address, chain_id=None, protocol_name=None, *, include_defaults=True)

Get vault-specific notes.

Notes can come from the descriptive vault or protocol notes matrices, special vault flags or chain-wide defaults. Descriptive notes do not make a vault flagged.

Parameters

  • address (Union[eth_typing.evm.HexAddress, str]) – Vault address (will be lowercased).

  • chain_id (Optional[int]) – Chain ID of the vault. Used to apply chain-wide default notes (e.g. all Hypercore vaults get HYPERCORE_VAULT_NOTE).

  • protocol_name (Optional[str]) – Optional protocol label for manual protocol warnings and default notes.

  • include_defaults (bool) – Include generic protocol and chain notes. Set to False when checking for a current manual override before using a cached adapter strategy note.

Returns

The maintained note, or None when no applicable note is present.

Return type

Optional[str]