Migrate Balance validation to zod
#1257
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
iamacook
commented
Mar 6, 2024
| @@ -125,7 +125,7 @@ export class SafeBalancesApi implements IBalancesApi { | |||
| ): Promise<Balance[]> { | |||
| const tokenAddresses = balances | |||
| .map((balance) => balance.tokenAddress) | |||
| .filter((address): address is string => address !== null); | |||
| .filter((address): address is `0x${string}` => address !== null); | |||
There was a problem hiding this comment.
This is a requirement as the schema checksums the address.
iamacook
commented
Mar 6, 2024
| @@ -230,7 +231,7 @@ export class ZerionBalancesApi implements IBalancesApi { | |||
| ): Erc20Balance { | |||
| const { fungible_info, quantity } = zerionBalanceAttributes; | |||
| return { | |||
| tokenAddress, | |||
| tokenAddress: getAddress(tokenAddress), | |||
There was a problem hiding this comment.
As before regarding the checksumming of addresses. I will not highlight the other instances of this, but everywhere an address is wrapped in a getAddress call, it is the same.
Pull Request Test Coverage Report for Build 8230510014Details
💛 - Coveralls |
iamacook
commented
Mar 6, 2024
Comment on lines
+159
to
+161
| address: transactionApiBalancesResponse[1].tokenAddress | ||
| ? getAddress(transactionApiBalancesResponse[1].tokenAddress) | ||
| : transactionApiBalancesResponse[1].tokenAddress, |
There was a problem hiding this comment.
Type-wise, tokenAddress may be 0x${string} or null, hence the ternary requirement.
hectorgomezv
approved these changes
Mar 8, 2024
| { | ||
| code: 'invalid_union', | ||
| unionErrors: [ | ||
| // @ts-expect-error - inferred types don't allow optional fields |
There was a problem hiding this comment.
Is this comment accurate? The error I get when removing the @ts-expect-error annotation is:
Type '{ issues: { code: "invalid_type"; expected: "string"; received: "undefined"; path: string[]; message: string; }[]; name: string; }' is missing the following properties from type 'ZodError<any>': errors, format, message, isEmpty, and 4 more.
(this is also applicable to other lines: 193, 253, 266)
There was a problem hiding this comment.
True - it looks like the error is not on our end. I updated the comment in 67f7390.
hectorgomezv
approved these changes
Mar 11, 2024
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.
Summary
This migrates the validation of
Balance(and associated sub-types) tozod.Changes
BalancesValidatorand associated schemaBalanceSchemaand infers type(s) from it