Merge pull request #72 from algorandfoundation/feat/box-array-5

feat: implement stubs for Box create, no arg ctors, and encode/decode native arrays

Author: boblat

examples/auction/contract.algo.ts

@@ -26,7 +26,6 @@ export class Auction extends Contract {
 
   claimableAmount = LocalState<uint64>()
 
-  @abimethod({ allowActions: 'NoOp', onCreate: 'require' })
   public createApplication(): void {
     this.auctionEnd.value = 0
     this.previousBid.value = 0

package-lock.json

@@ -66,8 +66,8 @@
     "vitest": "3.0.9"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "1.0.0-beta.65",
-    "@algorandfoundation/puya-ts": "1.0.0-beta.65",
+    "@algorandfoundation/algorand-typescript": "1.0.0-alpha.49",
+    "@algorandfoundation/puya-ts": "1.0.0-alpha.49",
     "elliptic": "^6.6.1",
     "js-sha256": "^0.11.0",
     "js-sha3": "^0.9.3",

package.json

@@ -1,6 +1,7 @@
 import type { OnCompleteActionStr } from '@algorandfoundation/algorand-typescript'
 import type { CreateOptions } from '@algorandfoundation/algorand-typescript/arc4'
 import js_sha512 from 'js-sha512'
+import { ConventionalRouting } from './constants'
 import type { TypeInfo } from './encoders'
 import { Arc4MethodConfigSymbol, Contract } from './impl/contract'
 import { getArc4TypeName as getArc4TypeNameForARC4Encoded } from './impl/encoded-types'
@@ -22,7 +23,12 @@ export const attachAbiMetadata = (contract: { new (): Contract }, methodName: st
     metadataStore.set(contract, {})
   }
   const metadatas: Record<string, AbiMetadata> = metadataStore.get(contract) as Record<string, AbiMetadata>
-  metadatas[methodName] = metadata
+  const conventionalRoutingConfig = getConventionalRoutingConfig(methodName)
+  metadatas[methodName] = {
+    ...metadata,
+    allowActions: metadata.allowActions ?? conventionalRoutingConfig?.allowActions,
+    onCreate: metadata.onCreate ?? conventionalRoutingConfig?.onCreate,
+  }
 }
 
 export const getContractAbiMetadata = <T extends Contract>(contract: T | { new (): T }): Record<string, AbiMetadata> => {
@@ -110,3 +116,36 @@ const getArc4TypeName = (t: TypeInfo): string => {
   }
   return entry
 }
+
+/**
+ * Get routing properties inferred by conventional naming
+ * @param methodName The name of the method
+ */
+const getConventionalRoutingConfig = (methodName: string): Pick<AbiMetadata, 'allowActions' | 'onCreate'> | undefined => {
+  switch (methodName) {
+    case ConventionalRouting.methodNames.closeOutOfApplication:
+      return {
+        allowActions: ['CloseOut'],
+        onCreate: 'disallow',
+      }
+    case ConventionalRouting.methodNames.createApplication:
+      return {
+        onCreate: 'require',
+      }
+    case ConventionalRouting.methodNames.deleteApplication:
+      return {
+        allowActions: ['DeleteApplication'],
+      }
+    case ConventionalRouting.methodNames.optInToApplication:
+      return {
+        allowActions: ['OptIn'],
+      }
+    case ConventionalRouting.methodNames.updateApplication:
+      return {
+        allowActions: ['UpdateApplication'],
+        onCreate: 'disallow',
+      }
+    default:
+      return undefined
+  }
+}

src/abi-metadata.ts

@@ -66,3 +66,13 @@ export enum OnApplicationComplete {
   UpdateApplicationOC = 4,
   DeleteApplicationOC = 5,
 }
+
+export const ConventionalRouting = {
+  methodNames: {
+    closeOutOfApplication: 'closeOutOfApplication',
+    createApplication: 'createApplication',
+    deleteApplication: 'deleteApplication',
+    optInToApplication: 'optInToApplication',
+    updateApplication: 'updateApplication',
+  },
+}

src/constants.ts

@@ -3,7 +3,7 @@ import { ARC4Encoded } from '@algorandfoundation/algorand-typescript/arc4'
 import { encodingUtil } from '@algorandfoundation/puya-ts'
 import { InternalError } from './errors'
 import { BytesBackedCls, Uint64BackedCls } from './impl/base'
-import { arc4Encoders, encodeArc4Impl, getArc4Encoder } from './impl/encoded-types'
+import { arc4Encoders, encodeArc4Impl, getArc4Encoder, tryArc4EncodedLengthImpl } from './impl/encoded-types'
 import { BigUint, Uint64, type StubBytesCompat } from './impl/primitives'
 import { AccountCls, ApplicationCls, AssetCls } from './impl/reference'
 import type { DeliberateAny } from './typescript-helpers'
@@ -63,7 +63,7 @@ export const getEncoder = <T>(typeInfo: TypeInfo): fromBytes<T> => {
 }
 
 export const toBytes = (val: unknown): bytes => {
-  const uint64Val = asMaybeUint64Cls(val)
+  const uint64Val = asMaybeUint64Cls(val, false)
   if (uint64Val !== undefined) {
     return uint64Val.toBytes().asAlgoTs()
   }
@@ -85,7 +85,12 @@ export const toBytes = (val: unknown): bytes => {
     return val.bytes
   }
   if (Array.isArray(val) || typeof val === 'object') {
-    return encodeArc4Impl('', val)
+    return encodeArc4Impl(undefined, val)
   }
   throw new InternalError(`Invalid type for bytes: ${nameOfType(val)}`)
 }
+
+export const minLengthForType = (typeInfo: TypeInfo): number => {
+  const minArc4StaticLength = tryArc4EncodedLengthImpl(typeInfo)
+  return minArc4StaticLength ?? 0
+}

src/encoders.ts

@@ -89,8 +89,15 @@ export function abiCall<TArgs extends DeliberateAny[], TReturn>(
   methodArgs: TypedApplicationCallFields<TArgs>,
   contract?: Contract | { new (): Contract },
 ): { itxn: ApplicationCallInnerTxn; returnValue: TReturn | undefined } {
+  const abiMetadata = contract ? getContractMethodAbiMetadata(contract, method.name) : undefined
   const selector = methodSelector(method, contract)
-  const itxnContext = ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields<TReturn>(methodArgs, selector)
+  const itxnContext = ApplicationCallInnerTxnContext.createFromTypedApplicationCallFields<TReturn>(
+    {
+      ...methodArgs,
+      onCompletion: methodArgs.onCompletion ?? abiMetadata?.allowActions?.map((action) => OnCompleteAction[action])[0],
+    },
+    selector,
+  )
   invokeCallback(itxnContext)
 
   return {