safe-global / safe-client-gateway / 34580385071

89%

push

github

feat(tokens): expose token metadata by address (#3419)

* feat(tokens): validate a comma-separated token address list

* feat(tokens): add the token route service with batch lookup semantics

* refactor(tokens): name the token metadata DTOs distinctly from the balances DTOs

* feat(tokens): expose token metadata by address

* test(tokens): tighten the token endpoint specs

- Replace the catch-all string-rejection in the integration mocks with a
  NetworkResponseError(418) so an unmatched URL can never satisfy a 503
  (or any other asserted status) expectation.
- Assert `success: true` before asserting length in the "keeps duplicates"
  schema test.
- Add a service-level test covering two non-404 failures at different
  request positions, asserting the lower-index error propagates even
  when the higher-index promise settles first.
- Note in the integration spec why the duplicate-address test still
  asserts via `mock.calls.filter` instead of `toHaveBeenCalledTimes`
  (R-005 exception: the same mock also serves the chain-config call).

* refactor(tokens): rename the DTO base class and complete the Swagger descriptions

- Rename the private DTO base class from BaseToken to BaseTokenMetadata:
  the balances module already has its own private BaseToken, and the
  shared name invited confusion between the two unrelated classes.
- Add missing descriptions to the tokens controller's @ApiOkResponse and
  @ApiParam({ name: 'chainId' }) decorators, mirroring the contracts
  controller's Swagger conventions.

* refactor(tokens): de-duplicate addresses with lodash uniqBy

The hand-rolled helper did exactly what lodash uniqBy already does, and
uniqBy is a dependency this repo already uses for the same shape in
push-notification.service.ts: first occurrence wins, order and checksum
casing preserved.

* fix(tokens): rate-limit the token routes and validate chainId with ChainIdSchema

Both routes are new unauthenticated lookups, and the batch route turns one
request ... (continued)

4147 of 4882 branches covered (84.94%)

Branch coverage included in aggregate %.

26 of 26 new or added lines in 5 files covered. (100.0%)

10546 of 11609 relevant lines covered (90.84%)

540.14 hits per line