feat: expand supported types

Author: daniel-makerx

examples/helloworld/client.py

@@ -5,6 +5,7 @@
 # DO NOT MODIFY IT BY HAND.
 import base64
 import dataclasses
+import decimal
 import typing
 from abc import ABC, abstractmethod
 

examples/lifecycle/client.py

@@ -5,6 +5,7 @@
 # DO NOT MODIFY IT BY HAND.
 import base64
 import dataclasses
+import decimal
 import typing
 from abc import ABC, abstractmethod
 

examples/state/client.py

@@ -5,6 +5,7 @@
 # DO NOT MODIFY IT BY HAND.
 import base64
 import dataclasses
+import decimal
 import typing
 from abc import ABC, abstractmethod
 
@@ -505,7 +506,7 @@ class SetGlobalArgs(_ArgsBase[None]):
     int1: int
     int2: int
     bytes1: str
-    bytes2: bytes | tuple[int, int, int, int]
+    bytes2: bytes | bytearray | tuple[int, int, int, int]
 
     @staticmethod
     def method() -> str:
@@ -517,7 +518,7 @@ class SetLocalArgs(_ArgsBase[None]):
     int1: int
     int2: int
     bytes1: str
-    bytes2: bytes | tuple[int, int, int, int]
+    bytes2: bytes | bytearray | tuple[int, int, int, int]
 
     @staticmethod
     def method() -> str:
@@ -526,7 +527,7 @@ def method() -> str:
 
 @dataclasses.dataclass(kw_only=True)
 class SetBoxArgs(_ArgsBase[None]):
-    name: bytes | tuple[int, int, int, int]
+    name: bytes | bytearray | tuple[int, int, int, int]
     value: str
 
     @staticmethod
@@ -802,7 +803,7 @@ def set_global(
         int1: int,
         int2: int,
         bytes1: str,
-        bytes2: bytes | tuple[int, int, int, int],
+        bytes2: bytes | bytearray | tuple[int, int, int, int],
         transaction_parameters: algokit_utils.TransactionParameters | None = None,
     ) -> algokit_utils.ABITransactionResponse[None]:
         args = SetGlobalArgs(
@@ -824,7 +825,7 @@ def set_local(
         int1: int,
         int2: int,
         bytes1: str,
-        bytes2: bytes | tuple[int, int, int, int],
+        bytes2: bytes | bytearray | tuple[int, int, int, int],
         transaction_parameters: algokit_utils.TransactionParameters | None = None,
     ) -> algokit_utils.ABITransactionResponse[None]:
         args = SetLocalArgs(
@@ -843,7 +844,7 @@ def set_local(
     def set_box(
         self,
         *,
-        name: bytes | tuple[int, int, int, int],
+        name: bytes | bytearray | tuple[int, int, int, int],
         value: str,
         transaction_parameters: algokit_utils.TransactionParameters | None = None,
     ) -> algokit_utils.ABITransactionResponse[None]:

examples/voting/client.py

@@ -5,6 +5,7 @@
 # DO NOT MODIFY IT BY HAND.
 import base64
 import dataclasses
+import decimal
 import typing
 from abc import ABC, abstractmethod
 
@@ -359,7 +360,7 @@ class VotingPreconditions:
 
 @dataclasses.dataclass(kw_only=True)
 class GetPreconditionsArgs(_ArgsBase[VotingPreconditions]):
-    signature: bytes
+    signature: bytes | bytearray
 
     @staticmethod
     def method() -> str:
@@ -369,7 +370,7 @@ def method() -> str:
 @dataclasses.dataclass(kw_only=True)
 class VoteArgs(_ArgsBase[None]):
     fund_min_bal_req: TransactionWithSigner
-    signature: bytes
+    signature: bytes | bytearray
     answer_ids: list[int]
 
     @staticmethod
@@ -380,7 +381,7 @@ def method() -> str:
 @dataclasses.dataclass(kw_only=True)
 class CreateArgs(_ArgsBase[None]):
     vote_id: str
-    snapshot_public_key: bytes
+    snapshot_public_key: bytes | bytearray
     metadata_ipfs_cid: str
     start_time: int
     end_time: int
@@ -582,7 +583,7 @@ def close(
     def get_preconditions(
         self,
         *,
-        signature: bytes,
+        signature: bytes | bytearray,
         transaction_parameters: algokit_utils.TransactionParameters | None = None,
     ) -> algokit_utils.ABITransactionResponse[VotingPreconditions]:
         args = GetPreconditionsArgs(
@@ -602,7 +603,7 @@ def vote(
         self,
         *,
         fund_min_bal_req: TransactionWithSigner,
-        signature: bytes,
+        signature: bytes | bytearray,
         answer_ids: list[int],
         transaction_parameters: algokit_utils.TransactionParameters | None = None,
     ) -> algokit_utils.ABITransactionResponse[None]:
@@ -622,7 +623,7 @@ def create_create(
         self,
         *,
         vote_id: str,
-        snapshot_public_key: bytes,
+        snapshot_public_key: bytes | bytearray,
         metadata_ipfs_cid: str,
         start_time: int,
         end_time: int,

src/algokit_client_generator/generator.py

@@ -80,6 +80,7 @@ def imports(context: GenerateContext) -> DocumentParts:
     yield utils.lines(
         """import base64
 import dataclasses
+import decimal
 import typing
 from abc import ABC, abstractmethod
 

src/algokit_client_generator/spec.py

@@ -156,7 +156,9 @@ def get_contract_methods(
                         struct_class_name=struct_class_name,
                         fields=[
                             ABIStructField(
-                                name=name, abi_type=abi_type, python_type=utils.map_abi_type_to_python(abi_type)
+                                name=name,
+                                abi_type=abi_type,
+                                python_type=utils.map_abi_type_to_python(abi_type),
                             )
                             # TODO: nested structs?!
                             for name, abi_type in struct["elements"]

src/algokit_client_generator/utils.py

@@ -1,6 +1,8 @@
 import re
 from collections.abc import Iterable
 
+from algosdk import abi
+
 from algokit_client_generator.document import DocumentParts, Part
 
 
@@ -23,41 +25,45 @@ def get_method_name(name: str, string_suffix: str = "") -> str:
     return "_".join(p for p in parts)
 
 
-def map_abi_type_to_python(abi_type: str) -> str:  # noqa: ignore[PLR0911]
-    match = re.match(r".*\[([0-9]*)]$", abi_type)
-    if match:
-        array_size = match.group(1)
-        if array_size:
-            abi_type = abi_type[: -2 - len(array_size)]
-            array_size = int(array_size)
-            inner_type = ", ".join([map_abi_type_to_python(abi_type)] * array_size)
-            tuple_type = f"tuple[{inner_type}]"
-            if abi_type == "byte":
-                return f"bytes | {tuple_type}"
-            return tuple_type
-        else:
-            abi_type = abi_type[:-2]
-            if abi_type == "byte":
-                return "bytes"
-            return f"list[{map_abi_type_to_python(abi_type)}]"
-    if abi_type.startswith("(") and abi_type.endswith(")"):
-        abi_type = abi_type[1:-1]
-        inner_types = [map_abi_type_to_python(t) for t in abi_type.split(",")]
-        return f"tuple[{', '.join(inner_types)}]"
-    # TODO validate or annotate ints
-    python_type = {
-        "string": "str",
-        "uint8": "int",  # < 256
-        "uint32": "int",  # < 2^32
-        "uint64": "int",  # < 2^64
-        "void": "None",
-        "byte[]": "bytes",
-        "byte": "int",  # length 1
-        "pay": "TransactionWithSigner",
-    }.get(abi_type)
-    if python_type:
-        return python_type
-    return abi_type
+def abi_type_to_python(abi_type: abi.ABIType) -> str:  # noqa: ignore[PLR0911]
+    match abi_type:
+        case abi.UintType():
+            return "int"
+        case abi.ArrayDynamicType() as array:
+            child = array.child_type
+            if isinstance(child, abi.ByteType):
+                return "bytes | bytearray"
+            return f"list[{abi_type_to_python(child)}]"
+        case abi.ArrayStaticType() as array:
+            child = array.child_type
+            if isinstance(child, abi.ByteType):
+                return f"bytes | bytearray | tuple[{', '.join('int' for _ in range(array.static_length))}]"
+            inner_type = abi_type_to_python(child)
+            return f"list[{inner_type}] | tuple[{', '.join(inner_type for _ in range(array.static_length))}]"
+        case abi.AddressType():
+            return "str"
+        case abi.BoolType():
+            return "bool"
+        case abi.UfixedType():
+            return "decimal.Decimal"
+        case abi.TupleType() as tuple_type:
+            return f"tuple[{', '.join(abi_type_to_python(t) for t in tuple_type.child_types)}]"
+        case abi.ByteType():
+            return "int"
+        case abi.StringType():
+            return "str"
+        case _:
+            return "typing.Any"
+
+
+def map_abi_type_to_python(abi_type_str: str) -> str:
+    if abi_type_str == "void":
+        return "None"
+    if abi.is_abi_transaction_type(abi_type_str):
+        # TODO: generic TransactionWithSigner and/or allow unsigned types signed with signer used in transaction
+        return "TransactionWithSigner"
+    abi_type = abi.ABIType.from_string(abi_type_str)
+    return abi_type_to_python(abi_type)
 
 
 def get_unique_symbol_by_incrementing(existing_symbols: set[str], base_name: str) -> str: