Earn integrator guide
EulerEarn vaults package multiple yield strategies into a single ERC-4626 vault. An integration can generally treat an Earn position as a vault share while using Euler's SDK and data services to discover vaults, display positions, and prepare user actions.
Choose an integration path
| Need | Start with |
|---|---|
| Build application flows and work with Euler entities | Euler SDK |
| Discover Earn vaults and query indexed vault data | Euler Data API V3 |
| Display names, curators, and listing status | Known vaults and metadata |
| Discover indexed account positions | Subgraphs |
| Read current protocol state | Lens contracts or direct contract calls |
| Find deployments and version-matched interfaces | Contract addresses and Euler interfaces |
For most TypeScript applications, the SDK is the best starting point. It brings together common reads, metadata, transaction planning, approvals, and simulation. Use the Data API for indexed and historical information, then confirm execution-sensitive state onchain.
Typical integration flow
- Discover supported Earn vaults and load their metadata.
- Show the vault's underlying asset, share position, performance, allocation, and available liquidity.
- Let users enter or exit through the supported SDK flow or the vault's standard ERC-4626 interface.
- Simulate the final transaction against current chain state before submission.
- Track the resulting position through the SDK, Data API, or your own indexer.
Simple integrations do not need to reproduce Euler's internal strategy-management logic. Advanced applications can add custom contract reads or EVC batching where a flow requires multiple atomic actions.
Things to account for
- Earn vaults may use different assets and share decimals; format values from contract or SDK metadata.
- Quotes, previews, APYs, and withdrawal limits change with onchain state.
- Withdrawals depend on liquidity across the vault's strategies and withdrawal queue.
- Indexed services can lag the chain, so do not use them as the final authority for transaction validity.
- A vault appearing in Euler metadata is not a guarantee of future safety or performance.
See Earn products for the product model and EulerEarn audits for security reviews.