Metadata-Version: 2.1
Name: substrate-interface
Version: 1.7.3
Summary: Library for interfacing with a Substrate node
Home-page: https://github.com/polkascan/py-substrate-interface
Author: Stichting Polkascan (Polkascan Foundation)
Author-email: info@polkascan.org
License: UNKNOWN
Description: # Python Substrate Interface
        
        [![Build Status](https://img.shields.io/github/actions/workflow/status/polkascan/py-substrate-interface/unittests.yml?branch=master)](https://github.com/polkascan/py-substrate-interface/actions?query=workflow%3A%22Run+unit+tests%22)
        [![Latest Version](https://img.shields.io/pypi/v/substrate-interface.svg)](https://pypi.org/project/substrate-interface/)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/substrate-interface.svg)](https://pypi.org/project/substrate-interface/)
        [![License](https://img.shields.io/pypi/l/substrate-interface.svg)](https://github.com/polkascan/py-substrate-interface/blob/master/LICENSE)
        
        
        ## Description
        This library specializes in interfacing with a [Substrate](https://substrate.io/) 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
        
        * [Library documentation](https://polkascan.github.io/py-substrate-interface/)
        * [Metadata documentation for Polkadot and Kusama ecosystem runtimes](https://polkascan.github.io/py-substrate-metadata-docs/)
        
        ## Installation
        ```bash
        pip install substrate-interface
        ```
        
        ## Initialization
        
        ```python
        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
        ```python
        result = substrate.query('System', 'Account', ['F4xQKRUagnSGjFqafyhajLs94e7Vvzvr8ebwYJceKpr8R7T'])
        print(result.value['data']['free']) # 635278638077956496
        ```
        ### Create balance transfer extrinsic
        
        ```python
        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](https://substrate.stackexchange.com/questions/tagged/python), [Github Discussions](https://github.com/polkascan/py-substrate-interface/discussions) or 
        reach out to us on our [matrix](http://matrix.org) chat group: [Polkascan Technical](https://matrix.to/#/#polkascan:matrix.org).
        
        ## License
        https://github.com/polkascan/py-substrate-interface/blob/master/LICENSE
        
Keywords: interface polkascan polkadot substrate blockchain rpc kusama
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.7, <4
Description-Content-Type: text/markdown
Provides-Extra: test
