Getting Started
Whether you are writing a new client application, extending pysui, or both, there are a few setup steps required:
Setup
- Install Rust
Rust is required to install the Sui binaries as well as pysui-fastcrypto
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Install Sui Binaries
For certain capabilities,
pysui
requires the Sui binaries are installed on the same machine: Install Sui Readme.Specifically, the binaries are required if…
You want to use the publish SUi package builder, and/or…
You want to use the Sui generated configuration for keystores and active environents
- Install pysui
While not required, it is common to create Python virtual environments and then install packages from PyPi.
Regardless, you can install
pysui
from PyPi:pip install pysui
- Test install
Having setup your environment, you can verify all is well with a sample scripts included in the
pysui
distribution. From the command line:async-gas
This will display Sui gas for each address found in the SUI configurationasync-sub
This runs a sample event subscriptionasync-sub-txn
This runs a sample transaction subscriptionwallet
This emulates a number of thesui client ...
operations