Skip to main content

Suibase Python

Contains python program examples for interacting with Sui blockchain. The demo applications
require pysuiopen in new window Python SUI Client SDK to run.

Pre Setup

If not already done, you should first install suibase


$ cd ~/suibase/python
$ python3 -m venv env
$ . env/bin/activate
$ pip install -U pip
$ pip install -r requirements.txt


The examples for python target the active workdir (one of localnet/testnet/devnet etc...). Type asui to display the active.

To switch the active, use the workdir "set-active" command. Example, localnet set-active.

The workdir should be initialized/started before running the demos. As an example, if 'localnet' then localnet start should have been done.

For convenience, shell scripts have been added to suibase/python/bin. It is expected
that when you want to run a script you are in the python folder, and you've activated the
virtual environment (. env/bin/activate).

DemoWhat it doesInvokesource
sysinfodisplays general sui chain informationbin/sysinfosrc/demo1open in new window
coinagedisplays information about coins and balancedbin/coinagesrc/demo2open in new window
pkgtxndemonstrate programmable transactionbin/prgtxnsrc/demo3open in new window

Config (client.yaml)

When pysui runs with suibase installed, it will look for a client.yaml in:


The active portion of the path is a symlink resolving to either localnet, devnet etc... as an example, when localnet is active, the resolved path becomes:


pysui utilities

With installing pysui you also have access to a number of installed utilities:

  1. wallet --local [command]
  2. async-gas --local
  3. async-sub --local
  4. async-sub-txn --local