enforces enums in wallet transaction rpc schemas #3680
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
the getAccountTransaction and getAccountTransactions RPC endpoints return a transaction status and a transaction type with each transaction in a response. each of these fields has a set of valid values that we define with an enum. the response schemas, however, only specify that 'status' and 'type' are strings. updates the response schemas to enforce that transaction status is one of the TransactionStatus enum values and that transaction type is one of the TransactionType enum values.
holahula
approved these changes
Mar 22, 2023
rohanjadvani
approved these changes
Mar 22, 2023
holahula
pushed a commit
that referenced
this pull request
Mar 23, 2023
the getAccountTransaction and getAccountTransactions RPC endpoints return a transaction status and a transaction type with each transaction in a response. each of these fields has a set of valid values that we define with an enum. the response schemas, however, only specify that 'status' and 'type' are strings. updates the response schemas to enforce that transaction status is one of the TransactionStatus enum values and that transaction type is one of the TransactionType enum values.
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.
Summary
the getAccountTransaction and getAccountTransactions RPC endpoints return a transaction status and a transaction type with each transaction in a response. each of these fields has a set of valid values that we define with an enum.
the response schemas, however, only specify that 'status' and 'type' are strings.
updates the response schemas to enforce that transaction status is one of the TransactionStatus enum values and that transaction type is one of the TransactionType enum values.
Proposed on Discord: https://discord.com/channels/771503434028941353/831945060777852998/1088097724907409468
Testing Plan
Documentation
Does this change require any updates to the Iron Fish Docs (ex. the RPC API
Reference)? If yes, link a
related documentation pull request for the website.
Breaking Change
Is this a breaking change? If yes, add notes below on why this is breaking and
what additional work is required, if any.