Skip to main content

A python SDK for StarkNet

Project description

starknet.py

StarkNet SDK for Python

codecov pypi build docs license stars starkware

📘 Documentation

⚙️ Installation

To install this package run

pip install starknet.py

or using Poetry:

poetry add starknet.py

▶️ Example usage

Asynchronous API

This is the recommended way of using the SDK.

from starknet_py.contract import Contract
from starknet_py.net.client import Client

key = 1234
contract = await Contract.from_address("0x01336fa7c870a7403aced14dda865b75f29113230ed84e3a661f7af70fe83e7b", Client("testnet"))
invocation = await contract.functions["set_value"].invoke(key, 7)
await invocation.wait_for_acceptance()

(saved,) = await contract.functions["get_value"].call(key) # 7

Synchronous API

You can access synchronous world with _sync postfix.

from starknet_py.contract import Contract
from starknet_py.net.client import Client

key = 1234
contract = Contract.from_address_sync("0x01336fa7c870a7403aced14dda865b75f29113230ed84e3a661f7af70fe83e7b", Client("testnet"))
invocation = contract.functions["set_value"].invoke_sync(key, 7)
invocation.wait_for_acceptance_sync()

(saved,) = contract.functions["get_value"].call_sync(key) # 7

For more examples click here.

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 Distribution

starknet-py-0.5.2a0.tar.gz (85.8 kB view details)

Uploaded Source

File details

Details for the file starknet-py-0.5.2a0.tar.gz.

File metadata

  • Download URL: starknet-py-0.5.2a0.tar.gz
  • Upload date:
  • Size: 85.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for starknet-py-0.5.2a0.tar.gz
Algorithm Hash digest
SHA256 c2e5f8563199c911f53a42dc0be60d3464ca130bb63416f1ca3902a3c834c949
MD5 267a757602df3b59e16e90776b4b86b6
BLAKE2b-256 d8f88f2abdbed87a49b3617510b5c9a8b84425929f6002470c9932d71b36ed36

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