tokenised_fund.usyc.historical

Documentation for eth_defi.tokenised_fund.usyc.historical Python module.

Historical reader for Circle USYC.

Classes

USYCHistoricalReader

Read USYC ERC-20 supply and official historical NAV/share.

class USYCHistoricalReader

Bases: eth_defi.vault.base.VaultHistoricalReader

Read USYC ERC-20 supply and official historical NAV/share.

USYC is not ERC-4626. Its Chainlink-compatible oracle publishes its NAV per token after business-day reconciliation, so scans derive TVL as token supply multiplied by the oracle answer.

Create a USYC historical reader.

Parameters

vault – USYC vault adapter.
stateful – Whether to attach shared adaptive reader state.

__init__(vault, stateful)

Create a USYC historical reader.

Parameters

vault (USYCVault) – USYC vault adapter.
stateful (bool) – Whether to attach shared adaptive reader state.

construct_multicalls()

Construct token-supply and oracle calls.

Returns: Multicalls for totalSupply and latestRoundData.
Return type: collections.abc.Iterable[eth_defi.event_reader.multicall_batcher.EncodedCall]

process_result(block_number, timestamp, call_results)

Convert supply and oracle observations to one historical row.

Parameters

block_number (int) – Historical block number.
timestamp (datetime.datetime) – Naive UTC block timestamp.
call_results (list[eth_defi.event_reader.multicall_batcher.EncodedCallResult]) – Multicall results at block_number.

Returns

USYC supply, NAV/share and TVL record.

Return type

eth_defi.vault.base.VaultHistoricalRead