VaultHistoricalReader

Documentation for eth_defi.vault.base.VaultHistoricalReader Python class.

class VaultHistoricalReader

Bases: abc.ABC

Support reading historical vault share prices.

• Allows to construct historical returns

Attributes summary

address
first_block
share_price_change_threshold	Return this reader's sparse share-price comparison threshold.
uses_contextual_history	Return whether this reader supplies protocol-sourced observations.
uses_share_price_equivalence	Return whether cash flows must be ignored by the sparse filter.
write_all_samples	Retain every successful static Multicall sample, including unchanged NAVs.

Methods summary

__init__(vault)
construct_multicalls()	Create smart contract calls needed to read the historical state of this vault.
fetch_contextual_historical_reads(...)	Yield protocol-sourced historical rows outside the static call grid.
process_result(block_number, timestamp, ...)	Process the result of mult

write_all_samples: bool = False

Retain every successful static Multicall sample, including unchanged NAVs.

__init__(vault)

Parameters

vault (eth_defi.vault.base.VaultBase) –

property share_price_change_threshold: float

Return this reader’s sparse share-price comparison threshold.

Event-only readers may require every exact price change; ordinary readers retain the existing ten-basis-point suppression threshold.

Returns

Non-negative relative suppression threshold.

property uses_contextual_history: bool

Return whether this reader supplies protocol-sourced observations.

Most EVM vaults expose static calldata that the common multicaller can execute on a regular block grid. Protocols such as GMX instead expose sparse value events that are prefetched into a protocol-owned cache.

Returns

False for the ordinary static-multicall path.

property uses_share_price_equivalence: bool

Return whether cash flows must be ignored by the sparse filter.

Vault-like products without a standard share-price method can still expose a supply-normalised price equivalent. Their TVL and supply changes must not create false performance observations.

Returns

True when the vault carries the share_price_equivalence feature.

fetch_contextual_historical_reads(start_block, end_block, step)

Yield protocol-sourced historical rows outside the static call grid.

Contextual readers override this method and read an already-prefilled local cache. Network collection belongs before the common price scan.

Parameters

• start_block (int) – Inclusive archive block boundary.

• end_block (int) – Exclusive archive block boundary.

• step (int) – Approximate block spacing used to downsample source observations.

Returns

Ordinary VaultHistoricalRead rows for the common writer.

Raises

NotImplementedError – If a reader opts into contextual history without implementing it.

Return type

Iterable[eth_defi.vault.base.VaultHistoricalRead]

abstract construct_multicalls()

Create smart contract calls needed to read the historical state of this vault.

• Multicall machinery will call these calls at a specific block and report back to process_result()

Return type

Iterable[eth_defi.event_reader.multicall_batcher.EncodedCall]

abstract process_result(block_number, timestamp, call_results)

Process the result of mult

• Calls are created in construct_multicalls()

• This method combines result of this calls to a easy to manage historical record VaultHistoricalRead

Parameters

• block_number (int) –

• timestamp (datetime.datetime) –

• call_results (list[eth_defi.event_reader.multicall_batcher.EncodedCallResult]) –

Return type

eth_defi.vault.base.VaultHistoricalRead