feat: surfacing error message returned from relayer #861
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
carmen0208
approved these changes
Sep 14, 2023
Comment on lines
128
to
129
| `Transaction failed to submit with status ${relayerTransaction.status}. ` | ||
| + `Error message: ${relayerTransaction.statusMessage}`, |
There was a problem hiding this comment.
I don't think the statusMessage is always set 🤔 Can we update this to handle this scenario? And can I suggest we simplify the message a little bit here, e.g.:
let errorMessage = `Transaction failed to submit with status ${relayerTransaction.status}`;
if (relayerTransaction.statusMessage) {
errorMessage += `: ${relayerTransaction.statusMessage}`;
}
There was a problem hiding this comment.
Good call. I've added your logic there, and also changed the RelayerTransaction interface so that statusMessage is optional.
| @@ -123,9 +123,13 @@ export const sendTransaction = ({ | |||
| RelayerTransactionStatus.SUBMITTED, | |||
| RelayerTransactionStatus.SUCCESSFUL, | |||
| ].includes(relayerTransaction.status)) { | |||
| let errorMessage = `Transaction failed to submit with status ${relayerTransaction.status}.`; | |||
| if (!relayerTransaction.statusMessage) { | |||
There was a problem hiding this comment.
Suggested change
| if (!relayerTransaction.statusMessage) { | |
| if (relayerTransaction.statusMessage) { |
haydenfowler
approved these changes
Sep 26, 2023
scastleman-immutable
deleted the
feature/ID-1049-relay-error-message-surfacing
branch
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
imGetTransactionByHashmethod now returns an additionalstatusMessagefield on transaction failure, which contains information about the cause of the error. This PR captures that message and returns it to the end user.Why the changes
This helps convey the specific reason a request failed so that the end user can better respond to the probelm.
Things worth calling out
The error test in
sendTransaction.test.tshas been updated to ensure this message is being returned, however I couldn't find a way to trigger an actual error in live testing, so there may be edge cases I was not able to capture.