Python Substrate Interface
![License](https://img.shields.io/pypi/l/substrate-interface.svg)
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'])
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