Fix(Balances): make decimals non-nullable #2291
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
reviewed
Jan 24, 2025
Comment on lines
201
to
205
| token: { | ||
| ...balance.token, | ||
| decimals: | ||
| balance.token?.decimals ?? SafeBalancesApi.DEFAULT_DECIMALS, | ||
| }, |
There was a problem hiding this comment.
As there are multiple IBalanceApis, we should assign the default value during validation. It then doesn't need to be done in both places and will solve the MultisigTransactionExecutionDetailsMapper CI error.
There was a problem hiding this comment.
Nice, thanks for the pointer!
iamacook
approved these changes
Jan 27, 2025
PooyaRaki
reviewed
Jan 27, 2025
| const token = tokenBuilder().build(); | ||
| // @ts-expect-error - inferred type doesn't allow optional properties | ||
| delete token.decimals; | ||
|
|
||
| const result = TokenSchema.safeParse(token); | ||
|
|
||
| expect(result.success && result.data.decimals).toBe(null); | ||
| expect(result.success && result.data.decimals).toBe(18); |
There was a problem hiding this comment.
Nit: I would add a new const is test named DEFAULT_DECIMALS.
PooyaRaki
approved these changes
Jan 27, 2025
PooyaRaki
approved these changes
Jan 27, 2025
katspaugh
added a commit
that referenced
this pull request
Jan 28, 2025
This reverts commit 4d3c894.
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
Token decimals being always a number has been the assumption on the client for quite some time and a lot of code would have to be changed if we were to start treating it as nullable.
Changes
So I've adjusted the OpenAPI type and also added a fallback value (although it's probably never null in reality).