Migrate Token to zod #1317
Merged
Migrate Token to zod #1317
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
Pull Request Test Coverage Report for Build 8327871145Details
💛 - Coveralls |
iamacook
reviewed
Mar 18, 2024
| export const TokenSchema = z.object({ | ||
| address: AddressSchema, | ||
| decimals: z.number().nullish().default(null), | ||
| logoUri: z.string(), |
There was a problem hiding this comment.
I would've said that this could be a z.string().url() but I see it's just a string in AJV. Perhaps we should revisit this later.
There was a problem hiding this comment.
I agree, this maybe this would be nullable as well according to the Transaction Service docs, but we can revisit it later as it might need adjustments in other parts of the code as well 🙂
Comment on lines
+6
to
+16
| export const TokenSchema = z.object({ | ||
| address: AddressSchema, | ||
| decimals: z.number().nullish().default(null), | ||
| logoUri: z.string(), | ||
| name: z.string(), | ||
| symbol: z.string(), | ||
| type: z.nativeEnum(TokenType), | ||
| trusted: z.boolean(), | ||
| }); | ||
|
|
||
| export const tokenSchema: JSONSchemaType<Token> = { | ||
| $id: TOKEN_SCHEMA_ID, | ||
| type: 'object', | ||
| properties: { | ||
| address: { type: 'string' }, | ||
| decimals: { oneOf: [{ type: 'number' }, { type: 'null', nullable: true }] }, | ||
| logoUri: { type: 'string' }, | ||
| name: { type: 'string' }, | ||
| symbol: { type: 'string' }, | ||
| type: { type: 'string', enum: Object.values(TokenType) }, | ||
| trusted: { type: 'boolean' }, | ||
| }, | ||
| required: [ | ||
| 'address', | ||
| 'decimals', | ||
| 'logoUri', | ||
| 'name', | ||
| 'symbol', | ||
| 'type', | ||
| 'trusted', | ||
| ], | ||
| }; | ||
|
|
||
| export const TOKEN_PAGE_SCHEMA_ID = | ||
| 'https://safe-client.safe.global/schemas/tokens/token-page.json'; | ||
|
|
||
| export const tokenPageSchema: Schema = buildPageSchema( | ||
| TOKEN_PAGE_SCHEMA_ID, | ||
| tokenSchema, | ||
| ); | ||
| export const TokenPageSchema = buildZodPageSchema(TokenSchema); |
iamacook
approved these changes
Mar 18, 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
Tokentozod.Changes
TokenValidatorand associated schemas.TokenSchemaand infer type from it.