refactor: Remove SpokePoolClient dependency from depositId search #476
+15
−25
Conversation
This file contains 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
The core binary search logic doesn't depend on the SpokePoolClient, so make a clean break.
pxrl
commented
Dec 17, 2023
Comment on lines
-40
to
-52
| // Sanity check to ensure that the spoke pool client is updated | ||
| [spokePool.isUpdated, "Spoke pool client is not updated"], | ||
| // Sanity check to ensure that initHigh is greater than or equal to initLow. | ||
| [initLow <= initHigh, "Binary search failed because low > high"], | ||
| // Sanity check to ensure that init Low is greater than or equal to zero. | ||
| [initLow >= deploymentBlock, "Binary search failed because low must be >= deploymentBlock"], | ||
| // Sanity check to ensure that maxSearches is greater than zero. | ||
| [maxSearches > 0, "maxSearches must be > 0"], | ||
| // Sanity check to ensure that deploymentBlock is greater than or equal to zero. | ||
| [deploymentBlock >= 0, "deploymentBlock must be >= 0"], | ||
| ] as [boolean, string][] | ||
| ).forEach(([condition, errorMessage]) => { | ||
| // If the condition is false, then we will throw an error. |
There was a problem hiding this comment.
These comments were just 100% mirroring what the code does (and what the error messages said the code was doing), so I opportunistically deleted them but wanted to flag it just in case.
| queriedIds[blockNumber] ??= await spokePool._getDepositIdAtBlock(blockNumber); | ||
| return queriedIds[blockNumber]; | ||
| const getDepositIdAtBlock = async (blockTag: number): Promise<number> => { | ||
| return queriedIds[blockTag] ??= await spokePool.numberOfDeposits({ blockTag }); |
There was a problem hiding this comment.
Intuitively this implementation is wrong to me, since numberOfDeposits != "highest depositId". I'd expect that we should be doing something like:
const nDeposits = await spokePoolClient.numberOfDeposits({ blockTag });
return Math.max(nDeposits - 1, 0);
nb. the above ignores the in-memory cache, but it's implied that that is used.
james-a-morris
approved these changes
Feb 19, 2024
| initLow: number, | ||
| initHigh: number, | ||
| maxSearches: number | ||
| ): Promise<{ | ||
| low: number; | ||
| high: number; | ||
| }> { | ||
| return getBlockRangeForDepositId(targetDepositId, initLow, initHigh, maxSearches, this); | ||
| return getBlockRangeForDepositId(depositId, initLow, initHigh, maxSearches, this.spokePool, this.deploymentBlock); |
There was a problem hiding this comment.
This is a good call - I thought we did this previously. +1
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.
The core binary search logic doesn't depend on the SpokePoolClient, so make a clean break.