YieldBasisHistoricalReader

Documentation for eth_defi.yield_basis.vault.YieldBasisHistoricalReader Python class.

class YieldBasisHistoricalReader

Bases: eth_defi.vault.base.VaultHistoricalReader

Read cached YieldBasis observations on a common block grid.

Historical archive calls are prefetched into the protocol context table; this reader only converts exact source rows to the common vault format.

Attributes summary

address
first_block
share_price_change_threshold	Return this reader's sparse share-price comparison threshold.
uses_contextual_history	Select the protocol-owned context path.
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()	Return no static calls; observations are prefetched.
fetch_contextual_historical_reads(...)	Yield the latest context observation inside each block bucket.
process_result(block_number, timestamp, ...)	Reject the ordinary static-call path.

property uses_contextual_history: bool

Select the protocol-owned context path.

construct_multicalls()

Return no static calls; observations are prefetched.

Return type

collections.abc.Iterable[eth_defi.event_reader.multicall_batcher.EncodedCall]

process_result(block_number, timestamp, call_results)

Reject the ordinary static-call path.

Parameters

• block_number (int) –

• timestamp (datetime.datetime) –

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

Return type

eth_defi.vault.base.VaultHistoricalRead

fetch_contextual_historical_reads(start_block, end_block, step)

Yield the latest context observation inside each block bucket.

Parameters

• start_block (int) –

• end_block (int) –

• step (int) –

Return type

collections.abc.Iterable[eth_defi.vault.base.VaultHistoricalRead]

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