Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[cli] Add CLI PTB support #16207

Merged
merged 8 commits into from
Feb 26, 2024
Merged

[cli] Add CLI PTB support #16207

merged 8 commits into from
Feb 26, 2024

Conversation

stefan-mysten
Copy link
Contributor

@stefan-mysten stefan-mysten commented Feb 12, 2024

Description

This PR adds support for writing and executing programmable transaction blocks from the CLI. In a nutshell, a new command is introduced: sui client ptb, where the user can pass in different arguments that correspond either to transactions or other flags (e.g., preview to list the transactions in the PTB without executing the PTB).

Test Plan

Snapshot testing, unit tests, etc.

cd crates/sui && cargo nextest run

If your changes are not user-facing and do not break anything, you can skip the following section. Otherwise, please briefly describe what has changed under the Release Notes section.

Type of Change (Check all that apply)

  • protocol change
  • user-visible impact
  • breaking change for a client SDKs
  • breaking change for FNs (FN binary must upgrade)
  • breaking change for validators or node operators (must upgrade binaries)
  • breaking change for on-chain data layout
  • necessitate either a data wipe or data migration

Release notes

Support was added for writing and executing programmable transaction blocks from the CLI. In a nutshell, a new command is introduced: sui client ptb, where the user can pass in different arguments that correspond either to transactions or other flags (e.g., preview to list the transactions in the PTB without executing the PTB).
Use the sui client ptb --help for the help menu that explains all the commands and shows some usage examples.

Copy link

vercel bot commented Feb 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-core ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2024 6:30pm
sui-typescript-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 26, 2024 6:30pm
4 Ignored Deployments
Name Status Preview Comments Updated (UTC)
explorer ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2024 6:30pm
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2024 6:30pm
mysten-ui ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2024 6:30pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Feb 26, 2024 6:30pm

@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Feb 14, 2024
Copy link
Member

@amnn amnn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go! 🚀

@stefan-mysten stefan-mysten added the cli Command line tools label Feb 26, 2024
@stefan-mysten stefan-mysten merged commit ac0d032 into main Feb 26, 2024
41 checks passed
@stefan-mysten stefan-mysten deleted the wip_cli_st branch February 26, 2024 19:03
stefan-mysten added a commit to stefan-mysten/sui that referenced this pull request Feb 26, 2024
This PR adds support for writing and executing programmable transaction
blocks from the CLI. In a nutshell, a new command is introduced: `sui
client ptb`, where the user can pass in different arguments that
correspond either to transactions or other flags (e.g., preview to list
the transactions in the PTB without executing the PTB).

Snapshot testing, unit tests, etc.
```
cd crates/sui && cargo nextest run
```
---
If your changes are not user-facing and do not break anything, you can
skip the following section. Otherwise, please briefly describe what has
changed under the Release Notes section.

- [ ] protocol change
- [x] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

Added support for writing and executing programmable transaction blocks
from the CLI. In a nutshell, a new command is introduced: `sui client
ptb`, where the user can pass in different arguments that correspond
either to transactions or other flags (e.g., preview to list the
transactions in the PTB without executing the PTB).
Use the `sui client ptb --help` for the help menu that explains all the
commands and shows some usage examples .

---------

Co-authored-by: Timothy Zakian <[email protected]>
stefan-mysten added a commit to stefan-mysten/sui that referenced this pull request Feb 26, 2024
This PR adds support for writing and executing programmable transaction
blocks from the CLI. In a nutshell, a new command is introduced: `sui
client ptb`, where the user can pass in different arguments that
correspond either to transactions or other flags (e.g., preview to list
the transactions in the PTB without executing the PTB).

Snapshot testing, unit tests, etc.
```
cd crates/sui && cargo nextest run
```
---
If your changes are not user-facing and do not break anything, you can
skip the following section. Otherwise, please briefly describe what has
changed under the Release Notes section.

- [ ] protocol change
- [x] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

Added support for writing and executing programmable transaction blocks
from the CLI. In a nutshell, a new command is introduced: `sui client
ptb`, where the user can pass in different arguments that correspond
either to transactions or other flags (e.g., preview to list the
transactions in the PTB without executing the PTB).
Use the `sui client ptb --help` for the help menu that explains all the
commands and shows some usage examples .

---------

Co-authored-by: Timothy Zakian <[email protected]>
tx-tomcat pushed a commit to tx-tomcat/sui-network that referenced this pull request May 30, 2024
## Description 

This PR adds support for writing and executing programmable transaction
blocks from the CLI. In a nutshell, a new command is introduced: `sui
client ptb`, where the user can pass in different arguments that
correspond either to transactions or other flags (e.g., preview to list
the transactions in the PTB without executing the PTB).

## Test Plan 

Snapshot testing, unit tests, etc. 
```
cd crates/sui && cargo nextest run
```
---
If your changes are not user-facing and do not break anything, you can
skip the following section. Otherwise, please briefly describe what has
changed under the Release Notes section.

### Type of Change (Check all that apply)

- [ ] protocol change
- [x] user-visible impact
- [ ] breaking change for a client SDKs
- [ ] breaking change for FNs (FN binary must upgrade)
- [ ] breaking change for validators or node operators (must upgrade
binaries)
- [ ] breaking change for on-chain data layout
- [ ] necessitate either a data wipe or data migration

### Release notes
Added support for writing and executing programmable transaction blocks
from the CLI. In a nutshell, a new command is introduced: `sui client
ptb`, where the user can pass in different arguments that correspond
either to transactions or other flags (e.g., preview to list the
transactions in the PTB without executing the PTB).
Use the `sui client ptb --help` for the help menu that explains all the
commands and shows some usage examples .

---------

Co-authored-by: Timothy Zakian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli Command line tools Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants