MellowApiVaultMetadata

Documentation for eth_defi.mellow.offchain_metadata.MellowApiVaultMetadata Python class.

class MellowApiVaultMetadata

Bases: object

Optional current Mellow API metadata attached to a vault.

The Mellow API is an enrichment source. Its USD TVL is intentionally kept separate from on-chain denomination-token TVL so current scan records remain comparable with ERC-4626 and other smart-contract vault protocols.

Attributes summary

chain_id

EVM chain id.

address

Canonical Mellow Vault address.

name

Public vault name.

symbol

Public vault symbol.

layer

Mellow API layer field, e.g.

tvl_usd

Current USD TVL from the public Mellow API, for diagnostics only.

base_token_address

Base token address from API/configuration, if known.

base_token_symbol

Base token symbol from API/configuration, if known.

raw

Raw API fields kept for diagnostics.

Methods summary

__init__([chain_id, address, name, symbol, ...])

chain_id: Optional[int]

EVM chain id.

address: Optional[eth_typing.evm.HexAddress]

Canonical Mellow Vault address.

name: Optional[str]

Public vault name.

symbol: Optional[str]

Public vault symbol.

layer: Optional[str]

Mellow API layer field, e.g. mellow or symbiotic.

tvl_usd: Optional[decimal.Decimal]

Current USD TVL from the public Mellow API, for diagnostics only.

Do not use this value as canonical production NAV. MellowVault reads comparable denomination-token TVL from on-chain share price and ShareManager.totalSupply().

base_token_address: Optional[eth_typing.evm.HexAddress]

Base token address from API/configuration, if known.

base_token_symbol: Optional[str]

Base token symbol from API/configuration, if known.

raw: dict[str, object]

Raw API fields kept for diagnostics.

__init__(chain_id=None, address=None, name=None, symbol=None, layer=None, tvl_usd=None, base_token_address=None, base_token_symbol=None, raw=<factory>)
Parameters
Return type

None