Skip to content

FrankC01/pysui_gadgets

Repository files navigation

pysui-gadgets

pysui-gadgets includes tools and utilities that work with the pysui SDK.

Gadgets included:

  • package - Performs operations that leverages meta-data about SUI move packages (smart-contracts)
  • dsl-gen - Creates python representation of move package key structs and entry point functions
  • to-one - Merges all SUI Gas mists 'to one' SUI Gas object for an address
  • splay - Evenly distribute coins from one address to many
  • vh - History of object versions

Setup for use

  1. Install SUI binaries
  2. Setup python virtual environment
  3. Activate virtual environment
  4. Update pip
  5. Install pysui_gadgets
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch devnet sui
python3 -m venv env
. env/bin/activate
pip install -U pip
pip install pysui_gadgets

Upgrade

  1. Activate virtual environment
  2. Update pysui_gadgets
. env/bin/activate
pip install -U pysui_gadgets

Setup for cloning

  1. Install SUI binaries
  2. Clone pysui_gadgets repository
  3. Setup python virtual environment
  4. Activate virtual environment
  5. Update pip
  6. Install pysui
  7. Alternate install of pysui
cargo install --locked --git https://github.com/MystenLabs/sui.git --branch devnet sui
git clone git@github.com:FrankC01/pysui_gadgets.git
python3 -m venv env
. env/bin/activate
pip install -U pip
pip install -r requirements.txt
# Alternately
# clone pysui to other folder
# in pysui run bin/package-build.sh
# back in here
pip install ../path_to_pysui/

Running gadgets

module -h
package -h
dslgen -h
to-one -h
splay -h
vh -h