Add support for querying protocol state by state hash or height #15893
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
…hash or height The `protocolState` GraphQL query has been updated to allow users to retrieve the protocol state for a specific block by providing either the state hash or the height of the desired block. This enhances the flexibility and usability of the API. Changes include: - Added `stateHash` argument to specify the state hash of the desired block - Added `height` argument to specify the height of the desired block in the best chain - Updated the resolver to handle the new arguments and retrieve the protocol state based on the provided state hash or height - If neither state hash nor height is provided, the protocol state of the current best tip is returned (previous behavior) - Improved error handling and validation to ensure that exactly one of state hash or height is provided - Updated documentation to reflect the new functionality This feature allows users to query historical protocol states and retrieve information about specific blocks, enabling more granular analysis and exploration of the Mina protocol's history.
The protocolState query now accepts two new optional arguments: - height: to specify the height of the desired block in the best chain - stateHash: to specify the state hash of the desired block This allows querying the protocol state for a specific block, instead of only the current state. The description of the query was updated to reflect this change.
MartinMinkov
changed the title
|
!ci-build-me |
|
pr looks good, i will run the container once it builds in CI to just manually check if this is backwards compatible with the old api. For the most part i think it is because of the way you are handling optional arguments, but testing will just seal the deal. |
|
okay the end point seems to be backwards compatible |
svv232
approved these changes
Jul 31, 2024
georgeee
approved these changes
Jul 31, 2024
src/lib/mina_graphql/mina_graphql.ml
Outdated
| ~resolve:(fun { ctx = mina; _ } () state_hash_base58_opt height_opt | ||
| encoding_opt -> | ||
| let open Deferred.Result.Let_syntax in | ||
| let%bind breadcrumb = |
There was a problem hiding this comment.
Suggested change
| let%bind breadcrumb = | |
| let%map breadcrumb = |
NIT, but this would allow to remove Deferred.Result.return below and make the whole code a bit less multilayered.
The protocol state encoding logic has been simplified: - Instead of using Deferred.Result.return to wrap the encoding result, the encoding is now performed directly in the match expression. - The match expression now directly returns the encoded protocol state string based on the selected encoding option. This refactoring improves code readability and eliminates the need for an extra Deferred.Result layer, as the encoding operation itself does not involve any asynchronous or fallible computations.
|
!ci-build-me |
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.
Context
This pull request enhances the
protocolStateGraphQL query to allow users to retrieve the protocol state for a specific block by providing either the state hash or the height of the desired block. This improvement increases the flexibility and usability of the API, enabling more granular analysis and exploration of the Mina protocol's history. This was a specific ask from Lambda for their Mina -> ETH bridge work.Description
The changes include:
stateHashandheightarguments to theprotocolStatequeryChanges made
src/lib/mina_graphql/mina_graphql.ml:stateHashandheightarguments to theprotocolStatequerygraphql_schema.json:heightandstateHasharguments to theprotocolStatequery schema