Type IPricesApi/IBalancesApi responses as "raw"
#2100
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
changed the title
IPricesApi responses as "raw"IPricesApi/IBalancesApi responses as "raw"
iamacook
commented
Nov 7, 2024
| }); | ||
|
|
||
| expect(networkService.get.mock.calls.length).toBe(4); | ||
| expect(networkService.get.mock.calls.length).toBe(3); |
There was a problem hiding this comment.
These will be addressed by adjusting the HttpErrorFactory.
There was a problem hiding this comment.
Sounds good to me, and I'm pretty sure you are aware, but just something to have in mind: I'd say we need to be cautious there and avoid exposing the details of a ZodError when the validation failure comes from an error while processing a Datasource response (e.g.: a Transaction Service response), to avoid leaking data through the public route controller 👍🏻
hectorgomezv
approved these changes
Nov 8, 2024
iamacook
force-pushed
the
raw-prices-api
branch
from
af62ce5
to
fc3d64b
Compare
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.
Partial implementation of #1731
Summary
We validate API responses on the domain layer, but directly assign the type in the datasources. This means that the response types are not necessarily correct.
This types all request responses of
IPricesApi/IBalancesApias "raw". These responses are therefore not be used directly unless they are validated.Not: these are combined as they are heavily interlinked.
Changes
Rawutility type toIStakingApiRawutility type toIBalancesApi