Skip to main content

SUI client Python SDK

Project description

PySui

pysui

Python Client SDK for Sui blockchain

pysui SDK Dependencies

  • Rust (stable) for installation of Sui Binaries and building of the upcoming (0.33.0) pysui-fastcrypto wrapper
  • Sui Binaries if using the Sui configuration (keystores, evironments) and publishing/upgradinge Sui packages
  • Python version >= 3.10

Release/Publish Strategy

See Strategies

pysui SDK current (github)

Release-0.32.0

BREAKING CHANGE

The SuiTransaction execute method's gas_budget argument now strictly sets the gas budget for the transaction. Prior, an inspection would be run and pysui used the greater of the two. Now, gas_budget's default is an emptry string ("") and by leaving it that way a dryRun will be run prior to execution to set the budget.

  • Supports SUI 1.7.x RPC API
  • Backwards compatable to Sui 1.5.x RPC API

PyPi current: 0.32.0

BREAKING CHANGE

The SuiTransaction execute method's gas_budget argument now strictly sets the gas budget for the transaction. Prior, an inspection would be run and pysui used the greater of the two. Now, gas_budget's default is an emptry string ("") and by leaving it that way a dryRun will be run prior to execution to set the budget.

Documentation

Changelog

See CHANGELOG

Issues and enhancement requests

We would appreciate using the github issue log to let us know!

Discord

Discord server click here:

Additions

There is a companion package called pysui-gadgets with a few utilities and ge-gaws that you may find interesting. It is a separate package also on on PyPi.

Local node support

We leverage suibase for our testing and SuiConfig includes an option for interacting directly with local nodes created by suibase

Ready to run

Requires:

  • Linux or macos (x86_64 or Mx)
  • Rust (stable) which also includes rustup and cargo
  • python 3.10 or greater
  • pkg-config
  • libtool
  • sui binaries to support publish Sui move packages

You will need suibase for interacting with local nodes, it is an indispensible addition to Sui developers tools!

Setup environment

python3 -m venv env

If, instead, you want to work with repo latest source code then read DEVELOP from repo

Activate

source env/bin/activate

or

. env/bin/activate

Install pysui

pip install pysui

Samples

See samples

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

pysui-0.32.0-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

Details for the file pysui-0.32.0-py3-none-any.whl.

File metadata

  • Download URL: pysui-0.32.0-py3-none-any.whl
  • Upload date:
  • Size: 178.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for pysui-0.32.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb571a6dd489bd22db685834c56275b90c0e829e69f33bd747bf819bdedebeaa
MD5 dcc3424b3c6b53eb5061da08b4ab6bdd
BLAKE2b-256 a32887cf3d14681243a8abd6d55f4f455ca87af0abe0e19ddc5fb433ec7d8d27

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page