@algorandfoundation/algokit-utils 7.0.0-beta.5 → 7.0.0-beta.7

package/types/amount.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"amount.mjs","sources":["../../src/types/amount.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAEA;MACa,UAAU,CAAA;;AAIrB,IAAA,IAAI,UAAU,GAAA;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAA;KAC9B;;AAGD,IAAA,IAAI,SAAS,GAAA;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAA;KAC9B;;AAGD,IAAA,IAAI,KAAK,GAAA;QACP,OAAO,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAA;KACjE;;AAGD,IAAA,IAAI,IAAI,GAAA;QACN,OAAO,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAA;KACjE;AAED,IAAA,WAAA,CACE,MAAiI,EAAA;AAEjI,QAAA,IAAI,CAAC,iBAAiB;AACpB,YAAA,YAAY,IAAI,MAAM;AACpB,kBAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;kBACzB,WAAW,IAAI,MAAM;AACrB,sBAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;sBACxB,OAAO,IAAI,MAAM;AACjB,0BAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACzD,0BAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACjE;IAED,QAAQ,GAAA;QACN,OAAO,CAAA,EAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA,MAAA,CAAQ,CAAA;KACzD;AAED;;;AAGG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;KAC9B;;IAGD,OAAO,KAAK,CAAC,MAAuB,EAAA;QAClC,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;KACzC;;IAGD,OAAO,IAAI,CAAC,MAAuB,EAAA;QACjC,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;KACzC;;IAGD,OAAO,UAAU,CAAC,MAAuB,EAAA;QACvC,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;KAC9C;;IAGD,OAAO,SAAS,CAAC,MAAuB,EAAA;QACtC,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;KAC9C;AACF;;;;"}
+{"version":3,"file":"amount.mjs","sources":["../../src/types/amount.ts"],"sourcesContent":["import algosdk from 'algosdk'\n\n/** Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers */\nexport class AlgoAmount {\n  private amountInMicroAlgo: bigint\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgos() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in µAlgo */\n  get microAlgo() {\n    return this.amountInMicroAlgo\n  }\n\n  /** Return the amount as a number in Algo */\n  get algos() {\n    return algosdk.microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  /** Return the amount as a number in Algo */\n  get algo() {\n    return algosdk.microalgosToAlgos(Number(this.amountInMicroAlgo))\n  }\n\n  constructor(\n    amount: { algos: number | bigint } | { algo: number | bigint } | { microAlgos: number | bigint } | { microAlgo: number | bigint },\n  ) {\n    this.amountInMicroAlgo =\n      'microAlgos' in amount\n        ? BigInt(amount.microAlgos)\n        : 'microAlgo' in amount\n          ? BigInt(amount.microAlgo)\n          : 'algos' in amount\n            ? BigInt(algosdk.algosToMicroalgos(Number(amount.algos)))\n            : BigInt(algosdk.algosToMicroalgos(Number(amount.algo)))\n  }\n\n  toString(): string {\n    return `${this.microAlgo.toLocaleString('en-US')} µALGO`\n  }\n\n  /** valueOf allows you to use `AlgoAmount` in comparison operations such as `<` and `>=` etc.,\n   * but it's not recommended to use this to convert to a number, it's much safer to explicitly call\n   * the algos or microAlgos properties\n   */\n  valueOf(): number {\n    return Number(this.microAlgo)\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algos(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of Algo */\n  static Algo(amount: number | bigint) {\n    return new AlgoAmount({ algos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgos(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n\n  /** Create a `AlgoAmount` object representing the given number of µAlgo */\n  static MicroAlgo(amount: number | bigint) {\n    return new AlgoAmount({ microAlgos: amount })\n  }\n}\n"],"names":[],"mappings":";;AAEA;MACa,UAAU,CAAA;;AAIrB,IAAA,IAAI,UAAU,GAAA;QACZ,OAAO,IAAI,CAAC,iBAAiB,CAAA;KAC9B;;AAGD,IAAA,IAAI,SAAS,GAAA;QACX,OAAO,IAAI,CAAC,iBAAiB,CAAA;KAC9B;;AAGD,IAAA,IAAI,KAAK,GAAA;QACP,OAAO,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAA;KACjE;;AAGD,IAAA,IAAI,IAAI,GAAA;QACN,OAAO,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAA;KACjE;AAED,IAAA,WAAA,CACE,MAAiI,EAAA;AAEjI,QAAA,IAAI,CAAC,iBAAiB;AACpB,YAAA,YAAY,IAAI,MAAM;AACpB,kBAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;kBACzB,WAAW,IAAI,MAAM;AACrB,sBAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;sBACxB,OAAO,IAAI,MAAM;AACjB,0BAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AACzD,0BAAE,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;KACjE;IAED,QAAQ,GAAA;QACN,OAAO,CAAA,EAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA,MAAA,CAAQ,CAAA;KACzD;AAED;;;AAGG;IACH,OAAO,GAAA;AACL,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;KAC9B;;IAGD,OAAO,KAAK,CAAC,MAAuB,EAAA;QAClC,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;KACzC;;IAGD,OAAO,IAAI,CAAC,MAAuB,EAAA;QACjC,OAAO,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;KACzC;;IAGD,OAAO,UAAU,CAAC,MAAuB,EAAA;QACvC,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;KAC9C;;IAGD,OAAO,SAAS,CAAC,MAAuB,EAAA;QACtC,OAAO,IAAI,UAAU,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC,CAAA;KAC9C;AACF;;;;"}

package/types/app-arc56.d.ts

@@ -1,17 +1,21 @@
 import algosdk from 'algosdk';
 import { ABIReturn } from './app';
 import { Expand } from './expand';
+/** Type to describe an argument within an `Arc56Method`. */
+export type Arc56MethodArg = Expand<Omit<Method['args'][number], 'type'> & {
+    type: algosdk.ABIArgumentType;
+}>;
+/** Type to describe a return type within an `Arc56Method`. */
+export type Arc56MethodReturnType = Expand<Omit<Method['returns'], 'type'> & {
+    type: algosdk.ABIReturnType;
+}>;
 /**
  * Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method.
  */
 export declare class Arc56Method extends algosdk.ABIMethod {
     method: Method;
-    readonly args: Array<Expand<Omit<Method['args'][number], 'type'> & {
-        type: algosdk.ABIArgumentType;
-    }>>;
-    readonly returns: Expand<Omit<Method['returns'], 'type'> & {
-        type: algosdk.ABIReturnType;
-    }>;
+    readonly args: Array<Arc56MethodArg>;
+    readonly returns: Arc56MethodReturnType;
     constructor(method: Method);
     toJSON(): Method;
 }
@@ -20,21 +24,21 @@ export declare class Arc56Method extends algosdk.ABIMethod {
  * @param struct The ARC-56 struct definition
  * @returns The `ABITupleType`
  */
-export declare function getABITupleTypeFromABIStructDefinition(struct: StructFields): algosdk.ABITupleType;
+export declare function getABITupleTypeFromABIStructDefinition(struct: StructField[], structs: Record<string, StructField[]>): algosdk.ABITupleType;
 /**
  * Converts a decoded ABI tuple as a struct.
  * @param decodedABITuple The decoded ABI tuple value
  * @param structFields The struct fields from an ARC-56 app spec
  * @returns The struct as a Record<string, any>
  */
-export declare function getABIStructFromABITuple<TReturn extends ABIStruct = Record<string, any>>(decodedABITuple: algosdk.ABIValue[], structFields: StructFields): TReturn;
+export declare function getABIStructFromABITuple<TReturn extends ABIStruct = Record<string, any>>(decodedABITuple: algosdk.ABIValue[], structFields: StructField[], structs: Record<string, StructField[]>): TReturn;
 /**
  * Converts an ARC-56 struct as an ABI tuple.
  * @param struct The struct to convert
  * @param structFields The struct fields from an ARC-56 app spec
  * @returns The struct as a decoded ABI tuple
  */
-export declare function getABITupleFromABIStruct(struct: ABIStruct, structFields: StructFields): algosdk.ABIValue[];
+export declare function getABITupleFromABIStruct(struct: ABIStruct, structFields: StructField[], structs: Record<string, StructField[]>): algosdk.ABIValue[];
 /** Decoded ARC-56 struct as a struct rather than a tuple. */
 export type ABIStruct = {
     [key: string]: ABIStruct | algosdk.ABIValue;
@@ -47,7 +51,7 @@ export type ABIStruct = {
  * @param structs The defined ARC-56 structs
  * @returns The decoded ABI value or struct
  */
-export declare function getABIDecodedValue(value: Uint8Array | number | bigint, type: string, structs: Record<string, StructFields>): algosdk.ABIValue | ABIStruct;
+export declare function getABIDecodedValue(value: Uint8Array | number | bigint, type: string, structs: Record<string, StructField[]>): algosdk.ABIValue | ABIStruct;
 /**
  * Returns the ABI-encoded value for the given value.
  * @param value The value to encode either already in encoded binary form (`Uint8Array`), a decoded ABI value or an ARC-56 struct
@@ -55,7 +59,7 @@ export declare function getABIDecodedValue(value: Uint8Array | number | bigint,
  * @param structs The defined ARC-56 structs
  * @returns The binary ABI-encoded value
  */
-export declare function getABIEncodedValue(value: Uint8Array | algosdk.ABIValue | ABIStruct, type: string, structs: Record<string, StructFields>): Uint8Array;
+export declare function getABIEncodedValue(value: Uint8Array | algosdk.ABIValue | ABIStruct, type: string, structs: Record<string, StructField[]>): Uint8Array;
 /**
  * Returns the ARC-56 ABI method object for a given method name or signature and ARC-56 app spec.
  * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.
@@ -72,7 +76,7 @@ export declare function getArc56Method(methodNameOrSignature: string, appSpec: A
  * @param structs The struct fields from the app spec
  * @returns The smart contract response with an updated return value
  */
-export declare function getArc56ReturnValue<TReturn extends Uint8Array | algosdk.ABIValue | ABIStruct | undefined>(returnValue: ABIReturn | undefined, method: Method | Arc56Method, structs: StructFields): TReturn;
+export declare function getArc56ReturnValue<TReturn extends Uint8Array | algosdk.ABIValue | ABIStruct | undefined>(returnValue: ABIReturn | undefined, method: Method | Arc56Method, structs: Record<string, StructField[]>): TReturn;
 /****************/
 /** ARC-56 spec */
 /****************/
@@ -85,23 +89,21 @@ export interface Arc56Contract {
     /** Optional, user-friendly description for the interface */
     desc?: string;
     /**
-     * Optional object listing the contract instances across different networks
+     * Optional object listing the contract instances across different networks.
+     * The key is the base64 genesis hash of the network, and the value contains
+     * information about the deployed contract in the network indicated by the
+     * key. A key containing the human-readable name of the network MAY be
+     * included, but the corresponding genesis hash key MUST also be define
      */
     networks?: {
-        /**
-         * The key is the base64 genesis hash of the network, and the value contains
-         * information about the deployed contract in the network indicated by the
-         * key. A key containing the human-readable name of the network MAY be
-         * included, but the corresponding genesis hash key MUST also be defined
-         */
         [network: string]: {
             /** The app ID of the deployed contract in this network */
             appID: number;
         };
     };
-    /** Named structs use by the application */
+    /** Named structs use by the application. Each struct field appears in the same order as ABI encoding. */
     structs: {
-        [structName: StructName]: StructFields;
+        [structName: StructName]: StructField[];
     };
     /** All of the methods that the contract implements */
     methods: Method[];
@@ -179,7 +181,7 @@ export interface Arc56Contract {
             major: number;
             minor: number;
             patch: number;
-            commit?: string;
+            commitHash?: string;
         };
     };
     /** ARC-28 events that MAY be emitted by this contract */
@@ -188,7 +190,7 @@ export interface Arc56Contract {
     templateVariables?: {
         [name: string]: {
             /** The type of the template variable */
-            type: ABIType | AVMBytes | StructName;
+            type: ABIType | AVMType | StructName;
             /** If given, the the base64 encoded value used for the given app/program */
             value?: string;
         };
@@ -197,7 +199,7 @@ export interface Arc56Contract {
     scratchVariables?: {
         [name: string]: {
             slot: number;
-            type: ABIType | AVMBytes | StructName;
+            type: ABIType | AVMType | StructName;
         };
     };
 }
@@ -209,7 +211,7 @@ export interface Method {
     desc?: string;
     /** The arguments of the method, in order */
     args: Array<{
-        /** The type of the argument */
+        /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */
         type: ABIType;
         /** If the type is a struct, the name of the struct */
         struct?: StructName;
@@ -217,12 +219,24 @@ export interface Method {
         name?: string;
         /** Optional, user-friendly description for the argument */
         desc?: string;
-        /** The default value that clients should use. MUST be base64 encoded bytes */
-        defaultValue?: string;
+        /** The default value that clients should use. */
+        defaultValue?: {
+            /** Base64 encoded bytes or uint64 */
+            data: string | number;
+            /** How the data is encoded. This is the encoding for the data provided here, not the arg type */
+            type: ABIType | AVMType;
+            /** Where the default value is coming from
+             * - box: The data key signifies the box key to read the value from
+             * - global: The data key signifies the global state key to read the value from
+             * - local: The data key signifies the local state key to read the value from (for the sender)
+             * - literal: the value is a literal and should be passed directly as the argument
+             */
+            source: 'box' | 'global' | 'local' | 'literal';
+        };
     }>;
     /** Information about the method's return value */
     returns: {
-        /** The type of the return value, or "void" to indicate no return value. */
+        /** The type of the return value, or "void" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */
         type: ABIType;
         /** If the type is a struct, the name of the struct */
         struct?: StructName;
@@ -271,7 +285,7 @@ export interface Event {
     desc?: string;
     /** The arguments of the event, in order */
     args: Array<{
-        /** The type of the argument */
+        /** The type of the argument. The `struct` field should also be checked to determine if this return value is a struct. */
         type: ABIType;
         /** Optional, user-friendly name for the argument */
         name?: string;
@@ -286,19 +300,28 @@ export type ABIType = string;
 /** The name of a defined struct */
 export type StructName = string;
 /** Raw byteslice without the length prefixed that is specified in ARC-4 */
-export type AVMBytes = 'bytes';
-/** Mapping of named structs to the ABI type of their fields */
-export interface StructFields {
-    [fieldName: string]: ABIType | StructFields;
+export type AVMBytes = 'AVMBytes';
+/** A utf-8 string without the length prefix that is specified in ARC-4 */
+export type AVMString = 'AVMString';
+/** A 64-bit unsigned integer */
+export type AVMUint64 = 'AVMUint64';
+/** A native AVM type */
+export type AVMType = AVMBytes | AVMString | AVMUint64;
+/** Information about a single field in a struct */
+export interface StructField {
+    /** The name of the struct field */
+    name: string;
+    /** The type of the struct field's value */
+    type: ABIType | StructName | StructField[];
 }
 /** Describes a single key in app storage */
 export interface StorageKey {
     /** Description of what this storage key holds */
     desc?: string;
     /** The type of the key */
-    keyType: ABIType | AVMBytes | StructName;
+    keyType: ABIType | AVMType | StructName;
     /** The type of the value */
-    valueType: ABIType | AVMBytes | StructName;
+    valueType: ABIType | AVMType | StructName;
     /** The bytes of the key encoded as base64 */
     key: string;
 }
@@ -307,9 +330,9 @@ export interface StorageMap {
     /** Description of what the key-value pairs in this mapping hold */
     desc?: string;
     /** The type of the keys in the map */
-    keyType: ABIType | AVMBytes | StructName;
+    keyType: ABIType | AVMType | StructName;
     /** The type of the values in the map */
-    valueType: ABIType | AVMBytes | StructName;
+    valueType: ABIType | AVMType | StructName;
     /** The base64-encoded prefix of the map keys*/
     prefix?: string;
 }
@@ -323,4 +346,3 @@ export interface SourceInfo {
     /** The line of the dissasembled TEAL this line of pre-compiled TEAL corresponds to */
     disassembledTeal?: number;
 }
-//# sourceMappingURL=app-arc56.d.ts.map

package/types/app-arc56.js

@@ -27,8 +27,12 @@ class Arc56Method extends algosdk.ABIMethod {
  * @param struct The ARC-56 struct definition
  * @returns The `ABITupleType`
  */
-function getABITupleTypeFromABIStructDefinition(struct) {
-    return new algosdk.ABITupleType(Object.values(struct).map((v) => (typeof v === 'string' ? algosdk.ABIType.from(v) : getABITupleTypeFromABIStructDefinition(v))));
+function getABITupleTypeFromABIStructDefinition(struct, structs) {
+    return new algosdk.ABITupleType(struct.map((v) => typeof v.type === 'string'
+        ? structs[v.type]
+            ? getABITupleTypeFromABIStructDefinition(structs[v.type], structs)
+            : algosdk.ABIType.from(v.type)
+        : getABITupleTypeFromABIStructDefinition(v.type, structs)));
 }
 /**
  * Converts a decoded ABI tuple as a struct.
@@ -37,10 +41,15 @@ function getABITupleTypeFromABIStructDefinition(struct) {
  * @returns The struct as a Record<string, any>
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function getABIStructFromABITuple(decodedABITuple, structFields) {
-    return Object.fromEntries(Object.entries(structFields).map(([key, type], i) => {
+function getABIStructFromABITuple(decodedABITuple, structFields, structs) {
+    return Object.fromEntries(structFields.map(({ name: key, type }, i) => {
         const abiValue = decodedABITuple[i];
-        return [key, typeof type === 'string' || !Array.isArray(abiValue) ? decodedABITuple[i] : getABIStructFromABITuple(abiValue, type)];
+        return [
+            key,
+            (typeof type === 'string' && !structs[type]) || !Array.isArray(abiValue)
+                ? decodedABITuple[i]
+                : getABIStructFromABITuple(abiValue, typeof type === 'string' ? structs[type] : type, structs),
+        ];
     }));
 }
 /**
@@ -49,10 +58,12 @@ function getABIStructFromABITuple(decodedABITuple, structFields) {
  * @param structFields The struct fields from an ARC-56 app spec
  * @returns The struct as a decoded ABI tuple
  */
-function getABITupleFromABIStruct(struct, structFields) {
-    return Object.entries(structFields).map(([key, type]) => {
+function getABITupleFromABIStruct(struct, structFields, structs) {
+    return structFields.map(({ name: key, type }) => {
         const value = struct[key];
-        return typeof type === 'string' ? value : getABITupleFromABIStruct(value, type);
+        return typeof type === 'string' && !structs[type]
+            ? value
+            : getABITupleFromABIStruct(value, typeof type === 'string' ? structs[type] : type, structs);
     });
 }
 /**
@@ -64,11 +75,15 @@ function getABITupleFromABIStruct(struct, structFields) {
  * @returns The decoded ABI value or struct
  */
 function getABIDecodedValue(value, type, structs) {
-    if (type === 'bytes' || typeof value !== 'object')
+    if (type === 'AVMBytes' || typeof value !== 'object')
         return value;
+    if (type === 'AVMString')
+        return Buffer.from(value).toString('utf-8');
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').decode(value);
     if (structs[type]) {
-        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type]).decode(value);
-        return getABIStructFromABITuple(tupleValue, structs[type]);
+        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type], structs).decode(value);
+        return getABIStructFromABITuple(tupleValue, structs[type], structs);
     }
     return algosdk.ABIType.from(type).decode(value);
 }
@@ -82,7 +97,9 @@ function getABIDecodedValue(value, type, structs) {
 function getABIEncodedValue(value, type, structs) {
     if (typeof value === 'object' && value instanceof Uint8Array)
         return value;
-    if (type === 'bytes') {
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').encode(value);
+    if (type === 'AVMBytes' || type === 'AVMString') {
         if (typeof value === 'string')
             return Buffer.from(value, 'utf-8');
         if (typeof value !== 'object' || !(value instanceof Uint8Array))
@@ -90,12 +107,12 @@ function getABIEncodedValue(value, type, structs) {
         return value;
     }
     if (structs[type]) {
-        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type]);
+        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type], structs);
         if (Array.isArray(value)) {
             tupleType.encode(value);
         }
         else {
-            return tupleType.encode(getABITupleFromABIStruct(value, structs[type]));
+            return tupleType.encode(getABITupleFromABIStruct(value, structs[type], structs));
         }
     }
     return algosdk.ABIType.from(type).encode(value);
@@ -144,10 +161,14 @@ function getArc56ReturnValue(returnValue, method, structs) {
     }
     if (type === undefined || type === 'void' || returnValue?.returnValue === undefined)
         return undefined;
-    if (type === 'bytes')
+    if (type === 'AVMBytes')
         return returnValue.rawReturnValue;
+    if (type === 'AVMString')
+        return Buffer.from(returnValue.rawReturnValue).toString('utf-8');
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').decode(returnValue.rawReturnValue);
     if (structs[type]) {
-        return getABIStructFromABITuple(returnValue.returnValue, structs[type]);
+        return getABIStructFromABITuple(returnValue.returnValue, structs[type], structs);
     }
     return returnValue.returnValue;
 }

package/types/app-arc56.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-arc56.js","sources":["../../src/types/app-arc56.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAIA;;AAEG;AACU,MAAA,WAAY,SAAQ,OAAO,CAAC,SAAS,CAAA;AAchD,IAAA,WAAA,CAAmB,MAAc,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAA;QADI,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;AAE/B,QAAA,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM;AACpC,YAAA,GAAG,GAAG;AACN,YAAA,IAAI,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AACjI,SAAA,CAAC,CAAC,CAAA;QACH,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;AACtB,YAAA,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACpG,CAAA;KACF;IAEQ,MAAM,GAAA;QACb,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;AACF,CAAA;AAED;;;;AAIG;AACG,SAAU,sCAAsC,CAAC,MAAoB,EAAA;IACzE,OAAO,IAAI,OAAO,CAAC,YAAY,CAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,sCAAsC,CAAC,CAAC,CAAC,CAAC,CAAC,CAChI,CAAA;AACH,CAAC;AAED;;;;;AAKG;AACH;AACgB,SAAA,wBAAwB,CACtC,eAAmC,EACnC,YAA0B,EAAA;IAE1B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,KAAI;AAClD,QAAA,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;AACnC,QAAA,OAAO,CAAC,GAAG,EAAE,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;KACnI,CAAC,CACQ,CAAA;AACd,CAAC;AAED;;;;;AAKG;AACa,SAAA,wBAAwB,CAAC,MAAiB,EAAE,YAA0B,EAAA;AACpF,IAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,KAAI;AACtD,QAAA,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;AACzB,QAAA,OAAO,OAAO,IAAI,KAAK,QAAQ,GAAI,KAA0B,GAAG,wBAAwB,CAAC,KAAkB,EAAE,IAAI,CAAC,CAAA;AACpH,KAAC,CAAC,CAAA;AACJ,CAAC;AAOD;;;;;;;AAOG;SACa,kBAAkB,CAChC,KAAmC,EACnC,IAAY,EACZ,OAAqC,EAAA;AAErC,IAAA,IAAI,IAAI,KAAK,OAAO,IAAI,OAAO,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,KAAK,CAAA;AAC/D,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,MAAM,UAAU,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACtF,OAAO,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;KAC3D;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;AAMG;SACa,kBAAkB,CAChC,KAAgD,EAChD,IAAY,EACZ,OAAqC,EAAA;AAErC,IAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,UAAU;AAAE,QAAA,OAAO,KAAK,CAAA;AAC1E,IAAA,IAAI,IAAI,KAAK,OAAO,EAAE;QACpB,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,EAAE,KAAK,YAAY,UAAU,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAA,yBAAA,EAA4B,IAAI,CAAa,UAAA,EAAA,KAAK,CAAE,CAAA,CAAC,CAAA;AACtI,QAAA,OAAO,KAAK,CAAA;KACb;AACD,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,MAAM,SAAS,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;AACvE,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACxB,YAAA,SAAS,CAAC,MAAM,CAAC,KAA2B,CAAC,CAAA;SAC9C;aAAM;AACL,YAAA,OAAO,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,KAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrF;KACF;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAyB,CAAC,CAAA;AACrE,CAAC;AAED;;;;;;AAMG;AACa,SAAA,cAAc,CAAC,qBAA6B,EAAE,OAAsB,EAAA;AAClF,IAAA,IAAI,MAAc,CAAA;IAClB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACxC,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;AAC/E,QAAA,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;AACnH,QAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACtB,YAAA,MAAM,IAAI,KAAK,CACb,CAAA,0BAAA,EAA6B,qBAAqB,CAAA,aAAA,EAChD,OAAO,CAAC,IACV,CAAA,kFAAA,EAAqF,OAAO,CAAC,OAAO;AACjG,iBAAA,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;AACnD,iBAAA,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE,CAChB,CAAA;SACF;AACD,QAAA,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KACpB;SAAM;QACL,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,qBAAqB,CAAC,CAAA;AACxG,QAAA,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;QACjG,MAAM,GAAG,CAAC,CAAA;KACX;AACD,IAAA,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;AAOG;SACa,mBAAmB,CACjC,WAAkC,EAClC,MAA4B,EAC5B,OAAqB,EAAA;AAErB,IAAA,MAAM,CAAC,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;AACrD,IAAA,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;AAC/C,IAAA,IAAI,WAAW,EAAE,WAAW,EAAE;QAC5B,MAAM,WAAW,CAAC,WAAW,CAAA;KAC9B;AACD,IAAA,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,IAAI,WAAW,EAAE,WAAW,KAAK,SAAS;AAAE,QAAA,OAAO,SAAoB,CAAA;IAEhH,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,WAAW,CAAC,cAAyB,CAAA;AAElE,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,OAAO,wBAAwB,CAAC,WAAW,CAAC,WAAiC,EAAE,OAAO,CAAC,IAAI,CAAiB,CAAY,CAAA;KACzH;IAED,OAAO,WAAW,CAAC,WAAsB,CAAA;AAC3C;;;;;;;;;;;"}
+{"version":3,"file":"app-arc56.js","sources":["../../src/types/app-arc56.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { ABIReturn } from './app'\nimport { Expand } from './expand'\n\n/** Type to describe an argument within an `Arc56Method`. */\nexport type Arc56MethodArg = Expand<\n  Omit<Method['args'][number], 'type'> & {\n    type: algosdk.ABIArgumentType\n  }\n>\n\n/** Type to describe a return type within an `Arc56Method`. */\nexport type Arc56MethodReturnType = Expand<\n  Omit<Method['returns'], 'type'> & {\n    type: algosdk.ABIReturnType\n  }\n>\n\n/**\n * Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method.\n */\nexport class Arc56Method extends algosdk.ABIMethod {\n  override readonly args: Array<Arc56MethodArg>\n  override readonly returns: Arc56MethodReturnType\n\n  constructor(public method: Method) {\n    super(method)\n    this.args = method.args.map((arg) => ({\n      ...arg,\n      type: algosdk.abiTypeIsTransaction(arg.type) || algosdk.abiTypeIsReference(arg.type) ? arg.type : algosdk.ABIType.from(arg.type),\n    }))\n    this.returns = {\n      ...this.method.returns,\n      type: this.method.returns.type === 'void' ? 'void' : algosdk.ABIType.from(this.method.returns.type),\n    }\n  }\n\n  override toJSON(): Method {\n    return this.method\n  }\n}\n\n/**\n * Returns the `ABITupleType` for the given ARC-56 struct definition\n * @param struct The ARC-56 struct definition\n * @returns The `ABITupleType`\n */\nexport function getABITupleTypeFromABIStructDefinition(\n  struct: StructField[],\n  structs: Record<string, StructField[]>,\n): algosdk.ABITupleType {\n  return new algosdk.ABITupleType(\n    struct.map((v) =>\n      typeof v.type === 'string'\n        ? structs[v.type]\n          ? getABITupleTypeFromABIStructDefinition(structs[v.type], structs)\n          : algosdk.ABIType.from(v.type)\n        : getABITupleTypeFromABIStructDefinition(v.type, structs),\n    ),\n  )\n}\n\n/**\n * Converts a decoded ABI tuple as a struct.\n * @param decodedABITuple The decoded ABI tuple value\n * @param structFields The struct fields from an ARC-56 app spec\n * @returns The struct as a Record<string, any>\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function getABIStructFromABITuple<TReturn extends ABIStruct = Record<string, any>>(\n  decodedABITuple: algosdk.ABIValue[],\n  structFields: StructField[],\n  structs: Record<string, StructField[]>,\n): TReturn {\n  return Object.fromEntries(\n    structFields.map(({ name: key, type }, i) => {\n      const abiValue = decodedABITuple[i]\n      return [\n        key,\n        (typeof type === 'string' && !structs[type]) || !Array.isArray(abiValue)\n          ? decodedABITuple[i]\n          : getABIStructFromABITuple(abiValue, typeof type === 'string' ? structs[type] : type, structs),\n      ]\n    }),\n  ) as TReturn\n}\n\n/**\n * Converts an ARC-56 struct as an ABI tuple.\n * @param struct The struct to convert\n * @param structFields The struct fields from an ARC-56 app spec\n * @returns The struct as a decoded ABI tuple\n */\nexport function getABITupleFromABIStruct(\n  struct: ABIStruct,\n  structFields: StructField[],\n  structs: Record<string, StructField[]>,\n): algosdk.ABIValue[] {\n  return structFields.map(({ name: key, type }) => {\n    const value = struct[key]\n    return typeof type === 'string' && !structs[type]\n      ? (value as algosdk.ABIValue)\n      : getABITupleFromABIStruct(value as ABIStruct, typeof type === 'string' ? structs[type] : type, structs)\n  })\n}\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | algosdk.ABIValue\n}\n\n/**\n * Returns the decoded ABI value (or struct for a struct type)\n * for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs.\n * @param value The raw Algorand value (bytes or uint64)\n * @param type The ARC-56 type - either an ABI Type string or a struct name\n * @param structs The defined ARC-56 structs\n * @returns The decoded ABI value or struct\n */\nexport function getABIDecodedValue(\n  value: Uint8Array | number | bigint,\n  type: string,\n  structs: Record<string, StructField[]>,\n): algosdk.ABIValue | ABIStruct {\n  if (type === 'AVMBytes' || typeof value !== 'object') return value\n  if (type === 'AVMString') return Buffer.from(value).toString('utf-8')\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').decode(value)\n  if (structs[type]) {\n    const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type], structs).decode(value)\n    return getABIStructFromABITuple(tupleValue, structs[type], structs)\n  }\n  return algosdk.ABIType.from(type).decode(value)\n}\n\n/**\n * Returns the ABI-encoded value for the given value.\n * @param value The value to encode either already in encoded binary form (`Uint8Array`), a decoded ABI value or an ARC-56 struct\n * @param type The ARC-56 type - either an ABI Type string or a struct name\n * @param structs The defined ARC-56 structs\n * @returns The binary ABI-encoded value\n */\nexport function getABIEncodedValue(\n  value: Uint8Array | algosdk.ABIValue | ABIStruct,\n  type: string,\n  structs: Record<string, StructField[]>,\n): Uint8Array {\n  if (typeof value === 'object' && value instanceof Uint8Array) return value\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').encode(value as bigint | number)\n  if (type === 'AVMBytes' || type === 'AVMString') {\n    if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n    if (typeof value !== 'object' || !(value instanceof Uint8Array)) throw new Error(`Expected bytes value for ${type}, but got ${value}`)\n    return value\n  }\n  if (structs[type]) {\n    const tupleType = getABITupleTypeFromABIStructDefinition(structs[type], structs)\n    if (Array.isArray(value)) {\n      tupleType.encode(value as algosdk.ABIValue[])\n    } else {\n      return tupleType.encode(getABITupleFromABIStruct(value as ABIStruct, structs[type], structs))\n    }\n  }\n  return algosdk.ABIType.from(type).encode(value as algosdk.ABIValue)\n}\n\n/**\n * Returns the ARC-56 ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `Arc56Method`\n */\nexport function getArc56Method(methodNameOrSignature: string, appSpec: Arc56Contract): Arc56Method {\n  let method: Method\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => new algosdk.ABIMethod(m).getSignature())\n          .join(', ')}`,\n      )\n    }\n    method = methods[0]\n  } else {\n    const m = appSpec.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodNameOrSignature)\n    if (!m) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    method = m\n  }\n  return new Arc56Method(method)\n}\n\n/**\n * Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type\n *\n * @param returnValue The smart contract response\n * @param method The method that was called\n * @param structs The struct fields from the app spec\n * @returns The smart contract response with an updated return value\n */\nexport function getArc56ReturnValue<TReturn extends Uint8Array | algosdk.ABIValue | ABIStruct | undefined>(\n  returnValue: ABIReturn | undefined,\n  method: Method | Arc56Method,\n  structs: Record<string, StructField[]>,\n): TReturn {\n  const m = 'method' in method ? method.method : method\n  const type = m.returns.struct ?? m.returns.type\n  if (returnValue?.decodeError) {\n    throw returnValue.decodeError\n  }\n  if (type === undefined || type === 'void' || returnValue?.returnValue === undefined) return undefined as TReturn\n\n  if (type === 'AVMBytes') return returnValue.rawReturnValue as TReturn\n  if (type === 'AVMString') return Buffer.from(returnValue.rawReturnValue).toString('utf-8') as TReturn\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').decode(returnValue.rawReturnValue) as TReturn\n\n  if (structs[type]) {\n    return getABIStructFromABITuple(returnValue.returnValue as algosdk.ABIValue[], structs[type], structs) as TReturn\n  }\n\n  return returnValue.returnValue as TReturn\n}\n\n/****************/\n/** ARC-56 spec */\n/****************/\n\n/** Describes the entire contract. This interface is an extension of the interface described in ARC-4 */\nexport interface Arc56Contract {\n  /** The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the interface */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be define\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs use by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: SourceInfo[]\n    /** Clear program information */\n    clear: SourceInfo[]\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the teal (not including TMPL_ prefix) to their respecive types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABIType | AVMType | StructName\n      /** If given, the the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABIType | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This interface is an extension of the interface described in ARC-4 */\nexport interface Method {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABIType\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes or uint64 */\n      data: string | number\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type: ABIType | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       */\n      source: 'box' | 'global' | 'local' | 'literal'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABIType\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport interface Event {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABIType\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABIType = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport interface StructField {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABIType | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport interface StorageKey {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABIType | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABIType | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport interface StorageMap {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABIType | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABIType | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\nexport interface SourceInfo {\n  /** The line of pre-compiled TEAL */\n  teal?: number\n  /** The program counter offset(s) that correspond to this line of TEAL */\n  pc?: Array<number>\n  /** A human-readable string that describes the error when the program fails at this given line of TEAL */\n  errorMessage?: string\n  /** The line of the dissasembled TEAL this line of pre-compiled TEAL corresponds to */\n  disassembledTeal?: number\n}\n"],"names":[],"mappings":";;;;AAkBA;;AAEG;AACU,MAAA,WAAY,SAAQ,OAAO,CAAC,SAAS,CAAA;AAIhD,IAAA,WAAA,CAAmB,MAAc,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAA;QADI,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;AAE/B,QAAA,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM;AACpC,YAAA,GAAG,GAAG;AACN,YAAA,IAAI,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AACjI,SAAA,CAAC,CAAC,CAAA;QACH,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;AACtB,YAAA,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACpG,CAAA;KACF;IAEQ,MAAM,GAAA;QACb,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;AACF,CAAA;AAED;;;;AAIG;AACa,SAAA,sCAAsC,CACpD,MAAqB,EACrB,OAAsC,EAAA;AAEtC,IAAA,OAAO,IAAI,OAAO,CAAC,YAAY,CAC7B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KACX,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ;AACxB,UAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;cACb,sCAAsC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;cAChE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;UAC9B,sCAAsC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAC5D,CACF,CAAA;AACH,CAAC;AAED;;;;;AAKG;AACH;SACgB,wBAAwB,CACtC,eAAmC,EACnC,YAA2B,EAC3B,OAAsC,EAAA;AAEtC,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,KAAI;AAC1C,QAAA,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QACnC,OAAO;YACL,GAAG;AACH,YAAA,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;AACtE,kBAAE,eAAe,CAAC,CAAC,CAAC;kBAClB,wBAAwB,CAAC,QAAQ,EAAE,OAAO,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;SACjG,CAAA;KACF,CAAC,CACQ,CAAA;AACd,CAAC;AAED;;;;;AAKG;SACa,wBAAwB,CACtC,MAAiB,EACjB,YAA2B,EAC3B,OAAsC,EAAA;AAEtC,IAAA,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAI;AAC9C,QAAA,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QACzB,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;AAC/C,cAAG,KAA0B;cAC3B,wBAAwB,CAAC,KAAkB,EAAE,OAAO,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,CAAA;AAC5G,KAAC,CAAC,CAAA;AACJ,CAAC;AAOD;;;;;;;AAOG;SACa,kBAAkB,CAChC,KAAmC,EACnC,IAAY,EACZ,OAAsC,EAAA;AAEtC,IAAA,IAAI,IAAI,KAAK,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,KAAK,CAAA;IAClE,IAAI,IAAI,KAAK,WAAW;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrE,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC7E,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,MAAM,UAAU,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC/F,OAAO,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAA;KACpE;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;AAMG;SACa,kBAAkB,CAChC,KAAgD,EAChD,IAAY,EACZ,OAAsC,EAAA;AAEtC,IAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,UAAU;AAAE,QAAA,OAAO,KAAK,CAAA;IAC1E,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAwB,CAAC,CAAA;IAChG,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,WAAW,EAAE;QAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,EAAE,KAAK,YAAY,UAAU,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAA,yBAAA,EAA4B,IAAI,CAAa,UAAA,EAAA,KAAK,CAAE,CAAA,CAAC,CAAA;AACtI,QAAA,OAAO,KAAK,CAAA;KACb;AACD,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,MAAM,SAAS,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAA;AAChF,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACxB,YAAA,SAAS,CAAC,MAAM,CAAC,KAA2B,CAAC,CAAA;SAC9C;aAAM;AACL,YAAA,OAAO,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,KAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAA;SAC9F;KACF;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAyB,CAAC,CAAA;AACrE,CAAC;AAED;;;;;;AAMG;AACa,SAAA,cAAc,CAAC,qBAA6B,EAAE,OAAsB,EAAA;AAClF,IAAA,IAAI,MAAc,CAAA;IAClB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACxC,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;AAC/E,QAAA,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;AACnH,QAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACtB,YAAA,MAAM,IAAI,KAAK,CACb,CAAA,0BAAA,EAA6B,qBAAqB,CAAA,aAAA,EAChD,OAAO,CAAC,IACV,CAAA,kFAAA,EAAqF,OAAO,CAAC,OAAO;AACjG,iBAAA,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;AACnD,iBAAA,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE,CAChB,CAAA;SACF;AACD,QAAA,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KACpB;SAAM;QACL,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,qBAAqB,CAAC,CAAA;AACxG,QAAA,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;QACjG,MAAM,GAAG,CAAC,CAAA;KACX;AACD,IAAA,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;AAOG;SACa,mBAAmB,CACjC,WAAkC,EAClC,MAA4B,EAC5B,OAAsC,EAAA;AAEtC,IAAA,MAAM,CAAC,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;AACrD,IAAA,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;AAC/C,IAAA,IAAI,WAAW,EAAE,WAAW,EAAE;QAC5B,MAAM,WAAW,CAAC,WAAW,CAAA;KAC9B;AACD,IAAA,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,IAAI,WAAW,EAAE,WAAW,KAAK,SAAS;AAAE,QAAA,OAAO,SAAoB,CAAA;IAEhH,IAAI,IAAI,KAAK,UAAU;QAAE,OAAO,WAAW,CAAC,cAAyB,CAAA;IACrE,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAY,CAAA;IACrG,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAY,CAAA;AAE7G,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,OAAO,wBAAwB,CAAC,WAAW,CAAC,WAAiC,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAY,CAAA;KAClH;IAED,OAAO,WAAW,CAAC,WAAsB,CAAA;AAC3C;;;;;;;;;;;"}

package/types/app-arc56.mjs

@@ -25,8 +25,12 @@ class Arc56Method extends algosdk.ABIMethod {
  * @param struct The ARC-56 struct definition
  * @returns The `ABITupleType`
  */
-function getABITupleTypeFromABIStructDefinition(struct) {
-    return new algosdk.ABITupleType(Object.values(struct).map((v) => (typeof v === 'string' ? algosdk.ABIType.from(v) : getABITupleTypeFromABIStructDefinition(v))));
+function getABITupleTypeFromABIStructDefinition(struct, structs) {
+    return new algosdk.ABITupleType(struct.map((v) => typeof v.type === 'string'
+        ? structs[v.type]
+            ? getABITupleTypeFromABIStructDefinition(structs[v.type], structs)
+            : algosdk.ABIType.from(v.type)
+        : getABITupleTypeFromABIStructDefinition(v.type, structs)));
 }
 /**
  * Converts a decoded ABI tuple as a struct.
@@ -35,10 +39,15 @@ function getABITupleTypeFromABIStructDefinition(struct) {
  * @returns The struct as a Record<string, any>
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function getABIStructFromABITuple(decodedABITuple, structFields) {
-    return Object.fromEntries(Object.entries(structFields).map(([key, type], i) => {
+function getABIStructFromABITuple(decodedABITuple, structFields, structs) {
+    return Object.fromEntries(structFields.map(({ name: key, type }, i) => {
         const abiValue = decodedABITuple[i];
-        return [key, typeof type === 'string' || !Array.isArray(abiValue) ? decodedABITuple[i] : getABIStructFromABITuple(abiValue, type)];
+        return [
+            key,
+            (typeof type === 'string' && !structs[type]) || !Array.isArray(abiValue)
+                ? decodedABITuple[i]
+                : getABIStructFromABITuple(abiValue, typeof type === 'string' ? structs[type] : type, structs),
+        ];
     }));
 }
 /**
@@ -47,10 +56,12 @@ function getABIStructFromABITuple(decodedABITuple, structFields) {
  * @param structFields The struct fields from an ARC-56 app spec
  * @returns The struct as a decoded ABI tuple
  */
-function getABITupleFromABIStruct(struct, structFields) {
-    return Object.entries(structFields).map(([key, type]) => {
+function getABITupleFromABIStruct(struct, structFields, structs) {
+    return structFields.map(({ name: key, type }) => {
         const value = struct[key];
-        return typeof type === 'string' ? value : getABITupleFromABIStruct(value, type);
+        return typeof type === 'string' && !structs[type]
+            ? value
+            : getABITupleFromABIStruct(value, typeof type === 'string' ? structs[type] : type, structs);
     });
 }
 /**
@@ -62,11 +73,15 @@ function getABITupleFromABIStruct(struct, structFields) {
  * @returns The decoded ABI value or struct
  */
 function getABIDecodedValue(value, type, structs) {
-    if (type === 'bytes' || typeof value !== 'object')
+    if (type === 'AVMBytes' || typeof value !== 'object')
         return value;
+    if (type === 'AVMString')
+        return Buffer.from(value).toString('utf-8');
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').decode(value);
     if (structs[type]) {
-        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type]).decode(value);
-        return getABIStructFromABITuple(tupleValue, structs[type]);
+        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type], structs).decode(value);
+        return getABIStructFromABITuple(tupleValue, structs[type], structs);
     }
     return algosdk.ABIType.from(type).decode(value);
 }
@@ -80,7 +95,9 @@ function getABIDecodedValue(value, type, structs) {
 function getABIEncodedValue(value, type, structs) {
     if (typeof value === 'object' && value instanceof Uint8Array)
         return value;
-    if (type === 'bytes') {
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').encode(value);
+    if (type === 'AVMBytes' || type === 'AVMString') {
         if (typeof value === 'string')
             return Buffer.from(value, 'utf-8');
         if (typeof value !== 'object' || !(value instanceof Uint8Array))
@@ -88,12 +105,12 @@ function getABIEncodedValue(value, type, structs) {
         return value;
     }
     if (structs[type]) {
-        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type]);
+        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type], structs);
         if (Array.isArray(value)) {
             tupleType.encode(value);
         }
         else {
-            return tupleType.encode(getABITupleFromABIStruct(value, structs[type]));
+            return tupleType.encode(getABITupleFromABIStruct(value, structs[type], structs));
         }
     }
     return algosdk.ABIType.from(type).encode(value);
@@ -142,10 +159,14 @@ function getArc56ReturnValue(returnValue, method, structs) {
     }
     if (type === undefined || type === 'void' || returnValue?.returnValue === undefined)
         return undefined;
-    if (type === 'bytes')
+    if (type === 'AVMBytes')
         return returnValue.rawReturnValue;
+    if (type === 'AVMString')
+        return Buffer.from(returnValue.rawReturnValue).toString('utf-8');
+    if (type === 'AVMUint64')
+        return algosdk.ABIType.from('uint64').decode(returnValue.rawReturnValue);
     if (structs[type]) {
-        return getABIStructFromABITuple(returnValue.returnValue, structs[type]);
+        return getABIStructFromABITuple(returnValue.returnValue, structs[type], structs);
     }
     return returnValue.returnValue;
 }

package/types/app-arc56.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app-arc56.mjs","sources":["../../src/types/app-arc56.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIA;;AAEG;AACU,MAAA,WAAY,SAAQ,OAAO,CAAC,SAAS,CAAA;AAchD,IAAA,WAAA,CAAmB,MAAc,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAA;QADI,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;AAE/B,QAAA,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM;AACpC,YAAA,GAAG,GAAG;AACN,YAAA,IAAI,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AACjI,SAAA,CAAC,CAAC,CAAA;QACH,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;AACtB,YAAA,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACpG,CAAA;KACF;IAEQ,MAAM,GAAA;QACb,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;AACF,CAAA;AAED;;;;AAIG;AACG,SAAU,sCAAsC,CAAC,MAAoB,EAAA;IACzE,OAAO,IAAI,OAAO,CAAC,YAAY,CAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,sCAAsC,CAAC,CAAC,CAAC,CAAC,CAAC,CAChI,CAAA;AACH,CAAC;AAED;;;;;AAKG;AACH;AACgB,SAAA,wBAAwB,CACtC,eAAmC,EACnC,YAA0B,EAAA;IAE1B,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,KAAI;AAClD,QAAA,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;AACnC,QAAA,OAAO,CAAC,GAAG,EAAE,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAA;KACnI,CAAC,CACQ,CAAA;AACd,CAAC;AAED;;;;;AAKG;AACa,SAAA,wBAAwB,CAAC,MAAiB,EAAE,YAA0B,EAAA;AACpF,IAAA,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,KAAI;AACtD,QAAA,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;AACzB,QAAA,OAAO,OAAO,IAAI,KAAK,QAAQ,GAAI,KAA0B,GAAG,wBAAwB,CAAC,KAAkB,EAAE,IAAI,CAAC,CAAA;AACpH,KAAC,CAAC,CAAA;AACJ,CAAC;AAOD;;;;;;;AAOG;SACa,kBAAkB,CAChC,KAAmC,EACnC,IAAY,EACZ,OAAqC,EAAA;AAErC,IAAA,IAAI,IAAI,KAAK,OAAO,IAAI,OAAO,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,KAAK,CAAA;AAC/D,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,MAAM,UAAU,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QACtF,OAAO,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;KAC3D;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;AAMG;SACa,kBAAkB,CAChC,KAAgD,EAChD,IAAY,EACZ,OAAqC,EAAA;AAErC,IAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,UAAU;AAAE,QAAA,OAAO,KAAK,CAAA;AAC1E,IAAA,IAAI,IAAI,KAAK,OAAO,EAAE;QACpB,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,EAAE,KAAK,YAAY,UAAU,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAA,yBAAA,EAA4B,IAAI,CAAa,UAAA,EAAA,KAAK,CAAE,CAAA,CAAC,CAAA;AACtI,QAAA,OAAO,KAAK,CAAA;KACb;AACD,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,MAAM,SAAS,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;AACvE,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACxB,YAAA,SAAS,CAAC,MAAM,CAAC,KAA2B,CAAC,CAAA;SAC9C;aAAM;AACL,YAAA,OAAO,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,KAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACrF;KACF;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAyB,CAAC,CAAA;AACrE,CAAC;AAED;;;;;;AAMG;AACa,SAAA,cAAc,CAAC,qBAA6B,EAAE,OAAsB,EAAA;AAClF,IAAA,IAAI,MAAc,CAAA;IAClB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACxC,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;AAC/E,QAAA,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;AACnH,QAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACtB,YAAA,MAAM,IAAI,KAAK,CACb,CAAA,0BAAA,EAA6B,qBAAqB,CAAA,aAAA,EAChD,OAAO,CAAC,IACV,CAAA,kFAAA,EAAqF,OAAO,CAAC,OAAO;AACjG,iBAAA,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;AACnD,iBAAA,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE,CAChB,CAAA;SACF;AACD,QAAA,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KACpB;SAAM;QACL,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,qBAAqB,CAAC,CAAA;AACxG,QAAA,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;QACjG,MAAM,GAAG,CAAC,CAAA;KACX;AACD,IAAA,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;AAOG;SACa,mBAAmB,CACjC,WAAkC,EAClC,MAA4B,EAC5B,OAAqB,EAAA;AAErB,IAAA,MAAM,CAAC,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;AACrD,IAAA,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;AAC/C,IAAA,IAAI,WAAW,EAAE,WAAW,EAAE;QAC5B,MAAM,WAAW,CAAC,WAAW,CAAA;KAC9B;AACD,IAAA,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,IAAI,WAAW,EAAE,WAAW,KAAK,SAAS;AAAE,QAAA,OAAO,SAAoB,CAAA;IAEhH,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,WAAW,CAAC,cAAyB,CAAA;AAElE,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,OAAO,wBAAwB,CAAC,WAAW,CAAC,WAAiC,EAAE,OAAO,CAAC,IAAI,CAAiB,CAAY,CAAA;KACzH;IAED,OAAO,WAAW,CAAC,WAAsB,CAAA;AAC3C;;;;"}
+{"version":3,"file":"app-arc56.mjs","sources":["../../src/types/app-arc56.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { ABIReturn } from './app'\nimport { Expand } from './expand'\n\n/** Type to describe an argument within an `Arc56Method`. */\nexport type Arc56MethodArg = Expand<\n  Omit<Method['args'][number], 'type'> & {\n    type: algosdk.ABIArgumentType\n  }\n>\n\n/** Type to describe a return type within an `Arc56Method`. */\nexport type Arc56MethodReturnType = Expand<\n  Omit<Method['returns'], 'type'> & {\n    type: algosdk.ABIReturnType\n  }\n>\n\n/**\n * Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method.\n */\nexport class Arc56Method extends algosdk.ABIMethod {\n  override readonly args: Array<Arc56MethodArg>\n  override readonly returns: Arc56MethodReturnType\n\n  constructor(public method: Method) {\n    super(method)\n    this.args = method.args.map((arg) => ({\n      ...arg,\n      type: algosdk.abiTypeIsTransaction(arg.type) || algosdk.abiTypeIsReference(arg.type) ? arg.type : algosdk.ABIType.from(arg.type),\n    }))\n    this.returns = {\n      ...this.method.returns,\n      type: this.method.returns.type === 'void' ? 'void' : algosdk.ABIType.from(this.method.returns.type),\n    }\n  }\n\n  override toJSON(): Method {\n    return this.method\n  }\n}\n\n/**\n * Returns the `ABITupleType` for the given ARC-56 struct definition\n * @param struct The ARC-56 struct definition\n * @returns The `ABITupleType`\n */\nexport function getABITupleTypeFromABIStructDefinition(\n  struct: StructField[],\n  structs: Record<string, StructField[]>,\n): algosdk.ABITupleType {\n  return new algosdk.ABITupleType(\n    struct.map((v) =>\n      typeof v.type === 'string'\n        ? structs[v.type]\n          ? getABITupleTypeFromABIStructDefinition(structs[v.type], structs)\n          : algosdk.ABIType.from(v.type)\n        : getABITupleTypeFromABIStructDefinition(v.type, structs),\n    ),\n  )\n}\n\n/**\n * Converts a decoded ABI tuple as a struct.\n * @param decodedABITuple The decoded ABI tuple value\n * @param structFields The struct fields from an ARC-56 app spec\n * @returns The struct as a Record<string, any>\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport function getABIStructFromABITuple<TReturn extends ABIStruct = Record<string, any>>(\n  decodedABITuple: algosdk.ABIValue[],\n  structFields: StructField[],\n  structs: Record<string, StructField[]>,\n): TReturn {\n  return Object.fromEntries(\n    structFields.map(({ name: key, type }, i) => {\n      const abiValue = decodedABITuple[i]\n      return [\n        key,\n        (typeof type === 'string' && !structs[type]) || !Array.isArray(abiValue)\n          ? decodedABITuple[i]\n          : getABIStructFromABITuple(abiValue, typeof type === 'string' ? structs[type] : type, structs),\n      ]\n    }),\n  ) as TReturn\n}\n\n/**\n * Converts an ARC-56 struct as an ABI tuple.\n * @param struct The struct to convert\n * @param structFields The struct fields from an ARC-56 app spec\n * @returns The struct as a decoded ABI tuple\n */\nexport function getABITupleFromABIStruct(\n  struct: ABIStruct,\n  structFields: StructField[],\n  structs: Record<string, StructField[]>,\n): algosdk.ABIValue[] {\n  return structFields.map(({ name: key, type }) => {\n    const value = struct[key]\n    return typeof type === 'string' && !structs[type]\n      ? (value as algosdk.ABIValue)\n      : getABITupleFromABIStruct(value as ABIStruct, typeof type === 'string' ? structs[type] : type, structs)\n  })\n}\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | algosdk.ABIValue\n}\n\n/**\n * Returns the decoded ABI value (or struct for a struct type)\n * for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs.\n * @param value The raw Algorand value (bytes or uint64)\n * @param type The ARC-56 type - either an ABI Type string or a struct name\n * @param structs The defined ARC-56 structs\n * @returns The decoded ABI value or struct\n */\nexport function getABIDecodedValue(\n  value: Uint8Array | number | bigint,\n  type: string,\n  structs: Record<string, StructField[]>,\n): algosdk.ABIValue | ABIStruct {\n  if (type === 'AVMBytes' || typeof value !== 'object') return value\n  if (type === 'AVMString') return Buffer.from(value).toString('utf-8')\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').decode(value)\n  if (structs[type]) {\n    const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type], structs).decode(value)\n    return getABIStructFromABITuple(tupleValue, structs[type], structs)\n  }\n  return algosdk.ABIType.from(type).decode(value)\n}\n\n/**\n * Returns the ABI-encoded value for the given value.\n * @param value The value to encode either already in encoded binary form (`Uint8Array`), a decoded ABI value or an ARC-56 struct\n * @param type The ARC-56 type - either an ABI Type string or a struct name\n * @param structs The defined ARC-56 structs\n * @returns The binary ABI-encoded value\n */\nexport function getABIEncodedValue(\n  value: Uint8Array | algosdk.ABIValue | ABIStruct,\n  type: string,\n  structs: Record<string, StructField[]>,\n): Uint8Array {\n  if (typeof value === 'object' && value instanceof Uint8Array) return value\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').encode(value as bigint | number)\n  if (type === 'AVMBytes' || type === 'AVMString') {\n    if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n    if (typeof value !== 'object' || !(value instanceof Uint8Array)) throw new Error(`Expected bytes value for ${type}, but got ${value}`)\n    return value\n  }\n  if (structs[type]) {\n    const tupleType = getABITupleTypeFromABIStructDefinition(structs[type], structs)\n    if (Array.isArray(value)) {\n      tupleType.encode(value as algosdk.ABIValue[])\n    } else {\n      return tupleType.encode(getABITupleFromABIStruct(value as ABIStruct, structs[type], structs))\n    }\n  }\n  return algosdk.ABIType.from(type).encode(value as algosdk.ABIValue)\n}\n\n/**\n * Returns the ARC-56 ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `Arc56Method`\n */\nexport function getArc56Method(methodNameOrSignature: string, appSpec: Arc56Contract): Arc56Method {\n  let method: Method\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => new algosdk.ABIMethod(m).getSignature())\n          .join(', ')}`,\n      )\n    }\n    method = methods[0]\n  } else {\n    const m = appSpec.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodNameOrSignature)\n    if (!m) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    method = m\n  }\n  return new Arc56Method(method)\n}\n\n/**\n * Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type\n *\n * @param returnValue The smart contract response\n * @param method The method that was called\n * @param structs The struct fields from the app spec\n * @returns The smart contract response with an updated return value\n */\nexport function getArc56ReturnValue<TReturn extends Uint8Array | algosdk.ABIValue | ABIStruct | undefined>(\n  returnValue: ABIReturn | undefined,\n  method: Method | Arc56Method,\n  structs: Record<string, StructField[]>,\n): TReturn {\n  const m = 'method' in method ? method.method : method\n  const type = m.returns.struct ?? m.returns.type\n  if (returnValue?.decodeError) {\n    throw returnValue.decodeError\n  }\n  if (type === undefined || type === 'void' || returnValue?.returnValue === undefined) return undefined as TReturn\n\n  if (type === 'AVMBytes') return returnValue.rawReturnValue as TReturn\n  if (type === 'AVMString') return Buffer.from(returnValue.rawReturnValue).toString('utf-8') as TReturn\n  if (type === 'AVMUint64') return algosdk.ABIType.from('uint64').decode(returnValue.rawReturnValue) as TReturn\n\n  if (structs[type]) {\n    return getABIStructFromABITuple(returnValue.returnValue as algosdk.ABIValue[], structs[type], structs) as TReturn\n  }\n\n  return returnValue.returnValue as TReturn\n}\n\n/****************/\n/** ARC-56 spec */\n/****************/\n\n/** Describes the entire contract. This interface is an extension of the interface described in ARC-4 */\nexport interface Arc56Contract {\n  /** The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the interface */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be define\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs use by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: SourceInfo[]\n    /** Clear program information */\n    clear: SourceInfo[]\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the teal (not including TMPL_ prefix) to their respecive types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABIType | AVMType | StructName\n      /** If given, the the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABIType | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This interface is an extension of the interface described in ARC-4 */\nexport interface Method {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABIType\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes or uint64 */\n      data: string | number\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type: ABIType | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       */\n      source: 'box' | 'global' | 'local' | 'literal'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABIType\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport interface Event {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABIType\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABIType = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport interface StructField {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABIType | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport interface StorageKey {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABIType | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABIType | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport interface StorageMap {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABIType | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABIType | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\nexport interface SourceInfo {\n  /** The line of pre-compiled TEAL */\n  teal?: number\n  /** The program counter offset(s) that correspond to this line of TEAL */\n  pc?: Array<number>\n  /** A human-readable string that describes the error when the program fails at this given line of TEAL */\n  errorMessage?: string\n  /** The line of the dissasembled TEAL this line of pre-compiled TEAL corresponds to */\n  disassembledTeal?: number\n}\n"],"names":[],"mappings":";;AAkBA;;AAEG;AACU,MAAA,WAAY,SAAQ,OAAO,CAAC,SAAS,CAAA;AAIhD,IAAA,WAAA,CAAmB,MAAc,EAAA;QAC/B,KAAK,CAAC,MAAM,CAAC,CAAA;QADI,IAAM,CAAA,MAAA,GAAN,MAAM,CAAQ;AAE/B,QAAA,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM;AACpC,YAAA,GAAG,GAAG;AACN,YAAA,IAAI,EAAE,OAAO,CAAC,oBAAoB,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;AACjI,SAAA,CAAC,CAAC,CAAA;QACH,IAAI,CAAC,OAAO,GAAG;AACb,YAAA,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;AACtB,YAAA,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACpG,CAAA;KACF;IAEQ,MAAM,GAAA;QACb,OAAO,IAAI,CAAC,MAAM,CAAA;KACnB;AACF,CAAA;AAED;;;;AAIG;AACa,SAAA,sCAAsC,CACpD,MAAqB,EACrB,OAAsC,EAAA;AAEtC,IAAA,OAAO,IAAI,OAAO,CAAC,YAAY,CAC7B,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KACX,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ;AACxB,UAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;cACb,sCAAsC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;cAChE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;UAC9B,sCAAsC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAC5D,CACF,CAAA;AACH,CAAC;AAED;;;;;AAKG;AACH;SACgB,wBAAwB,CACtC,eAAmC,EACnC,YAA2B,EAC3B,OAAsC,EAAA;AAEtC,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,KAAI;AAC1C,QAAA,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;QACnC,OAAO;YACL,GAAG;AACH,YAAA,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;AACtE,kBAAE,eAAe,CAAC,CAAC,CAAC;kBAClB,wBAAwB,CAAC,QAAQ,EAAE,OAAO,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC;SACjG,CAAA;KACF,CAAC,CACQ,CAAA;AACd,CAAC;AAED;;;;;AAKG;SACa,wBAAwB,CACtC,MAAiB,EACjB,YAA2B,EAC3B,OAAsC,EAAA;AAEtC,IAAA,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAI;AAC9C,QAAA,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QACzB,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;AAC/C,cAAG,KAA0B;cAC3B,wBAAwB,CAAC,KAAkB,EAAE,OAAO,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,CAAA;AAC5G,KAAC,CAAC,CAAA;AACJ,CAAC;AAOD;;;;;;;AAOG;SACa,kBAAkB,CAChC,KAAmC,EACnC,IAAY,EACZ,OAAsC,EAAA;AAEtC,IAAA,IAAI,IAAI,KAAK,UAAU,IAAI,OAAO,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,KAAK,CAAA;IAClE,IAAI,IAAI,KAAK,WAAW;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;IACrE,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC7E,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,MAAM,UAAU,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC/F,OAAO,wBAAwB,CAAC,UAAU,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAA;KACpE;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AACjD,CAAC;AAED;;;;;;AAMG;SACa,kBAAkB,CAChC,KAAgD,EAChD,IAAY,EACZ,OAAsC,EAAA;AAEtC,IAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,UAAU;AAAE,QAAA,OAAO,KAAK,CAAA;IAC1E,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAwB,CAAC,CAAA;IAChG,IAAI,IAAI,KAAK,UAAU,IAAI,IAAI,KAAK,WAAW,EAAE;QAC/C,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACjE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,EAAE,KAAK,YAAY,UAAU,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAA,yBAAA,EAA4B,IAAI,CAAa,UAAA,EAAA,KAAK,CAAE,CAAA,CAAC,CAAA;AACtI,QAAA,OAAO,KAAK,CAAA;KACb;AACD,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;QACjB,MAAM,SAAS,GAAG,sCAAsC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAA;AAChF,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;AACxB,YAAA,SAAS,CAAC,MAAM,CAAC,KAA2B,CAAC,CAAA;SAC9C;aAAM;AACL,YAAA,OAAO,SAAS,CAAC,MAAM,CAAC,wBAAwB,CAAC,KAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAA;SAC9F;KACF;AACD,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAyB,CAAC,CAAA;AACrE,CAAC;AAED;;;;;;AAMG;AACa,SAAA,cAAc,CAAC,qBAA6B,EAAE,OAAsB,EAAA;AAClF,IAAA,IAAI,MAAc,CAAA;IAClB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACxC,QAAA,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,qBAAqB,CAAC,CAAA;AAC/E,QAAA,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;AACnH,QAAA,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;AACtB,YAAA,MAAM,IAAI,KAAK,CACb,CAAA,0BAAA,EAA6B,qBAAqB,CAAA,aAAA,EAChD,OAAO,CAAC,IACV,CAAA,kFAAA,EAAqF,OAAO,CAAC,OAAO;AACjG,iBAAA,GAAG,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAC;AACnD,iBAAA,IAAI,CAAC,IAAI,CAAC,CAAA,CAAE,CAChB,CAAA;SACF;AACD,QAAA,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;KACpB;SAAM;QACL,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,KAAK,qBAAqB,CAAC,CAAA;AACxG,QAAA,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,CAAyB,sBAAA,EAAA,qBAAqB,CAAO,IAAA,EAAA,OAAO,CAAC,IAAI,CAAO,KAAA,CAAA,CAAC,CAAA;QACjG,MAAM,GAAG,CAAC,CAAA;KACX;AACD,IAAA,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;AAChC,CAAC;AAED;;;;;;;AAOG;SACa,mBAAmB,CACjC,WAAkC,EAClC,MAA4B,EAC5B,OAAsC,EAAA;AAEtC,IAAA,MAAM,CAAC,GAAG,QAAQ,IAAI,MAAM,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,CAAA;AACrD,IAAA,MAAM,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;AAC/C,IAAA,IAAI,WAAW,EAAE,WAAW,EAAE;QAC5B,MAAM,WAAW,CAAC,WAAW,CAAA;KAC9B;AACD,IAAA,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,MAAM,IAAI,WAAW,EAAE,WAAW,KAAK,SAAS;AAAE,QAAA,OAAO,SAAoB,CAAA;IAEhH,IAAI,IAAI,KAAK,UAAU;QAAE,OAAO,WAAW,CAAC,cAAyB,CAAA;IACrE,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAY,CAAA;IACrG,IAAI,IAAI,KAAK,WAAW;AAAE,QAAA,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAY,CAAA;AAE7G,IAAA,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE;AACjB,QAAA,OAAO,wBAAwB,CAAC,WAAW,CAAC,WAAiC,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,CAAY,CAAA;KAClH;IAED,OAAO,WAAW,CAAC,WAAsB,CAAA;AAC3C;;;;"}