feat: Unify v2 & v3 types #501
Merged
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
For preparing v3 SpokePoolClient functionality in advance of bumping contracts-v2.
This PR just shuffles some existing types around to make room for the new v3 types. It also introduces some convenience functions that will be useful for discriminating between v2 and v3 types, as well as extracting data from them. No functional change intended.
This change makes some non-functional refactoring to the SpokePoolClient to make it easier to introduce the support for v3. Doing it now just reduces the size and complexity of the subsequent diff.
Also update existing naming to map 1:1 onto their underlying SpokePool functions.
Suggested by James. Co-authored-by: James Morris, MS <96435344+james-a-morris@users.noreply.github.com>
Upgrade the various RelayData-dependent functions to work with v3 types. This will importantly be used for slow fill requests in the pending v3 bump.
Introduced unintentionally in the previous commit, this prevents parallel test execution and suppresses all other tests from running.
It's not possible to determine the realizedLpFeePct until a corresponding deposit has been located, because the deposit contains the quoteTimestamp.
The type of RelayData is implied by the parent object. tsc is quite good at figuring this out.
pxrl
commented
Feb 7, 2024
pxrl
commented
Feb 7, 2024
mrice32
reviewed
Feb 7, 2024
There was a problem hiding this comment.
Added some comments on the use of asserts for ts hinting.
I think that practice is okay (better than casting), but if we can fix it through explicit function types, I think that's preferable. If we force the types on the reduce function, for instance, typescript might show an error that reveals that there is a case we aren't covering in our type assumptions.
nicholaspai
reviewed
Feb 7, 2024
nicholaspai
reviewed
Feb 7, 2024
nicholaspai
reviewed
Feb 7, 2024
nicholaspai
approved these changes
Feb 7, 2024
Signed-off-by: Matt Rice <matthewcrice32@gmail.com>
This reverts commit 8d96c72.
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.
This PR rolls out v3 types everywhere by unifying them under the Deposit, Fill, ... types that are handled throughout the SDK and relayer codebases. With this change, all consumers of these datatypes must have implemented specific handling to discriminate between v2 and v3 events. In many cases these objects are passed transparently though functions because they are not evaluating any of the fields which are different between the two. tsc is very helpful to identify which codepaths need to be upgraded. Much of that work has occurred in advance of this change.