feat: recognise conventional methods and use appropriate

OnCompleteAction as default

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
@@ -82,7 +81,7 @@ export class Auction extends Contract {
   }
 
   @abimethod({ allowActions: 'OptIn' })
-  public optInToApplication(): void {}
+  public optInToApplication(): void { }
 
   public bid(payment: gtxn.PaymentTxn): void {
     /// Ensure auction hasn't ended

src/abi-metadata.ts

@@ -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/constants.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/impl/c2c.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 {

src/subcontexts/contract-context.ts

@@ -279,6 +279,9 @@ const getContractOptions = (contract: BaseContract): ContractOptionsParameter |
 }
 
 const hasCreateMethods = (contract: Contract) => {
+  const createFn = Reflect.get(contract, 'createApplication')
+  if (createFn !== undefined && typeof createFn === 'function') return true
+
   const metadatas = getContractAbiMetadata(contract)
   return Object.values(metadatas).some((metadata) => (metadata.onCreate ?? 'disallow') !== 'disallow')
 }

tests/references/arc4-contract.spec.ts

@@ -1,5 +1,5 @@
 import type { Account, bytes, uint64 } from '@algorandfoundation/algorand-typescript'
-import { arc4, assert, BaseContract, Bytes, contract, Contract, Global, Txn, Uint64 } from '@algorandfoundation/algorand-typescript'
+import { assert, BaseContract, Bytes, contract, Contract, Global, Txn, Uint64 } from '@algorandfoundation/algorand-typescript'
 import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
 import { afterEach, describe, expect, it } from 'vitest'
 import { lazyContext } from '../../src/context-helpers/internal-context'
@@ -39,8 +39,7 @@ class ContractARC4Create extends Contract {
     this.#stateTotals = Uint64()
   }
 
-  @arc4.abimethod({ onCreate: 'require' })
-  create(val: uint64): void {
+  createApplication(val: uint64): void {
     this.arg1 = val
     assert(Global.currentApplicationId.globalNumBytes === 4)
     assert(Global.currentApplicationId.globalNumUint === 5)
@@ -82,7 +81,7 @@ describe('arc4 contract creation', () => {
 
     const contract = ctx.contract.create(ContractARC4Create)
     ctx.txn.createScope([ctx.any.txn.applicationCall({ appId: ctx.ledger.getApplicationForContract(contract), sender })]).execute(() => {
-      contract.create(arg1)
+      contract.createApplication(arg1)
       expect(contract.arg1).toEqual(arg1)
       expect(contract.creator).toEqual(sender)
     })
@@ -96,7 +95,7 @@ describe('arc4 contract creation', () => {
     const appData = lazyContext.getApplicationData(contract)
     expect(appData.isCreating).toBe(true)
 
-    contract.create(arg1)
+    contract.createApplication(arg1)
 
     expect(appData.isCreating).toBe(false)
     expect(contract.arg1).toEqual(arg1)