ERC-4626 API

This module contains ERC-4626 support for Python.

ERC-4626 is a standard to optimize and unify the technical parameters of yield-bearing vaults. It provides a standard API for tokenized yield-bearing vaults that represent shares of a single underlying ERC-20 token. ERC-4626 also outlines an optional extension for tokenized vaults utilizing ERC-20, offering basic functionality for depositing, withdrawing tokens and reading balances.

• Scan chains for all ERC-4626 vaults

• Read historical market data

• Deposit and redeem from vaults

• Specific protocol integrations like eth_defi.lagoon.vault, eth_defi.ipor.vault, eth_defi.morpho.vault subclass these base classes

Tutorials

• scan-erc_4626_vaults

More info

• https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/

• https://docs.openzeppelin.com/contracts/5.x/erc4626

eth_defi.erc_4626.vault	Generic ECR-4626 vault reader implementation.
eth_defi.erc_4626.deposit_redeem	ERC-4626 deposit and redeem requests.
eth_defi.erc_4626.deposit_probe	Anvil-only guarded vault-deposit probe.
eth_defi.erc_4626.flow	Deposit and redemption from ERC-4626 vaults.
eth_defi.erc_4626.analysis	ERC-4626 deposit slippage analysis.
eth_defi.erc_4626.hypersync_discovery	Find ERC-4626 vaults onchain using HyperSync.
eth_defi.erc_4626.core	ERC-4626 core functions.
eth_defi.erc_4626.classification	ERC-4626 vault type classification.
eth_defi.erc_4626.scan	Turn vault discoveries to human-readable and machine-readable tables.
eth_defi.erc_4626.estimate	ERC-4626 estimations.
eth_defi.erc_4626.profit_and_loss	Calculate ERC-4626 vault APY, or profitability.
eth_defi.erc_4626.discovery_base	Events we use in the vault discovery.
eth_defi.erc_4626.lead_scan_core	Core logic for scanning the vault leads.
eth_defi.erc_4626.rpc_discovery	Find ERC-4626 vaults onchain using JSON-RPC.
eth_defi.erc_4626.settlement_events	ERC-4626 event reader helpers for settlement-style events.
eth_defi.erc_4626.settlement_scan	Populate generic vault settlement data from ERC-4626 protocol readers.
eth_defi.erc_4626.warmup	Warmup system to detect broken vault contract calls.
eth_defi.erc_4626.vault_protocol.lagoon.settlement	Lagoon settlement event reader.
eth_defi.erc_4626.vault_protocol.d2.settlement	D2 Finance settlement and phase event reader.
eth_defi.erc_4626.vault_protocol.ember.deposit_redeem	Ember synchronous-deposit and operator-finalised redemption support.
eth_defi.erc_4626.vault_protocol.ember.settlement	Historical Ember operator-settlement event reader.
eth_defi.erc_4626.vault_protocol.accountable.deposit_redeem	Accountable synchronous deposits and asynchronous redemption claims.
eth_defi.erc_4626.vault_protocol.accountable.settlement	Historical Accountable redemption-settlement event reader.
eth_defi.erc_4626.vault_protocol.csigma.deposit_redeem	cSigma ERC-4626 deposit and redemption requests.