@algorandfoundation/algokit-utils 9.2.0 → 10.0.0-alpha.10

package/types/app-spec.mjs.map

@@ -1 +1 @@
-{"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\n/**\n * Converts an ARC-32 Application Specification to an ARC-56 Contract\n * @param appSpec The ARC-32 Application Specification\n * @returns The ARC-56 Contract\n * @example\n * ```typescript\n * const arc56AppSpec = arc32ToArc56(arc32AppSpec)\n * ```\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;AAEpC;;;;;;;;AAQG;AACG,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;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;AACvE,QAAA,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC;KAC7B,CAAC,CAC+C;IACnD,MAAM,IAAI,GAAG,CAAC,CAAkB,KAAK,OAAO,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,YAAY,EAAE,CAAqB;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;AACnG,KAAC;AACD,IAAA,MAAM,WAAW,GAAG,CAAC,IAAuB,KAAI;QAC9C,OAAO,mBAAmB,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC;AAC5D,KAAC;AACD,IAAA,MAAM,mBAAmB,GAAG,CAAC,CAAa,EAAE,IAAuB,KAAI;QACrE,MAAM,OAAO,GAAiG,EAAE;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;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;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;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;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;AAC3G,QAAA,OAAO,OAAO;AAChB,KAAC;AACD,IAAA,MAAM,kBAAkB,GAAG,CACzB,IAAY,EACZ,UAAuC,KACmB;AAC1D,QAAA,IAAI,CAAC,UAAU;AAAE,YAAA,OAAO,SAAS;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;;QAGH,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;AACH,KAAC;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;AAC3B;;;;"}
+{"version":3,"file":"app-spec.mjs","names":["hint","actions: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]","actions","defaultValueType: string | undefined","ABITypeClass"],"sources":["../../src/types/app-spec.ts"],"sourcesContent":["import {\n  ABIMethod,\n  ABIType as ABITypeClass,\n  ARC28Event,\n  Arc56Contract,\n  Arc56Method,\n  StorageKey,\n  StructField,\n} from '@algorandfoundation/algokit-abi'\n\n/**\n * Converts an ARC-32 Application Specification to an ARC-56 Contract\n * @param appSpec The ARC-32 Application Specification\n * @returns The ARC-56 Contract\n * @example\n * ```typescript\n * const arc56AppSpec = arc32ToArc56(arc32AppSpec)\n * ```\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[getABIMethodParamsSignature(m)] 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 = (defaultArg: DefaultArgument | undefined): 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    const mappedSource = defaultArg.source === 'constant' ? 'literal' : defaultArg.source === 'global-state' ? 'global' : 'local'\n\n    // type is only set for literal source\n    let defaultValueType: string | undefined = undefined\n    if (mappedSource === 'literal') {\n      if (typeof defaultArg.data === 'number') {\n        defaultValueType = 'uint64'\n      } else if (typeof defaultArg.data === 'string') {\n        defaultValueType = 'AVMString'\n      }\n    }\n\n    const argData =\n      typeof defaultArg.data === 'number'\n        ? ABITypeClass.from('uint64').encode(defaultArg.data)\n        : typeof defaultArg.data === 'string'\n          ? new TextEncoder().encode(defaultArg.data)\n          : defaultArg.data\n\n    return {\n      source: mappedSource,\n      data: Buffer.from(argData).toString('base64'),\n      type: defaultValueType,\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.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\nfunction getABIMethodParamsSignature(params: ABIMethodParams) {\n  const args = params.args.map((a) => a.type).join(',')\n  return `${params.name}(${args})${params.returns.type}`\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\ninterface ABIContractParams {\n  name: string\n  desc?: string\n  networks?: ABIContractNetworks\n  methods: ABIMethodParams[]\n  events?: ARC28Event[]\n}\n\ninterface ABIContractNetworks {\n  [network: string]: ABIContractNetworkInfo\n}\n\ninterface ABIContractNetworkInfo {\n  appID: number\n}\n\ninterface ABIMethodParams {\n  name: string\n  desc?: string\n  args: ABIMethodArgParams[]\n  returns: ABIMethodReturnParams\n  /** Optional, is it a read-only method (according to [ARC-22](https://arc.algorand.foundation/ARCs/arc-0022)) */\n  readonly?: boolean\n  /** [ARC-28](https://arc.algorand.foundation/ARCs/arc-0028) events that MAY be emitted by this method */\n  events?: ARC28Event[]\n}\n\ninterface ABIMethodArgParams {\n  type: string\n  name?: string\n  desc?: string\n}\n\ninterface ABIMethodReturnParams {\n  type: string\n  desc?: string\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: ABIMethod\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"],"mappings":";;;;;;;;;;;;AAmBA,SAAgB,aAAa,SAAiC;CAC5D,MAAM,eAAe,OAAO,OAAO,QAAQ,MAAM,CAAC,SAAS,WAAS,OAAO,QAAQA,OAAK,WAAW,EAAE,CAAC,CAAC;CACvG,MAAM,UAAU,OAAO,YACrB,aAAa,KAAK,CAAC,GAAG,YAAY;EAChC,MAAM,SAAS,OAAO,SAAS,KAAK,OAAO;GAAE,MAAM,EAAE;GAAI,MAAM,EAAE;GAAI,EAAE;AACvE,SAAO,CAAC,OAAO,MAAM,OAAO;GAC5B,CACH;CACD,MAAM,QAAQ,MAAuB,QAAQ,MAAM,4BAA4B,EAAE;CACjF,MAAM,WAAW,GAAoB,SAA4B;AAE/D,SAAO,KAAK,EAAE,EAAE,gBAAgB,SAAY,oBAAoB,KAAK,EAAE,EAAE,aAAc,KAAK,GAAG,EAAE;;CAEnG,MAAM,eAAe,SAA4B;AAC/C,SAAO,oBAAoB,QAAQ,kBAAkB,KAAK;;CAE5D,MAAM,uBAAuB,GAAe,SAA4B;EACtE,MAAMC,YAAwG,EAAE;AAChH,MAAI,EAAE,aAAa,CAAC,OAAO,KAAK,CAAC,SAAS,EAAE,UAAU,CAAE,WAAQ,KAAK,WAAW;AAChF,MAAI,EAAE,sBAAsB,CAAC,OAAO,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAE,WAAQ,KAAK,oBAAoB;AAC3G,MAAI,EAAE,SAAS,CAAC,OAAO,KAAK,CAAC,SAAS,EAAE,MAAM,CAAE,WAAQ,KAAK,OAAO;AACpE,MAAI,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,SAAS,EAAE,OAAO,CAAE,WAAQ,KAAK,QAAQ;AACvE,MAAI,EAAE,sBAAsB,CAAC,OAAO,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAE,WAAQ,KAAK,oBAAoB;AAC3G,SAAOC;;CAET,MAAM,sBAAsB,eAAoG;AAC9H,MAAI,CAAC,WAAY,QAAO;AAExB,MAAI,WAAW,WAAW,aACxB,QAAO;GACL,QAAQ;GACR,MAAM,WAAW,KAAK;GACvB;EAGH,MAAM,eAAe,WAAW,WAAW,aAAa,YAAY,WAAW,WAAW,iBAAiB,WAAW;EAGtH,IAAIC,mBAAuC;AAC3C,MAAI,iBAAiB,WACnB;OAAI,OAAO,WAAW,SAAS,SAC7B,oBAAmB;YACV,OAAO,WAAW,SAAS,SACpC,oBAAmB;;EAIvB,MAAM,UACJ,OAAO,WAAW,SAAS,WACvBC,QAAa,KAAK,SAAS,CAAC,OAAO,WAAW,KAAK,GACnD,OAAO,WAAW,SAAS,WACzB,IAAI,aAAa,CAAC,OAAO,WAAW,KAAK,GACzC,WAAW;AAEnB,SAAO;GACL,QAAQ;GACR,MAAM,OAAO,KAAK,QAAQ,CAAC,SAAS,SAAS;GAC7C,MAAM;GACP;;AAGH,QAAO;EACL,MAAM,EAAE;EACR,MAAM,QAAQ,SAAS;EACvB,MAAM,QAAQ,SAAS;EACd;EACT,SAAS,QAAQ,SAAS,QAAQ,KAC/B,OACE;GACC,MAAM,EAAE;GACR,MAAM,EAAE;GACR,MAAM,EAAE,KAAK,KAAK,OAAO;IACvB,MAAM,EAAE;IACR,MAAM,EAAE;IACR,MAAM,EAAE;IACR,QAAQ,EAAE,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,OAAO,OAAO;IACpD,cAAc,mBAAmB,CAAC,EAAE,OAAO,SAAY,KAAK,EAAE,EAAE,oBAAoB,EAAE,MAAM;IAC7F,EAAE;GACH,SAAS;IACP,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,QAAQ,KAAK,EAAE,EAAE,SAAS,QAAQ;IACnC;GACD,QAAQ,EAAE;GACV,UAAU,KAAK,EAAE,EAAE;GACnB,SAAS;IACP,QAAQ,QAAQ,GAAG,SAAS;IAC5B,MAAM,QAAQ,GAAG,OAAO;IACzB;GACF,EACJ;EACD,OAAO;GACL,QAAQ;IACN,QAAQ;KACN,MAAM,QAAQ,MAAM,OAAO;KAC3B,OAAO,QAAQ,MAAM,OAAO;KAC7B;IACD,OAAO;KACL,MAAM,QAAQ,MAAM,MAAM;KAC1B,OAAO,QAAQ,MAAM,MAAM;KAC5B;IACF;GACD,MAAM;IACJ,QAAQ,OAAO,YACb,OAAO,QAAQ,QAAQ,OAAO,OAAO,SAAS,CAAC,KAAK,MAAM,CACxD,EAAE,IACF;KACE,KAAK,OAAO,KAAK,EAAE,GAAG,KAAK,QAAQ,CAAC,SAAS,SAAS;KACtD,SAAS;KACT,WAAW,EAAE,GAAG,SAAS,WAAW,cAAc;KAClD,MAAM,EAAE,GAAG;KACZ,CACF,CAAC,CACH;IACD,OAAO,OAAO,YACZ,OAAO,QAAQ,QAAQ,OAAO,MAAM,SAAS,CAAC,KAAK,MAAM,CACvD,EAAE,IACF;KACE,KAAK,OAAO,KAAK,EAAE,GAAG,KAAK,QAAQ,CAAC,SAAS,SAAS;KACtD,SAAS;KACT,WAAW,EAAE,GAAG,SAAS,WAAW,cAAc;KAClD,MAAM,EAAE,GAAG;KACZ,CACF,CAAC,CACH;IACD,KAAK,EAAE;IACR;GACD,MAAM;IACJ,QAAQ,EAAE;IACV,OAAO,EAAE;IACT,KAAK,EAAE;IACR;GACF;EACD,QAAQ,QAAQ;EAChB,aAAa;GACX,QAAQ,YAAY,SAAS;GAC7B,MAAM,YAAY,OAAO;GAC1B;EACD,UAAU;EACV,cAAc;EACd,QAAQ;EACR,UAAU;EACV,kBAAkB;EAClB,YAAY;EACZ,mBAAmB;EACpB;;AAGH,SAAS,4BAA4B,QAAyB;CAC5D,MAAM,OAAO,OAAO,KAAK,KAAK,MAAM,EAAE,KAAK,CAAC,KAAK,IAAI;AACrD,QAAO,GAAG,OAAO,KAAK,GAAG,KAAK,GAAG,OAAO,QAAQ"}

package/types/app.d.ts

@@ -1,362 +1,257 @@
-import algosdk from 'algosdk';
-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;
-import ABIType = algosdk.ABIType;
-import ABIValue = algosdk.ABIValue;
-import Address = algosdk.Address;
-import OnApplicationComplete = algosdk.OnApplicationComplete;
-import SourceMap = algosdk.ProgramSourceMap;
-import SuggestedParams = algosdk.SuggestedParams;
-import Transaction = algosdk.Transaction;
+import { Address } from "../packages/common/src/address.js";
+import { ABIValue } from "../packages/abi/src/abi-value.js";
+import { ABIType } from "../packages/abi/src/abi-type.js";
+import { ABIMethod, ABIReturn } from "../packages/abi/src/abi-method.js";
+import { BoxReference, OnApplicationComplete } from "../packages/transact/src/transactions/app-call.js";
+import { Transaction } from "../packages/transact/src/transactions/transaction.js";
+import { SuggestedParams } from "../packages/algod_client/src/models/suggested-params.js";
+import { ProgramSourceMap } from "../packages/sdk/src/logic/sourcemap.js";
+import { BoxIdentifier, BoxReference as BoxReference$1 } from "./app-manager.js";
+import { Expand } from "./expand.js";
+import { SendSingleTransactionResult, SendTransactionFrom, SendTransactionParams, SendTransactionResult, SendTransactionResults, TransactionNote, TransactionToSign } from "./transaction.js";
+import { TransactionWithSigner } from "../transaction/transaction.js";
+
+//#region src/types/app.d.ts
+type SourceMap = ProgramSourceMap;
 /** The name of the TEAL template variable for deploy-time immutability control */
-export declare const UPDATABLE_TEMPLATE_NAME = "TMPL_UPDATABLE";
+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";
+declare const DELETABLE_TEMPLATE_NAME = "TMPL_DELETABLE";
 /** 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";
+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;
+declare const APP_PAGE_MAX_SIZE = 2048;
 /** First 4 bytes of SHA-512/256 hash of "return" for retrieving ABI return values */
-export declare const ABI_RETURN_PREFIX: Uint8Array;
+declare const ABI_RETURN_PREFIX: Uint8Array;
 /** Information about an Algorand app */
-export interface AppReference {
-    /** The id of the app */
-    appId: number | bigint;
-    /** The Algorand address of the account associated with the app */
-    appAddress: string;
+interface AppReference {
+  /** The id of the app */
+  appId: number | bigint;
+  /** The Algorand address of the account associated with the app */
+  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 {
-    /**
-     * A unique application id
-     */
-    appId: number | bigint;
-    /**
-     * Name of box to reference
-     */
-    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)
- *  * `SendTransactionFrom` (encoded into the public key address of the corresponding account)
- */
-export type BoxIdentifier = string | Uint8Array | SendTransactionFrom;
 /** Common app call arguments for ABI and non-ABI (raw) calls */
-export interface CoreAppCallArgs {
-    /** The optional lease for the transaction */
-    lease?: string | Uint8Array;
-    /** Any box references to load */
-    boxes?: (algosdk.BoxReference | BoxReference | BoxIdentifier)[];
-    /** The address of any accounts to load in */
-    accounts?: (string | Address)[];
-    /** IDs of any apps to load into the foreignApps array */
-    apps?: number[];
-    /** IDs of any assets to load into the foreignAssets array */
-    assets?: number[];
-    /** 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.
-     *
-     * **Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first.
-     */
-    rekeyTo?: SendTransactionFrom | string;
+interface CoreAppCallArgs {
+  /** The optional lease for the transaction */
+  lease?: string | Uint8Array;
+  /** Any box references to load */
+  boxes?: (BoxReference | BoxReference$1 | BoxIdentifier)[];
+  /** The address of any accounts to load in */
+  accounts?: (string | Address)[];
+  /** IDs of any apps to load into the foreignApps array */
+  apps?: number[];
+  /** IDs of any assets to load into the foreignAssets array */
+  assets?: number[];
+  /** 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.
+   *
+   * **Note:** Use with extreme caution and review the [official rekey guidance](https://dev.algorand.co/concepts/accounts/rekeying) first.
+   */
+  rekeyTo?: SendTransactionFrom | string;
 }
 /**
  * App call args with non-ABI (raw) values (minus some processing like encoding strings as binary)
  */
-export interface RawAppCallArgs extends CoreAppCallArgs {
-    /** Any application arguments to pass through */
-    appArgs?: (Uint8Array | string)[];
-    /** Property to aid intellisense */
-    method?: undefined;
+interface RawAppCallArgs extends CoreAppCallArgs {
+  /** Any application arguments to pass through */
+  appArgs?: (Uint8Array | string)[];
+  /** Property to aid intellisense */
+  method?: undefined;
 }
 /** 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` */
-export type ABIAppCallArg = ABIArgument | TransactionToSign | Transaction | Promise<SendTransactionResult> | SendTransactionResult | undefined;
+type ABIAppCallArg = ABIValue | TransactionWithSigner | TransactionToSign | Transaction | Promise<SendTransactionResult> | SendTransactionResult | undefined;
 /**
  * App call args for an ABI call
  */
-export type ABIAppCallArgs = CoreAppCallArgs & {
-    /** The ABI method to call */
-    method: ABIMethodParams | ABIMethod;
-    /** The ABI method args to pass in */
-    methodArgs: ABIAppCallArg[];
+type ABIAppCallArgs = CoreAppCallArgs & {
+  /** The ABI method to call */
+  method: ABIMethod;
+  /** The ABI method args to pass in */
+  methodArgs: ABIAppCallArg[];
 };
 /** Arguments to pass to an app call either:
  *   * The raw app call values to pass through into the transaction (after processing); or
  *   * An ABI method definition (method and args)
  **/
-export type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
-/**
- * @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;
-    /** The approval program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
-    approvalProgram: Uint8Array | string;
-    /** The clear state program as raw teal (string) or compiled teal, base 64 encoded as a byte array (Uint8Array) */
-    clearStateProgram: Uint8Array | string;
-    /** Optional transaction parameters */
-    transactionParams?: SuggestedParams;
-    /** The (optional) transaction note */
-    note?: TransactionNote;
-    /** The arguments passed in to the app call */
-    args?: AppCallArgs;
-}
-/**
- * @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>;
-}
-/**
- * @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;
-}
-/**
- * @deprecated Use `algosdk.OnApplicationComplete` directly instead.
- *
- * The type of call / [on-completion action](https://dev.algorand.co/concepts/smart-contracts/overview#smart-contract-lifecycle) for a smart contract call.
- *
- * Equivalent of `algosdk.OnApplicationComplete`, but as a more convenient string enum.
- *
- * * `no_op`: Normal smart contract call, no special on-complete action
- * * `opt_in`: Opt-in to smart contract local storage
- * * `close_out`: Close-out local storage storage
- * * `clear_state`: Clear local storage state
- * * `update_application`: Update the smart contract
- * * `delete_application`: Delete the smart contract
- */
-export type AppCallType = 'no_op' | 'opt_in' | 'close_out' | 'clear_state' | 'update_application' | 'delete_application';
+type AppCallArgs = RawAppCallArgs | ABIAppCallArgs;
 /** Parameters representing a call to an app. */
-export interface AppCallParams extends SendTransactionParams {
-    /** The id of the app to call */
-    appId: number | bigint;
-    /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */
-    callType: Exclude<AppCallType, 'update_application'> | Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplicationOC>;
-    /** The account to make the call from */
-    from: SendTransactionFrom;
-    /** Optional transaction parameters */
-    transactionParams?: SuggestedParams;
-    /** The (optional) transaction note */
-    note?: TransactionNote;
-    /** The arguments passed in to the app call */
-    args?: AppCallArgs;
+interface AppCallParams extends SendTransactionParams {
+  /** The id of the app to call */
+  appId: number | bigint;
+  /** The type of call, everything except create (see `createApp`) and update (see `updateApp`) */
+  callType: Exclude<OnApplicationComplete, OnApplicationComplete.UpdateApplication>;
+  /** The account to make the call from */
+  from: SendTransactionFrom;
+  /** Optional transaction parameters */
+  transactionParams?: SuggestedParams;
+  /** The (optional) transaction note */
+  note?: TransactionNote;
+  /** The arguments passed in to the app call */
+  args?: AppCallArgs;
 }
 /** Parameters representing the storage schema of an app. */
-export interface AppStorageSchema {
-    /** Restricts number of ints in per-user local state */
-    localInts: number;
-    /** Restricts number of byte slices in per-user local state */
-    localByteSlices: number;
-    /** Restricts number of ints in global state */
-    globalInts: number;
-    /** Restricts number of byte slices in global state */
-    globalByteSlices: number;
-    /** 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 */
-    extraPages?: number;
+interface AppStorageSchema {
+  /** Restricts number of ints in per-user local state */
+  localInts: number;
+  /** Restricts number of byte slices in per-user local state */
+  localByteSlices: number;
+  /** Restricts number of ints in global state */
+  globalInts: number;
+  /** Restricts number of byte slices in global state */
+  globalByteSlices: number;
+  /** 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 */
+  extraPages?: number;
 }
 /** Information about a compiled teal program */
-export interface CompiledTeal {
-    /** Original TEAL code */
-    teal: string;
-    /** The compiled code */
-    compiled: string;
-    /** The hash returned by the compiler */
-    compiledHash: string;
-    /** The base64 encoded code as a byte array */
-    compiledBase64ToBytes: Uint8Array;
-    /** Source map from the compilation */
-    sourceMap: SourceMap;
+interface CompiledTeal {
+  /** Original TEAL code */
+  teal: string;
+  /** The compiled code */
+  compiled: string;
+  /** The hash returned by the compiler */
+  compiledHash: string;
+  /** The base64 encoded code as a byte array */
+  compiledBase64ToBytes: Uint8Array;
+  /** Source map from the compilation */
+  sourceMap: SourceMap;
 }
-export interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {
-    /** If an ABI method was called the processed return value */
-    return?: T;
+interface AppCallTransactionResultOfType<T> extends SendTransactionResults, SendTransactionResult {
+  /** If an ABI method was called the processed return value */
+  return?: T;
 }
 /** Result from calling an app */
-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;
-    method?: undefined;
-    decodeError: Error;
-};
+type AppCallTransactionResult = AppCallTransactionResultOfType<ABIReturn>;
 /**
  * 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`.
  */
-export interface AppDeployMetadata {
-    /** The unique name identifier of the app within the creator account */
-    name: string;
-    /** The version of app that is / will be deployed */
-    version: string;
-    /** Whether or not the app is deletable / permanent / unspecified */
-    deletable?: boolean;
-    /** Whether or not the app is updatable / immutable / unspecified */
-    updatable?: boolean;
+interface AppDeployMetadata {
+  /** The unique name identifier of the app within the creator account */
+  name: string;
+  /** The version of app that is / will be deployed */
+  version: string;
+  /** Whether or not the app is deletable / permanent / unspecified */
+  deletable?: boolean;
+  /** Whether or not the app is updatable / immutable / unspecified */
+  updatable?: boolean;
 }
 /** The metadata that can be collected about a deployed app */
-export interface AppMetadata extends AppReference, AppDeployMetadata {
-    /** The round the app was created */
-    createdRound: number;
-    /** The last round that the app was updated */
-    updatedRound: number;
-    /** The metadata when the app was created */
-    createdMetadata: AppDeployMetadata;
-    /** Whether or not the app is deleted */
-    deleted: boolean;
+interface AppMetadata extends AppReference, AppDeployMetadata {
+  /** The round the app was created */
+  createdRound: number;
+  /** The last round that the app was updated */
+  updatedRound: number;
+  /** The metadata when the app was created */
+  createdMetadata: AppDeployMetadata;
+  /** Whether or not the app is deleted */
+  deleted: boolean;
 }
 /** A lookup of name -> Algorand app for a creator */
-export interface AppLookup {
-    creator: Readonly<string>;
-    apps: Readonly<{
-        [name: string]: AppMetadata;
-    }>;
+interface AppLookup {
+  creator: Readonly<string>;
+  apps: Readonly<{
+    [name: string]: AppMetadata;
+  }>;
 }
 /** Dictionary of deploy-time parameters to replace in a teal template.
  *
  * Note: Looks for `TMPL_{parameter}` for template replacements i.e. you can leave out the `TMPL_`.
  *
  */
-export interface TealTemplateParams {
-    [key: string]: string | bigint | number | Uint8Array;
+interface TealTemplateParams {
+  [key: string]: string | bigint | number | Uint8Array;
 }
 /** What action to perform when deploying an app and an update is detected in the TEAL code */
-export declare enum OnUpdate {
-    /** Fail the deployment */
-    Fail = 0,
-    /** Update the app */
-    UpdateApp = 1,
-    /** Delete the app and create a new one in its place */
-    ReplaceApp = 2,
-    /** Create a new app */
-    AppendApp = 3
+declare enum OnUpdate {
+  /** Fail the deployment */
+  Fail = 0,
+  /** Update the app */
+  UpdateApp = 1,
+  /** Delete the app and create a new one in its place */
+  ReplaceApp = 2,
+  /** Create a new app */
+  AppendApp = 3,
 }
 /** What action to perform when deploying an app and a breaking schema change is detected */
-export declare enum OnSchemaBreak {
-    /** Fail the deployment */
-    Fail = 0,
-    /** Delete the app and create a new one in its place */
-    ReplaceApp = 1,
-    /** Create a new app */
-    AppendApp = 2
-}
-/** The parameters to deploy an app */
-export interface AppDeploymentParams extends Omit<CreateAppParams, 'onCompleteAction' | 'args' | 'note' | 'skipSending' | 'skipWaiting' | 'atc'> {
-    /** The deployment metadata */
-    metadata: AppDeployMetadata;
-    /** Any deploy-time parameters to replace in the TEAL code */
-    deployTimeParams?: TealTemplateParams;
-    /** What action to perform if a schema break is detected */
-    onSchemaBreak?: 'replace' | 'fail' | 'append' | OnSchemaBreak;
-    /** What action to perform if a TEAL update is detected */
-    onUpdate?: 'update' | 'replace' | 'fail' | 'append' | OnUpdate;
-    /** Optional cached value of the existing apps for the given creator */
-    existingDeployments?: AppLookup;
-    /** Any args to pass to any create transaction that is issued as part of deployment */
-    createArgs?: AppCallArgs;
-    /** Override the on-completion action for the create call; defaults to NoOp */
-    createOnCompleteAction?: Exclude<AppCallType, 'clear_state'> | Exclude<OnApplicationComplete, OnApplicationComplete.ClearStateOC>;
-    /** Any args to pass to any update transaction that is issued as part of deployment */
-    updateArgs?: AppCallArgs;
-    /** Any args to pass to any delete transaction that is issued as part of deployment */
-    deleteArgs?: AppCallArgs;
+declare enum OnSchemaBreak {
+  /** Fail the deployment */
+  Fail = 0,
+  /** Delete the app and create a new one in its place */
+  ReplaceApp = 1,
+  /** Create a new app */
+  AppendApp = 2,
 }
 /** The result of compiling the approval and clear state TEAL programs for an app */
-export interface AppCompilationResult {
-    /** The result of compiling the approval program */
-    compiledApproval: CompiledTeal;
-    /** The result of compiling the clear state program */
-    compiledClear: CompiledTeal;
+interface AppCompilationResult {
+  /** The result of compiling the approval program */
+  compiledApproval: CompiledTeal;
+  /** The result of compiling the clear state program */
+  compiledClear: CompiledTeal;
 }
-export type AppReturn<TReturn> = {
-    /** The ABI method call return value */
-    return?: TReturn;
+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;
+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>>;
+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;
+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: bigint;
-        keyRaw: Uint8Array;
-        keyBase64: string;
-    } | {
-        value: string;
-        valueRaw: Uint8Array;
-        valueBase64: string;
-        keyRaw: Uint8Array;
-        keyBase64: string;
-    };
+interface AppState {
+  [key: string]: {
+    value: bigint;
+    keyRaw: Uint8Array;
+    keyBase64: string;
+  } | {
+    value: string;
+    valueRaw: Uint8Array;
+    valueBase64: string;
+    keyRaw: Uint8Array;
+    keyBase64: string;
+  };
 }
 /**
  * The name of a box storage box */
-export interface BoxName {
-    /** Name in UTF-8 */
-    name: string;
-    /** Name in binary bytes */
-    nameRaw: Uint8Array;
-    /** Name in Base64 */
-    nameBase64: string;
+interface BoxName {
+  /** Name in UTF-8 */
+  name: string;
+  /** Name in binary bytes */
+  nameRaw: Uint8Array;
+  /** Name in Base64 */
+  nameBase64: string;
 }
 /**
  * @deprecated Use `types/app-manager/BoxValueRequestParams` instead.
  * Parameters to get and decode a box value as an ABI type.
  */
-export interface BoxValueRequestParams {
-    /** The ID of the app return box names for */
-    appId: number | bigint;
-    /** The name of the box to return either as a string, binary array or `BoxName` */
-    boxName: string | Uint8Array | BoxName;
-    /** The ABI type to decode the value using */
-    type: ABIType;
+interface BoxValueRequestParams {
+  /** The ID of the app return box names for */
+  appId: number | bigint;
+  /** The name of the box to return either as a string, binary array or `BoxName` */
+  boxName: string | Uint8Array | BoxName;
+  /** The ABI type to decode the value using */
+  type: ABIType;
 }
 /**
  * @deprecated Use `types/app-manager/BoxValuesRequestParams` instead.
  * Parameters to get and decode a box value as an ABI type.
  */
-export interface BoxValuesRequestParams {
-    /** The ID of the app return box names for */
-    appId: number;
-    /** The names of the boxes to return either as a string, binary array or BoxName` */
-    boxNames: (string | Uint8Array | BoxName)[];
-    /** The ABI type to decode the value using */
-    type: ABIType;
+interface BoxValuesRequestParams {
+  /** The ID of the app return box names for */
+  appId: number;
+  /** The names of the boxes to return either as a string, binary array or BoxName` */
+  boxNames: (string | Uint8Array | BoxName)[];
+  /** The ABI type to decode the value using */
+  type: ABIType;
 }
-export {};
+//#endregion
+export { ABIAppCallArg, ABIAppCallArgs, ABI_RETURN_PREFIX, APP_DEPLOY_NOTE_DAPP, APP_PAGE_MAX_SIZE, AppCallArgs, AppCallParams, AppCallTransactionResult, AppCallTransactionResultOfType, AppCompilationResult, AppDeployMetadata, AppLookup, AppMetadata, AppReference, AppReturn, AppState, AppStorageSchema, BoxName, BoxValueRequestParams, BoxValuesRequestParams, CompiledTeal, CoreAppCallArgs, DELETABLE_TEMPLATE_NAME, OnSchemaBreak, OnUpdate, RawAppCallArgs, SendAppCreateTransactionResult, SendAppTransactionResult, SendAppUpdateTransactionResult, TealTemplateParams, UPDATABLE_TEMPLATE_NAME };
+//# sourceMappingURL=app.d.ts.map