SymbioticVaultMetadata

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

class SymbioticVaultMetadata

Bases: TypedDict

Normalised official metadata for an individual Symbiotic vault.

Attributes summary

name	Vault display name.
description	Curator-provided strategy description.
tags	Tags selected by the curator.
links	Vault-specific user-facing links.
curator_id	Curator identifier from the official metadata repository.
curator_name	Curator display name, when its metadata record exists.
curator_description	Curator description, when its metadata record exists.
curator_links	Curator user-facing links, when its metadata record exists.

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

Vault display name.

description: Optional[str]

Curator-provided strategy description.

tags: list[str]

Tags selected by the curator.

links: list[eth_defi.erc_4626.vault_protocol.symbiotic.offchain_metadata.SymbioticMetadataLink]

Vault-specific user-facing links.

curator_id: Optional[str]

Curator identifier from the official metadata repository.

curator_name: Optional[str]

Curator display name, when its metadata record exists.

curator_description: Optional[str]

Curator description, when its metadata record exists.

curator_links: list[eth_defi.erc_4626.vault_protocol.symbiotic.offchain_metadata.SymbioticMetadataLink]

Curator user-facing links, when its metadata record exists.

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