feat(iota-tx-test-runner/docs): documentation of init, run, publish , print-bytecode task commands #5128
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
…print-bytecode task commands
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
miker83z
requested changes
Feb 4, 2025
|
Pls also run |
miker83z
reviewed
Feb 6, 2025
miker83z
approved these changes
Feb 6, 2025
|
|
||
| This command is **optional**, but if used, it must be the first command in the test sequence. | ||
|
|
||
| Command should be use: |
There was a problem hiding this comment.
Suggested change
| Command should be use: | |
| You should use the command: |
| //# init [OPTIONS] | ||
| ``` | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Suggested change
| Example: | |
| #### Example |
|
|
||
| ### `print-bytecode` | ||
|
|
||
| Command reads a compiled Move binary and prints its bytecode instructions in a readable format. |
There was a problem hiding this comment.
Suggested change
| Command reads a compiled Move binary and prints its bytecode instructions in a readable format. | |
| A command that reads a compiled Move binary and prints its bytecode instructions in a readable format. |
|
|
||
| #### What is the simulator mode? | ||
|
|
||
| This type of execution when we can control the checkpoint, epoch creation process and manually advance clock as needed. |
There was a problem hiding this comment.
Suggested change
| This type of execution when we can control the checkpoint, epoch creation process and manually advance clock as needed. | |
| This type of execution allows control of the checkpoint and epoch creation process and manually advances the clock as needed. |
| //# print-bytecode | ||
| ``` | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Suggested change
| Example: | |
| #### Example |
| } | ||
| ``` | ||
|
|
||
| - Publishes transfer.move on-chain. |
There was a problem hiding this comment.
Suggested change
| - Publishes transfer.move on-chain. | |
| - Publishes `transfer.move` on-chain. |
| ``` | ||
|
|
||
| - Publishes transfer.move on-chain. | ||
| - acc1 is the sender. |
There was a problem hiding this comment.
Suggested change
| - acc1 is the sender. | |
| - `acc1` is the sender. |
| --syntax <SYNTAX>: move syntax type (`source` or `ir`). | ||
| ``` | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Suggested change
| Example: | |
| ### Example |
There was a problem hiding this comment.
Done with additional # :D
| //# view-object 2,0 | ||
| ``` | ||
|
|
||
| `test::transfer` should have been published already before `run` command execution. |
There was a problem hiding this comment.
Suggested change
| `test::transfer` should have been published already before `run` command execution. | |
| `test::transfer` should have been published already before you can `run` the command execution. |
Comment on lines
319
to
320
| - acc1 is the sender. | ||
| - @acc2 is an identifier of recepient address. |
There was a problem hiding this comment.
Suggested change
| - acc1 is the sender. | |
| - @acc2 is an identifier of recepient address. | |
| - `acc1` is the sender. | |
| - `@acc2` is an identifier of recipient address. |
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 of change
Documentation of
init,run,publish,print-bytecodetask commands in order to have good usage perspective.Links to any relevant issues
Fixes #5122.
Type of change