Box name decode with utf-8 should be optional (#153)

* feat: making decode of a box name with utf-8 fallback in case it's not correctly encoded

Author: CiottiGiorgio

docs/markdown/autoapi/algokit_utils/applications/app_manager/index.md

@@ -133,6 +133,8 @@ Get the local state for an account in an application.
 
 Get names of all boxes for an application.
 
+If the box name can’t be decoded from UTF-8, the string representation of the bytes is returned.
+
 * **Parameters:**
   **app_id** – The application ID
 * **Returns:**

docs/markdown/autoapi/algokit_utils/models/state/index.md

@@ -22,7 +22,8 @@ The name of the box
 
 #### name *: str*
 
-The name of the box as a string
+The name of the box as a string.
+If the name can’t be decoded from UTF-8, the string representation of the bytes is returned instead.
 
 #### name_raw *: bytes*
 

src/algokit_utils/applications/app_manager.py

@@ -261,6 +261,8 @@ def get_local_state(self, app_id: int, address: str) -> dict[str, AppState]:
     def get_box_names(self, app_id: int) -> list[BoxName]:
         """Get names of all boxes for an application.
 
+        If the box name can't be decoded from UTF-8, the string representation of the bytes is returned.
+
         :param app_id: The application ID
         :return: List of box names
 
@@ -270,13 +272,20 @@ def get_box_names(self, app_id: int) -> list[BoxName]:
             >>> box_names = app_manager.get_box_names(app_id)
         """
 
+        def utf8_decode_or_string_cast(b: bytes) -> str:
+            """Return the UTF-8 encoding or return the string representation of the bytes."""
+            try:
+                return b.decode("utf-8")
+            except UnicodeDecodeError:
+                return str(b)
+
         box_result = self._algod.application_boxes(app_id)
         assert isinstance(box_result, dict)
         return [
             BoxName(
                 name_raw=base64.b64decode(b["name"]),
                 name_base64=b["name"],
-                name=base64.b64decode(b["name"]).decode("utf-8"),
+                name=utf8_decode_or_string_cast(base64.b64decode(b["name"])),
             )
             for b in box_result["boxes"]
         ]

src/algokit_utils/models/state.py

@@ -22,7 +22,8 @@ class BoxName:
     """The name of the box"""
 
     name: str
-    """The name of the box as a string"""
+    """The name of the box as a string.
+    If the name can't be decoded from UTF-8, the string representation of the bytes is returned instead."""
     name_raw: bytes
     """The name of the box as raw bytes"""
     name_base64: str