REST route endpoint standardization #1794
Open
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
Due to naming and versioning inconsistencies, this PR updates all of the Sei custom modules to use a more traditional route and proto package naming convention. Additionally this PR regenerated the underlying code using the ignite CLI. The following modules have been updated: - epoch - EVM - TokenFactory - Oracle - Mint
- Fix broken query paths on oracle and tokenfactory
Regenerated files according to new REST routes
|
So this adds additional routes while keeping existing ones for compatibility? |
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.
Describe your changes and provide context
Currently, there is in-congruency in the Sei REST API endpoint’s routes for all the custom sei-protocol modules.
Typically REST endpoints have the format /{org}/{module}/{version}/, for example “/cosmwasm/wasm/v1/” or “/cosmos/feegrant/v1beta1/*”.
IBC routes have the format /{org}/{package}/{module}/{version}/, such as IBC “/ibc/apps/transfer/v1/”.
Some of the Sei routes use “sei-chain” as the package, while others use “seichain”.
Some have “sei-protocol” as the org prefix, while others do not have an org prefix.
Only mint contains versions, while the others do not.
This PR standardizes the REST routes and proto package names to be /org/module/version/** with "sei" as the org.
Example:
Old route:
http://localhost:1317/sei-protocol/sei-chain/oracle/slash_window
New route:
http://localhost:1317/sei/oracle/v1/slash_window
It is important to note that for backwards compatibility the old routes have been kept in this version. Once merged, docs and integration guides will be updated to use the newer routes formats.
Testing performed to validate your change
Tested locally on all custom module endpoints by two separate people