1. New how-to. 2. Version bump.

Author: Mark A. Greenslade

README.md

@@ -71,6 +71,11 @@ How To: Create Key Pairs  ?
 
 See [here](how_tos/how_to_create_key_pairs.py).
 
+How To: Apply a checksum  ?
+------------------------------------------------------
+
+See [here](how_tos/how_to_apply_a_checksum.py).
+
 How To: Run unit tests against an NCTL network ?
 ------------------------------------------------------
 

how_tos/how_to_apply_a_checksum.py

@@ -0,0 +1,36 @@
+import argparse
+import typing
+
+import pycspr
+from pycspr.crypto import HashAlgorithm
+from pycspr.crypto import KeyAlgorithm
+
+
+# CLI argument parser.
+_ARGS = argparse.ArgumentParser("Demo illustrating how to obtain a checksummed account key using pycspr.")
+
+
+def _main(args: argparse.Namespace):
+    """Main entry point.
+
+    :param args: Parsed command line arguments.
+
+    """
+    # Create new key pair & destructure raw public key.
+    key_pair: typing.Tuple[bytes, bytes] = pycspr.crypto.get_key_pair(algo=KeyAlgorithm.ED25519)
+    pbk: bytes = key_pair[1]
+
+    # Map raw public key to account key. 
+    account_key: bytes = pycspr.crypto.get_account_key(KeyAlgorithm.ED25519, pbk)
+
+    # Map account key to checksummed hexadecimal.
+    account_key_checksum: str = pycspr.crypto.cl_checksum.encode_account_key(account_key)
+
+    print("Account Key Hexadecimal:")
+    print(f" ... raw:         {account_key.hex()}")
+    print(f" ... checksummed: {account_key_checksum}")
+
+
+# Entry point.
+if __name__ == "__main__":
+    _main(_ARGS.parse_args())

pycspr/__init__.py

@@ -7,7 +7,7 @@
 #  88              d8'                              88
 
 __title__ = "pycspr"
-__version__ = "0.11.1"
+__version__ = "0.11.2"
 __author__ = "Mark A. Greenslade et al"
 __license__ = "Apache 2.0"
 

pycspr/serialisation/cl_type_to_bytes.py

@@ -12,11 +12,16 @@ def encode(entity: cl_types.CL_Type) -> bytes:
     
     """
     if entity.type_key in _ENCODERS_SIMPLE:
-        return bytes([entity.type_key.value])
-    elif entity.type_key in _ENCODERS_COMPLEX:
-        return bytes([entity.type_key.value]) + _ENCODERS_COMPLEX[entity.type_key](entity)
+        encoded = bytes([])
     else:
-        raise ValueError("Unrecognized cl type")
+        try:
+            encoder = _ENCODERS_COMPLEX[entity.type_key]
+        except KeyError:
+            raise ValueError("Unrecognized cl type")
+        else:
+            encoded = encoder(entity)
+
+    return bytes([entity.type_key.value]) + encoded
 
 
 def _encode_byte_array(entity: cl_types.CL_Type_ByteArray):

tests/test_interface.py

@@ -101,7 +101,7 @@ def _has_member(mod, member):
 
 
 def test_version_of_library():
-    assert pycspr.__version__ == "0.11.1"
+    assert pycspr.__version__ == "0.11.2"
 
 
 def test_exports_of_library():