@algorandfoundation/algokit-utils 7.0.0-beta.3 → 7.0.0-beta.4

package/types/app-arc56.d.ts

@@ -0,0 +1,326 @@
+import algosdk from 'algosdk';
+import { ABIReturn } from './app';
+import { Expand } from './expand';
+/**
+ * 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;
+    }>;
+    constructor(method: Method);
+    toJSON(): Method;
+}
+/**
+ * Returns the `ABITupleType` for the given ARC-56 struct definition
+ * @param struct The ARC-56 struct definition
+ * @returns The `ABITupleType`
+ */
+export declare function getABITupleTypeFromABIStructDefinition(struct: StructFields): 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;
+/**
+ * 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[];
+/** Decoded ARC-56 struct as a struct rather than a tuple. */
+export type ABIStruct = {
+    [key: string]: ABIStruct | algosdk.ABIValue;
+};
+/**
+ * Returns the decoded ABI value (or struct for a struct type)
+ * for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs.
+ * @param value The raw Algorand value (bytes or uint64)
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @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;
+/**
+ * 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
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @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;
+/**
+ * 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.
+ * e.g. `my_method` or `my_method(unit64,string)bytes`
+ * @param appSpec The app spec for the app
+ * @returns The `Arc56Method`
+ */
+export declare function getArc56Method(methodNameOrSignature: string, appSpec: Arc56Contract): Arc56Method;
+/**
+ * Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type
+ *
+ * @param returnValue The smart contract response
+ * @param method The method that was called
+ * @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;
+/****************/
+/** ARC-56 spec */
+/****************/
+/** Describes the entire contract. This interface is an extension of the interface described in ARC-4 */
+export interface Arc56Contract {
+    /** The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56 */
+    arcs: number[];
+    /** A user-friendly name for the contract */
+    name: string;
+    /** Optional, user-friendly description for the interface */
+    desc?: string;
+    /**
+     * Optional object listing the contract instances across different networks
+     */
+    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 */
+    structs: {
+        [structName: StructName]: StructFields;
+    };
+    /** All of the methods that the contract implements */
+    methods: Method[];
+    state: {
+        /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */
+        schema: {
+            global: {
+                ints: number;
+                bytes: number;
+            };
+            local: {
+                ints: number;
+                bytes: number;
+            };
+        };
+        /** Mapping of human-readable names to StorageKey objects */
+        keys: {
+            global: {
+                [name: string]: StorageKey;
+            };
+            local: {
+                [name: string]: StorageKey;
+            };
+            box: {
+                [name: string]: StorageKey;
+            };
+        };
+        /** Mapping of human-readable names to StorageMap objects */
+        maps: {
+            global: {
+                [name: string]: StorageMap;
+            };
+            local: {
+                [name: string]: StorageMap;
+            };
+            box: {
+                [name: string]: StorageMap;
+            };
+        };
+    };
+    /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */
+    bareActions: {
+        /** OnCompletes this method allows when appID === 0 */
+        create: ('NoOp' | 'OptIn' | 'DeleteApplication')[];
+        /** OnCompletes this method allows when appID !== 0 */
+        call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[];
+    };
+    /** Information about the TEAL programs */
+    sourceInfo?: {
+        /** Approval program information */
+        approval: SourceInfo[];
+        /** Clear program information */
+        clear: SourceInfo[];
+    };
+    /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */
+    source?: {
+        /** The approval program */
+        approval: string;
+        /** The clear program */
+        clear: string;
+    };
+    /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */
+    byteCode?: {
+        /** The approval program */
+        approval: string;
+        /** The clear program */
+        clear: string;
+    };
+    /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */
+    compilerInfo?: {
+        /** The name of the compiler */
+        compiler: 'algod' | 'puya';
+        /** Compiler version information */
+        compilerVersion: {
+            major: number;
+            minor: number;
+            patch: number;
+            commit?: string;
+        };
+    };
+    /** ARC-28 events that MAY be emitted by this contract */
+    events?: Array<Event>;
+    /** A mapping of template variable names as they appear in the teal (not including TMPL_ prefix) to their respecive types and values (if applicable) */
+    templateVariables?: {
+        [name: string]: {
+            /** The type of the template variable */
+            type: ABIType | AVMBytes | StructName;
+            /** If given, the the base64 encoded value used for the given app/program */
+            value?: string;
+        };
+    };
+    /** The scratch variables used during runtime */
+    scratchVariables?: {
+        [name: string]: {
+            slot: number;
+            type: ABIType | AVMBytes | StructName;
+        };
+    };
+}
+/** Describes a method in the contract. This interface is an extension of the interface described in ARC-4 */
+export interface Method {
+    /** The name of the method */
+    name: string;
+    /** Optional, user-friendly description for the method */
+    desc?: string;
+    /** The arguments of the method, in order */
+    args: Array<{
+        /** The type of the argument */
+        type: ABIType;
+        /** If the type is a struct, the name of the struct */
+        struct?: StructName;
+        /** Optional, user-friendly name for the argument */
+        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;
+    }>;
+    /** Information about the method's return value */
+    returns: {
+        /** The type of the return value, or "void" to indicate no return value. */
+        type: ABIType;
+        /** If the type is a struct, the name of the struct */
+        struct?: StructName;
+        /** Optional, user-friendly description for the return value */
+        desc?: string;
+    };
+    /** an action is a combination of call/create and an OnComplete */
+    actions: {
+        /** OnCompletes this method allows when appID === 0 */
+        create: ('NoOp' | 'OptIn' | 'DeleteApplication')[];
+        /** OnCompletes this method allows when appID !== 0 */
+        call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[];
+    };
+    /** If this method does not write anything to the ledger (ARC-22) */
+    readonly?: boolean;
+    /** ARC-28 events that MAY be emitted by this method */
+    events?: Array<Event>;
+    /** Information that clients can use when calling the method */
+    recommendations?: {
+        /** The number of inner transactions the caller should cover the fees for */
+        innerTransactionCount?: number;
+        /** Recommended box references to include */
+        boxes?: {
+            /** The app ID for the box */
+            app?: number;
+            /** The base64 encoded box key */
+            key: string;
+            /** The number of bytes being read from the box */
+            readBytes: number;
+            /** The number of bytes being written to the box */
+            writeBytes: number;
+        };
+        /** Recommended foreign accounts */
+        accounts?: string[];
+        /** Recommended foreign apps */
+        apps?: number[];
+        /** Recommended foreign assets */
+        assets?: number[];
+    };
+}
+/** ARC-28 event */
+export interface Event {
+    /** The name of the event */
+    name: string;
+    /** Optional, user-friendly description for the event */
+    desc?: string;
+    /** The arguments of the event, in order */
+    args: Array<{
+        /** The type of the argument */
+        type: ABIType;
+        /** Optional, user-friendly name for the argument */
+        name?: string;
+        /** Optional, user-friendly description for the argument */
+        desc?: string;
+        /** If the type is a struct, the name of the struct */
+        struct?: StructName;
+    }>;
+}
+/** An ABI-encoded type */
+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;
+}
+/** 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;
+    /** The type of the value */
+    valueType: ABIType | AVMBytes | StructName;
+    /** The bytes of the key encoded as base64 */
+    key: string;
+}
+/** Describes a mapping of key-value pairs in storage */
+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;
+    /** The type of the values in the map */
+    valueType: ABIType | AVMBytes | StructName;
+    /** The base64-encoded prefix of the map keys*/
+    prefix?: string;
+}
+export interface SourceInfo {
+    /** The line of pre-compiled TEAL */
+    teal?: number;
+    /** The program counter offset(s) that correspond to this line of TEAL */
+    pc?: Array<number>;
+    /** A human-readable string that describes the error when the program fails at this given line of TEAL */
+    errorMessage?: string;
+    /** 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.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-arc56.d.ts","sourceRoot":"","sources":["../../src/types/app-arc56.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,SAAS,CAAA;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AACjC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC;;GAEG;AACH,qBAAa,WAAY,SAAQ,OAAO,CAAC,SAAS;IAc7B,MAAM,EAAE,MAAM;IAbjC,SAAkB,IAAI,EAAE,KAAK,CAC3B,MAAM,CACJ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GAAG;QACrC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAA;KAC9B,CACF,CACF,CAAA;IACD,SAAkB,OAAO,EAAE,MAAM,CAC/B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,GAAG;QAChC,IAAI,EAAE,OAAO,CAAC,aAAa,CAAA;KAC5B,CACF,CAAA;gBAEkB,MAAM,EAAE,MAAM;IAYxB,MAAM,IAAI,MAAM;CAG1B;AAED;;;;GAIG;AACH,wBAAgB,sCAAsC,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAIjG;AAED;;;;;GAKG;AAEH,wBAAgB,wBAAwB,CAAC,OAAO,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACtF,eAAe,EAAE,OAAO,CAAC,QAAQ,EAAE,EACnC,YAAY,EAAE,YAAY,GACzB,OAAO,CAOT;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,EAAE,CAK1G;AAED,6DAA6D;AAC7D,MAAM,MAAM,SAAS,GAAG;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAA;CAC5C,CAAA;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,MAAM,EACnC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GACpC,OAAO,CAAC,QAAQ,GAAG,SAAS,CAO9B;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,EAChD,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GACpC,UAAU,CAgBZ;AAED;;;;;;GAMG;AACH,wBAAgB,cAAc,CAAC,qBAAqB,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,WAAW,CAqBjG;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,SAAS,UAAU,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,GAAG,SAAS,EACvG,WAAW,EAAE,SAAS,GAAG,SAAS,EAClC,MAAM,EAAE,MAAM,GAAG,WAAW,EAC5B,OAAO,EAAE,YAAY,GACpB,OAAO,CAeT;AAED,kBAAkB;AAClB,kBAAkB;AAClB,kBAAkB;AAElB,wGAAwG;AACxG,MAAM,WAAW,aAAa;IAC5B,sGAAsG;IACtG,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE;QACT;;;;;WAKG;QACH,CAAC,OAAO,EAAE,MAAM,GAAG;YACjB,0DAA0D;YAC1D,KAAK,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;IACD,2CAA2C;IAC3C,OAAO,EAAE;QAAE,CAAC,UAAU,EAAE,UAAU,GAAG,YAAY,CAAA;KAAE,CAAA;IACnD,sDAAsD;IACtD,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE;QACL,uJAAuJ;QACvJ,MAAM,EAAE;YACN,MAAM,EAAE;gBACN,IAAI,EAAE,MAAM,CAAA;gBACZ,KAAK,EAAE,MAAM,CAAA;aACd,CAAA;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAA;gBACZ,KAAK,EAAE,MAAM,CAAA;aACd,CAAA;SACF,CAAA;QACD,4DAA4D;QAC5D,IAAI,EAAE;YACJ,MAAM,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;YACtC,KAAK,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;YACrC,GAAG,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;SACpC,CAAA;QACD,4DAA4D;QAC5D,IAAI,EAAE;YACJ,MAAM,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;YACtC,KAAK,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;YACrC,GAAG,EAAE;gBAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;aAAE,CAAA;SACpC,CAAA;KACF,CAAA;IACD,2GAA2G;IAC3G,WAAW,EAAE;QACX,sDAAsD;QACtD,MAAM,EAAE,CAAC,MAAM,GAAG,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAA;QAClD,sDAAsD;QACtD,IAAI,EAAE,CAAC,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,mBAAmB,GAAG,mBAAmB,CAAC,EAAE,CAAA;KACnG,CAAA;IACD,0CAA0C;IAC1C,UAAU,CAAC,EAAE;QACX,mCAAmC;QACnC,QAAQ,EAAE,UAAU,EAAE,CAAA;QACtB,gCAAgC;QAChC,KAAK,EAAE,UAAU,EAAE,CAAA;KACpB,CAAA;IACD,8GAA8G;IAC9G,MAAM,CAAC,EAAE;QACP,2BAA2B;QAC3B,QAAQ,EAAE,MAAM,CAAA;QAChB,wBAAwB;QACxB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,8FAA8F;IAC9F,QAAQ,CAAC,EAAE;QACT,2BAA2B;QAC3B,QAAQ,EAAE,MAAM,CAAA;QAChB,wBAAwB;QACxB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,oIAAoI;IACpI,YAAY,CAAC,EAAE;QACb,+BAA+B;QAC/B,QAAQ,EAAE,OAAO,GAAG,MAAM,CAAA;QAC1B,mCAAmC;QACnC,eAAe,EAAE;YACf,KAAK,EAAE,MAAM,CAAA;YACb,KAAK,EAAE,MAAM,CAAA;YACb,KAAK,EAAE,MAAM,CAAA;YACb,MAAM,CAAC,EAAE,MAAM,CAAA;SAChB,CAAA;KACF,CAAA;IACD,yDAAyD;IACzD,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IACrB,uJAAuJ;IACvJ,iBAAiB,CAAC,EAAE;QAClB,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,wCAAwC;YACxC,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;YACrC,4EAA4E;YAC5E,KAAK,CAAC,EAAE,MAAM,CAAA;SACf,CAAA;KACF,CAAA;IACD,gDAAgD;IAChD,gBAAgB,CAAC,EAAE;QACjB,CAAC,IAAI,EAAE,MAAM,GAAG;YACd,IAAI,EAAE,MAAM,CAAA;YACZ,IAAI,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;SACtC,CAAA;KACF,CAAA;CACF;AAED,6GAA6G;AAC7G,MAAM,WAAW,MAAM;IACrB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,IAAI,EAAE,KAAK,CAAC;QACV,+BAA+B;QAC/B,IAAI,EAAE,OAAO,CAAA;QACb,sDAAsD;QACtD,MAAM,CAAC,EAAE,UAAU,CAAA;QACnB,oDAAoD;QACpD,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,2DAA2D;QAC3D,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,8EAA8E;QAC9E,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,CAAC,CAAA;IACF,kDAAkD;IAClD,OAAO,EAAE;QACP,2EAA2E;QAC3E,IAAI,EAAE,OAAO,CAAA;QACb,sDAAsD;QACtD,MAAM,CAAC,EAAE,UAAU,CAAA;QACnB,+DAA+D;QAC/D,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,kEAAkE;IAClE,OAAO,EAAE;QACP,sDAAsD;QACtD,MAAM,EAAE,CAAC,MAAM,GAAG,OAAO,GAAG,mBAAmB,CAAC,EAAE,CAAA;QAClD,sDAAsD;QACtD,IAAI,EAAE,CAAC,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,mBAAmB,GAAG,mBAAmB,CAAC,EAAE,CAAA;KACnG,CAAA;IACD,oEAAoE;IACpE,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,uDAAuD;IACvD,MAAM,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA;IACrB,+DAA+D;IAC/D,eAAe,CAAC,EAAE;QAChB,4EAA4E;QAC5E,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,4CAA4C;QAC5C,KAAK,CAAC,EAAE;YACN,6BAA6B;YAC7B,GAAG,CAAC,EAAE,MAAM,CAAA;YACZ,iCAAiC;YACjC,GAAG,EAAE,MAAM,CAAA;YACX,kDAAkD;YAClD,SAAS,EAAE,MAAM,CAAA;YACjB,mDAAmD;YACnD,UAAU,EAAE,MAAM,CAAA;SACnB,CAAA;QACD,mCAAmC;QACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;QACnB,+BAA+B;QAC/B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;QACf,iCAAiC;QACjC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;KAClB,CAAA;CACF;AAED,mBAAmB;AACnB,MAAM,WAAW,KAAK;IACpB,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,2CAA2C;IAC3C,IAAI,EAAE,KAAK,CAAC;QACV,+BAA+B;QAC/B,IAAI,EAAE,OAAO,CAAA;QACb,oDAAoD;QACpD,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,2DAA2D;QAC3D,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,sDAAsD;QACtD,MAAM,CAAC,EAAE,UAAU,CAAA;KACpB,CAAC,CAAA;CACH;AAED,0BAA0B;AAC1B,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAE5B,mCAAmC;AACnC,MAAM,MAAM,UAAU,GAAG,MAAM,CAAA;AAE/B,2EAA2E;AAC3E,MAAM,MAAM,QAAQ,GAAG,OAAO,CAAA;AAE9B,+DAA+D;AAC/D,MAAM,WAAW,YAAY;IAC3B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,GAAG,YAAY,CAAA;CAC5C;AAED,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IACzB,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,0BAA0B;IAC1B,OAAO,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;IAExC,4BAA4B;IAC5B,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;IAC1C,6CAA6C;IAC7C,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,sCAAsC;IACtC,OAAO,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;IACxC,wCAAwC;IACxC,SAAS,EAAE,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;IAC1C,+CAA+C;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,UAAU;IACzB,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,yEAAyE;IACzE,EAAE,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAClB,yGAAyG;IACzG,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,sFAAsF;IACtF,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B"}

package/types/app-arc56.js

@@ -0,0 +1,163 @@
+'use strict';
+
+var algosdk = require('algosdk');
+
+/**
+ * Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method.
+ */
+class Arc56Method extends algosdk.ABIMethod {
+    constructor(method) {
+        super(method);
+        this.method = method;
+        this.args = method.args.map((arg) => ({
+            ...arg,
+            type: algosdk.abiTypeIsTransaction(arg.type) || algosdk.abiTypeIsReference(arg.type) ? arg.type : algosdk.ABIType.from(arg.type),
+        }));
+        this.returns = {
+            ...this.method.returns,
+            type: this.method.returns.type === 'void' ? 'void' : algosdk.ABIType.from(this.method.returns.type),
+        };
+    }
+    toJSON() {
+        return this.method;
+    }
+}
+/**
+ * Returns the `ABITupleType` for the given ARC-56 struct definition
+ * @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))));
+}
+/**
+ * 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>
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getABIStructFromABITuple(decodedABITuple, structFields) {
+    return Object.fromEntries(Object.entries(structFields).map(([key, type], i) => {
+        const abiValue = decodedABITuple[i];
+        return [key, typeof type === 'string' || !Array.isArray(abiValue) ? decodedABITuple[i] : getABIStructFromABITuple(abiValue, type)];
+    }));
+}
+/**
+ * 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
+ */
+function getABITupleFromABIStruct(struct, structFields) {
+    return Object.entries(structFields).map(([key, type]) => {
+        const value = struct[key];
+        return typeof type === 'string' ? value : getABITupleFromABIStruct(value, type);
+    });
+}
+/**
+ * Returns the decoded ABI value (or struct for a struct type)
+ * for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs.
+ * @param value The raw Algorand value (bytes or uint64)
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @param structs The defined ARC-56 structs
+ * @returns The decoded ABI value or struct
+ */
+function getABIDecodedValue(value, type, structs) {
+    if (type === 'bytes' || typeof value !== 'object')
+        return value;
+    if (structs[type]) {
+        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type]).decode(value);
+        return getABIStructFromABITuple(tupleValue, structs[type]);
+    }
+    return algosdk.ABIType.from(type).decode(value);
+}
+/**
+ * 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
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @param structs The defined ARC-56 structs
+ * @returns The binary ABI-encoded value
+ */
+function getABIEncodedValue(value, type, structs) {
+    if (typeof value === 'object' && value instanceof Uint8Array)
+        return value;
+    if (type === 'bytes') {
+        if (typeof value === 'string')
+            return Buffer.from(value, 'utf-8');
+        if (typeof value !== 'object' || !(value instanceof Uint8Array))
+            throw new Error(`Expected bytes value for ${type}, but got ${value}`);
+        return value;
+    }
+    if (structs[type]) {
+        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type]);
+        if (Array.isArray(value)) {
+            tupleType.encode(value);
+        }
+        else {
+            return tupleType.encode(getABITupleFromABIStruct(value, structs[type]));
+        }
+    }
+    return algosdk.ABIType.from(type).encode(value);
+}
+/**
+ * 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.
+ * e.g. `my_method` or `my_method(unit64,string)bytes`
+ * @param appSpec The app spec for the app
+ * @returns The `Arc56Method`
+ */
+function getArc56Method(methodNameOrSignature, appSpec) {
+    let method;
+    if (!methodNameOrSignature.includes('(')) {
+        const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature);
+        if (methods.length === 0)
+            throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+        if (methods.length > 1) {
+            throw new Error(`Received a call to method ${methodNameOrSignature} in contract ${appSpec.name}, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods
+                .map((m) => new algosdk.ABIMethod(m).getSignature())
+                .join(', ')}`);
+        }
+        method = methods[0];
+    }
+    else {
+        const m = appSpec.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodNameOrSignature);
+        if (!m)
+            throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+        method = m;
+    }
+    return new Arc56Method(method);
+}
+/**
+ * Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type
+ *
+ * @param returnValue The smart contract response
+ * @param method The method that was called
+ * @param structs The struct fields from the app spec
+ * @returns The smart contract response with an updated return value
+ */
+function getArc56ReturnValue(returnValue, method, structs) {
+    const m = 'method' in method ? method.method : method;
+    const type = m.returns.struct ?? m.returns.type;
+    if (returnValue?.decodeError) {
+        throw returnValue.decodeError;
+    }
+    if (type === undefined || type === 'void' || returnValue?.returnValue === undefined)
+        return undefined;
+    if (type === 'bytes')
+        return returnValue.rawReturnValue;
+    if (structs[type]) {
+        return getABIStructFromABITuple(returnValue.returnValue, structs[type]);
+    }
+    return returnValue.returnValue;
+}
+
+exports.Arc56Method = Arc56Method;
+exports.getABIDecodedValue = getABIDecodedValue;
+exports.getABIEncodedValue = getABIEncodedValue;
+exports.getABIStructFromABITuple = getABIStructFromABITuple;
+exports.getABITupleFromABIStruct = getABITupleFromABIStruct;
+exports.getABITupleTypeFromABIStructDefinition = getABITupleTypeFromABIStructDefinition;
+exports.getArc56Method = getArc56Method;
+exports.getArc56ReturnValue = getArc56ReturnValue;
+//# sourceMappingURL=app-arc56.js.map

package/types/app-arc56.js.map

@@ -0,0 +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;;;;;;;;;;;"}

package/types/app-arc56.mjs

@@ -0,0 +1,154 @@
+import algosdk from 'algosdk';
+
+/**
+ * Wrapper around `algosdk.ABIMethod` that represents an ARC-56 ABI method.
+ */
+class Arc56Method extends algosdk.ABIMethod {
+    constructor(method) {
+        super(method);
+        this.method = method;
+        this.args = method.args.map((arg) => ({
+            ...arg,
+            type: algosdk.abiTypeIsTransaction(arg.type) || algosdk.abiTypeIsReference(arg.type) ? arg.type : algosdk.ABIType.from(arg.type),
+        }));
+        this.returns = {
+            ...this.method.returns,
+            type: this.method.returns.type === 'void' ? 'void' : algosdk.ABIType.from(this.method.returns.type),
+        };
+    }
+    toJSON() {
+        return this.method;
+    }
+}
+/**
+ * Returns the `ABITupleType` for the given ARC-56 struct definition
+ * @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))));
+}
+/**
+ * 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>
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getABIStructFromABITuple(decodedABITuple, structFields) {
+    return Object.fromEntries(Object.entries(structFields).map(([key, type], i) => {
+        const abiValue = decodedABITuple[i];
+        return [key, typeof type === 'string' || !Array.isArray(abiValue) ? decodedABITuple[i] : getABIStructFromABITuple(abiValue, type)];
+    }));
+}
+/**
+ * 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
+ */
+function getABITupleFromABIStruct(struct, structFields) {
+    return Object.entries(structFields).map(([key, type]) => {
+        const value = struct[key];
+        return typeof type === 'string' ? value : getABITupleFromABIStruct(value, type);
+    });
+}
+/**
+ * Returns the decoded ABI value (or struct for a struct type)
+ * for the given raw Algorand value given an ARC-56 type and defined ARC-56 structs.
+ * @param value The raw Algorand value (bytes or uint64)
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @param structs The defined ARC-56 structs
+ * @returns The decoded ABI value or struct
+ */
+function getABIDecodedValue(value, type, structs) {
+    if (type === 'bytes' || typeof value !== 'object')
+        return value;
+    if (structs[type]) {
+        const tupleValue = getABITupleTypeFromABIStructDefinition(structs[type]).decode(value);
+        return getABIStructFromABITuple(tupleValue, structs[type]);
+    }
+    return algosdk.ABIType.from(type).decode(value);
+}
+/**
+ * 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
+ * @param type The ARC-56 type - either an ABI Type string or a struct name
+ * @param structs The defined ARC-56 structs
+ * @returns The binary ABI-encoded value
+ */
+function getABIEncodedValue(value, type, structs) {
+    if (typeof value === 'object' && value instanceof Uint8Array)
+        return value;
+    if (type === 'bytes') {
+        if (typeof value === 'string')
+            return Buffer.from(value, 'utf-8');
+        if (typeof value !== 'object' || !(value instanceof Uint8Array))
+            throw new Error(`Expected bytes value for ${type}, but got ${value}`);
+        return value;
+    }
+    if (structs[type]) {
+        const tupleType = getABITupleTypeFromABIStructDefinition(structs[type]);
+        if (Array.isArray(value)) {
+            tupleType.encode(value);
+        }
+        else {
+            return tupleType.encode(getABITupleFromABIStruct(value, structs[type]));
+        }
+    }
+    return algosdk.ABIType.from(type).encode(value);
+}
+/**
+ * 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.
+ * e.g. `my_method` or `my_method(unit64,string)bytes`
+ * @param appSpec The app spec for the app
+ * @returns The `Arc56Method`
+ */
+function getArc56Method(methodNameOrSignature, appSpec) {
+    let method;
+    if (!methodNameOrSignature.includes('(')) {
+        const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature);
+        if (methods.length === 0)
+            throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+        if (methods.length > 1) {
+            throw new Error(`Received a call to method ${methodNameOrSignature} in contract ${appSpec.name}, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods
+                .map((m) => new algosdk.ABIMethod(m).getSignature())
+                .join(', ')}`);
+        }
+        method = methods[0];
+    }
+    else {
+        const m = appSpec.methods.find((m) => new algosdk.ABIMethod(m).getSignature() === methodNameOrSignature);
+        if (!m)
+            throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+        method = m;
+    }
+    return new Arc56Method(method);
+}
+/**
+ * Checks for decode errors on the AppCallTransactionResult and maps the return value to the specified generic type
+ *
+ * @param returnValue The smart contract response
+ * @param method The method that was called
+ * @param structs The struct fields from the app spec
+ * @returns The smart contract response with an updated return value
+ */
+function getArc56ReturnValue(returnValue, method, structs) {
+    const m = 'method' in method ? method.method : method;
+    const type = m.returns.struct ?? m.returns.type;
+    if (returnValue?.decodeError) {
+        throw returnValue.decodeError;
+    }
+    if (type === undefined || type === 'void' || returnValue?.returnValue === undefined)
+        return undefined;
+    if (type === 'bytes')
+        return returnValue.rawReturnValue;
+    if (structs[type]) {
+        return getABIStructFromABITuple(returnValue.returnValue, structs[type]);
+    }
+    return returnValue.returnValue;
+}
+
+export { Arc56Method, getABIDecodedValue, getABIEncodedValue, getABIStructFromABITuple, getABITupleFromABIStruct, getABITupleTypeFromABIStructDefinition, getArc56Method, getArc56ReturnValue };
+//# sourceMappingURL=app-arc56.mjs.map