feat(taiko-client): add swagger api for preconf server #18274
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
davidtaikocha
approved these changes
Oct 22, 2024
dantaik
reviewed
Oct 22, 2024
| } | ||
| } | ||
| }, | ||
| "/preconfBlocks": { |
There was a problem hiding this comment.
Renamed to POST /tentativeBlocks as suggested below
dantaik
reviewed
Oct 22, 2024
| }, | ||
| "/preconfBlocks": { | ||
| "post": { | ||
| "description": "Insert preconfirmation blocks by the given groups to the backend L2 execution engine, please note that\nthe AVS service should sort the groups and make sure all the groups are valid at first.", |
There was a problem hiding this comment.
Suggested change
| "description": "Insert preconfirmation blocks by the given groups to the backend L2 execution engine, please note that\nthe AVS service should sort the groups and make sure all the groups are valid at first.", | |
| "description": "Insert a group of transactions into a tentative block for preconfirmation. If the group is the first for a block, a new tentative block will be created. Otherwise, the transactions will be appended to the existing tentative block. The API will fail if: 1) the block is not tentative, 2) any transaction in the group is invalid or a duplicate, 3) block-level parameters are invalid or do not match the current tentative block’s parameters, 4) the group ID is not exactly 1 greater than the previous one, or 5) the last group of the block indicates no further transactions are allowed.", |
dantaik
reviewed
Oct 22, 2024
dantaik
requested changes
Oct 22, 2024
| }, | ||
| "/preconfHead": { | ||
| "put": { | ||
| "description": "Resets the backend L2 execution engine preconfirmation head, please note that\nthe AVS service should make sure the new head height is from a valid preconfirmation head.", |
There was a problem hiding this comment.
Suggested change
| "description": "Resets the backend L2 execution engine preconfirmation head, please note that\nthe AVS service should make sure the new head height is from a valid preconfirmation head.", | |
| "description": "Remove all tentative blocks from the blockchain beyond the specified block height, ensuring the latest block ID does not exceed the given height. This method will fail if the block with an ID one greater than the specified height is not a tentative block. If the specified block height is greater than the latest tentative block ID, the method will succeed without modifying the blockchain.", |
| // @Param body body CreateOrUpdateBlocksFromBatchResponseBodyRequestBody true "preconf blocks creation request body" | ||
| // @Accept json | ||
| // @Produce json | ||
| // @Success 200 {object} CreateOrUpdateBlocksFromBatchResponseBody | ||
| // @Router /perconfBlocks [post] | ||
| // @Router /preconfBlocks [post] |
There was a problem hiding this comment.
Suggested change
| // @Router /preconfBlocks [post] | |
| // @Router /preconfTransactions [post] |
There was a problem hiding this comment.
Shall we use ResetPreconfirmationBlockHeight? If the only parameter is a block ID/height, we should use height, as "head" usually means a structure.
There was a problem hiding this comment.
After another thought: Lets name these two functions:
- build_tentative_blocks (buildTentativeBlocks)
- remove_tentative_blocks (removeTentativeBlocks)
There was a problem hiding this comment.
After another thought: Lets name these two functions:
- build_tentative_blocks (buildTentativeBlocks)
- remove_tentative_blocks (removeTentativeBlocks)
Updated the method names and the URL path
dantaik
reviewed
Oct 22, 2024
| @@ -75,6 +75,6 @@ func (s *PreconfAPIServer) configureMiddleware(corsOrigins []string) { | |||
| func (s *PreconfAPIServer) configureRoutes() { | |||
| s.echo.GET("/", s.HealthCheck) | |||
| s.echo.GET("/healthz", s.HealthCheck) | |||
| s.echo.POST("/perconfTransactions", s.CreateOrUpdateBlocksFromBatch) | |||
| s.echo.POST("/preconfTransactions", s.CreateOrUpdateBlocksFromBatch) | |||
There was a problem hiding this comment.
I think we should use "preconfirm_transactions" or "preconfirmTransactions", and "remove_tentative_blocks"
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.
No description provided.