feat: lazy load pending deposit using generator #7584
Draft
+95
−52
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
ensi321
force-pushed
the
nc/deposit-generator
branch
from
6724128 to
8eb6b38
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## unstable #7584 +/- ##
============================================
- Coverage 50.24% 50.22% -0.02%
============================================
Files 604 605 +1
Lines 40466 40485 +19
Branches 2229 2229
============================================
+ Hits 20331 20333 +2
- Misses 20093 20110 +17
Partials 42 42 🚀 New features to boost your workflow:
|
Contributor
Performance Report✔️ no performance regression detected Full benchmark results
|
Member
|
do we still want this? seems to me like we do, cc @twoeths |
Contributor
Author
Yes. Still relevant |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Comment on lines
+19
to
+27
| export function* pendingDepositIterator( | ||
| state: BeaconStateElectra, | ||
| startIndex?: number, | ||
| chunkSize?: number | ||
| ): Generator<CompositeViewDU<DepositType>> { | ||
| for (const deposit of chunkedIterator(state.pendingDeposits, startIndex, chunkSize)) { | ||
| yield deposit as CompositeViewDU<DepositType>; | ||
| } | ||
| } |
There was a problem hiding this comment.
The exported function pendingDepositIterator would benefit from JSDoc documentation that describes its purpose, parameters, and return value. This would maintain consistency with the documentation standards in the codebase and make the API more accessible to other developers. Consider adding a comment similar to the one provided for the chunkedIterator function below it.
GitHub: Fixes #1234
/**
* Generator function that yields pending deposits from the beacon state
* @param state - The beacon state containing pending deposits
* @param startIndex - Optional starting index for iteration (default: 0)
* @param chunkSize - Optional number of items to retrieve per chunk (default: 100)
* @returns A generator that yields deposit objects
*/
export function* pendingDepositIterator(...)
Suggested change
| export function* pendingDepositIterator( | |
| state: BeaconStateElectra, | |
| startIndex?: number, | |
| chunkSize?: number | |
| ): Generator<CompositeViewDU<DepositType>> { | |
| for (const deposit of chunkedIterator(state.pendingDeposits, startIndex, chunkSize)) { | |
| yield deposit as CompositeViewDU<DepositType>; | |
| } | |
| } | |
| /** | |
| * Generator function that yields pending deposits from the beacon state | |
| * @param state - The beacon state containing pending deposits | |
| * @param startIndex - Optional starting index for iteration (default: 0) | |
| * @param chunkSize - Optional number of items to retrieve per chunk (default: 100) | |
| * @returns A generator that yields deposit objects | |
| */ | |
| export function* pendingDepositIterator( | |
| state: BeaconStateElectra, | |
| startIndex?: number, | |
| chunkSize?: number | |
| ): Generator<CompositeViewDU<DepositType>> { | |
| for (const deposit of chunkedIterator(state.pendingDeposits, startIndex, chunkSize)) { | |
| yield deposit as CompositeViewDU<DepositType>; | |
| } | |
| } | |
Spotted by Diamond (based on custom rules)
Is this helpful? React 👍 or 👎 to let us know.
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.
Note: This PR has a dependency on ssz v1.2.0. Staying as draft for now