VaultScanManifest

Documentation for eth_defi.vault.scan_manifest.VaultScanManifest Python class.

class VaultScanManifest

Bases: TypedDict

Wire contract polled before a live strategy downloads its universe.

publish_vault_scan_manifest() serialises this mapping as JSON after private price export. The matching consumer is tradingstrategy.vault_scan_manifest.VaultScanManifest. Chain-wide freshness is a scheduling hint, not a guarantee that every vault has data.

Attributes summary

schema_version

Wire schema version; the consumer currently supports version 1 only.

published_at

UTC publication time after the referenced price upload.

price_file

Identity and source version of the referenced cleaned price object.

chains

Decimal chain-ID keys and their published freshness metadata.

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.

schema_version: Literal[1]

Wire schema version; the consumer currently supports version 1 only.

published_at: str

UTC publication time after the referenced price upload.

price_file: eth_defi.vault.scan_manifest.VaultPriceFileManifest

Identity and source version of the referenced cleaned price object.

chains: dict[str, eth_defi.vault.scan_manifest.VaultChainScanManifest]

Decimal chain-ID keys and their published freshness metadata.

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