VaultMetricsExport

Documentation for eth_defi.research.vault_metrics.VaultMetricsExport Python class.

class VaultMetricsExport

Bases: TypedDict

Top-level structure of the vault metrics JSON export.

Describes the shape of top_vaults_by_chain.json uploaded to R2.

Attributes summary

generated_at	ISO 8601 UTC timestamp when the export was generated
metadata	Export provenance metadata, see ExportMetadata.
core3_protocols	Core3 risk intelligence keyed by protocol slug.
xerberus_protocols	Xerberus protocol-level metadata keyed by our protocol slug.
curators	Curator metadata and recent feed entries keyed by curator slug.
vaults	List of per-vault metric records

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.

generated_at: str

ISO 8601 UTC timestamp when the export was generated

metadata: eth_defi.research.vault_metrics.ExportMetadata

Export provenance metadata, see ExportMetadata.

core3_protocols: dict[str, eth_defi.core3.vault_protocol.Core3ExportRecord]

Core3 risk intelligence keyed by protocol slug. Only protocols present in the exported vaults are included.

xerberus_protocols: dict[str, eth_defi.xerberus.vault_export.XerberusProtocolExportRecord]

Xerberus protocol-level metadata keyed by our protocol slug. Only protocols present in the exported vaults are included. Per-vault scores live on each vault row under xerberus.

curators: dict[str, 'CuratorExportRecord']

Curator metadata and recent feed entries keyed by curator slug. Only curators present in the exported vaults are included.

vaults: list[eth_defi.research.vault_metrics.VaultMetricsRecord]

List of per-vault metric records

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