feat: add support for ABI validation (#99)

---------

Co-authored-by: Neil Campbell <[email protected]>

Author: boblat

docs/tg-concepts.md

@@ -70,3 +70,8 @@ As explained in the [introduction](testing-guide.md), `algorand-typescript-testi
 3. **Mockable**: Not implemented, but can be mocked or patched. For example, `op.onlineStake` can be mocked to return specific values or behaviours; otherwise, it raises a `NotImplementedError`. This category covers cases where native or emulated implementation in a unit test context is impractical or overly complex.
 
 For a full list of all public `algorand-typescript` types and their corresponding implementation category, refer to the [Coverage](./coverage.md) section.
+
+## Data Validation
+
+Algorand TypeScript and the puya compiler have functionality to perform validation of transaction inputs via the `--validate-abi-args`, `--validate-abi-return` CLI arguments, `arc4.abimethod({validateEncoding: ...})` decorator, `convertBytes(..., { strategy: 'validate' }) method` and `validateEncoding(...)` method.
+The Algorand TypeScript Testing library does _NOT_ implement this validation behaviour, as you should test invalid inputs using an integrated test against a real Algorand network.

package-lock.json

@@ -68,8 +68,8 @@
     "vitest": "3.2.4"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.87",
-    "@algorandfoundation/puya-ts": "1.0.0-alpha.87",
+    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.90",
+    "@algorandfoundation/puya-ts": "1.0.0-alpha.90",
     "elliptic": "^6.6.1",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",

package.json

@@ -1220,7 +1220,7 @@ export function decodeArc4<T>(
 export function convertBytes<T extends _ARC4Encoded>(
   typeInfoString: string,
   bytes: StubBytesCompat,
-  options: { prefix?: 'none' | 'log'; strategy: 'unsafe-cast' },
+  options: { prefix?: 'none' | 'log'; strategy: 'unsafe-cast' | 'validate' },
 ): T {
   const typeInfo = JSON.parse(typeInfoString)
   return getEncoder<T>(typeInfo)(bytes, typeInfo, options.prefix)

src/impl/encoded-types/encoded-types.ts

@@ -0,0 +1,2 @@
+/** @internal */
+export function validateEncoding<T>(_value: T) {}

src/impl/validate-encoding.ts

@@ -5,6 +5,8 @@ export { BaseContract, contract } from '../impl/base-contract'
 /** @internal */
 export { clone } from '../impl/clone'
 /** @internal */
+export { validateEncoding } from '../impl/validate-encoding'
+/** @internal */
 export { compile } from '../impl/compiled'
 /** @internal */
 export { abimethod, baremethod, Contract, readonly } from '../impl/contract'

src/internal/index.ts

@@ -71,7 +71,8 @@ describe('arc4.Address', () => {
 
   test.each(testData)('fromBytes method', (value) => {
     const sdkResult = getABIEncodedValue(asUint8Array(value), abiTypeString, {})
-    const result = convertBytes<Address>(value, { strategy: 'unsafe-cast' })
+    // no actual validation in testing lib, just making sure 'validate' strategy value can be passed
+    const result = convertBytes<Address>(value, { strategy: 'validate' })
     expect(result.bytes).toEqual(sdkResult)
   })
 

tests/arc4/address.algo.spec.ts

@@ -1,15 +1,16 @@
 import type { biguint, bytes, uint64 } from '@algorandfoundation/algorand-typescript'
-import { arc4, BigUint, clone, emit } from '@algorandfoundation/algorand-typescript'
+import { arc4, BigUint, clone, emit, validateEncoding } from '@algorandfoundation/algorand-typescript'
 import type { Bool, UFixed } from '@algorandfoundation/algorand-typescript/arc4'
 import { Byte, Contract, convertBytes, Str, Uint } from '@algorandfoundation/algorand-typescript/arc4'
 
 export class Arc4PrimitiveOpsContract extends Contract {
-  @arc4.abimethod()
+  @arc4.abimethod({ validateEncoding: 'unsafe-disabled' })
   public verify_uintn_uintn_eq(a: bytes, b: bytes): boolean {
     const aBiguint = BigUint(a)
     const bBiguint = BigUint(b)
     const aUintN = new Uint<64>(aBiguint)
     const bUintN = new Uint<64>(bBiguint)
+    validateEncoding(aUintN)
     return aUintN === bUintN
   }
   @arc4.abimethod()