feat: accept abi method reference as a parameter to methodSelector function

Author: boblat

examples/precompiled/contract.algo.ts

@@ -9,7 +9,7 @@ export class HelloFactory extends Contract {
 
     const helloApp = itxn
       .applicationCall({
-        appArgs: [methodSelector('create(string)void'), encodeArc4('hello')],
+        appArgs: [methodSelector(Hello.prototype.create), encodeArc4('hello')],
         approvalProgram: compiled.approvalProgram,
         clearStateProgram: compiled.clearStateProgram,
         globalNumBytes: 1,
@@ -18,7 +18,7 @@ export class HelloFactory extends Contract {
 
     const txn = itxn
       .applicationCall({
-        appArgs: [methodSelector('greet(string)string'), encodeArc4('world')],
+        appArgs: [methodSelector(Hello.prototype.greet), encodeArc4('world')],
         appId: helloApp,
       })
       .submit()
@@ -29,7 +29,7 @@ export class HelloFactory extends Contract {
     itxn
       .applicationCall({
         appId: helloApp,
-        appArgs: [methodSelector('delete()void')],
+        appArgs: [methodSelector(Hello.prototype.delete)],
         onCompletion: OnCompleteAction.DeleteApplication,
       })
       .submit()

examples/precompiled/precompiled-apps.algo.ts

@@ -15,7 +15,7 @@ abstract class HelloBase extends Contract {
 }
 
 export class Hello extends HelloBase {
-  @abimethod({ onCreate: 'require' })
+  @abimethod({ name: 'helloCreate', onCreate: 'require' })
   create(greeting: string) {
     this.greeting.value = greeting
   }

src/abi-metadata.ts

@@ -7,6 +7,7 @@ import type { DeliberateAny } from './typescript-helpers'
 
 export interface AbiMetadata {
   methodName: string
+  methodNameOverride?: string
   methodSignature: string | undefined
   argTypes: string[]
   returnType: string
@@ -42,6 +43,8 @@ export const captureMethodConfig = <T extends Contract>(
   config?: AbiMethodConfig<T> | BareMethodConfig,
 ): void => {
   const metadata = getContractMethodAbiMetadata(contract, methodName)
+
+  metadata.methodNameOverride = config && 'name' in config ? config.name : undefined
   metadata.onCreate = config?.onCreate ?? 'disallow'
   metadata.allowActions = ([] as OnCompleteActionStr[]).concat(config?.allowActions ?? 'NoOp')
 }
@@ -53,7 +56,7 @@ export const hasAbiMetadata = <T extends Contract>(contract: T): boolean => {
   )
 }
 export const getContractAbiMetadata = <T extends BaseContract>(contract: T): Record<string, AbiMetadata> => {
-  if ((contract as DeliberateAny)[isContractProxy]) {
+  if ((contract as DeliberateAny)[AbiMetaSymbol]) {
     return (contract as DeliberateAny)[AbiMetaSymbol] as Record<string, AbiMetadata>
   }
   const contractClass = contract.constructor as { new (): T }
@@ -73,7 +76,7 @@ export const getArc4Signature = (metadata: AbiMetadata): string => {
   if (metadata.methodSignature === undefined) {
     const argTypes = metadata.argTypes.map((t) => JSON.parse(t) as TypeInfo).map(getArc4TypeName)
     const returnType = getArc4TypeName(JSON.parse(metadata.returnType) as TypeInfo)
-    metadata.methodSignature = `${metadata.methodName}(${argTypes.join(',')})${returnType}`
+    metadata.methodSignature = `${metadata.methodNameOverride ?? metadata.methodName}(${argTypes.join(',')})${returnType}`
   }
   return metadata.methodSignature
 }

src/impl/contract.ts

@@ -1,6 +1,6 @@
 import type { arc4, bytes } from '@algorandfoundation/algorand-typescript'
 import { encodingUtil } from '@algorandfoundation/puya-ts'
-import { captureMethodConfig } from '../abi-metadata'
+import { captureMethodConfig, getArc4Selector, getContractMethodAbiMetadata } from '../abi-metadata'
 import type { DeliberateAny } from '../typescript-helpers'
 import { BaseContract } from './base-contract'
 import { sha512_256 } from './crypto'
@@ -38,6 +38,11 @@ export function baremethod<TContract extends Contract>(config?: arc4.BareMethodC
   }
 }
 
-export const methodSelector: typeof arc4.methodSelector = (methodSignature: string): bytes => {
-  return sha512_256(Bytes(encodingUtil.utf8ToUint8Array(methodSignature))).slice(0, 4)
+export const methodSelector = (methodSignature: Parameters<typeof arc4.methodSelector>[0], contract?: DeliberateAny): bytes => {
+  if (typeof methodSignature === 'string') {
+    return sha512_256(Bytes(encodingUtil.utf8ToUint8Array(methodSignature))).slice(0, 4)
+  } else {
+    const abiMetadata = getContractMethodAbiMetadata(contract, methodSignature.name)
+    return Bytes(getArc4Selector(abiMetadata))
+  }
 }

src/test-transformer/node-factory.ts

@@ -107,4 +107,16 @@ export const nodeFactory = {
       [typeInfoArg, ...(node.arguments ?? [])].filter((arg) => !!arg),
     )
   },
+
+  callMethodSelectorFunction(node: ts.CallExpression) {
+    if (
+      node.arguments.length === 1 &&
+      ts.isPropertyAccessExpression(node.arguments[0]) &&
+      ts.isPropertyAccessExpression(node.arguments[0].expression)
+    ) {
+      const contractIdenifier = node.arguments[0].expression.expression
+      return factory.updateCallExpression(node, node.expression, node.typeArguments, [...node.arguments, contractIdenifier])
+    }
+    return node
+  },
 } satisfies Record<string, (...args: DeliberateAny[]) => ts.Node>

src/test-transformer/visitors.ts

@@ -168,7 +168,11 @@ class ExpressionVisitor {
           const targetTypeInfo = getGenericTypeInfo(targetType)
           infoArg = targetTypeInfo
         }
-        updatedNode = stubbedFunctionName ? nodeFactory.callStubbedFunction(stubbedFunctionName, updatedNode, infoArg) : updatedNode
+        updatedNode = stubbedFunctionName
+          ? isCallingMethodSelector(stubbedFunctionName)
+            ? nodeFactory.callMethodSelectorFunction(updatedNode)
+            : nodeFactory.callStubbedFunction(stubbedFunctionName, updatedNode, infoArg)
+          : updatedNode
       }
       return needsToCaptureTypeInfo
         ? nodeFactory.captureGenericTypeInfo(ts.visitEachChild(updatedNode, this.visit, this.context), JSON.stringify(info))
@@ -417,9 +421,10 @@ const tryGetStubbedFunctionName = (node: ts.CallExpression, helper: VisitorHelpe
     if (sourceFileName && !algotsModulePaths.some((s) => sourceFileName.includes(s))) return undefined
   }
   const functionName = functionSymbol?.getName() ?? identityExpression.text
-  const stubbedFunctionNames = ['interpretAsArc4', 'decodeArc4', 'encodeArc4', 'emit']
+  const stubbedFunctionNames = ['interpretAsArc4', 'decodeArc4', 'encodeArc4', 'emit', 'methodSelector']
   return stubbedFunctionNames.includes(functionName) ? functionName : undefined
 }
 
 const isCallingDecodeArc4 = (functionName: string | undefined): boolean => ['decodeArc4', 'encodeArc4'].includes(functionName ?? '')
 const isCallingEmit = (functionName: string | undefined): boolean => 'emit' === (functionName ?? '')
+const isCallingMethodSelector = (functionName: string | undefined): boolean => 'methodSelector' === (functionName ?? '')