Class MethodDescription

Inheritance
object
MethodDescription
Inherited Members
Namespace: AVM.ClientGenerator.ABI.ARC4
Assembly: Algorand.dll
Syntax
public class MethodDescription

Properties

| Edit this page View Source

ARC4MethodSignature

Declaration
public string ARC4MethodSignature { get; }
Property Value
Type Description
string
| Edit this page View Source

Args

Declaration
public List<ArgumentDescription> Args { get; set; }
Property Value
Type Description
List<ArgumentDescription>
| Edit this page View Source

Defaults

Declaration
[JsonIgnore]
public Dictionary<string, DefaultArgumentSpec> Defaults { get; set; }
Property Value
Type Description
Dictionary<string, DefaultArgumentSpec>
| Edit this page View Source

Desc

Declaration
public string Desc { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Identifier

Declaration
[JsonIgnore]
public string Identifier { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Name

Declaration
[JsonRequired]
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

OnCompletion

Declaration
[JsonIgnore]
public CallConfigSpec OnCompletion { get; set; }
Property Value
Type Description
CallConfigSpec
| Edit this page View Source

Returns

Declaration
public ReturnTypeDescription Returns { get; set; }
Property Value
Type Description
ReturnTypeDescription
| Edit this page View Source

Selector

Declaration
public byte[] Selector { get; set; }
Property Value
Type Description
byte[]

Methods

| Edit this page View Source

FormatMethodName(string)

Declaration
public static string FormatMethodName(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string
| Edit this page View Source

FormatStructName(string, bool)

Declaration
public static string FormatStructName(string name, bool appendStruct = false)
Parameters
Type Name Description
string name
bool appendStruct
Returns
Type Description
string
| Edit this page View Source

FromMethod(MethodDeclarationSyntax, SemanticModel)

Declaration
public static MethodDescription FromMethod(MethodDeclarationSyntax ms, SemanticModel model)
Parameters
Type Name Description
MethodDeclarationSyntax ms
SemanticModel model
Returns
Type Description
MethodDescription
| Edit this page View Source

SafeIdentifier(string)

ARC56 method/event argument names are free-form and may collide with a C# reserved word (e.g. an ABI arg literally named "operator", as in ARC-1400's arc1410IsOperator). Since the generator otherwise emits arg.Name verbatim as a C# identifier (parameter declarations and in-body references), escape it with "@" whenever it is one, matching the C# verbatim-identifier syntax.

Declaration
public static string SafeIdentifier(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string
| Edit this page View Source

ToARC4Caller()

Declaration
public string ToARC4Caller()
Returns
Type Description
string
| Edit this page View Source

ToARC4MethodSelector()

Declaration
public byte[] ToARC4MethodSelector()
Returns
Type Description
byte[]
| Edit this page View Source

ToARC4MethodSelector(string)

Converts the specified ARC4 method signature into a 4-byte selector value.

Declaration
public static byte[] ToARC4MethodSelector(string arc4MethodSignature)
Parameters
Type Name Description
string arc4MethodSignature

The ARC4 method signature to be converted. This must be a non-null, non-empty string.
Returns
Type Description
byte[]

A 4-byte array representing the selector value derived from the ARC4 method signature.
Remarks

The method computes the selector value by hashing the input string using a SHA-512/256 digest and returning the first 4 bytes of the resulting hash.