erc_4626.lead_scan_core

Documentation for eth_defi.erc_4626.lead_scan_core Python module.

Core logic for scanning the vault leads.

  • Does not scan historical prices, but only discovers vaults

Functions

display_vaults_table(df[, nav_threshold, ...])

Diplay scanned vault leads in the terminal

scan_leads(json_rpc_urls, vault_db_file[, ...])

Core loop to discover new vaults on a chain.

display_vaults_table(df, nav_threshold=Decimal('1.100000000000000088817841970012523233890533447265625'), max_entries=None)

Diplay scanned vault leads in the terminal

Parameters
Return type

None

scan_leads(json_rpc_urls, vault_db_file, max_workers=16, start_block=None, end_block=None, printer=<built-in function print>, backend='auto', max_getlogs_range=None, hypersync_api_key=None, hypersync_concurrency=None, max_display_entries=None, rpc_request_stats=None, web3=None)

Core loop to discover new vaults on a chain.

  • Use Hypersync if available, otherwise fall back to JSON-RPC only scanning

  • Resume for the last known block

Parameters
  • hypersync_concurrency (Optional[int]) – Number of concurrent Hypersync stream requests. None falls back to the HYPERSYNC_CONCURRENCY env var, then to the Hypersync server default.

  • max_display_entries (Optional[int]) – Maximum number of vaults included in the diagnostic results table. None displays all matching vaults.

  • rpc_request_stats (Optional[eth_defi.provider.rpcdb.RPCRequestStats]) – Optional phase accumulator for physical JSON-RPC request accounting.

  • web3 (Optional[web3.main.Web3]) – Optional phase-owned Web3 connection. Supplying it lets an outer scanner establish the chain id before entering exception-handled work.

  • json_rpc_urls (str) –

  • vault_db_file (pathlib.Path) –

  • max_workers (int) –

  • start_block (Optional[int]) –

  • end_block (Optional[int]) –

  • backend (Literal['auto', 'hypersync', 'rpc']) –

  • max_getlogs_range (Optional[int]) –

  • hypersync_api_key (Optional[str]) –

Return type

eth_defi.erc_4626.discovery_base.LeadScanReport