Attempt to add integration tests which simulate graph calculations #1612
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tamtamchik
reviewed
Dec 14, 2025
Hardhat Unit Tests Coverage SummaryDetailsDiff against masterResults for commit: a2426bd Minimum allowed coverage is ♻️ This comment has been updated with latest results |
There was a problem hiding this comment.
Pull request overview
This PR introduces a comprehensive Graph simulator and integration test suite to validate entity computation in the Lido subgraph. The implementation simulates event-driven entity updates from transaction events and compares the resulting state against on-chain data to detect drift or bugs in the subgraph mappings.
Key changes:
- Created a TypeScript Graph simulator that processes Lido events and generates entities matching the subgraph's behavior
- Implemented integration tests with a 32-action scenario covering deposits, transfers, oracle reports, withdrawals, and V3 vault operations
- Added utilities for state capture, event extraction, and entity validation
Reviewed changes
Copilot reviewed 15 out of 17 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| test/graph/simulator/index.ts | Main simulator entry point with GraphSimulator class and processTransaction function |
| test/graph/simulator/handlers/lido.ts | Event handlers for Lido events (ETHDistributed, Submitted, Transfer, SharesBurnt, V3 events) |
| test/graph/simulator/entities.ts | Entity type definitions (TotalReward, Totals, Shares, LidoTransfer, etc.) |
| test/graph/simulator/store.ts | In-memory entity store with load/save operations |
| test/graph/simulator/helpers.ts | APR calculation and helper functions |
| test/graph/utils/event-extraction.ts | Event parsing and extraction utilities |
| test/graph/utils/state-capture.ts | Chain state capture functions |
| test/graph/entities-scenario.integration.ts | Comprehensive 32-action integration test scenario |
| test/graph/README.md | Documentation for the test framework and approach |
| package.json | Updated test commands for integration tests |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1040
to
+1041
| * Note: totalShares is not directly updated here as it's handled by the SharesBurnt event. | ||
| * This handler only updates totalPooledEther from contract. |
There was a problem hiding this comment.
The comment states totalShares is handled by SharesBurnt, but according to the V3 event handler pattern and line 1041's implementation comment, this is describing ExternalSharesBurnt which only updates totalPooledEther. The comment should clarify that the accompanying SharesBurnt event (not ExternalSharesBurnt) updates totalShares.
Suggested change
| * Note: totalShares is not directly updated here as it's handled by the SharesBurnt event. | |
| * This handler only updates totalPooledEther from contract. | |
| * Note: totalShares is not directly updated here; it is updated by the accompanying | |
| * SharesBurnt event. This handler only updates totalPooledEther from the contract. |
Comment on lines
+40
to
+41
| * - V3 external shares mint: 5+ | ||
| * - V3 external shares burn: 5+ |
There was a problem hiding this comment.
The target numbers don't match the minimum validation on lines 1019-1024. The comment claims '6+' deposits and '5+' for other actions, but the test validates '>= 6' deposits, '>= 5' transfers, '>= 7' reports, '>= 5' withdrawals, '>= 4' mints, and '>= 4' burns. Update the comment to match the actual validation: 'V3 external shares mint: 4+' and 'V3 external shares burn: 4+'.
Suggested change
| * - V3 external shares mint: 5+ | |
| * - V3 external shares burn: 5+ | |
| * - V3 external shares mint: 4+ | |
| * - V3 external shares burn: 4+ |
|
|
||
| File `entities-scenario.integration.ts`. | ||
|
|
||
| **Minimum targets:** 6 deposits, 5 transfers, 7 oracle reports, 5 withdrawal requests, 4 V3 mints, 4 V3 burns. |
There was a problem hiding this comment.
This line correctly states the minimum targets, which matches the test validation. However, it contradicts the comment in entities-scenario.integration.ts lines 33-38 which states '5+ V3 mints' and '5+ V3 burns'. The README is correct; the test file comment should be updated.
| "test:watch": "SKIP_GAS_REPORT=true SKIP_CONTRACT_SIZE=true hardhat watch test", | ||
| "test:integration": "MODE=forking hardhat test test/integration/**/*.ts", | ||
| "test:integration": "yarn test:integration:helper test/integration/**/*.ts", | ||
| "test:integration:helper": "SKIP_GAS_REPORT=true SKIP_CONTRACT_SIZE=true SKIP_INTERFACES_CHECK=true SKIP_GAS_REPORT=true MODE=forking hardhat test ", |
There was a problem hiding this comment.
SKIP_GAS_REPORT is duplicated in the environment variables. Remove one occurrence.
|
|
||
| ### ❌ Missing in Simulator | ||
|
|
||
| 1. **SharesBurnt handling** - Real graph manually processes SharesBurnt events within handleETHDistributed; simulator has placeholder but does not handle this yet. |
There was a problem hiding this comment.
This document states SharesBurnt handling is missing in the simulator, but the code in test/graph/simulator/handlers/lido.ts lines 208-215 shows that SharesBurnt events ARE handled within handleETHDistributed (findAllEventsByName and handleSharesBurnt calls). The documentation should be updated to reflect the current implementation status.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.