feat: update dry run endpoint to use new runtime api call #1519
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
IkerAlus
reviewed
Oct 17, 2024
There was a problem hiding this comment.
The interface, inputs and expected outputs look good to me. I haven't tested this properly though.
Also, remember to update the endpoint docs accordingly: https://paritytech.github.io/substrate-api-sidecar/dist/
filvecchiato
force-pushed
the
update_dry_run
branch
from
808b32f
to
dac893f
Compare
filvecchiato
force-pushed
the
update_dry_run
branch
from
dac893f
to
2ae138f
Compare
TarikGul
reviewed
Oct 17, 2024
TarikGul
reviewed
Oct 17, 2024
TarikGul
requested changes
Oct 17, 2024
TarikGul
approved these changes
Oct 17, 2024
|
Great job :) |
Imod7
reviewed
Oct 18, 2024
There was a problem hiding this comment.
Regarding the docs that @IkerAlus mentioned, you need to update this file because the dry-run endpoint now accepts 2 additional parameters basides tx: senderAddress and at.
The usual steps I follow are :
- I check the endpoint and schema sections in that file and make any necessary updates.
- After I complete the changes, I verify that the yaml file has no errors by copy pasting it in the Swagger Editor.
- If everything looks good, I run
yarn build:docs - Then I open the page
index.html(from folderdocs/dist) in my browser to confirm that all changes have been applied. - If everything looks good, I push the changes.
|
I updated the docs and also updated the response to include response Type defining if its an error or a dispatch outcome |
Imod7
requested changes
Oct 22, 2024
| @@ -1067,7 +1067,7 @@ paths: | |||
| description: Use the dryrun call to practice submission of a transaction. | |||
There was a problem hiding this comment.
Suggested change
| description: Use the dryrun call to practice submission of a transaction. | |
| description: Use the `dryRun` call to simulate the submission of a transaction without executing it so that you can check for potential errors and validate the expected outcome. |
Comment on lines
+4519
to
+4528
| type: object | ||
| properties: | ||
| actualWeight: | ||
| type: string | ||
| format: unsignedInteger | ||
| description: The actual weight of the transaction. | ||
| paysFee: | ||
| type: string | ||
| format: boolean | ||
| description: Whether the transaction pays a fee. |
There was a problem hiding this comment.
Suggested change
| type: object | |
| properties: | |
| actualWeight: | |
| type: string | |
| format: unsignedInteger | |
| description: The actual weight of the transaction. | |
| paysFee: | |
| type: string | |
| format: boolean | |
| description: Whether the transaction pays a fee. | |
| oneOf: | |
| - $ref: '#/components/schemas/TransactionDispatchOutcome' | |
| - $ref: '#/components/schemas/TransactionValidityError' |
| @@ -4494,6 +4494,18 @@ components: | |||
| tx: | |||
| type: string | |||
| format: hex | |||
| DryRunBody: | |||
There was a problem hiding this comment.
Suggested change
| DryRunBody: | |
| TransactionDispatchOutcome: | |
| type: object | |
| description: The result of a valid transaction submitted via the `dry-run` endpoint. | |
| properties: | |
| actualWeight: | |
| type: string | |
| format: unsignedInteger | |
| description: The actual weight of the transaction. | |
| paysFee: | |
| type: string | |
| format: boolean | |
| description: Whether the transaction pays a fee. | |
| TransactionValidityError: | |
| type: object | |
| description: The error result from an invalid transaction submitted via the `dry-run` endpoint. | |
| properties: | |
| errorType: | |
| type: string | |
| enum: | |
| - Unimplemented | |
| - VersionedConversionFailed | |
| description: The type of transaction error, either `Unimplemented` or `VersionedConversionFailed`. | |
| DryRunBody: |
| - `UnknownTransaction`: https://crates.parity.io/sp_runtime/transaction_validity/enum.UnknownTransaction.html | ||
| - `InvalidTransaction`: https://crates.parity.io/sp_runtime/transaction_validity/enum.InvalidTransaction.html | ||
| - `PostDispatchInfo`: https://docs.rs/frame-support/38.0.0/frame_support/dispatch/struct.PostDispatchInfo.html | ||
| - `Error Type`: https://paritytech.github.io/polkadot-sdk/master/xcm_runtime_apis/dry_run/enum.Error.html |
There was a problem hiding this comment.
We could also get a DispatchError no ? Maybe we can add this here along with an additional schema (like TransactionDispatchOutcome and TransactionValidityError helper schemas) ?
Imod7
approved these changes
Oct 22, 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.
It updates the transaction dry run endpoint to accept a body with the transaction string, the sender address and the block number. it returns if the dry run was successful or if it errored and for which block hash