Return FastPayResult<ExecutionStatus> from adapter #215
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
sblackshear
reviewed
Jan 20, 2022
| @@ -44,7 +45,11 @@ pub fn new_move_vm(natives: NativeFunctionTable) -> Result<Arc<MoveVM>, FastPayE | |||
|
|
|||
| /// Execute `module::function<type_args>(object_args ++ pure_args)` as a call from `sender` with the given `gas_budget`. | |||
| /// Execution will read from/write to the store in `state_view`. | |||
| /// Returns both the execution result, and the amount of gas used (even in the case of error). | |||
| /// IMPORTANT NOTES on the resturn value: | |||
There was a problem hiding this comment.
Suggested change
| /// IMPORTANT NOTES on the resturn value: | |
| /// IMPORTANT NOTES on the return value: |
| /// IMPORTANT NOTES on the resturn value: | ||
| /// The return value indicates whether a system error has occured (i.e. issues with the fastx system, not with user transaction). | ||
| /// As long as there are no system issues we return Ok(ExecutionStatus). | ||
| /// ExecutionStatus indicates the execution result. If execution faied, we wrap both the gas used and the error |
There was a problem hiding this comment.
Suggested change
| /// ExecutionStatus indicates the execution result. If execution faied, we wrap both the gas used and the error | |
| /// ExecutionStatus indicates the execution result. If execution failed, we wrap both the gas used and the error |
| @@ -128,25 +128,26 @@ pub struct OrderInfoResponse { | |||
| #[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] | |||
| pub enum ExecutionStatus { | |||
| Success, | |||
There was a problem hiding this comment.
I think we should eventually plumb through the gas used here too.
fastx_types/src/messages.rs
Outdated
| @@ -128,25 +128,26 @@ pub struct OrderInfoResponse { | |||
| #[derive(Eq, PartialEq, Clone, Debug, Serialize, Deserialize)] | |||
| pub enum ExecutionStatus { | |||
| Success, | |||
| Failure(Box<FastPayError>), | |||
| // Gas used in the failed case, and the error. | |||
| Failure(u64, Box<FastPayError>), | |||
There was a problem hiding this comment.
Rust has these fancy inline structs (I think that's what this feature is called? @huitseeker?) that are useful for this:
Suggested change
| Failure(u64, Box<FastPayError>), | |
| Failure { gas_used: u64, error: Box<FastPayError> } |
There was a problem hiding this comment.
"Any variant that is valid as a struct [variant] is also valid as an enum [variant]"
https://doc.rust-lang.org/rust-by-example/custom_types/enum.html
sblackshear
approved these changes
Jan 20, 2022
mwtian
pushed a commit
to mwtian/sui
that referenced
this pull request
Sep 29, 2022
fix: broken links in files
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.
All order execution functions now return
FastPayResult<ExecutionStatus>. The result indicates whether there is system issue.ExecutionStatusindicates the actual execution result. In the case ofExecutionStatus::Failure, we also include gas used for gas charge in the fail case.