SymbioticOffchainVault

Documentation for eth_defi.erc_4626.vault_protocol.symbiotic.offchain_metadata.SymbioticOffchainVault Python class.

class SymbioticOffchainVault

Bases: TypedDict

A vault record from Symbiotic’s public application data API.

Attributes summary

address	ERC-4626 vault address.
name	User-facing vault name, if the curator has submitted it.
chain_name	Human-readable chain name for the application API deployment.
curator_name	Curator display name, or its identifier if no display name is available.
tvl	Current USD total value locked as calculated by Symbiotic's API.
vault_type	Symbiotic vault implementation category, such as v2.

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.

address: eth_typing.evm.HexAddress

ERC-4626 vault address.

name: Optional[str]

User-facing vault name, if the curator has submitted it.

chain_name: str

Human-readable chain name for the application API deployment.

curator_name: Optional[str]

Curator display name, or its identifier if no display name is available.

tvl: Optional[decimal.Decimal]

Current USD total value locked as calculated by Symbiotic’s API.

vault_type: str

Symbiotic vault implementation category, such as v2.

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