[x/programs] Add simulator feature to RustSDK #567
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
Signed-off-by: Sam Batschelet <[email protected]>
Signed-off-by: Sam Batschelet <[email protected]>
exdx
previously approved these changes
Oct 17, 2023
exdx
reviewed
Oct 17, 2023
Signed-off-by: Sam Batschelet <[email protected]>
Signed-off-by: Sam Batschelet <[email protected]>
patrick-ogrady
approved these changes
Oct 17, 2023
samliok
reviewed
Oct 17, 2023
| /// # Errors | ||
| /// | ||
| /// Returns an error if the if serialization or plan fails. | ||
| pub fn execute<T>(&self, data: Step, key: &str) -> Result<T, Box<dyn Error>> |
There was a problem hiding this comment.
what is the point of explicitly noting execute vs read_only?
There was a problem hiding this comment.
the expectation is that one returns a tx ID the other returns the result of a function.
There was a problem hiding this comment.
I think we will want the SDK to be able to better describe this. Some functions are read_only thus can be run against a local nodes as a read only call. But something that explicitly could change state would be part of a transaction. That's my thinking at least.
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.
This PR adds the types to describe VM simulation
Plansin Rust. This is the API that the Simulator will use, I adding this first will allow us to come to consensus on the API and unblock writing tests for program examples.The idea behind this feature is to provide a simple API to communicate with the simulator using Rust types that serialize to
JSONinstead ofJSON/YAMLdirectly. This will allow for Rust developers to write tests for their programs completely in Rust or directly withYAML/JSON.