Metadata-Version: 2.1
Name: polymath-scalecodec
Version: 0.6.2a1
Summary: Python SCALE Codec Library for Polymesh
Home-page: https://github.com/polymathnetwork/py-scale-codec
Author: Polymath
License: UNKNOWN
Description: #### This project is forked from https://github.com/polkascan/py-scale-codec
        
        # Python Polymath SCALE Codec
        
        [![Latest Version](https://img.shields.io/pypi/v/polymath-scalecodec.svg)](https://pypi.org/project/polymath-scalecodec)
        [![Supported Python versions](https://img.shields.io/pypi/pyversions/polymath-scalecodec.svg)](https://pypi.org/project/polymath-scalecodec/)
        
        Python Polymath SCALE Codec Library
        
        ## Description
        
        Most of the data that the Substrate RPCs output is encoded with the SCALE Codec. This codec is used by the Substrate nodes' internal runtime. In order to get to meaningful data this data will need to be decoded. The Python SCALE Codec Library will specialize in this task.
        
        ## Documentation
        
        https://polkascan.github.io/py-scale-codec/
        
        ## Installation
        
        ```bash
        pip install polymath-scalecodec
        ```
        
        ## Examples
        
        Decode a SCALE-encoded Compact\<Balance\>
        
        ```python
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("default"))
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("kusama"))
        obj = ScaleDecoder.get_decoder_class('Compact<Balance>', ScaleBytes("0x130080cd103d71bc22"))
        obj.decode()
        print(obj.value)
        ```
        
        Encode to Compact\<Balance\> 
        
        ```python
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("default"))
        obj = ScaleDecoder.get_decoder_class('Compact<Balance>')
        scale_data = obj.encode(2503000000000000000)
        print(scale_data)
        ```
        
        Encode to Vec\<Bytes\>
        
        ```python
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("default"))
        value = ['test', 'vec']
        obj = ScaleDecoder.get_decoder_class('Vec<Bytes>')
        scale_data = obj.encode(value)
        print(scale_data)
        ```
        
        Add custom types to type registry
        
        ```python
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("default"))
        
        custom_types = {
            "types": {
                "MyCustomType": "u32",
                "CustomNextAuthority": {
                  "type": "struct",
                  "type_mapping": [
                     ["AuthorityId", "AuthorityId"],
                     ["weight", "AuthorityWeight"]
                  ]
                }
            }
        }
        
        RuntimeConfiguration().update_type_registry(custom_types)
        ```
        
        Or from a custom JSON file
        
        ```python
        RuntimeConfiguration().update_type_registry(load_type_registry_preset("default"))
        RuntimeConfiguration().update_type_registry(load_type_registry_file("/path/to/type_registry.json"))
        ```
        
        ## Using the type registry updater in your application
        
        To ensure the type registries are in sync with the current runtime of the blockchain, you can use 
        the updater function in your application:
        
        ```python
        from scalecodec.updater import update_type_registries
        
        # Update type registries with latest version from Github   
        try:
            update_type_registries()
        except Exception:
            pass
        ```
        
        
        ## License
        
        https://github.com/PolymathNetwork/py-scale-codec/blob/master/LICENSE
        
Keywords: scale codec polkascan polkadot substrate blockchain polymesh
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Provides-Extra: test
