sncast_std appendix in cairo code
#2262
Open
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
| /// - `contract_address` - address of the contract which will be called | ||
| /// - `function_selector` - hashed name of the target function (can be obtained with `selector!` macro) | ||
| /// - `calldata` - calldata for the function inputs, serialized with `Serde` | ||
| /// Returns [`CallResult`] with the returned data from the called function, or [`ScriptCommandError`] in case of failure |
There was a problem hiding this comment.
Suggested change
| /// Returns [`CallResult`] with the returned data from the called function, or [`ScriptCommandError`] in case of failure | |
| /// Returns [`CallResult`] with the returned data from the called function, or [`ScriptCommandError`] in case of failure |
| pub class_hash: ClassHash, | ||
| /// A hash which references the transaction in which the declaration was made |
There was a problem hiding this comment.
Suggested change
| /// A hash which references the transaction in which the declaration was made | |
| /// Hash of the transaction in which it was declared |
| #[derive(Drop, Clone, Debug, Serde)] | ||
| pub struct DeclareResult { | ||
| /// Resulting class hash which was declared during the transaction |
There was a problem hiding this comment.
Suggested change
| /// Resulting class hash which was declared during the transaction | |
| /// Resulting class hash which was declared by the transaction |
| @@ -319,10 +452,12 @@ pub impl DisplayExecutionStatus of Display<ExecutionStatus> { | |||
| } | |||
| } | |||
|
|
|||
|
|
|||
| /// A structure representing status of the transaction execution after its' submission | |||
There was a problem hiding this comment.
Suggested change
| /// A structure representing status of the transaction execution after its' submission | |
| /// A structure representing status of the transaction execution after its submission |
| @@ -303,9 +433,12 @@ pub impl DisplayFinalityStatus of Display<FinalityStatus> { | |||
| } | |||
|
|
|||
|
|
|||
| /// Result of cairo code execution for the transaction after validation | |||
There was a problem hiding this comment.
Suggested change
| /// Result of cairo code execution for the transaction after validation | |
| /// Result of Cairo code execution for the transaction after validation |
| /// If not provided, max fee will be automatically estimated via estimation endpoint. | ||
| /// - `nonce` - Account nonce for declare transaction. | ||
| /// If not provided, nonce will be set automatically (by fetching it from the account contract in the background). | ||
| /// Returns `InvokeResult` or `ScriptCommandError` if *submitting* the transaction failed |
There was a problem hiding this comment.
Suggested change
| /// Returns `InvokeResult` or `ScriptCommandError` if *submitting* the transaction failed | |
| /// Returns `InvokeResult`, or `ScriptCommandError` if *submitting* the transaction failed |
| @@ -276,17 +387,36 @@ pub fn invoke( | |||
| result_data | |||
| } | |||
|
|
|||
| /// Gets nonce of an account for a given block tag | |||
| /// - `block_tag` - block tag name in form of shortstring (one of 'pending' or 'latest'). | |||
There was a problem hiding this comment.
Suggested change
| /// - `block_tag` - block tag name in form of shortstring (one of 'pending' or 'latest'). | |
| /// - `block_tag` - block tag in form of a shortstring ('pending' or 'latest'). |
block tag is self-explanatory
| #[derive(Drop, Clone, Debug, Serde, PartialEq)] | ||
| pub enum FinalityStatus { | ||
| /// Transaction was received by the node successfully |
There was a problem hiding this comment.
Wondering if these sentences shouldn't be in present perfect (has been received) etc.
| pub finality_status: FinalityStatus, | ||
| /// Result of the cairo code execution. Present when the transaction was actually included in the block. |
There was a problem hiding this comment.
Suggested change
| /// Result of the cairo code execution. Present when the transaction was actually included in the block. | |
| /// Result of the Cairo code execution. Present when the transaction was actually included in the block. |
|
|
||
| /// Gets the status of a transaction. Useful for assessment of completion status for the transaction. | ||
| /// - `transaction_hash` - A `felt252` representing hash of the transaction (i.e. result of `deploy`/`invoke`/`declare`) | ||
| /// Returns `TxStatusResult` or `ScriptCommandError` if retrieving the status failed |
There was a problem hiding this comment.
Suggested change
| /// Returns `TxStatusResult` or `ScriptCommandError` if retrieving the status failed | |
| /// Returns `TxStatusResult`, or `ScriptCommandError` if retrieving the status failed |
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.
Closes #2015
Introduced changes
scarb docFollow up for this: #2263
Checklist
CHANGELOG.md