Improve the HTTP server response + type usage common.hash instead of String.
#65
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
Ethnical
changed the title
common.hash instead of String.
nodauf
reviewed
Sep 14, 2024
| return | ||
| } | ||
|
|
||
| if (txHash != common.Hash{}) && (err != nil) { // If the transaction hash is not empty and the error is not nil we return the transaction hash. |
There was a problem hiding this comment.
Hi,
Just notice you have forgotten the case where the txHash is not set while no error is returned. Although this case cannot be returned by the FetchAndExecute function with the current implementation, it might be better to handle every possible case right now to avoid errors in the future. For example, you could return a generic http error.
if (txHash == common.hash{}) && (err == nil) {
response := Response{
Message: "🛑 Unknown error, transaction hash does not exist 🛑",
Status: http.StatusInternalServerError,
}
json.NewEncoder(w).Encode(response)
return
}What do you think ?
There was a problem hiding this comment.
Thanks @nodauf, for the suggestion as you mentioned this is not used for now, but still worth it to apply right now to avoid any mistakes in the future!
I have applied the suggestion in the latest commit :)
op-defender/psp_executor/defender.go
Outdated
| Message: "🛑" + err.Error() + "🛑", | ||
| Status: http.StatusInternalServerError, | ||
| } | ||
| json.NewEncoder(w).Encode(response) |
There was a problem hiding this comment.
Suggested change
| json.NewEncoder(w).Encode(response) | |
| if err := json.NewEncoder(w).Encode(response); err != nil { | |
| http.Error(w, "Failed to encode response", http.StatusInternalServerError) | |
| return | |
| } |
op-defender/psp_executor/defender.go
Outdated
| Message: "🚧 Transaction Executed 🚧, but the SuperchainConfig is not *pause*. An error occured: " + err.Error() + ". The TxHash: " + txHash.Hex(), | ||
| Status: http.StatusInternalServerError, | ||
| } | ||
| json.NewEncoder(w).Encode(response) |
There was a problem hiding this comment.
Suggested change
| json.NewEncoder(w).Encode(response) | |
| if err := json.NewEncoder(w).Encode(response); err != nil { | |
| http.Error(w, "Failed to encode response", http.StatusInternalServerError) | |
| return | |
| } |
op-defender/psp_executor/defender.go
Outdated
| w.Header().Set("Content-Type", "application/json") | ||
| w.WriteHeader(http.StatusOK) | ||
| response := Response{ | ||
| Message: "PSP executed successfully", | ||
| Message: "PSP executed successfully ✅ Transaction hash: " + txHash.Hex() + "🎉", | ||
| Status: http.StatusOK, | ||
| } | ||
| json.NewEncoder(w).Encode(response) |
There was a problem hiding this comment.
Suggested change
| json.NewEncoder(w).Encode(response) | |
| if err := json.NewEncoder(w).Encode(response); err != nil { | |
| http.Error(w, "Failed to encode response", http.StatusInternalServerError) | |
| return | |
| } |
raffaele-oplabs
requested changes
Sep 16, 2024
raffaele-oplabs
approved these changes
Sep 16, 2024
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.
Description
This PR Improve the HTTP server response + type usage
common.hashinstead ofString. This now return theTxHashto help the triagger to quickly make sure the transaction is valid on chain.This also introduce an error if the super-chain is not pause after the transaction has been executed without any error.
And also return an error if the superchain is paused before doing the pause.
Tests
Fix the tests with the new signatures.
Additional context
This is part of the https://github.com/ethereum-optimism/security-pod/issues/148