XerberusVaultSection

Documentation for eth_defi.xerberus.vault_export.XerberusVaultSection Python class.

class XerberusVaultSection

Bases: TypedDict

Compact per-vault Xerberus risk summary on each vault metrics row.

Attributes summary

score

Composite score 0–100, or None.

score_scale

Always XERBERUS_SCORE_SCALE.

entity_type

pool when vault-specific; protocol on fallback.

entity_id

Xerberus entity id.

name

Display name.

protocol_slug

Our protocol slug when entity_type is protocol.

report_url

Dendrogram report URL when known.

fetched_at

ISO 8601 snapshot timestamp.

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.

score: Optional[float]

Composite score 0–100, or None.

score_scale: str

Always XERBERUS_SCORE_SCALE.

entity_type: Literal['pool', 'protocol']

pool when vault-specific; protocol on fallback.

entity_id: str

Xerberus entity id.

name: Optional[str]

Display name.

protocol_slug: Optional[str]

Our protocol slug when entity_type is protocol.

report_url: Optional[str]

Dendrogram report URL when known.

fetched_at: str

ISO 8601 snapshot timestamp.

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