Add v2/contracts/{chainId} API endpoint
#1857
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
Includes the initial setup of routes and types needed for API v2, as it's the first endpoint
Some shells require mocha's `recursive` option to go through all subdirectories
manuelwedler
changed the title
v2/contracts/{chainId} API endpoint
|
We decided to implement id based pagination to circumvent the above issue. We need to add the The API query should look like this then: @marcocastignoli you can wait with reviewing until I implemented this. |
|
Just to make sure, should it be from |
|
It should be |
marcocastignoli
requested changes
Jan 16, 2025
services/server/src/server/services/storageServices/SourcifyDatabaseService.ts
Outdated
Show resolved
Hide resolved
manuelwedler
added a commit
that referenced
this pull request
Jan 30, 2025
* Move `safeHandler` to common.ts
* Update API v2 spec
* Add `v2/contracts/{chainId}` API endpoint
Includes the initial setup of routes and types needed for API v2, as it's the first endpoint
* Fix server test commands
Some shells require mocha's `recursive` option to go through all subdirectories
* Move API v1 routes to apiv1 folder
* Update API v2 spec
* Change pagination to be id based
* Add `getTotalMatchLevel` util function
* Rename MatchLevel types
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.
See #1827
Adds the
v2/contracts/{chainId}endpoint as described in https://sourcify.stoplight.io/docs/sourcify-apiv2/kqms8dret0zja-list-of-verified-contracts-per-chainIncludes the initial setup of routes and types needed for API v2, as it's the first endpoint. Also refactors some API v1 code to the apiv1 folder.
Pagination issue
I discovered an issue about the pagination design of the API. The issue is that we include the
totalResultsin the response. To gather this information, we run a very long db query for counting the matches. It took 60-90 seconds in my trials on production. This issue is already present in API v1.I think we can still review this PR, and resolve this issue in another when we decided how to go about it.