@algorandfoundation/algokit-utils 6.3.0-beta.1 → 7.0.0-alpha.1

package/types/app-spec.js

@@ -1,3 +1,130 @@
 'use strict';
 
+var algosdk = require('algosdk');
+
+var ABIMethod = algosdk.ABIMethod;
+function arc32ToArc56(appSpec) {
+    const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}));
+    const structs = Object.fromEntries(arc32Structs.map(([_, struct]) => {
+        const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }));
+        return [struct.name, fields];
+    }));
+    const hint = (m) => appSpec.hints[new ABIMethod(m).getSignature()];
+    const actions = (m, type) => {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
+        return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config, type) : [];
+    };
+    const bareActions = (type) => {
+        return callConfigToActions(appSpec.bare_call_config, type);
+    };
+    const callConfigToActions = (c, type) => {
+        const actions = [];
+        if (c.close_out && ['ALL', type].includes(c.close_out))
+            actions.push('CloseOut');
+        if (c.delete_application && ['ALL', type].includes(c.delete_application))
+            actions.push('DeleteApplication');
+        if (c.no_op && ['ALL', type].includes(c.no_op))
+            actions.push('NoOp');
+        if (c.opt_in && ['ALL', type].includes(c.opt_in))
+            actions.push('OptIn');
+        if (c.update_application && ['ALL', type].includes(c.update_application))
+            actions.push('UpdateApplication');
+        return actions;
+    };
+    const getDefaultArgValue = (type, defaultArg) => {
+        if (!defaultArg)
+            return undefined;
+        if (defaultArg.source === 'abi-method') {
+            return {
+                source: 'method',
+                data: defaultArg.data.name,
+            };
+        }
+        return {
+            source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',
+            data: Buffer.from(typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data).toString('base64'),
+            type: type === 'string' ? 'AVMString' : type,
+        };
+    };
+    return {
+        arcs: [],
+        name: appSpec.contract.name,
+        desc: appSpec.contract.desc,
+        structs: structs,
+        methods: appSpec.contract.methods.map((m) => ({
+            name: m.name,
+            desc: m.desc,
+            args: m.args.map((a) => ({
+                name: a.name,
+                type: a.type,
+                desc: a.desc,
+                struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,
+                defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),
+            })),
+            returns: {
+                type: m.returns.type,
+                desc: m.returns.desc,
+                struct: hint(m)?.structs?.output?.name,
+            },
+            events: [],
+            readonly: hint(m)?.read_only,
+            actions: {
+                create: actions(m, 'CREATE'),
+                call: actions(m, 'CALL'),
+            },
+        })),
+        state: {
+            schema: {
+                global: {
+                    ints: appSpec.state.global.num_uints,
+                    bytes: appSpec.state.global.num_byte_slices,
+                },
+                local: {
+                    ints: appSpec.state.local.num_uints,
+                    bytes: appSpec.state.local.num_byte_slices,
+                },
+            },
+            keys: {
+                global: Object.fromEntries(Object.entries(appSpec.schema.global.declared).map((s) => [
+                    s[0],
+                    {
+                        key: Buffer.from(s[1].key, 'utf-8').toString('base64'),
+                        keyType: 'AVMString',
+                        valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',
+                        desc: s[1].descr,
+                    },
+                ])),
+                local: Object.fromEntries(Object.entries(appSpec.schema.local.declared).map((s) => [
+                    s[0],
+                    {
+                        key: Buffer.from(s[1].key, 'utf-8').toString('base64'),
+                        keyType: 'AVMString',
+                        valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',
+                        desc: s[1].descr,
+                    },
+                ])),
+                box: {},
+            },
+            maps: {
+                global: {},
+                local: {},
+                box: {},
+            },
+        },
+        source: appSpec.source,
+        bareActions: {
+            create: bareActions('CREATE'),
+            call: bareActions('CALL'),
+        },
+        byteCode: undefined,
+        compilerInfo: undefined,
+        events: undefined,
+        networks: undefined,
+        scratchVariables: undefined,
+        sourceInfo: undefined,
+        templateVariables: undefined,
+    };
+}
+
+exports.arc32ToArc56 = arc32ToArc56;
 //# sourceMappingURL=app-spec.js.map

package/types/app-spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"app-spec.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;"}
+{"version":3,"file":"app-spec.js","sources":["../../src/types/app-spec.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Arc56Contract, Method as Arc56Method, StorageKey, StructField } from './app-arc56'\nimport ABIContractParams = algosdk.ABIContractParams\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIMethod = algosdk.ABIMethod\n\nexport function arc32ToArc56(appSpec: AppSpec): Arc56Contract {\n  const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}))\n  const structs = Object.fromEntries(\n    arc32Structs.map(([_, struct]) => {\n      const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }))\n      return [struct.name, fields]\n    }),\n  ) satisfies { [structName: string]: StructField[] }\n  const hint = (m: ABIMethodParams) => appSpec.hints[new ABIMethod(m).getSignature()] as Hint | undefined\n  const actions = (m: ABIMethodParams, type: 'CREATE' | 'CALL') => {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n    return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config!, type) : []\n  }\n  const bareActions = (type: 'CREATE' | 'CALL') => {\n    return callConfigToActions(appSpec.bare_call_config, type)\n  }\n  const callConfigToActions = (c: CallConfig, type: 'CREATE' | 'CALL') => {\n    const actions: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[] = []\n    if (c.close_out && ['ALL', type].includes(c.close_out)) actions.push('CloseOut')\n    if (c.delete_application && ['ALL', type].includes(c.delete_application)) actions.push('DeleteApplication')\n    if (c.no_op && ['ALL', type].includes(c.no_op)) actions.push('NoOp')\n    if (c.opt_in && ['ALL', type].includes(c.opt_in)) actions.push('OptIn')\n    if (c.update_application && ['ALL', type].includes(c.update_application)) actions.push('UpdateApplication')\n    return actions\n  }\n  const getDefaultArgValue = (\n    type: string,\n    defaultArg: DefaultArgument | undefined,\n  ): Arc56Contract['methods'][0]['args'][0]['defaultValue'] => {\n    if (!defaultArg) return undefined\n\n    if (defaultArg.source === 'abi-method') {\n      return {\n        source: 'method',\n        data: defaultArg.data.name,\n      }\n    }\n\n    return {\n      source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',\n      data: Buffer.from(\n        typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data,\n      ).toString('base64'),\n      type: type === 'string' ? 'AVMString' : type,\n    }\n  }\n\n  return {\n    arcs: [],\n    name: appSpec.contract.name,\n    desc: appSpec.contract.desc,\n    structs: structs,\n    methods: appSpec.contract.methods.map(\n      (m) =>\n        ({\n          name: m.name,\n          desc: m.desc,\n          args: m.args.map((a) => ({\n            name: a.name,\n            type: a.type,\n            desc: a.desc,\n            struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,\n            defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),\n          })),\n          returns: {\n            type: m.returns.type,\n            desc: m.returns.desc,\n            struct: hint(m)?.structs?.output?.name,\n          },\n          events: [],\n          readonly: hint(m)?.read_only,\n          actions: {\n            create: actions(m, 'CREATE') as Arc56Method['actions']['create'],\n            call: actions(m, 'CALL'),\n          },\n        }) satisfies Arc56Method,\n    ),\n    state: {\n      schema: {\n        global: {\n          ints: appSpec.state.global.num_uints,\n          bytes: appSpec.state.global.num_byte_slices,\n        },\n        local: {\n          ints: appSpec.state.local.num_uints,\n          bytes: appSpec.state.local.num_byte_slices,\n        },\n      },\n      keys: {\n        global: Object.fromEntries(\n          Object.entries(appSpec.schema.global.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        local: Object.fromEntries(\n          Object.entries(appSpec.schema.local.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        box: {},\n      },\n      maps: {\n        global: {},\n        local: {},\n        box: {},\n      },\n    },\n    source: appSpec.source,\n    bareActions: {\n      create: bareActions('CREATE') as unknown as Arc56Contract['bareActions']['create'],\n      call: bareActions('CALL'),\n    },\n    byteCode: undefined,\n    compilerInfo: undefined,\n    events: undefined,\n    networks: undefined,\n    scratchVariables: undefined,\n    sourceInfo: undefined,\n    templateVariables: undefined,\n  } satisfies Arc56Contract\n}\n\n/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */\nexport interface AppSpec {\n  /** Method call hints */\n  hints: HintSpec\n  /** The TEAL source */\n  source: AppSources\n  /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */\n  contract: ABIContractParams\n  /** The values that make up the local and global state */\n  schema: SchemaSpec\n  /** The rolled-up schema allocation values for local and global state */\n  state: StateSchemaSpec\n  /** The config of all BARE calls (i.e. non ABI calls with no args) */\n  bare_call_config: CallConfig\n}\n\n/** A lookup of encoded method call spec to hint */\nexport type HintSpec = Record<string, Hint>\n\n/** The TEAL source of a contract */\nexport interface AppSources {\n  /** The TEAL source of the approval program */\n  approval: string\n  /** The TEAL source of the clear program */\n  clear: string\n}\n\n/** The various call configs:\n *  * `NEVER`: Will not be called\n *  * `CALL`: Can be called during a non-create call i.e. app id != 0\n *  * `CREATE`: Can be called during a create call i.e. app id = 0\n *  * `ALL`: Can be during a create OR non-create call\n **/\nexport type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL'\n\n/** Call configuration for a method */\nexport interface CallConfig {\n  /** NoOp call config */\n  no_op?: CallConfigValue\n  /** Opt-in call config */\n  opt_in?: CallConfigValue\n  /** Close out call config */\n  close_out?: CallConfigValue\n  /** Update call config */\n  update_application?: CallConfigValue\n  /** Delete call config */\n  delete_application?: CallConfigValue\n}\n\n/** Hint information for a given method call to allow client generation */\nexport interface Hint {\n  /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */\n  structs?: Record<string, Struct>\n  read_only?: boolean\n  default_arguments?: Record<string, DefaultArgument>\n  call_config: CallConfig\n}\n\n/** The name of a field */\nexport type FieldName = string\n\n/** The string name of an ABI type */\nexport type ABIType = string\n\n/** The elements of the struct/tuple: `FieldName`, `ABIType` */\nexport type StructElement = [FieldName, ABIType]\n\n/** A user-defined struct/tuple type */\nexport interface Struct {\n  /** The name of the type */\n  name: string\n  /** The elements (in order) that make up the struct/tuple */\n  elements: StructElement[]\n}\n\n/**\n * Defines a strategy for obtaining a default value for a given ABI arg.\n */\nexport type DefaultArgument =\n  | {\n      /**\n       * The default value should be fetched by invoking an ABI method\n       */\n      source: 'abi-method'\n      data: ABIMethodParams\n    }\n  | {\n      /**\n       * The default value should be fetched from global state\n       */\n      source: 'global-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value should be fetched from the local state of the sender user\n       */\n      source: 'local-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value is a constant.\n       */\n      source: 'constant'\n      /**\n       * The static default value to use.\n       */\n      data: string | number\n    }\n\n/** AVM data type */\nexport type AVMType = 'uint64' | 'bytes'\n\n/** Declared schema value specification */\nexport interface DeclaredSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The name of the key */\n  key: string\n  /** A description of the variable */\n  descr?: string\n  /** Whether or not the value is set statically (at create time only) or dynamically */\n  static?: boolean\n}\n\n/** Reserved schema value specification */\nexport interface ReservedSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The description of the reserved storage space */\n  descr: string\n  /** The maximum number of slots to reserve */\n  max_keys: number\n}\n\n/** The schema for global and local storage */\nexport interface SchemaSpec {\n  /** The local storage schema */\n  local: Schema\n  /** The global storage schema */\n  global: Schema\n}\n\n/** The storage schema definition */\nexport interface Schema {\n  /** Declared storage schema */\n  declared: Record<string, DeclaredSchemaValueSpec>\n  /** Reserved storage schema */\n  reserved: Record<string, ReservedSchemaValueSpec>\n}\n\n/** The rolled-up schema allocation specification for local and global state */\nexport interface StateSchemaSpec {\n  /** Global storage spec */\n  global: StateSchema\n  /** Local storage spec */\n  local: StateSchema\n}\n\n/** Schema spec summary for global or local storage */\nexport type StateSchema = {\n  /** Number of uint slots */\n  num_uints: number\n  /** Number of byte slots */\n  num_byte_slices: number\n}\n"],"names":[],"mappings":";;;;AAIA,IAAO,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;AAE9B,SAAU,YAAY,CAAC,OAAgB,EAAA;AAC3C,IAAA,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;AACvG,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAI;AAC/B,QAAA,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACvE,QAAA,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;KAC7B,CAAC,CAC+C,CAAA;IACnD,MAAM,IAAI,GAAG,CAAC,CAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAqB,CAAA;AACvG,IAAA,MAAM,OAAO,GAAG,CAAC,CAAkB,EAAE,IAAuB,KAAI;;QAE9D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,KAAK,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAY,EAAE,IAAI,CAAC,GAAG,EAAE,CAAA;AACnG,KAAC,CAAA;AACD,IAAA,MAAM,WAAW,GAAG,CAAC,IAAuB,KAAI;QAC9C,OAAO,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;AAC5D,KAAC,CAAA;AACD,IAAA,MAAM,mBAAmB,GAAG,CAAC,CAAa,EAAE,IAAuB,KAAI;QACrE,MAAM,OAAO,GAAiG,EAAE,CAAA;AAChH,QAAA,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;AAChF,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;AAC3G,QAAA,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACpE,QAAA,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACvE,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;AAC3G,QAAA,OAAO,OAAO,CAAA;AAChB,KAAC,CAAA;AACD,IAAA,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,UAAuC,KACmB;AAC1D,QAAA,IAAI,CAAC,UAAU;AAAE,YAAA,OAAO,SAAS,CAAA;AAEjC,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,YAAY,EAAE;YACtC,OAAO;AACL,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI;aAC3B,CAAA;SACF;QAED,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC,MAAM,KAAK,cAAc,GAAG,QAAQ,GAAG,OAAO;AAChH,YAAA,IAAI,EAAE,MAAM,CAAC,IAAI,CACf,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAC/G,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACpB,IAAI,EAAE,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,IAAI;SAC7C,CAAA;AACH,KAAC,CAAA;IAED,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,OAAO,EAAE,OAAO;AAChB,QAAA,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CACnC,CAAC,CAAC,MACC;YACC,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,CAAC,CAAC,IAAI;AACZ,YAAA,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;gBACvB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,MAAM,EAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS;AAC7D,gBAAA,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,aAAA,CAAC,CAAC;AACH,YAAA,OAAO,EAAE;AACP,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;AACpB,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;gBACpB,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI;AACvC,aAAA;AACD,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS;AAC5B,YAAA,OAAO,EAAE;AACP,gBAAA,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAqC;AAChE,gBAAA,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;AACzB,aAAA;AACF,SAAA,CAAuB,CAC3B;AACD,QAAA,KAAK,EAAE;AACL,YAAA,MAAM,EAAE;AACN,gBAAA,MAAM,EAAE;AACN,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS;AACpC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe;AAC5C,iBAAA;AACD,gBAAA,KAAK,EAAE;AACL,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS;AACnC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;AAC3C,iBAAA;AACF,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACxD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;gBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACvD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;AACD,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,EAAE;AACV,gBAAA,KAAK,EAAE,EAAE;AACT,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACF,SAAA;QACD,MAAM,EAAE,OAAO,CAAC,MAAM;AACtB,QAAA,WAAW,EAAE;AACX,YAAA,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAsD;AAClF,YAAA,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;AAC1B,SAAA;AACD,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,YAAY,EAAE,SAAS;AACvB,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,gBAAgB,EAAE,SAAS;AAC3B,QAAA,UAAU,EAAE,SAAS;AACrB,QAAA,iBAAiB,EAAE,SAAS;KACL,CAAA;AAC3B;;;;"}

package/types/app-spec.mjs

@@ -1,2 +1,128 @@
+import algosdk from 'algosdk';
 
+var ABIMethod = algosdk.ABIMethod;
+function arc32ToArc56(appSpec) {
+    const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}));
+    const structs = Object.fromEntries(arc32Structs.map(([_, struct]) => {
+        const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }));
+        return [struct.name, fields];
+    }));
+    const hint = (m) => appSpec.hints[new ABIMethod(m).getSignature()];
+    const actions = (m, type) => {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain
+        return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config, type) : [];
+    };
+    const bareActions = (type) => {
+        return callConfigToActions(appSpec.bare_call_config, type);
+    };
+    const callConfigToActions = (c, type) => {
+        const actions = [];
+        if (c.close_out && ['ALL', type].includes(c.close_out))
+            actions.push('CloseOut');
+        if (c.delete_application && ['ALL', type].includes(c.delete_application))
+            actions.push('DeleteApplication');
+        if (c.no_op && ['ALL', type].includes(c.no_op))
+            actions.push('NoOp');
+        if (c.opt_in && ['ALL', type].includes(c.opt_in))
+            actions.push('OptIn');
+        if (c.update_application && ['ALL', type].includes(c.update_application))
+            actions.push('UpdateApplication');
+        return actions;
+    };
+    const getDefaultArgValue = (type, defaultArg) => {
+        if (!defaultArg)
+            return undefined;
+        if (defaultArg.source === 'abi-method') {
+            return {
+                source: 'method',
+                data: defaultArg.data.name,
+            };
+        }
+        return {
+            source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',
+            data: Buffer.from(typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data).toString('base64'),
+            type: type === 'string' ? 'AVMString' : type,
+        };
+    };
+    return {
+        arcs: [],
+        name: appSpec.contract.name,
+        desc: appSpec.contract.desc,
+        structs: structs,
+        methods: appSpec.contract.methods.map((m) => ({
+            name: m.name,
+            desc: m.desc,
+            args: m.args.map((a) => ({
+                name: a.name,
+                type: a.type,
+                desc: a.desc,
+                struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,
+                defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),
+            })),
+            returns: {
+                type: m.returns.type,
+                desc: m.returns.desc,
+                struct: hint(m)?.structs?.output?.name,
+            },
+            events: [],
+            readonly: hint(m)?.read_only,
+            actions: {
+                create: actions(m, 'CREATE'),
+                call: actions(m, 'CALL'),
+            },
+        })),
+        state: {
+            schema: {
+                global: {
+                    ints: appSpec.state.global.num_uints,
+                    bytes: appSpec.state.global.num_byte_slices,
+                },
+                local: {
+                    ints: appSpec.state.local.num_uints,
+                    bytes: appSpec.state.local.num_byte_slices,
+                },
+            },
+            keys: {
+                global: Object.fromEntries(Object.entries(appSpec.schema.global.declared).map((s) => [
+                    s[0],
+                    {
+                        key: Buffer.from(s[1].key, 'utf-8').toString('base64'),
+                        keyType: 'AVMString',
+                        valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',
+                        desc: s[1].descr,
+                    },
+                ])),
+                local: Object.fromEntries(Object.entries(appSpec.schema.local.declared).map((s) => [
+                    s[0],
+                    {
+                        key: Buffer.from(s[1].key, 'utf-8').toString('base64'),
+                        keyType: 'AVMString',
+                        valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',
+                        desc: s[1].descr,
+                    },
+                ])),
+                box: {},
+            },
+            maps: {
+                global: {},
+                local: {},
+                box: {},
+            },
+        },
+        source: appSpec.source,
+        bareActions: {
+            create: bareActions('CREATE'),
+            call: bareActions('CALL'),
+        },
+        byteCode: undefined,
+        compilerInfo: undefined,
+        events: undefined,
+        networks: undefined,
+        scratchVariables: undefined,
+        sourceInfo: undefined,
+        templateVariables: undefined,
+    };
+}
+
+export { arc32ToArc56 };
 //# sourceMappingURL=app-spec.mjs.map

package/types/app-spec.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app-spec.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"app-spec.mjs","sources":["../../src/types/app-spec.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Arc56Contract, Method as Arc56Method, StorageKey, StructField } from './app-arc56'\nimport ABIContractParams = algosdk.ABIContractParams\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIMethod = algosdk.ABIMethod\n\nexport function arc32ToArc56(appSpec: AppSpec): Arc56Contract {\n  const arc32Structs = Object.values(appSpec.hints).flatMap((hint) => Object.entries(hint.structs ?? {}))\n  const structs = Object.fromEntries(\n    arc32Structs.map(([_, struct]) => {\n      const fields = struct.elements.map((e) => ({ name: e[0], type: e[1] }))\n      return [struct.name, fields]\n    }),\n  ) satisfies { [structName: string]: StructField[] }\n  const hint = (m: ABIMethodParams) => appSpec.hints[new ABIMethod(m).getSignature()] as Hint | undefined\n  const actions = (m: ABIMethodParams, type: 'CREATE' | 'CALL') => {\n    // eslint-disable-next-line @typescript-eslint/no-non-null-asserted-optional-chain\n    return hint(m)?.call_config !== undefined ? callConfigToActions(hint(m)?.call_config!, type) : []\n  }\n  const bareActions = (type: 'CREATE' | 'CALL') => {\n    return callConfigToActions(appSpec.bare_call_config, type)\n  }\n  const callConfigToActions = (c: CallConfig, type: 'CREATE' | 'CALL') => {\n    const actions: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[] = []\n    if (c.close_out && ['ALL', type].includes(c.close_out)) actions.push('CloseOut')\n    if (c.delete_application && ['ALL', type].includes(c.delete_application)) actions.push('DeleteApplication')\n    if (c.no_op && ['ALL', type].includes(c.no_op)) actions.push('NoOp')\n    if (c.opt_in && ['ALL', type].includes(c.opt_in)) actions.push('OptIn')\n    if (c.update_application && ['ALL', type].includes(c.update_application)) actions.push('UpdateApplication')\n    return actions\n  }\n  const getDefaultArgValue = (\n    type: string,\n    defaultArg: DefaultArgument | undefined,\n  ): Arc56Contract['methods'][0]['args'][0]['defaultValue'] => {\n    if (!defaultArg) return undefined\n\n    if (defaultArg.source === 'abi-method') {\n      return {\n        source: 'method',\n        data: defaultArg.data.name,\n      }\n    }\n\n    return {\n      source: defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local',\n      data: Buffer.from(\n        typeof defaultArg.data === 'number' ? algosdk.ABIType.from('uint64').encode(defaultArg.data) : defaultArg.data,\n      ).toString('base64'),\n      type: type === 'string' ? 'AVMString' : type,\n    }\n  }\n\n  return {\n    arcs: [],\n    name: appSpec.contract.name,\n    desc: appSpec.contract.desc,\n    structs: structs,\n    methods: appSpec.contract.methods.map(\n      (m) =>\n        ({\n          name: m.name,\n          desc: m.desc,\n          args: m.args.map((a) => ({\n            name: a.name,\n            type: a.type,\n            desc: a.desc,\n            struct: a.name ? hint(m)?.structs?.[a.name]?.name : undefined,\n            defaultValue: getDefaultArgValue(a.type, !a.name ? undefined : hint(m)?.default_arguments?.[a.name]),\n          })),\n          returns: {\n            type: m.returns.type,\n            desc: m.returns.desc,\n            struct: hint(m)?.structs?.output?.name,\n          },\n          events: [],\n          readonly: hint(m)?.read_only,\n          actions: {\n            create: actions(m, 'CREATE') as Arc56Method['actions']['create'],\n            call: actions(m, 'CALL'),\n          },\n        }) satisfies Arc56Method,\n    ),\n    state: {\n      schema: {\n        global: {\n          ints: appSpec.state.global.num_uints,\n          bytes: appSpec.state.global.num_byte_slices,\n        },\n        local: {\n          ints: appSpec.state.local.num_uints,\n          bytes: appSpec.state.local.num_byte_slices,\n        },\n      },\n      keys: {\n        global: Object.fromEntries(\n          Object.entries(appSpec.schema.global.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        local: Object.fromEntries(\n          Object.entries(appSpec.schema.local.declared).map((s) => [\n            s[0],\n            {\n              key: Buffer.from(s[1].key, 'utf-8').toString('base64'),\n              keyType: 'AVMString',\n              valueType: s[1].type === 'uint64' ? 'AVMUint64' : 'AVMBytes',\n              desc: s[1].descr,\n            } satisfies StorageKey,\n          ]),\n        ),\n        box: {},\n      },\n      maps: {\n        global: {},\n        local: {},\n        box: {},\n      },\n    },\n    source: appSpec.source,\n    bareActions: {\n      create: bareActions('CREATE') as unknown as Arc56Contract['bareActions']['create'],\n      call: bareActions('CALL'),\n    },\n    byteCode: undefined,\n    compilerInfo: undefined,\n    events: undefined,\n    networks: undefined,\n    scratchVariables: undefined,\n    sourceInfo: undefined,\n    templateVariables: undefined,\n  } satisfies Arc56Contract\n}\n\n/** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */\nexport interface AppSpec {\n  /** Method call hints */\n  hints: HintSpec\n  /** The TEAL source */\n  source: AppSources\n  /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */\n  contract: ABIContractParams\n  /** The values that make up the local and global state */\n  schema: SchemaSpec\n  /** The rolled-up schema allocation values for local and global state */\n  state: StateSchemaSpec\n  /** The config of all BARE calls (i.e. non ABI calls with no args) */\n  bare_call_config: CallConfig\n}\n\n/** A lookup of encoded method call spec to hint */\nexport type HintSpec = Record<string, Hint>\n\n/** The TEAL source of a contract */\nexport interface AppSources {\n  /** The TEAL source of the approval program */\n  approval: string\n  /** The TEAL source of the clear program */\n  clear: string\n}\n\n/** The various call configs:\n *  * `NEVER`: Will not be called\n *  * `CALL`: Can be called during a non-create call i.e. app id != 0\n *  * `CREATE`: Can be called during a create call i.e. app id = 0\n *  * `ALL`: Can be during a create OR non-create call\n **/\nexport type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL'\n\n/** Call configuration for a method */\nexport interface CallConfig {\n  /** NoOp call config */\n  no_op?: CallConfigValue\n  /** Opt-in call config */\n  opt_in?: CallConfigValue\n  /** Close out call config */\n  close_out?: CallConfigValue\n  /** Update call config */\n  update_application?: CallConfigValue\n  /** Delete call config */\n  delete_application?: CallConfigValue\n}\n\n/** Hint information for a given method call to allow client generation */\nexport interface Hint {\n  /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */\n  structs?: Record<string, Struct>\n  read_only?: boolean\n  default_arguments?: Record<string, DefaultArgument>\n  call_config: CallConfig\n}\n\n/** The name of a field */\nexport type FieldName = string\n\n/** The string name of an ABI type */\nexport type ABIType = string\n\n/** The elements of the struct/tuple: `FieldName`, `ABIType` */\nexport type StructElement = [FieldName, ABIType]\n\n/** A user-defined struct/tuple type */\nexport interface Struct {\n  /** The name of the type */\n  name: string\n  /** The elements (in order) that make up the struct/tuple */\n  elements: StructElement[]\n}\n\n/**\n * Defines a strategy for obtaining a default value for a given ABI arg.\n */\nexport type DefaultArgument =\n  | {\n      /**\n       * The default value should be fetched by invoking an ABI method\n       */\n      source: 'abi-method'\n      data: ABIMethodParams\n    }\n  | {\n      /**\n       * The default value should be fetched from global state\n       */\n      source: 'global-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value should be fetched from the local state of the sender user\n       */\n      source: 'local-state'\n      /**\n       * The key of the state variable\n       */\n      data: string\n    }\n  | {\n      /**\n       * The default value is a constant.\n       */\n      source: 'constant'\n      /**\n       * The static default value to use.\n       */\n      data: string | number\n    }\n\n/** AVM data type */\nexport type AVMType = 'uint64' | 'bytes'\n\n/** Declared schema value specification */\nexport interface DeclaredSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The name of the key */\n  key: string\n  /** A description of the variable */\n  descr?: string\n  /** Whether or not the value is set statically (at create time only) or dynamically */\n  static?: boolean\n}\n\n/** Reserved schema value specification */\nexport interface ReservedSchemaValueSpec {\n  /** The type of value */\n  type: AVMType\n  /** The description of the reserved storage space */\n  descr: string\n  /** The maximum number of slots to reserve */\n  max_keys: number\n}\n\n/** The schema for global and local storage */\nexport interface SchemaSpec {\n  /** The local storage schema */\n  local: Schema\n  /** The global storage schema */\n  global: Schema\n}\n\n/** The storage schema definition */\nexport interface Schema {\n  /** Declared storage schema */\n  declared: Record<string, DeclaredSchemaValueSpec>\n  /** Reserved storage schema */\n  reserved: Record<string, ReservedSchemaValueSpec>\n}\n\n/** The rolled-up schema allocation specification for local and global state */\nexport interface StateSchemaSpec {\n  /** Global storage spec */\n  global: StateSchema\n  /** Local storage spec */\n  local: StateSchema\n}\n\n/** Schema spec summary for global or local storage */\nexport type StateSchema = {\n  /** Number of uint slots */\n  num_uints: number\n  /** Number of byte slots */\n  num_byte_slices: number\n}\n"],"names":[],"mappings":";;AAIA,IAAO,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;AAE9B,SAAU,YAAY,CAAC,OAAgB,EAAA;AAC3C,IAAA,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAA;AACvG,IAAA,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAI;AAC/B,QAAA,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;AACvE,QAAA,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;KAC7B,CAAC,CAC+C,CAAA;IACnD,MAAM,IAAI,GAAG,CAAC,CAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAqB,CAAA;AACvG,IAAA,MAAM,OAAO,GAAG,CAAC,CAAkB,EAAE,IAAuB,KAAI;;QAE9D,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,KAAK,SAAS,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAY,EAAE,IAAI,CAAC,GAAG,EAAE,CAAA;AACnG,KAAC,CAAA;AACD,IAAA,MAAM,WAAW,GAAG,CAAC,IAAuB,KAAI;QAC9C,OAAO,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAA;AAC5D,KAAC,CAAA;AACD,IAAA,MAAM,mBAAmB,GAAG,CAAC,CAAa,EAAE,IAAuB,KAAI;QACrE,MAAM,OAAO,GAAiG,EAAE,CAAA;AAChH,QAAA,IAAI,CAAC,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;AAChF,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;AAC3G,QAAA,IAAI,CAAC,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AACpE,QAAA,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACvE,QAAA,IAAI,CAAC,CAAC,kBAAkB,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,kBAAkB,CAAC;AAAE,YAAA,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;AAC3G,QAAA,OAAO,OAAO,CAAA;AAChB,KAAC,CAAA;AACD,IAAA,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,UAAuC,KACmB;AAC1D,QAAA,IAAI,CAAC,UAAU;AAAE,YAAA,OAAO,SAAS,CAAA;AAEjC,QAAA,IAAI,UAAU,CAAC,MAAM,KAAK,YAAY,EAAE;YACtC,OAAO;AACL,gBAAA,MAAM,EAAE,QAAQ;AAChB,gBAAA,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI;aAC3B,CAAA;SACF;QAED,OAAO;YACL,MAAM,EAAE,UAAU,CAAC,MAAM,KAAK,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC,MAAM,KAAK,cAAc,GAAG,QAAQ,GAAG,OAAO;AAChH,YAAA,IAAI,EAAE,MAAM,CAAC,IAAI,CACf,OAAO,UAAU,CAAC,IAAI,KAAK,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAC/G,CAAC,QAAQ,CAAC,QAAQ,CAAC;YACpB,IAAI,EAAE,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,IAAI;SAC7C,CAAA;AACH,KAAC,CAAA;IAED,OAAO;AACL,QAAA,IAAI,EAAE,EAAE;AACR,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI;AAC3B,QAAA,OAAO,EAAE,OAAO;AAChB,QAAA,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CACnC,CAAC,CAAC,MACC;YACC,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,IAAI,EAAE,CAAC,CAAC,IAAI;AACZ,YAAA,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM;gBACvB,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,IAAI,EAAE,CAAC,CAAC,IAAI;gBACZ,MAAM,EAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS;AAC7D,gBAAA,YAAY,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,iBAAiB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AACrG,aAAA,CAAC,CAAC;AACH,YAAA,OAAO,EAAE;AACP,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;AACpB,gBAAA,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI;gBACpB,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI;AACvC,aAAA;AACD,YAAA,MAAM,EAAE,EAAE;AACV,YAAA,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS;AAC5B,YAAA,OAAO,EAAE;AACP,gBAAA,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,QAAQ,CAAqC;AAChE,gBAAA,IAAI,EAAE,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;AACzB,aAAA;AACF,SAAA,CAAuB,CAC3B;AACD,QAAA,KAAK,EAAE;AACL,YAAA,MAAM,EAAE;AACN,gBAAA,MAAM,EAAE;AACN,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS;AACpC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,eAAe;AAC5C,iBAAA;AACD,gBAAA,KAAK,EAAE;AACL,oBAAA,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS;AACnC,oBAAA,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,eAAe;AAC3C,iBAAA;AACF,aAAA;AACD,YAAA,IAAI,EAAE;gBACJ,MAAM,EAAE,MAAM,CAAC,WAAW,CACxB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACxD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;gBACD,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK;oBACvD,CAAC,CAAC,CAAC,CAAC;AACJ,oBAAA;AACE,wBAAA,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;AACtD,wBAAA,OAAO,EAAE,WAAW;AACpB,wBAAA,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,GAAG,WAAW,GAAG,UAAU;AAC5D,wBAAA,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;AACI,qBAAA;AACvB,iBAAA,CAAC,CACH;AACD,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,EAAE;AACV,gBAAA,KAAK,EAAE,EAAE;AACT,gBAAA,GAAG,EAAE,EAAE;AACR,aAAA;AACF,SAAA;QACD,MAAM,EAAE,OAAO,CAAC,MAAM;AACtB,QAAA,WAAW,EAAE;AACX,YAAA,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAsD;AAClF,YAAA,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC;AAC1B,SAAA;AACD,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,YAAY,EAAE,SAAS;AACvB,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,QAAQ,EAAE,SAAS;AACnB,QAAA,gBAAgB,EAAE,SAAS;AAC3B,QAAA,UAAU,EAAE,SAAS;AACrB,QAAA,iBAAiB,EAAE,SAAS;KACL,CAAA;AAC3B;;;;"}

package/types/app.d.ts

@@ -1,5 +1,6 @@
 import algosdk from 'algosdk';
-import { SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from './transaction';
+import { Expand } from './expand';
+import { SendSingleTransactionResult, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from './transaction';
 import ABIArgument = algosdk.ABIArgument;
 import ABIMethod = algosdk.ABIMethod;
 import ABIMethodParams = algosdk.ABIMethodParams;
@@ -7,14 +8,14 @@ import ABIType = algosdk.ABIType;
 import ABIValue = algosdk.ABIValue;
 import Address = algosdk.Address;
 import OnApplicationComplete = algosdk.OnApplicationComplete;
-import SourceMap = algosdk.SourceMap;
+import SourceMap = algosdk.ProgramSourceMap;
 import SuggestedParams = algosdk.SuggestedParams;
 import Transaction = algosdk.Transaction;
 /** The name of the TEAL template variable for deploy-time immutability control */
 export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
 /** The name of the TEAL template variable for deploy-time permanence control */
 export declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
-/** The app create/update ARC-2 transaction note prefix */
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
 export declare const APP_DEPLOY_NOTE_DAPP = "ALGOKIT_DEPLOYER";
 /** The maximum number of bytes in a single app code page */
 export declare const APP_PAGE_MAX_SIZE = 2048;
@@ -28,6 +29,8 @@ export interface AppReference {
     appAddress: string;
 }
 /**
+ * @deprecated Use `types/app-manager/BoxReference` instead.
+ *
  * A grouping of the app ID and name of the box in an Uint8Array
  */
 export interface BoxReference {
@@ -41,6 +44,8 @@ export interface BoxReference {
     name: BoxIdentifier;
 }
 /**
+ * @deprecated Use `types/app-manager/BoxIdentifier` instead.
+ *
  * Something that identifies a box name - either a:
  *  * `Uint8Array`
  *  * `string` (that will be encoded to a Uint8Array)
@@ -90,7 +95,11 @@ export type ABIAppCallArgs = CoreAppCallArgs & {
  *   * An ABI method definition (method and args)
  **/
 export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
-/** Base interface for common data passed to an app create or update. */
+/**
+ * @deprecated Use `TransactionComposer` to construct create app transactions instead.
+ *
+ * Base interface for common data passed to an app create or update.
+ */
 interface CreateOrUpdateAppParams extends SendTransactionParams {
     /** The account (with private key loaded) that will send the transaction */
     from: SendTransactionFrom;
@@ -105,19 +114,28 @@ interface CreateOrUpdateAppParams extends SendTransactionParams {
     /** The arguments passed in to the app call */
     args?: AppCallArgs;
 }
-/** Parameters that are passed in when creating an app. */
+/**
+ * @deprecated Use `TransactionComposer` to construct create app transactions instead.
+ *
+ * Parameters that are passed in when creating an app. */
 export interface CreateAppParams extends CreateOrUpdateAppParams {
     /** The storage schema to request for the created app */
     schema: AppStorageSchema;
     /** Override the on-completion action for the create call; defaults to NoOp */
     onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
 }
-/** Parameters that are passed in when updating an app. */
+/**
+ * @deprecated Use `TransactionComposer` to construct update app transactions instead.
+ *
+ * Parameters that are passed in when updating an app. */
 export interface UpdateAppParams extends CreateOrUpdateAppParams {
     /** The id of the app to update */
     appId: number | bigint;
 }
-/** The type of call / [on-completion action](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/apps/#the-lifecycle-of-a-smart-contract) for a smart contract call.
+/**
+ * @deprecated Use `algosdk.OnApplicationComplete` directly instead.
+ *
+ * The type of call / [on-completion action](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/apps/#the-lifecycle-of-a-smart-contract) for a smart contract call.
  *
  * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.
  *
@@ -163,7 +181,7 @@ export interface CompiledTeal {
     teal: string;
     /** The compiled code */
     compiled: string;
-    /** The has returned by the compiler */
+    /** The hash returned by the compiler */
     compiledHash: string;
     /** The base64 encoded code as a byte array */
     compiledBase64ToBytes: Uint8Array;
@@ -175,16 +193,17 @@ export interface AppCallTransactionResultOfType<T> extends SendTransactionResult
     return?: T;
 }
 /** Result from calling an app */
-export interface AppCallTransactionResult extends AppCallTransactionResultOfType<ABIReturn> {
-}
+export type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>;
 /** The return value of an ABI method call */
 export type ABIReturn = {
     rawReturnValue: Uint8Array;
     returnValue: ABIValue;
+    method: ABIMethod;
     decodeError: undefined;
 } | {
-    rawReturnValue: undefined;
-    returnValue: undefined;
+    rawReturnValue?: undefined;
+    returnValue?: undefined;
+    method?: undefined;
     decodeError: Error;
 };
 /**
@@ -267,17 +286,35 @@ export interface AppDeploymentParams extends Omit<CreateAppParams, 'onCompleteAc
     /** Any args to pass to any delete transaction that is issued as part of deployment */
     deleteArgs?: AppCallArgs;
 }
-/** The result of compiling the approval and clear TEAL for an app */
+/** The result of compiling the approval and clear state TEAL programs for an app */
 export interface AppCompilationResult {
-    /** The compilation result of approval */
+    /** The result of compiling the approval program */
     compiledApproval: CompiledTeal;
-    /** The compilation result of clear */
+    /** The result of compiling the clear state program */
     compiledClear: CompiledTeal;
 }
+export type AppReturn<TReturn> = {
+    /** The ABI method call return value */
+    return?: TReturn;
+};
+/** Result from sending a single app transaction. */
+export type SendAppTransactionResult = Expand<SendSingleTransactionResult & {
+    /** If an ABI method was called the processed return value */
+    return?: ABIReturn;
+}>;
+/** Result from sending a single app transaction. */
+export type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>;
+/** Result from sending a single app transaction. */
+export type SendAppCreateTransactionResult = Expand<SendAppUpdateTransactionResult & {
+    /** The id of the created app */
+    appId: bigint;
+    /** The Algorand address of the account associated with the app */
+    appAddress: Address;
+}>;
 /** Object holding app state values */
 export interface AppState {
     [key: string]: {
-        value: number | bigint;
+        value: bigint;
         keyRaw: Uint8Array;
         keyBase64: string;
     } | {
@@ -288,7 +325,8 @@ export interface AppState {
         keyBase64: string;
     };
 }
-/** The name of a box storage box */
+/**
+ * The name of a box storage box */
 export interface BoxName {
     /** Name in UTF-8 */
     name: string;
@@ -298,6 +336,7 @@ export interface BoxName {
     nameBase64: string;
 }
 /**
+ * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.
  * Parameters to get and decode a box value as an ABI type.
  */
 export interface BoxValueRequestParams {
@@ -309,6 +348,7 @@ export interface BoxValueRequestParams {
     type: ABIType;
 }
 /**
+ * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.
  * Parameters to get and decode a box value as an ABI type.
  */
 export interface BoxValuesRequestParams {
@@ -320,4 +360,3 @@ export interface BoxValuesRequestParams {
     type: ABIType;
 }
 export {};
-//# sourceMappingURL=app.d.ts.map

package/types/app.js

@@ -4,7 +4,7 @@
 const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE';
 /** The name of the TEAL template variable for deploy-time permanence control */
 const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE';
-/** The app create/update ARC-2 transaction note prefix */
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
 const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER';
 /** The maximum number of bytes in a single app code page */
 const APP_PAGE_MAX_SIZE = 2048;

package/types/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sources":["../../src/types/app.ts"],"sourcesContent":[null],"names":["OnUpdate","OnSchemaBreak"],"mappings":";;AAoBA;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,oBAAoB,GAAG,mBAAkB;AAEtD;AACO,MAAM,iBAAiB,GAAG,KAAI;AAErC;AACa,MAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,EAAC;AA0OnE;AACYA,0BASX;AATD,CAAA,UAAY,QAAQ,EAAA;;AAElB,IAAA,QAAA,CAAA,QAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;;AAET,IAAA,QAAA,CAAA,QAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EATWA,gBAAQ,KAARA,gBAAQ,GASnB,EAAA,CAAA,CAAA,CAAA;AAED;AACYC,+BAOX;AAPD,CAAA,UAAY,aAAa,EAAA;;AAEvB,IAAA,aAAA,CAAA,aAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EAPWA,qBAAa,KAAbA,qBAAa,GAOxB,EAAA,CAAA,CAAA;;;;;;;;"}
+{"version":3,"file":"app.js","sources":["../../src/types/app.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Expand } from './expand'\nimport {\n  SendSingleTransactionResult,\n  SendTransactionFrom,\n  SendTransactionParams,\n  SendTransactionResult,\n  SendTransactionResults,\n  TransactionNote,\n  TransactionToSign,\n} from './transaction'\nimport ABIArgument = algosdk.ABIArgument\nimport ABIMethod = algosdk.ABIMethod\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIType = algosdk.ABIType\nimport ABIValue = algosdk.ABIValue\nimport Address = algosdk.Address\nimport OnApplicationComplete = algosdk.OnApplicationComplete\nimport SourceMap = algosdk.ProgramSourceMap\nimport SuggestedParams = algosdk.SuggestedParams\nimport Transaction = algosdk.Transaction\n\n/** The name of the TEAL template variable for deploy-time immutability control */\nexport const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE'\n\n/** The name of the TEAL template variable for deploy-time permanence control */\nexport const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE'\n\n/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */\nexport const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER'\n\n/** The maximum number of bytes in a single app code page */\nexport const APP_PAGE_MAX_SIZE = 2048\n\n/** First 4 bytes of SHA-512/256 hash of \"return\" for retrieving ABI return values */\nexport const ABI_RETURN_PREFIX = new Uint8Array([21, 31, 124, 117])\n\n/** Information about an Algorand app */\nexport interface AppReference {\n  /** The id of the app */\n  appId: number | bigint\n  /** The Algorand address of the account associated with the app */\n  appAddress: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxReference` instead.\n *\n * A grouping of the app ID and name of the box in an Uint8Array\n */\nexport interface BoxReference {\n  /**\n   * A unique application id\n   */\n  appId: number | bigint\n  /**\n   * Name of box to reference\n   */\n  name: BoxIdentifier\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxIdentifier` instead.\n *\n * Something that identifies a box name - either a:\n *  * `Uint8Array`\n *  * `string` (that will be encoded to a Uint8Array)\n *  * `SendTransactionFrom` (encoded into the public key address of the corresponding account)\n */\nexport type BoxIdentifier = string | Uint8Array | SendTransactionFrom\n\n/** Common app call arguments for ABI and non-ABI (raw) calls */\nexport interface CoreAppCallArgs {\n  /** The optional lease for the transaction */\n  lease?: string | Uint8Array\n  /** Any box references to load */\n  boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[]\n  /** The address of any accounts to load in */\n  accounts?: (string | Address)[]\n  /** IDs of any apps to load into the foreignApps array */\n  apps?: number[]\n  /** IDs of any assets to load into the foreignAssets array */\n  assets?: number[]\n  /** Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.\n   *\n   * **Note:** Use with extreme caution and review the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/) first.\n   */\n  rekeyTo?: SendTransactionFrom | string\n}\n\n/**\n * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)\n */\nexport interface RawAppCallArgs extends CoreAppCallArgs {\n  /** Any application arguments to pass through */\n  appArgs?: (Uint8Array | string)[]\n  /** Property to aid intellisense */\n  method?: undefined\n}\n\n/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */\nexport type ABIAppCallArg =\n  | ABIArgument\n  | TransactionToSign\n  | Transaction\n  | Promise<SendTransactionResult>\n  | SendTransactionResult\n  | undefined\n\n/**\n * App call args for an ABI call\n */\nexport type ABIAppCallArgs = CoreAppCallArgs & {\n  /** The ABI method to call */\n  method: ABIMethodParams | ABIMethod\n  /** The ABI method args to pass in */\n  methodArgs: ABIAppCallArg[]\n}\n\n/** Arguments to pass to an app call either:\n *   * The raw app call values to pass through into the transaction (after processing); or\n *   * An ABI method definition (method and args)\n **/\nexport type AppCallArgs = RawAppCallArgs | ABIAppCallArgs\n\n/**\n * @deprecated Use `TransactionComposer` to construct create app transactions instead.\n *\n * Base interface for common data passed to an app create or update.\n */\ninterface CreateOrUpdateAppParams extends SendTransactionParams {\n  /** The account (with private key loaded) that will send the transaction */\n  from: SendTransactionFrom\n  /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */\n  approvalProgram: Uint8Array | string\n  /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */\n  clearStateProgram: Uint8Array | string\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/**\n * @deprecated Use `TransactionComposer` to construct create app transactions instead.\n *\n * Parameters that are passed in when creating an app. */\nexport interface CreateAppParams extends CreateOrUpdateAppParams {\n  /** The storage schema to request for the created app */\n  schema: AppStorageSchema\n  /** Override the on-completion action for the create call; defaults to NoOp */\n  onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>\n}\n\n/**\n * @deprecated Use `TransactionComposer` to construct update app transactions instead.\n *\n * Parameters that are passed in when updating an app. */\nexport interface UpdateAppParams extends CreateOrUpdateAppParams {\n  /** The id of the app to update */\n  appId: number | bigint\n}\n\n/**\n * @deprecated Use `algosdk.OnApplicationComplete` directly instead.\n *\n * The type of call / [on-completion action](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/apps/#the-lifecycle-of-a-smart-contract) for a smart contract call.\n *\n * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.\n *\n * * `no_op`: Normal smart contract call, no special on-complete action\n * * `opt_in`: Opt-in to smart contract local storage\n * * `close_out`: Close-out local storage storage\n * * `clear_state`: Clear local storage state\n * * `update_application`: Update the smart contract\n * * `delete_application`: Delete the smart contract\n */\nexport type AppCallType = 'no_op' | 'opt_in' | 'close_out' | 'clear_state' | 'update_application' | 'delete_application'\n\n/** Parameters representing a call to an app. */\nexport interface AppCallParams extends SendTransactionParams {\n  /** The id of the app to call */\n  appId: number | bigint\n  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */\n  callType: Exclude<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>\n  /** The account to make the call from */\n  from: SendTransactionFrom\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/** Parameters representing the storage schema of an app. */\nexport interface AppStorageSchema {\n  /** Restricts number of ints in per-user local state */\n  localInts: number\n  /** Restricts number of byte slices in per-user local state */\n  localByteSlices: number\n  /** Restricts number of ints in global state */\n  globalInts: number\n  /** Restricts number of byte slices in global state */\n  globalByteSlices: number\n  /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */\n  extraPages?: number\n}\n\n/** Information about a compiled teal program */\nexport interface CompiledTeal {\n  /** Original TEAL code */\n  teal: string\n  /** The compiled code */\n  compiled: string\n  /** The hash returned by the compiler */\n  compiledHash: string\n  /** The base64 encoded code as a byte array */\n  compiledBase64ToBytes: Uint8Array\n  /** Source map from the compilation */\n  sourceMap: SourceMap\n}\n\nexport interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {\n  /** If an ABI method was called the processed return value */\n  return?: T\n}\n\n/** Result from calling an app */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>\n\n/** The return value of an ABI method call */\nexport type ABIReturn =\n  | {\n      rawReturnValue: Uint8Array\n      returnValue: ABIValue\n      method: ABIMethod\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method?: undefined; decodeError: Error }\n\n/**\n * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.\n */\nexport interface AppDeployMetadata {\n  /** The unique name identifier of the app within the creator account */\n  name: string\n  /** The version of app that is / will be deployed */\n  version: string\n  /** Whether or not the app is deletable / permanent / unspecified */\n  deletable?: boolean\n  /** Whether or not the app is updatable / immutable / unspecified */\n  updatable?: boolean\n}\n\n/** The metadata that can be collected about a deployed app */\nexport interface AppMetadata extends AppReference, AppDeployMetadata {\n  /** The round the app was created */\n  createdRound: number\n  /** The last round that the app was updated */\n  updatedRound: number\n  /** The metadata when the app was created */\n  createdMetadata: AppDeployMetadata\n  /** Whether or not the app is deleted */\n  deleted: boolean\n}\n\n/** A lookup of name -> Algorand app for a creator */\nexport interface AppLookup {\n  creator: Readonly<string>\n  apps: Readonly<{\n    [name: string]: AppMetadata\n  }>\n}\n\n/** Dictionary of deploy-time parameters to replace in a teal template.\n *\n * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.\n *\n */\nexport interface TealTemplateParams {\n  [key: string]: string | bigint | number | Uint8Array\n}\n\n/** What action to perform when deploying an app and an update is detected in the TEAL code */\nexport enum OnUpdate {\n  /** Fail the deployment */\n  Fail,\n  /** Update the app */\n  UpdateApp,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** What action to perform when deploying an app and a breaking schema change is detected */\nexport enum OnSchemaBreak {\n  /** Fail the deployment */\n  Fail,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** The parameters to deploy an app */\nexport interface AppDeploymentParams\n  extends Omit<CreateAppParams, 'onCompleteAction' | 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {\n  /** The deployment metadata */\n  metadata: AppDeployMetadata\n  /** Any deploy-time parameters to replace in the TEAL code */\n  deployTimeParams?: TealTemplateParams\n  /** What action to perform if a schema break is detected */\n  onSchemaBreak?: 'replace' | 'fail' | 'append' | OnSchemaBreak\n  /** What action to perform if a TEAL update is detected */\n  onUpdate?: 'update' | 'replace' | 'fail' | 'append' | OnUpdate\n  /** Optional cached value of the existing apps for the given creator */\n  existingDeployments?: AppLookup\n  /** Any args to pass to any create transaction that is issued as part of deployment */\n  createArgs?: AppCallArgs\n  /** Override the on-completion action for the create call; defaults to NoOp */\n  createOnCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>\n  /** Any args to pass to any update transaction that is issued as part of deployment */\n  updateArgs?: AppCallArgs\n  /** Any args to pass to any delete transaction that is issued as part of deployment */\n  deleteArgs?: AppCallArgs\n}\n\n/** The result of compiling the approval and clear state TEAL programs for an app */\nexport interface AppCompilationResult {\n  /** The result of compiling the approval program */\n  compiledApproval: CompiledTeal\n  /** The result of compiling the clear state program */\n  compiledClear: CompiledTeal\n}\n\nexport type AppReturn<TReturn> = {\n  /** The ABI method call return value */\n  return?: TReturn\n}\n\n/** Result from sending a single app transaction. */\nexport type SendAppTransactionResult = Expand<\n  SendSingleTransactionResult & {\n    /** If an ABI method was called the processed return value */\n    return?: ABIReturn\n  }\n>\n\n/** Result from sending a single app transaction. */\nexport type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>\n\n/** Result from sending a single app transaction. */\nexport type SendAppCreateTransactionResult = Expand<\n  SendAppUpdateTransactionResult & {\n    /** The id of the created app */\n    appId: bigint\n    /** The Algorand address of the account associated with the app */\n    appAddress: Address\n  }\n>\n\n/** Object holding app state values */\nexport interface AppState {\n  [key: string]:\n    | {\n        value: bigint\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n    | {\n        value: string\n        valueRaw: Uint8Array\n        valueBase64: string\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n}\n\n/**\n * The name of a box storage box */\nexport interface BoxName {\n  /** Name in UTF-8 */\n  name: string\n  /** Name in binary bytes */\n  nameRaw: Uint8Array\n  /** Name in Base64 */\n  nameBase64: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValueRequestParams {\n  /** The ID of the app return box names for */\n  appId: number | bigint\n  /** The name of the box to return either as a string, binary array or `BoxName` */\n  boxName: string | Uint8Array | BoxName\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValuesRequestParams {\n  /** The ID of the app return box names for */\n  appId: number\n  /** The names of the boxes to return either as a string, binary array or BoxName` */\n  boxNames: (string | Uint8Array | BoxName)[]\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n"],"names":["OnUpdate","OnSchemaBreak"],"mappings":";;AAsBA;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,oBAAoB,GAAG,mBAAkB;AAEtD;AACO,MAAM,iBAAiB,GAAG,KAAI;AAErC;AACa,MAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,EAAC;AA4PnE;AACYA,0BASX;AATD,CAAA,UAAY,QAAQ,EAAA;;AAElB,IAAA,QAAA,CAAA,QAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;;AAET,IAAA,QAAA,CAAA,QAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EATWA,gBAAQ,KAARA,gBAAQ,GASnB,EAAA,CAAA,CAAA,CAAA;AAED;AACYC,+BAOX;AAPD,CAAA,UAAY,aAAa,EAAA;;AAEvB,IAAA,aAAA,CAAA,aAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EAPWA,qBAAa,KAAbA,qBAAa,GAOxB,EAAA,CAAA,CAAA;;;;;;;;"}

package/types/app.mjs

@@ -2,7 +2,7 @@
 const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE';
 /** The name of the TEAL template variable for deploy-time permanence control */
 const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE';
-/** The app create/update ARC-2 transaction note prefix */
+/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */
 const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER';
 /** The maximum number of bytes in a single app code page */
 const APP_PAGE_MAX_SIZE = 2048;

package/types/app.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app.mjs","sources":["../../src/types/app.ts"],"sourcesContent":[null],"names":[],"mappings":"AAoBA;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,oBAAoB,GAAG,mBAAkB;AAEtD;AACO,MAAM,iBAAiB,GAAG,KAAI;AAErC;AACa,MAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,EAAC;AA0OnE;IACY,SASX;AATD,CAAA,UAAY,QAAQ,EAAA;;AAElB,IAAA,QAAA,CAAA,QAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;;AAET,IAAA,QAAA,CAAA,QAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EATW,QAAQ,KAAR,QAAQ,GASnB,EAAA,CAAA,CAAA,CAAA;AAED;IACY,cAOX;AAPD,CAAA,UAAY,aAAa,EAAA;;AAEvB,IAAA,aAAA,CAAA,aAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EAPW,aAAa,KAAb,aAAa,GAOxB,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"app.mjs","sources":["../../src/types/app.ts"],"sourcesContent":["import algosdk from 'algosdk'\nimport { Expand } from './expand'\nimport {\n  SendSingleTransactionResult,\n  SendTransactionFrom,\n  SendTransactionParams,\n  SendTransactionResult,\n  SendTransactionResults,\n  TransactionNote,\n  TransactionToSign,\n} from './transaction'\nimport ABIArgument = algosdk.ABIArgument\nimport ABIMethod = algosdk.ABIMethod\nimport ABIMethodParams = algosdk.ABIMethodParams\nimport ABIType = algosdk.ABIType\nimport ABIValue = algosdk.ABIValue\nimport Address = algosdk.Address\nimport OnApplicationComplete = algosdk.OnApplicationComplete\nimport SourceMap = algosdk.ProgramSourceMap\nimport SuggestedParams = algosdk.SuggestedParams\nimport Transaction = algosdk.Transaction\n\n/** The name of the TEAL template variable for deploy-time immutability control */\nexport const UPDATABLE_TEMPLATE_NAME = 'TMPL_UPDATABLE'\n\n/** The name of the TEAL template variable for deploy-time permanence control */\nexport const DELETABLE_TEMPLATE_NAME = 'TMPL_DELETABLE'\n\n/** The app create/update [ARC-2](https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0002.md) transaction note prefix */\nexport const APP_DEPLOY_NOTE_DAPP = 'ALGOKIT_DEPLOYER'\n\n/** The maximum number of bytes in a single app code page */\nexport const APP_PAGE_MAX_SIZE = 2048\n\n/** First 4 bytes of SHA-512/256 hash of \"return\" for retrieving ABI return values */\nexport const ABI_RETURN_PREFIX = new Uint8Array([21, 31, 124, 117])\n\n/** Information about an Algorand app */\nexport interface AppReference {\n  /** The id of the app */\n  appId: number | bigint\n  /** The Algorand address of the account associated with the app */\n  appAddress: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxReference` instead.\n *\n * A grouping of the app ID and name of the box in an Uint8Array\n */\nexport interface BoxReference {\n  /**\n   * A unique application id\n   */\n  appId: number | bigint\n  /**\n   * Name of box to reference\n   */\n  name: BoxIdentifier\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxIdentifier` instead.\n *\n * Something that identifies a box name - either a:\n *  * `Uint8Array`\n *  * `string` (that will be encoded to a Uint8Array)\n *  * `SendTransactionFrom` (encoded into the public key address of the corresponding account)\n */\nexport type BoxIdentifier = string | Uint8Array | SendTransactionFrom\n\n/** Common app call arguments for ABI and non-ABI (raw) calls */\nexport interface CoreAppCallArgs {\n  /** The optional lease for the transaction */\n  lease?: string | Uint8Array\n  /** Any box references to load */\n  boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[]\n  /** The address of any accounts to load in */\n  accounts?: (string | Address)[]\n  /** IDs of any apps to load into the foreignApps array */\n  apps?: number[]\n  /** IDs of any assets to load into the foreignAssets array */\n  assets?: number[]\n  /** Optional account / account address that should be authorised to transact on behalf of the from account the app call is sent from after this transaction.\n   *\n   * **Note:** Use with extreme caution and review the [official rekey guidance](https://developer.algorand.org/docs/get-details/accounts/rekey/) first.\n   */\n  rekeyTo?: SendTransactionFrom | string\n}\n\n/**\n * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)\n */\nexport interface RawAppCallArgs extends CoreAppCallArgs {\n  /** Any application arguments to pass through */\n  appArgs?: (Uint8Array | string)[]\n  /** Property to aid intellisense */\n  method?: undefined\n}\n\n/** An argument for an ABI method, either a primitive value, or a transaction with or without signer, or the unawaited async return value of an algokit method that returns a `SendTransactionResult` */\nexport type ABIAppCallArg =\n  | ABIArgument\n  | TransactionToSign\n  | Transaction\n  | Promise<SendTransactionResult>\n  | SendTransactionResult\n  | undefined\n\n/**\n * App call args for an ABI call\n */\nexport type ABIAppCallArgs = CoreAppCallArgs & {\n  /** The ABI method to call */\n  method: ABIMethodParams | ABIMethod\n  /** The ABI method args to pass in */\n  methodArgs: ABIAppCallArg[]\n}\n\n/** Arguments to pass to an app call either:\n *   * The raw app call values to pass through into the transaction (after processing); or\n *   * An ABI method definition (method and args)\n **/\nexport type AppCallArgs = RawAppCallArgs | ABIAppCallArgs\n\n/**\n * @deprecated Use `TransactionComposer` to construct create app transactions instead.\n *\n * Base interface for common data passed to an app create or update.\n */\ninterface CreateOrUpdateAppParams extends SendTransactionParams {\n  /** The account (with private key loaded) that will send the transaction */\n  from: SendTransactionFrom\n  /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */\n  approvalProgram: Uint8Array | string\n  /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */\n  clearStateProgram: Uint8Array | string\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/**\n * @deprecated Use `TransactionComposer` to construct create app transactions instead.\n *\n * Parameters that are passed in when creating an app. */\nexport interface CreateAppParams extends CreateOrUpdateAppParams {\n  /** The storage schema to request for the created app */\n  schema: AppStorageSchema\n  /** Override the on-completion action for the create call; defaults to NoOp */\n  onCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>\n}\n\n/**\n * @deprecated Use `TransactionComposer` to construct update app transactions instead.\n *\n * Parameters that are passed in when updating an app. */\nexport interface UpdateAppParams extends CreateOrUpdateAppParams {\n  /** The id of the app to update */\n  appId: number | bigint\n}\n\n/**\n * @deprecated Use `algosdk.OnApplicationComplete` directly instead.\n *\n * The type of call / [on-completion action](https://developer.algorand.org/docs/get-details/dapps/smart-contracts/apps/#the-lifecycle-of-a-smart-contract) for a smart contract call.\n *\n * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.\n *\n * * `no_op`: Normal smart contract call, no special on-complete action\n * * `opt_in`: Opt-in to smart contract local storage\n * * `close_out`: Close-out local storage storage\n * * `clear_state`: Clear local storage state\n * * `update_application`: Update the smart contract\n * * `delete_application`: Delete the smart contract\n */\nexport type AppCallType = 'no_op' | 'opt_in' | 'close_out' | 'clear_state' | 'update_application' | 'delete_application'\n\n/** Parameters representing a call to an app. */\nexport interface AppCallParams extends SendTransactionParams {\n  /** The id of the app to call */\n  appId: number | bigint\n  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */\n  callType: Exclude<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>\n  /** The account to make the call from */\n  from: SendTransactionFrom\n  /** Optional transaction parameters */\n  transactionParams?: SuggestedParams\n  /** The (optional) transaction note */\n  note?: TransactionNote\n  /** The arguments passed in to the app call */\n  args?: AppCallArgs\n}\n\n/** Parameters representing the storage schema of an app. */\nexport interface AppStorageSchema {\n  /** Restricts number of ints in per-user local state */\n  localInts: number\n  /** Restricts number of byte slices in per-user local state */\n  localByteSlices: number\n  /** Restricts number of ints in global state */\n  globalInts: number\n  /** Restricts number of byte slices in global state */\n  globalByteSlices: number\n  /** Any extra pages that are needed for the smart contract; if left blank then the right number of pages will be calculated based on the teal code size */\n  extraPages?: number\n}\n\n/** Information about a compiled teal program */\nexport interface CompiledTeal {\n  /** Original TEAL code */\n  teal: string\n  /** The compiled code */\n  compiled: string\n  /** The hash returned by the compiler */\n  compiledHash: string\n  /** The base64 encoded code as a byte array */\n  compiledBase64ToBytes: Uint8Array\n  /** Source map from the compilation */\n  sourceMap: SourceMap\n}\n\nexport interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {\n  /** If an ABI method was called the processed return value */\n  return?: T\n}\n\n/** Result from calling an app */\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>\n\n/** The return value of an ABI method call */\nexport type ABIReturn =\n  | {\n      rawReturnValue: Uint8Array\n      returnValue: ABIValue\n      method: ABIMethod\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method?: undefined; decodeError: Error }\n\n/**\n * The payload of the metadata to add to the transaction note when deploying an app, noting it will be prefixed with `APP_DEPLOY_NOTE_PREFIX`.\n */\nexport interface AppDeployMetadata {\n  /** The unique name identifier of the app within the creator account */\n  name: string\n  /** The version of app that is / will be deployed */\n  version: string\n  /** Whether or not the app is deletable / permanent / unspecified */\n  deletable?: boolean\n  /** Whether or not the app is updatable / immutable / unspecified */\n  updatable?: boolean\n}\n\n/** The metadata that can be collected about a deployed app */\nexport interface AppMetadata extends AppReference, AppDeployMetadata {\n  /** The round the app was created */\n  createdRound: number\n  /** The last round that the app was updated */\n  updatedRound: number\n  /** The metadata when the app was created */\n  createdMetadata: AppDeployMetadata\n  /** Whether or not the app is deleted */\n  deleted: boolean\n}\n\n/** A lookup of name -> Algorand app for a creator */\nexport interface AppLookup {\n  creator: Readonly<string>\n  apps: Readonly<{\n    [name: string]: AppMetadata\n  }>\n}\n\n/** Dictionary of deploy-time parameters to replace in a teal template.\n *\n * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.\n *\n */\nexport interface TealTemplateParams {\n  [key: string]: string | bigint | number | Uint8Array\n}\n\n/** What action to perform when deploying an app and an update is detected in the TEAL code */\nexport enum OnUpdate {\n  /** Fail the deployment */\n  Fail,\n  /** Update the app */\n  UpdateApp,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** What action to perform when deploying an app and a breaking schema change is detected */\nexport enum OnSchemaBreak {\n  /** Fail the deployment */\n  Fail,\n  /** Delete the app and create a new one in its place */\n  ReplaceApp,\n  /** Create a new app */\n  AppendApp,\n}\n\n/** The parameters to deploy an app */\nexport interface AppDeploymentParams\n  extends Omit<CreateAppParams, 'onCompleteAction' | 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {\n  /** The deployment metadata */\n  metadata: AppDeployMetadata\n  /** Any deploy-time parameters to replace in the TEAL code */\n  deployTimeParams?: TealTemplateParams\n  /** What action to perform if a schema break is detected */\n  onSchemaBreak?: 'replace' | 'fail' | 'append' | OnSchemaBreak\n  /** What action to perform if a TEAL update is detected */\n  onUpdate?: 'update' | 'replace' | 'fail' | 'append' | OnUpdate\n  /** Optional cached value of the existing apps for the given creator */\n  existingDeployments?: AppLookup\n  /** Any args to pass to any create transaction that is issued as part of deployment */\n  createArgs?: AppCallArgs\n  /** Override the on-completion action for the create call; defaults to NoOp */\n  createOnCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>\n  /** Any args to pass to any update transaction that is issued as part of deployment */\n  updateArgs?: AppCallArgs\n  /** Any args to pass to any delete transaction that is issued as part of deployment */\n  deleteArgs?: AppCallArgs\n}\n\n/** The result of compiling the approval and clear state TEAL programs for an app */\nexport interface AppCompilationResult {\n  /** The result of compiling the approval program */\n  compiledApproval: CompiledTeal\n  /** The result of compiling the clear state program */\n  compiledClear: CompiledTeal\n}\n\nexport type AppReturn<TReturn> = {\n  /** The ABI method call return value */\n  return?: TReturn\n}\n\n/** Result from sending a single app transaction. */\nexport type SendAppTransactionResult = Expand<\n  SendSingleTransactionResult & {\n    /** If an ABI method was called the processed return value */\n    return?: ABIReturn\n  }\n>\n\n/** Result from sending a single app transaction. */\nexport type SendAppUpdateTransactionResult = Expand<SendAppTransactionResult & Partial<AppCompilationResult>>\n\n/** Result from sending a single app transaction. */\nexport type SendAppCreateTransactionResult = Expand<\n  SendAppUpdateTransactionResult & {\n    /** The id of the created app */\n    appId: bigint\n    /** The Algorand address of the account associated with the app */\n    appAddress: Address\n  }\n>\n\n/** Object holding app state values */\nexport interface AppState {\n  [key: string]:\n    | {\n        value: bigint\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n    | {\n        value: string\n        valueRaw: Uint8Array\n        valueBase64: string\n        keyRaw: Uint8Array\n        keyBase64: string\n      }\n}\n\n/**\n * The name of a box storage box */\nexport interface BoxName {\n  /** Name in UTF-8 */\n  name: string\n  /** Name in binary bytes */\n  nameRaw: Uint8Array\n  /** Name in Base64 */\n  nameBase64: string\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValueRequestParams {\n  /** The ID of the app return box names for */\n  appId: number | bigint\n  /** The name of the box to return either as a string, binary array or `BoxName` */\n  boxName: string | Uint8Array | BoxName\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n\n/**\n * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.\n * Parameters to get and decode a box value as an ABI type.\n */\nexport interface BoxValuesRequestParams {\n  /** The ID of the app return box names for */\n  appId: number\n  /** The names of the boxes to return either as a string, binary array or BoxName` */\n  boxNames: (string | Uint8Array | BoxName)[]\n  /** The ABI type to decode the value using */\n  type: ABIType\n}\n"],"names":[],"mappings":"AAsBA;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,uBAAuB,GAAG,iBAAgB;AAEvD;AACO,MAAM,oBAAoB,GAAG,mBAAkB;AAEtD;AACO,MAAM,iBAAiB,GAAG,KAAI;AAErC;AACa,MAAA,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,EAAC;AA4PnE;IACY,SASX;AATD,CAAA,UAAY,QAAQ,EAAA;;AAElB,IAAA,QAAA,CAAA,QAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;;AAET,IAAA,QAAA,CAAA,QAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,QAAA,CAAA,QAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EATW,QAAQ,KAAR,QAAQ,GASnB,EAAA,CAAA,CAAA,CAAA;AAED;IACY,cAOX;AAPD,CAAA,UAAY,aAAa,EAAA;;AAEvB,IAAA,aAAA,CAAA,aAAA,CAAA,MAAA,CAAA,GAAA,CAAA,CAAA,GAAA,MAAI,CAAA;;AAEJ,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,CAAA,CAAA,GAAA,YAAU,CAAA;;AAEV,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,CAAA,CAAA,GAAA,WAAS,CAAA;AACX,CAAC,EAPW,aAAa,KAAb,aAAa,GAOxB,EAAA,CAAA,CAAA;;;;"}