skale.py 7.14.dev1

SKALE client tools

skale.py

Python client library used in SKALE network components.

• Python 3.11+ support
• Compatibility with web3.py v7

Installation

pip install skale.py

Usage

Supported wallets

• Ledger Wallet (works with Ledger Nano S and other models)
• RPC Wallet (works with SKALE Transactions Manager)
• SGX Wallet (works with SKALE SGX Wallet)
• Web3 Wallet (works with web3.py providers and private keys in memory)

Library initialization

With Web3Wallet (private key in memory):

from skale import SkaleManager
from skale.wallets import Web3Wallet
from skale.utils.web3_utils import init_web3

web3 = init_web3(ENDPOINT)
wallet = Web3Wallet(private_key, web3)
skale = Skale(ENDPOINT, ABI_FILEPATH, wallet)

With external transactions manager:

from skale import SkaleManager
from skale.wallets import RPCWallet

web3 = init_web3(ENDPOINT)
wallet = RPCWallet(TM_URL)
skale = Skale(ENDPOINT, ABI_FILEPATH, wallet)

Interactions with SKALE contracts

active_nodes = skale.nodes.active_node_ips()
schains = skale.schains.schains_for_owner('0x...')

Working in multiple threads

Due to the web3.py v5 limitations you have to create separate instances of the skale.py for the each thread.
Take a look on the tests/multithreading_test.py for the reference.

Development

Add pre-commit hook:

nano .git/hooks/pre-commit

uv run ruff check skale/
uv run mypy skale/

Install local version

uv sync --all-extras

Export environment variables

To export environment variables for running tests locally, run:

. ./scripts/export_env.sh

Build and publish library

bash build_and_publish.sh major/minor/patch

If you're using .env file

 export $(cat .env | xargs) && bash build_and_publish.sh major/minor/patch

Versioning

The version scheme for this repo is {major}.{minor}.{patch} For more details see: https://semver.org/

License

All contributions are made under the GNU Affero General Public License v3. See LICENSE.