feat: add mock implementations for validation functionality

Author: daniel-makerx

src/_algopy_testing/arc4.py

@@ -158,6 +158,9 @@ def bytes(self) -> algopy.Bytes:
 
         return algopy.Bytes(self._value)
 
+    def validate(self) -> None:
+        pass
+
     def __eq__(self, other: object) -> bool:
         if isinstance(other, _ABIEncoded):
             return self._type_info == other._type_info and self.bytes == other.bytes

src/_algopy_testing/decorators/arc4.py

@@ -151,6 +151,7 @@ def abimethod(  # noqa: PLR0913
     resource_encoding: _ResourceEncoding = "value",
     readonly: bool = False,
     default_args: Mapping[str, str | object] | None = None,
+    validate_encoding: typing.Literal["unsafe_disabled", "args"] = "args",  # noqa: ARG001
 ) -> Callable[[Callable[_P, _R]], Callable[_P, _R]] | Callable[_P, _R]:
     from _algopy_testing.utilities.log import log
 

src/_algopy_testing/models/account.py

@@ -128,6 +128,9 @@ def bytes(self) -> Bytes:
     def public_key(self) -> str:
         return algosdk.encoding.encode_address(self._public_key)  # type: ignore[no-any-return]
 
+    def validate(self) -> None:
+        pass
+
     def __getattr__(self, name: str) -> typing.Any:
         try:
             return self.data.fields[name]  # type: ignore[literal-required]

src/_algopy_testing/primitives/array.py

@@ -144,6 +144,9 @@ def serialize(self) -> bytes:
     def from_bytes(cls, value: bytes, /) -> typing.Self:
         return deserialize_from_bytes(cls, value)
 
+    def validate(self) -> None:
+        pass
+
 
 class _FixedArrayMeta(type, typing.Generic[_TArrayItem, _TArrayLength]):
     __concrete__: typing.ClassVar[dict[tuple[type, type], type]] = {}
@@ -255,6 +258,9 @@ def serialize(self) -> bytes:
     def from_bytes(cls, value: bytes, /) -> typing.Self:
         return deserialize_from_bytes(cls, value)
 
+    def validate(self) -> None:
+        pass
+
 
 class _ImmutableArrayMeta(type):
     __concrete__: typing.ClassVar[dict[type, type]] = {}
@@ -362,6 +368,9 @@ def serialize(self) -> bytes:
     def from_bytes(cls, value: bytes, /) -> typing.Self:
         return deserialize_from_bytes(cls, value)
 
+    def validate(self) -> None:
+        pass
+
 
 class ReferenceArray(Reversible[_TArrayItem]):
     def __init__(self, values: Iterable[_TArrayItem] = ()):
@@ -510,6 +519,9 @@ def serialize(self) -> bytes:
     def from_bytes(cls, value: bytes, /) -> typing.Self:
         return deserialize_from_bytes(cls, value)
 
+    def validate(self) -> None:
+        pass
+
 
 @typing.dataclass_transform()
 class Struct(Serializable, MutableBytes):
@@ -558,6 +570,9 @@ def from_bytes(cls, value: bytes, /) -> typing.Self:
     def _update_backing_value(self) -> None:
         self._value = serialize_to_bytes(self)
 
+    def validate(self) -> None:
+        pass
+
 
 def zero_bytes(typ: type[_T]) -> _T:
     # Get the static size of the type

tests/artifacts/Arc4ABIMethod/contract.py

@@ -33,7 +33,7 @@ def create(self) -> None:
         assert app_txn.app_id == 0, "expected txn to have 0"
         assert Txn.application_id == 0, "expected txn to have 0"
 
-    @arc4.abimethod
+    @arc4.abimethod(validate_encoding="unsafe_disabled")
     def sink(self, value: arc4.String, arr: UInt8Array) -> None:
         assert value
         assert arr
@@ -84,6 +84,7 @@ def with_acc(self, value: arc4.String, acc: Account, arr: UInt8Array) -> None:
     def complex_sig(
         self, struct1: MyStruct, txn: algopy.gtxn.Transaction, acc: Account, five: UInt8Array
     ) -> tuple[MyStructAlias, MyStruct]:
+        five.validate()
         assert Txn.num_app_args == 4
         # struct
         assert struct1.another_struct.one == 1
@@ -123,6 +124,7 @@ def echo_resource_by_index(
     def echo_resource_by_value(
         self, asset: Asset, app: Application, acc: Account
     ) -> tuple[Asset, Application, Account]:
+        acc.validate()
         asset_id = op.btoi(Txn.application_args(1))
         assert asset.id == asset_id, "expected asset to be passed by value"
         app_id = op.btoi(Txn.application_args(2))

tests/artifacts/Arrays/immutable.py

@@ -155,6 +155,7 @@ def test_biguint_array(self) -> None:
     @arc4.abimethod()
     def test_bool_array(self, length: UInt64) -> None:
         arr = ImmutableArray[bool]()
+        arr.validate()  # does nothing but should still be callable
         assert arr.length == 0
 
         for i in urange(length):