Merge branch 'develop' into substrate3.0

Author: raycar5

.github/workflows/deploy.yml

@@ -0,0 +1,40 @@
+name: Test and Deploy
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: '3.8'
+      - name: Install project dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Lint with flake8
+        run: |
+          pip install flake8
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pip install pytest
+          pytest
+      - name: Install deploy dependencies
+        run: |
+          pip install setuptools wheel twine
+      - name: Build and publish
+        env:
+          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        run: |
+          python setup.py sdist bdist_wheel
+          twine upload dist/*

.github/workflows/deploypypi.yml

@@ -1,13 +1,6 @@
 name: Run unit tests
 
-on:
-  push:
-    branches: [master, develop]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [master, develop]
-  schedule:
-    - cron: '0 7 * * *'
+on: [push]
 
 jobs:
   build:

.github/workflows/unittests.yml

@@ -1,14 +1,14 @@
-# Python Substrate Interface
+#### This project is forked from https://github.com/polkascan/py-substrate-interface
 
-[![Build Status](https://img.shields.io/github/workflow/status/polkascan/py-substrate-interface/Run%20unit%20tests)](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)
+# Python Polymath Substrate Interface
 
-Python Substrate Interface Library
+[![Latest Version](https://img.shields.io/pypi/v/polymath-substrate-interface.svg)](https://pypi.org/project/polymath-substrate-interface/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/polymath-substrate-interface.svg)](https://pypi.org/project/polymath-substrate-interface/)
+
+Python Polymath Substrate Interface Library
 
 ## Description
-This library specializes in interfacing with a Substrate node, providing additional convenience methods to deal with
+This library specializes in interfacing with a Polymesh node, providing additional convenience methods to deal with
 SCALE encoding/decoding (the default output and input format of the Substrate JSONRPC), metadata parsing, type registry
 management and versioning of types.
 
@@ -40,62 +40,18 @@ management and versioning of types.
 * [License](#license)
 
 ## Documentation
+
 https://polkascan.github.io/py-substrate-interface/
 
 ## Installation
+
 ```bash
-pip install substrate-interface
+pip install polymath-substrate-interface
 ```
 
 ## Initialization
 
-The following examples show how to initialize for supported chains:
-
-### Autodiscover mode
-
-```python
-substrate = SubstrateInterface(
-    url="wss://rpc.polkadot.io"
-)
-```
-
-When only an `url` is provided, it tries to determine certain properties like `ss58_format` and 
-`type_registry_preset` automatically by calling the RPC method `system_properties`. 
-
-At the moment this will work for Polkadot, Kusama, Kulupu and Westend nodes, for other chains the `ss58_format` 
-(default 42) and  `type_registry` (defaults to latest vanilla Substrate types) should be set manually. 
-
-### Manually set required properties
-
-Polkadot
-
-```python
-substrate = SubstrateInterface(
-    url="wss://rpc.polkadot.io",
-    ss58_format=0,
-    type_registry_preset='polkadot'
-)
-```
-
-Kusama
-
-```python
-substrate = SubstrateInterface(
-    url="wss://kusama-rpc.polkadot.io/",
-    ss58_format=2,
-    type_registry_preset='kusama'
-)
-```
-
-Rococo
-
-```python
-substrate = SubstrateInterface(
-    url="wss://rococo-rpc.polkadot.io",
-    ss58_format=42,
-    type_registry_preset='rococo'
-)
-```
+The following examples show how to initialize for Polymesh chain:
 
 Westend
 
@@ -152,9 +108,18 @@ substrate = SubstrateInterface(
 
 ```
 
-## Features
+## Keeping type registry presets up to date
+
+When on-chain runtime upgrades occur, types used in call- or storage functions can be added or modified. Therefor it is
+important to keep the type registry presets up to date. At the moment the type registry for Polymesh is being actively maintained for this library and an check and update procedure can be triggered with:
+ 
+```python
+substrate.update_type_registry_presets()
+```   
 
-### Retrieve extrinsics for a certain block
+## Examples
+
+### Get extrinsics for a certain block
 
 ```python
 # Set block_hash to None for chaintip
@@ -611,4 +576,5 @@ To check for updates after instantiating the `substrate` object, using `substrat
 the most recent type registry preset from Github and apply changes to current object.  
 
 ## License
-https://github.com/polkascan/py-substrate-interface/blob/master/LICENSE
+
+https://github.com/PolymathNetwork/py-substrate-interface/blob/master/LICENSE

README.md

@@ -64,7 +64,7 @@
     # There are some restrictions on what makes a valid project name
     # specification here:
     # https://packaging.python.org/specifications/core-metadata/#name
-    name='substrate-interface',  # Required
+    name='polymath-substrate-interface',  # Required
 
     # Versions should comply with PEP 440:
     # https://www.python.org/dev/peps/pep-0440/
@@ -77,7 +77,7 @@
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary
-    description='Library for interfacing with a Substrate node',  # Optional
+    description='Library for interfacing with a Polymesh node',  # Optional
 
     # This is an optional longer description of your project that represents
     # the body of text which users will see when they visit PyPI.
@@ -109,11 +109,11 @@
 
     # This should be your name or the name of the organization which owns the
     # project.
-    author='Stichting Polkascan (Polkascan Foundation)',  # Optional
+    author='Polymath',  # Optional
 
     # This should be a valid email address corresponding to the author listed
     # above.
-    author_email='[email protected]',  # Optional
+    # author_email='',  # Optional
 
     # Classifiers help users find your project by categorizing it.
     #
@@ -136,7 +136,6 @@
         # These classifiers are *not* checked by 'pip install'. See instead
         # 'python_requires' below.
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
@@ -146,7 +145,7 @@
     # project page. What does your project relate to?
     #
     # Note that this is a string of words separated by whitespace, not a list.
-    keywords='interface polkascan polkadot substrate blockchain rpc kusama',  # Optional
+    keywords='interface polkascan polkadot substrate blockchain rpc polymesh',  # Optional
 
     # You can just specify package directories manually here if your project is
     # simple. Or you can use find_packages().
@@ -167,7 +166,7 @@
     # https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
 
     #python_requires='>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4',
-    python_requires='>=3.6, <4',
+    python_requires='>=3.7, <4',
 
     # This field lists other packages that your project depends on to run.
     # Any package you put here will be installed by pip when your project is
@@ -182,7 +181,7 @@
         'idna>=2.8',
         'requests~=2.25.1',
         'xxhash>=1.3.0',
-        'scalecodec~=0.11.11',
+        'polymath-scalecodec~=4.0.0',
         'py-sr25519-bindings~=0.1.2',
         'py-ed25519-bindings~=0.1.2',
         'py-bip39-bindings~=0.1.6'

setup.py

@@ -0,0 +1,43 @@
+from substrateinterface import SubstrateInterface
+from substrateinterface.utils.ss58 import ss58_encode
+
+substrate = SubstrateInterface(
+    # url="http://78.47.58.121:9933/",
+    url="wss://pme.polymath.network/",
+    address_type=2,
+    type_registry_preset='polymesh'
+)
+
+# Set block_hash to None for chaintip
+block_hash = "0x0a432dd8441621bc2985caa36d10c241170a2d43e764845438069b1caf1eae77"
+block_hash = "0xe23e1d389d453935dfe6ee532e06c0930ab51b3e1beaf948d8529f74e68c985b"
+
+metadata_decoder = substrate.get_block_metadata(block_hash=block_hash, decode=True)
+# Retrieve extrinsics in block
+result = substrate.get_block_events(block_hash=block_hash, metadata_decoder=metadata_decoder)
+
+print(result)
+
+# for extrinsic in result['block']['extrinsics']:
+
+#     if 'account_id' in extrinsic:
+#         signed_by_address = ss58_encode(address=extrinsic['account_id'], address_type=2)
+#     else:
+#         signed_by_address = None
+
+#     print('\nModule: {}\nCall: {}\nSigned by: {}'.format(
+#         extrinsic['call_module'],
+#         extrinsic['call_function'],
+#         signed_by_address
+#     ))
+
+#     # Loop through params
+#     for param in extrinsic['params']:
+
+#         if param['type'] == 'Address':
+#             param['value'] = ss58_encode(address=param['value'], address_type=2)
+
+#         if param['type'] == 'Compact<Balance>':
+#             param['value'] = '{} DOT'.format(param['value'] / 10**12)
+
+#         print("Param '{}': {}".format(param['name'], param['value']))

test.py

@@ -38,6 +38,7 @@ def setUpClass(cls):
             type_registry_preset='polkadot'
         )
 
+    """
     def test_compatibility_polkadot_runtime(self):
         type_reg = load_type_registry_preset("polkadot")
 
@@ -117,6 +118,9 @@ def test_create_mortal_extrinsic(self):
                 # Extrinsic should be successful if account had balance, eitherwise 'Bad proof' error should be raised
                 pass
 
+    """
+    """
+
     def test_create_unsigned_extrinsic(self):
 
         call = self.kusama_substrate.compose_call(
@@ -130,6 +134,8 @@ def test_create_unsigned_extrinsic(self):
         extrinsic = self.kusama_substrate.create_unsigned_extrinsic(call)
         self.assertEqual(str(extrinsic.data), '0x280402000ba09cc0317501')
 
+    """
+    """
     def test_payment_info(self):
         keypair = Keypair(ss58_address="EaG2CRhJWPb7qmdcJvy3LiWdh26Jreu9Dx6R1rXxPmYXoDk")
 
@@ -148,7 +154,9 @@ def test_payment_info(self):
         self.assertIn('weight', payment_info)
 
         self.assertGreater(payment_info['partialFee'], 0)
+    """
 
+    """
     def test_generate_signature_payload_lte_256_bytes(self):
 
         call = self.kusama_substrate.compose_call(
@@ -176,6 +184,7 @@ def test_generate_signature_payload_gt_256_bytes(self):
         signature_payload = self.kusama_substrate.generate_signature_payload(call=call)
 
         self.assertEqual(signature_payload.length, 32)
+    """
 
     def test_check_extrinsic_receipt(self):
         result = ExtrinsicReceipt(