WildcatHistoricalReader
Documentation for eth_defi.erc_4626.vault_protocol.wildcat.historical.WildcatHistoricalReader Python class.
- class WildcatHistoricalReader
Bases:
eth_defi.vault.base.VaultHistoricalReaderRead a Wildcat market’s share price, supply and liquidity at historical blocks.
Create a historical Wildcat market reader.
- Parameters
vault – Wildcat market adapter to read.
stateful – Whether adaptive reader state should be retained.
Attributes summary
addressfirst_blockReturn this reader's sparse share-price comparison threshold.
Return whether this reader supplies protocol-sourced observations.
Return whether cash flows must be ignored by the sparse filter.
write_all_samplesRetain every successful static Multicall sample, including unchanged NAVs.
Methods summary
__init__(vault, stateful)Create a historical Wildcat market reader.
Build the market state and cash reads.
Yield protocol-sourced historical rows outside the static call grid.
process_result(block_number, timestamp, ...)Convert the market reads into a price row.
- __init__(vault, stateful)
Create a historical Wildcat market reader.
- Parameters
vault (WildcatMarket) – Wildcat market adapter to read.
stateful (bool) – Whether adaptive reader state should be retained.
- Return type
None
- construct_multicalls()
Build the market state and cash reads.
- Returns
currentState()andtotalAssets()calls.- Return type
collections.abc.Iterable[eth_defi.event_reader.multicall_batcher.EncodedCall]
- process_result(block_number, timestamp, call_results)
Convert the market reads into a price row.
- Parameters
block_number (int) – Sampled EVM block.
timestamp (datetime.datetime) – Naive UTC timestamp of the sampled block.
call_results (list[eth_defi.event_reader.multicall_batcher.EncodedCallResult]) – Responses from
construct_multicalls().
- Returns
Share price, lender value, scaled supply, deposit capacity, available liquidity and utilisation.
- Return type
- 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
- Returns
Ordinary
VaultHistoricalReadrows for the common writer.- Raises
NotImplementedError – If a reader opts into contextual history without implementing it.
- Return type
- 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
Falsefor 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
Truewhen the vault carries theshare_price_equivalencefeature.