RoycoOffchainVaultMetadata

Documentation for eth_defi.erc_4626.vault_protocol.royco.offchain_metadata.RoycoOffchainVaultMetadata Python class.

class RoycoOffchainVaultMetadata

Bases: TypedDict

Royco offchain vault metadata.

Attributes summary

source	API source that produced the row.
chain_id	EVM chain id.
vault_address	Vault contract address to scan.
underlying_vault_address	Underlying vault address for Royco Vault Market wrappers, when supplied.
name	Royco display name.
description	Royco description text.
is_active	Whether the market row is active.
is_verified	Whether Royco marks the row verified.
tvl_usd	Royco's USD TVL snapshot.
share_price	Royco's share price string for Royco Vault product rows.
last_updated	API row last-updated timestamp.
raw	Original API row.

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.

source: Literal['vault_explore', 'market_explore']

API source that produced the row.

chain_id: int

EVM chain id.

vault_address: eth_typing.evm.HexAddress

Vault contract address to scan.

underlying_vault_address: Optional[eth_typing.evm.HexAddress]

Underlying vault address for Royco Vault Market wrappers, when supplied.

name: str

Royco display name.

description: Optional[str]

Royco description text.

is_active: Optional[bool]

Whether the market row is active.

Royco Vault product rows do not expose this flag and use None.

is_verified: bool

Whether Royco marks the row verified.

tvl_usd: Optional[float]

Royco’s USD TVL snapshot.

share_price: Optional[str]

Royco’s share price string for Royco Vault product rows.

last_updated: Optional[str]

API row last-updated timestamp.

raw: dict[str, Any]

Original API row.

__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.