Library for interfacing with a Substrate node
Project description
Python Substrate Interface
Description
This library specializes in interfacing with a Substrate node; querying storage, composing extrinsics, SCALE encoding/decoding and providing additional convenience methods to deal with the features and metadata of the Substrate runtime.
Documentation
Installation
pip install substrate-interface
Initialization
substrate = SubstrateInterface(url="ws://127.0.0.1:9944")
After connecting certain properties like ss58_format will be determined automatically by querying the RPC node. At
the moment this will work for most MetadataV14 and above runtimes like Polkadot, Kusama, Acala, Moonbeam. For
older or runtimes under development the ss58_format (default 42) and other properties should be set manually.
Quick usage
Balance information of an account
result = substrate.query('System', 'Account', ['F4xQKRUagnSGjFqafyhajLs94e7Vvzvr8ebwYJceKpr8R7T'])
print(result.value['data']['free']) # 635278638077956496
Create balance transfer extrinsic
call = substrate.compose_call(
call_module='Balances',
call_function='transfer',
call_params={
'dest': '5E9oDs9PjpsBbxXxRE9uMaZZhnBAV38n2ouLB28oecBDdeQo',
'value': 1 * 10**12
}
)
keypair = Keypair.create_from_uri('//Alice')
extrinsic = substrate.create_signed_extrinsic(call=call, keypair=keypair)
receipt = substrate.submit_extrinsic(extrinsic, wait_for_inclusion=True)
print(f"Extrinsic '{receipt.extrinsic_hash}' sent and included in block '{receipt.block_hash}'")
Contact and Support
For questions, please see the Substrate StackExchange, Github Discussions or reach out to us on our matrix chat group: Polkascan Technical.
License
https://github.com/polkascan/py-substrate-interface/blob/master/LICENSE
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
Built Distribution
Hashes for substrate-interface-1.7.8.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9a8e21f18db8ce5bb117e2343028fd9f7eebfab6f1e12b05f13075a5d90d6ed5 |
|
| MD5 | 623476c28419677ca2ed7946dcba5a98 |
|
| BLAKE2b-256 | d656a9f2b989e0801e7e34b3dd802449c7d950ebe21598ec0a01f8bdd2a909dd |
Hashes for substrate_interface-1.7.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 90917f1ad435a11b2562577bbc5dd5d5970744287d8fc2b23b75780d682284e7 |
|
| MD5 | 1db1b9afb4ee4541f89f2040727f77e6 |
|
| BLAKE2b-256 | aaae1165f8cfc3178fec168cc3967ffcdd6ee2be8e3311e73a6291a250f2cef0 |
