NestVaultMetadata

Documentation for eth_defi.erc_4626.vault_protocol.nest.offchain_metadata.NestVaultMetadata Python class.

class NestVaultMetadata

Bases: TypedDict

First-party data for a chain-specific Nest vault entrypoint.

Attributes summary

name	Nest product name, for example Nest BlackOpal LiquidStone II Vault.
display_name	Current product display name from Nest's CMS, if published.
slug	Stable Nest web-application product slug.
symbol	Share token symbol, for example nOPAL.
display_symbol	Marketing symbol from Nest's CMS; the onchain token symbol remains authoritative.
share_token_address	ERC-20 share token shared by the product's EVM routes.
vault_address	Chain-specific NestVault entrypoint address.
chain_id	EVM chain ID of vault_address.
asset_symbol	Deposit/redemption denomination symbol, for example USDC.
asset_address	Deposit/redemption denomination token address on chain_id.
start_block	Block where Nest reports the product as deployed on this chain.
category	Product category shown by Nest, if supplied by the CMS.
short_description	Short user-facing strategy summary from the Nest CMS.
description	Full user-facing strategy explanation from the Nest CMS.
yield_origin	CMS explanation of how the strategy earns its yield.
risk_summary	CMS summary of the strategy's risks.
underlying_risks	CMS detail about the underlying assets' risks.
redemption_time_days	Estimated redemption time in days, if supplied by the Nest CMS.
status	Product status, for example active.
yield_source_partners	Yield-source partner names displayed by Nest.
icon_url	Product icon URL supplied by Nest.
reported_apy	Catalogue SEC 30-day annualised yield as a fraction; its month-end window can differ from the application's rolling NAV yield.
target_apy	Product target APY reported by the contract catalogue, distinct from realised yield.
estimated_apy	CMS yield estimate, which may be unpublished or stale on some products.
tvl_usd	Reported product TVL in USD.
num_holders	Holder count reported by Nest's live API.
volume_24h_usd	USD-denominated 24-hour volume reported by Nest's live API.

Methods summary

__init__(*args, **kwargs)
clear()	Remove all items from the dict.
copy()	Return a shallow copy of the dict.
fromkeys([value])	Create a new dictionary with keys from iterable and values set to value.
get(key[, default])	Return the value for key if key is in the dictionary, else default.
items()	Return a set-like object providing a view on the dict's items.
keys()	Return a set-like object providing a view on the dict's keys.
pop(k[,d])	If the key is not found, return the default if given; otherwise, raise a KeyError.
popitem()	Remove and return a (key, value) pair as a 2-tuple.
setdefault(key[, default])	Insert key with a value of default if key is not in the dictionary.
update([E, ]**F)	If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]
values()	Return an object providing a view on the dict's values.

name: str

Nest product name, for example Nest BlackOpal LiquidStone II Vault.

display_name: Optional[str]

Current product display name from Nest’s CMS, if published.

slug: str

Stable Nest web-application product slug.

symbol: str

Share token symbol, for example nOPAL.

display_symbol: Optional[str]

Marketing symbol from Nest’s CMS; the onchain token symbol remains authoritative.

share_token_address: eth_typing.evm.HexAddress

ERC-20 share token shared by the product’s EVM routes.

vault_address: eth_typing.evm.HexAddress

Chain-specific NestVault entrypoint address.

chain_id: int

EVM chain ID of vault_address.

asset_symbol: str

Deposit/redemption denomination symbol, for example USDC.

asset_address: eth_typing.evm.HexAddress

Deposit/redemption denomination token address on chain_id.

start_block: Optional[int]

Block where Nest reports the product as deployed on this chain. A historical lower bound, not proof of an entrypoint’s bytecode at this block.

category: Optional[str]

Product category shown by Nest, if supplied by the CMS.

short_description: Optional[str]

Short user-facing strategy summary from the Nest CMS.

description: Optional[str]

Full user-facing strategy explanation from the Nest CMS.

yield_origin: Optional[str]

CMS explanation of how the strategy earns its yield.

risk_summary: Optional[str]

CMS summary of the strategy’s risks.

underlying_risks: Optional[str]

CMS detail about the underlying assets’ risks.

redemption_time_days: Optional[int]

Estimated redemption time in days, if supplied by the Nest CMS.

status: Optional[str]

Product status, for example active.

yield_source_partners: list[str]

Yield-source partner names displayed by Nest.

icon_url: Optional[str]

Product icon URL supplied by Nest.

reported_apy: Optional[float]

Catalogue SEC 30-day annualised yield as a fraction; its month-end window can differ from the application’s rolling NAV yield.

target_apy: Optional[float]

Product target APY reported by the contract catalogue, distinct from realised yield.

estimated_apy: Optional[float]

CMS yield estimate, which may be unpublished or stale on some products.

tvl_usd: Optional[float]

Reported product TVL in USD.

num_holders: Optional[int]

Holder count reported by Nest’s live API.

volume_24h_usd: Optional[float]

USD-denominated 24-hour volume reported by Nest’s live API.

__init__(*args, **kwargs)

__new__(**kwargs)

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.