@algorandfoundation/algokit-utils 10.0.0-alpha.7 → 10.0.0-alpha.9

package/packages/abi/src/arc56-contract.js

@@ -1,6 +1,7 @@
 const require_abi_type = require('./abi-type.js');
 
 //#region packages/abi/src/arc56-contract.ts
+/** ARC-56 spec */
 /** Storage Helper Functions */
 /**
 * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType

package/packages/abi/src/arc56-contract.js.map

@@ -1 +1 @@
-{"version":3,"file":"arc56-contract.js","names":["ABIStructType","ABIType","result: Record<string, ABIStorageKey>","result: Record<string, ABIStorageMap>"],"sources":["../../../../packages/abi/src/arc56-contract.ts"],"sourcesContent":["/****************/\n/** ARC-56 spec */\n/****************/\n\nimport { ABIStructType, ABIType } from './abi-type'\n\n/** Describes a single key in app storage with parsed ABI types */\nexport type ABIStorageKey = {\n  /** The bytes of the key encoded as base64 */\n  key: string\n  /** The parsed type of the key (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the value (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what this storage key holds */\n  desc?: string\n}\n\n/** Describes a storage map with parsed ABI types */\nexport type ABIStorageMap = {\n  /** The parsed type of the keys in the map (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the values in the map (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The base64-encoded prefix of the map keys */\n  prefix?: string\n}\n\n/** Describes the entire contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Contract = {\n  /** The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the type */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be defined\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs used by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Arc56Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: ProgramSourceInfo\n    /** Clear program information */\n    clear: ProgramSourceInfo\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABITypeName | AVMType | StructName\n      /** If given, the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABITypeName | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Method = {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n      data: string\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type?: ABITypeName | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       * - method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value\n       */\n      source: 'box' | 'global' | 'local' | 'literal' | 'method'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport type Event = {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABITypeName = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport type StructField = {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABITypeName | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport type StorageKey = {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABITypeName | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABITypeName | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport type StorageMap = {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABITypeName | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABITypeName | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\ntype SourceInfo = {\n  /** The program counter value(s). Could be offset if pcOffsetMethod is not \"none\" */\n  pc: Array<number>\n  /** A human-readable string that describes the error when the program fails at the given PC */\n  errorMessage?: string\n  /** The TEAL line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  teal?: number\n  /** The original source file and line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  source?: string\n}\n\nexport type ProgramSourceInfo = {\n  /** The source information for the program */\n  sourceInfo: SourceInfo[]\n  /** How the program counter offset is calculated\n   * - none: The pc values in sourceInfo are not offset\n   * - cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program\n   */\n  pcOffsetMethod: 'none' | 'cblocks'\n}\n\n/*************************/\n/** Storage Helper Functions */\n/*************************/\n\n/**\n * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType\n * @param typeStr The type string to resolve\n * @param structs The structs defined in the contract\n * @returns The parsed ABIType or AVMType string\n */\nfunction resolveStorageType(typeStr: string, structs: Record<string, StructField[]>): ABIType | AVMType {\n  // Check if it's an AVM type\n  if (typeStr === 'AVMBytes' || typeStr === 'AVMString' || typeStr === 'AVMUint64') {\n    return typeStr as AVMType\n  }\n\n  // Check if it's a struct type\n  if (structs[typeStr]) {\n    return ABIStructType.fromStruct(typeStr, structs)\n  }\n\n  // Otherwise parse as ABI type\n  try {\n    return ABIType.from(typeStr)\n  } catch (error) {\n    throw new Error(`Failed to parse storage type '${typeStr}': ${error}`)\n  }\n}\n\n/**\n * Converts a StorageKey to an ABIStorageKey with parsed types\n * @param storageKey The storage key to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageKey\n */\nfunction convertStorageKey(storageKey: StorageKey, structs: Record<string, StructField[]>): ABIStorageKey {\n  const keyType = resolveStorageType(storageKey.keyType, structs)\n  const valueType = resolveStorageType(storageKey.valueType, structs)\n\n  return {\n    key: storageKey.key,\n    keyType,\n    valueType,\n    desc: storageKey.desc,\n  }\n}\n\n/**\n * Converts a StorageMap to an ABIStorageMap with parsed types\n * @param storageMap The storage map to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageMap\n */\nfunction convertStorageMap(storageMap: StorageMap, structs: Record<string, StructField[]>): ABIStorageMap {\n  const keyType = resolveStorageType(storageMap.keyType, structs)\n  const valueType = resolveStorageType(storageMap.valueType, structs)\n\n  return {\n    keyType,\n    valueType,\n    desc: storageMap.desc,\n    prefix: storageMap.prefix,\n  }\n}\n\n/**\n * Get a specific global storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getGlobalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.global[keyName]\n  if (!storageKey) {\n    throw new Error(`Global storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific local storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getLocalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.local[keyName]\n  if (!storageKey) {\n    throw new Error(`Local storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific box storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getBoxABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.box[keyName]\n  if (!storageKey) {\n    throw new Error(`Box storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get all global storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getGlobalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.global)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getLocalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.local)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getBoxABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.box)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get a specific global storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getGlobalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.global[mapName]\n  if (!storageMap) {\n    throw new Error(`Global storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific local storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getLocalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.local[mapName]\n  if (!storageMap) {\n    throw new Error(`Local storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific box storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getBoxABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.box[mapName]\n  if (!storageMap) {\n    throw new Error(`Box storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get all global storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getGlobalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.global)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getLocalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.local)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getBoxABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.box)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n"],"mappings":";;;;;;;;;;AA6TA,SAAS,mBAAmB,SAAiB,SAA2D;AAEtG,KAAI,YAAY,cAAc,YAAY,eAAe,YAAY,YACnE,QAAO;AAIT,KAAI,QAAQ,SACV,QAAOA,+BAAc,WAAW,SAAS,QAAQ;AAInD,KAAI;AACF,SAAOC,yBAAQ,KAAK,QAAQ;UACrB,OAAO;AACd,QAAM,IAAI,MAAM,iCAAiC,QAAQ,KAAK,QAAQ;;;;;;;;;AAU1E,SAAS,kBAAkB,YAAwB,SAAuD;CACxG,MAAM,UAAU,mBAAmB,WAAW,SAAS,QAAQ;CAC/D,MAAM,YAAY,mBAAmB,WAAW,WAAW,QAAQ;AAEnE,QAAO;EACL,KAAK,WAAW;EAChB;EACA;EACA,MAAM,WAAW;EAClB;;;;;;;;AASH,SAAS,kBAAkB,YAAwB,SAAuD;AAIxG,QAAO;EACL,SAJc,mBAAmB,WAAW,SAAS,QAAQ;EAK7D,WAJgB,mBAAmB,WAAW,WAAW,QAAQ;EAKjE,MAAM,WAAW;EACjB,QAAQ,WAAW;EACpB;;;;;;;;;AAUH,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;;;AAUT,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO"}
+{"version":3,"file":"arc56-contract.js","names":["ABIStructType","ABIType","result: Record<string, ABIStorageKey>","result: Record<string, ABIStorageMap>"],"sources":["../../../../packages/abi/src/arc56-contract.ts"],"sourcesContent":["/****************/\n/** ARC-56 spec */\n/****************/\n\nimport { ABIStructType, ABIType } from './abi-type'\n\n/** Describes a single key in app storage with parsed ABI types */\nexport type ABIStorageKey = {\n  /** The bytes of the key encoded as base64 */\n  key: string\n  /** The parsed type of the key (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the value (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what this storage key holds */\n  desc?: string\n}\n\n/** Describes a storage map with parsed ABI types */\nexport type ABIStorageMap = {\n  /** The parsed type of the keys in the map (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the values in the map (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The base64-encoded prefix of the map keys */\n  prefix?: string\n}\n\n/** Describes the entire contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Contract = {\n  /** The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the type */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be defined\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs used by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Arc56Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: ProgramSourceInfo\n    /** Clear program information */\n    clear: ProgramSourceInfo\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABITypeName | AVMType | StructName\n      /** If given, the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABITypeName | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Method = {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n      data: string\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type?: ABITypeName | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       * - method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value\n       */\n      source: 'box' | 'global' | 'local' | 'literal' | 'method'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport type Event = {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABITypeName = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport type StructField = {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABITypeName | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport type StorageKey = {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABITypeName | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABITypeName | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport type StorageMap = {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABITypeName | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABITypeName | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\ntype SourceInfo = {\n  /** The program counter value(s). Could be offset if pcOffsetMethod is not \"none\" */\n  pc: Array<number>\n  /** A human-readable string that describes the error when the program fails at the given PC */\n  errorMessage?: string\n  /** The TEAL line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  teal?: number\n  /** The original source file and line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  source?: string\n}\n\nexport type ProgramSourceInfo = {\n  /** The source information for the program */\n  sourceInfo: SourceInfo[]\n  /** How the program counter offset is calculated\n   * - none: The pc values in sourceInfo are not offset\n   * - cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program\n   */\n  pcOffsetMethod: 'none' | 'cblocks'\n}\n\n/*************************/\n/** Storage Helper Functions */\n/*************************/\n\n/**\n * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType\n * @param typeStr The type string to resolve\n * @param structs The structs defined in the contract\n * @returns The parsed ABIType or AVMType string\n */\nfunction resolveStorageType(typeStr: string, structs: Record<string, StructField[]>): ABIType | AVMType {\n  // Check if it's an AVM type\n  if (typeStr === 'AVMBytes' || typeStr === 'AVMString' || typeStr === 'AVMUint64') {\n    return typeStr as AVMType\n  }\n\n  // Check if it's a struct type\n  if (structs[typeStr]) {\n    return ABIStructType.fromStruct(typeStr, structs)\n  }\n\n  // Otherwise parse as ABI type\n  try {\n    return ABIType.from(typeStr)\n  } catch (error) {\n    throw new Error(`Failed to parse storage type '${typeStr}': ${error}`)\n  }\n}\n\n/**\n * Converts a StorageKey to an ABIStorageKey with parsed types\n * @param storageKey The storage key to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageKey\n */\nfunction convertStorageKey(storageKey: StorageKey, structs: Record<string, StructField[]>): ABIStorageKey {\n  const keyType = resolveStorageType(storageKey.keyType, structs)\n  const valueType = resolveStorageType(storageKey.valueType, structs)\n\n  return {\n    key: storageKey.key,\n    keyType,\n    valueType,\n    desc: storageKey.desc,\n  }\n}\n\n/**\n * Converts a StorageMap to an ABIStorageMap with parsed types\n * @param storageMap The storage map to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageMap\n */\nfunction convertStorageMap(storageMap: StorageMap, structs: Record<string, StructField[]>): ABIStorageMap {\n  const keyType = resolveStorageType(storageMap.keyType, structs)\n  const valueType = resolveStorageType(storageMap.valueType, structs)\n\n  return {\n    keyType,\n    valueType,\n    desc: storageMap.desc,\n    prefix: storageMap.prefix,\n  }\n}\n\n/**\n * Get a specific global storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getGlobalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.global[keyName]\n  if (!storageKey) {\n    throw new Error(`Global storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific local storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getLocalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.local[keyName]\n  if (!storageKey) {\n    throw new Error(`Local storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific box storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getBoxABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.box[keyName]\n  if (!storageKey) {\n    throw new Error(`Box storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get all global storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getGlobalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.global)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getLocalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.local)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getBoxABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.box)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get a specific global storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getGlobalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.global[mapName]\n  if (!storageMap) {\n    throw new Error(`Global storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific local storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getLocalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.local[mapName]\n  if (!storageMap) {\n    throw new Error(`Local storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific box storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getBoxABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.box[mapName]\n  if (!storageMap) {\n    throw new Error(`Box storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get all global storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getGlobalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.global)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getLocalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.local)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getBoxABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.box)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n"],"mappings":";;;;;;;;;;;AA6TA,SAAS,mBAAmB,SAAiB,SAA2D;AAEtG,KAAI,YAAY,cAAc,YAAY,eAAe,YAAY,YACnE,QAAO;AAIT,KAAI,QAAQ,SACV,QAAOA,+BAAc,WAAW,SAAS,QAAQ;AAInD,KAAI;AACF,SAAOC,yBAAQ,KAAK,QAAQ;UACrB,OAAO;AACd,QAAM,IAAI,MAAM,iCAAiC,QAAQ,KAAK,QAAQ;;;;;;;;;AAU1E,SAAS,kBAAkB,YAAwB,SAAuD;CACxG,MAAM,UAAU,mBAAmB,WAAW,SAAS,QAAQ;CAC/D,MAAM,YAAY,mBAAmB,WAAW,WAAW,QAAQ;AAEnE,QAAO;EACL,KAAK,WAAW;EAChB;EACA;EACA,MAAM,WAAW;EAClB;;;;;;;;AASH,SAAS,kBAAkB,YAAwB,SAAuD;AAIxG,QAAO;EACL,SAJc,mBAAmB,WAAW,SAAS,QAAQ;EAK7D,WAJgB,mBAAmB,WAAW,WAAW,QAAQ;EAKjE,MAAM,WAAW;EACjB,QAAQ,WAAW;EACpB;;;;;;;;;AAUH,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;;;AAUT,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO"}

package/packages/abi/src/arc56-contract.mjs

@@ -1,6 +1,7 @@
 import { ABIStructType, ABIType } from "./abi-type.mjs";
 
 //#region packages/abi/src/arc56-contract.ts
+/** ARC-56 spec */
 /** Storage Helper Functions */
 /**
 * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType

package/packages/abi/src/arc56-contract.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"arc56-contract.mjs","names":["result: Record<string, ABIStorageKey>","result: Record<string, ABIStorageMap>"],"sources":["../../../../packages/abi/src/arc56-contract.ts"],"sourcesContent":["/****************/\n/** ARC-56 spec */\n/****************/\n\nimport { ABIStructType, ABIType } from './abi-type'\n\n/** Describes a single key in app storage with parsed ABI types */\nexport type ABIStorageKey = {\n  /** The bytes of the key encoded as base64 */\n  key: string\n  /** The parsed type of the key (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the value (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what this storage key holds */\n  desc?: string\n}\n\n/** Describes a storage map with parsed ABI types */\nexport type ABIStorageMap = {\n  /** The parsed type of the keys in the map (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the values in the map (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The base64-encoded prefix of the map keys */\n  prefix?: string\n}\n\n/** Describes the entire contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Contract = {\n  /** The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the type */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be defined\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs used by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Arc56Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: ProgramSourceInfo\n    /** Clear program information */\n    clear: ProgramSourceInfo\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABITypeName | AVMType | StructName\n      /** If given, the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABITypeName | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Method = {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n      data: string\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type?: ABITypeName | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       * - method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value\n       */\n      source: 'box' | 'global' | 'local' | 'literal' | 'method'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport type Event = {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABITypeName = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport type StructField = {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABITypeName | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport type StorageKey = {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABITypeName | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABITypeName | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport type StorageMap = {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABITypeName | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABITypeName | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\ntype SourceInfo = {\n  /** The program counter value(s). Could be offset if pcOffsetMethod is not \"none\" */\n  pc: Array<number>\n  /** A human-readable string that describes the error when the program fails at the given PC */\n  errorMessage?: string\n  /** The TEAL line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  teal?: number\n  /** The original source file and line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  source?: string\n}\n\nexport type ProgramSourceInfo = {\n  /** The source information for the program */\n  sourceInfo: SourceInfo[]\n  /** How the program counter offset is calculated\n   * - none: The pc values in sourceInfo are not offset\n   * - cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program\n   */\n  pcOffsetMethod: 'none' | 'cblocks'\n}\n\n/*************************/\n/** Storage Helper Functions */\n/*************************/\n\n/**\n * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType\n * @param typeStr The type string to resolve\n * @param structs The structs defined in the contract\n * @returns The parsed ABIType or AVMType string\n */\nfunction resolveStorageType(typeStr: string, structs: Record<string, StructField[]>): ABIType | AVMType {\n  // Check if it's an AVM type\n  if (typeStr === 'AVMBytes' || typeStr === 'AVMString' || typeStr === 'AVMUint64') {\n    return typeStr as AVMType\n  }\n\n  // Check if it's a struct type\n  if (structs[typeStr]) {\n    return ABIStructType.fromStruct(typeStr, structs)\n  }\n\n  // Otherwise parse as ABI type\n  try {\n    return ABIType.from(typeStr)\n  } catch (error) {\n    throw new Error(`Failed to parse storage type '${typeStr}': ${error}`)\n  }\n}\n\n/**\n * Converts a StorageKey to an ABIStorageKey with parsed types\n * @param storageKey The storage key to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageKey\n */\nfunction convertStorageKey(storageKey: StorageKey, structs: Record<string, StructField[]>): ABIStorageKey {\n  const keyType = resolveStorageType(storageKey.keyType, structs)\n  const valueType = resolveStorageType(storageKey.valueType, structs)\n\n  return {\n    key: storageKey.key,\n    keyType,\n    valueType,\n    desc: storageKey.desc,\n  }\n}\n\n/**\n * Converts a StorageMap to an ABIStorageMap with parsed types\n * @param storageMap The storage map to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageMap\n */\nfunction convertStorageMap(storageMap: StorageMap, structs: Record<string, StructField[]>): ABIStorageMap {\n  const keyType = resolveStorageType(storageMap.keyType, structs)\n  const valueType = resolveStorageType(storageMap.valueType, structs)\n\n  return {\n    keyType,\n    valueType,\n    desc: storageMap.desc,\n    prefix: storageMap.prefix,\n  }\n}\n\n/**\n * Get a specific global storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getGlobalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.global[keyName]\n  if (!storageKey) {\n    throw new Error(`Global storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific local storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getLocalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.local[keyName]\n  if (!storageKey) {\n    throw new Error(`Local storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific box storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getBoxABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.box[keyName]\n  if (!storageKey) {\n    throw new Error(`Box storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get all global storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getGlobalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.global)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getLocalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.local)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getBoxABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.box)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get a specific global storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getGlobalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.global[mapName]\n  if (!storageMap) {\n    throw new Error(`Global storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific local storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getLocalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.local[mapName]\n  if (!storageMap) {\n    throw new Error(`Local storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific box storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getBoxABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.box[mapName]\n  if (!storageMap) {\n    throw new Error(`Box storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get all global storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getGlobalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.global)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getLocalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.local)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getBoxABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.box)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n"],"mappings":";;;;;;;;;;AA6TA,SAAS,mBAAmB,SAAiB,SAA2D;AAEtG,KAAI,YAAY,cAAc,YAAY,eAAe,YAAY,YACnE,QAAO;AAIT,KAAI,QAAQ,SACV,QAAO,cAAc,WAAW,SAAS,QAAQ;AAInD,KAAI;AACF,SAAO,QAAQ,KAAK,QAAQ;UACrB,OAAO;AACd,QAAM,IAAI,MAAM,iCAAiC,QAAQ,KAAK,QAAQ;;;;;;;;;AAU1E,SAAS,kBAAkB,YAAwB,SAAuD;CACxG,MAAM,UAAU,mBAAmB,WAAW,SAAS,QAAQ;CAC/D,MAAM,YAAY,mBAAmB,WAAW,WAAW,QAAQ;AAEnE,QAAO;EACL,KAAK,WAAW;EAChB;EACA;EACA,MAAM,WAAW;EAClB;;;;;;;;AASH,SAAS,kBAAkB,YAAwB,SAAuD;AAIxG,QAAO;EACL,SAJc,mBAAmB,WAAW,SAAS,QAAQ;EAK7D,WAJgB,mBAAmB,WAAW,WAAW,QAAQ;EAKjE,MAAM,WAAW;EACjB,QAAQ,WAAW;EACpB;;;;;;;;;AAUH,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;;;AAUT,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO"}
+{"version":3,"file":"arc56-contract.mjs","names":["result: Record<string, ABIStorageKey>","result: Record<string, ABIStorageMap>"],"sources":["../../../../packages/abi/src/arc56-contract.ts"],"sourcesContent":["/****************/\n/** ARC-56 spec */\n/****************/\n\nimport { ABIStructType, ABIType } from './abi-type'\n\n/** Describes a single key in app storage with parsed ABI types */\nexport type ABIStorageKey = {\n  /** The bytes of the key encoded as base64 */\n  key: string\n  /** The parsed type of the key (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the value (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what this storage key holds */\n  desc?: string\n}\n\n/** Describes a storage map with parsed ABI types */\nexport type ABIStorageMap = {\n  /** The parsed type of the keys in the map (ABI type or AVM type) */\n  keyType: ABIType | AVMType\n  /** The parsed type of the values in the map (ABI type or AVM type) */\n  valueType: ABIType | AVMType\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The base64-encoded prefix of the map keys */\n  prefix?: string\n}\n\n/** Describes the entire contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Contract = {\n  /** The ARCs used and/or supported by this contract. All contracts implicitly support ARC4 and ARC56 */\n  arcs: number[]\n  /** A user-friendly name for the contract */\n  name: string\n  /** Optional, user-friendly description for the type */\n  desc?: string\n  /**\n   * Optional object listing the contract instances across different networks.\n   * The key is the base64 genesis hash of the network, and the value contains\n   * information about the deployed contract in the network indicated by the\n   * key. A key containing the human-readable name of the network MAY be\n   * included, but the corresponding genesis hash key MUST also be defined\n   */\n  networks?: {\n    [network: string]: {\n      /** The app ID of the deployed contract in this network */\n      appID: number\n    }\n  }\n  /** Named structs used by the application. Each struct field appears in the same order as ABI encoding. */\n  structs: { [structName: StructName]: StructField[] }\n  /** All of the methods that the contract implements */\n  methods: Arc56Method[]\n  state: {\n    /** Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application  */\n    schema: {\n      global: {\n        ints: number\n        bytes: number\n      }\n      local: {\n        ints: number\n        bytes: number\n      }\n    }\n    /** Mapping of human-readable names to StorageKey objects */\n    keys: {\n      global: { [name: string]: StorageKey }\n      local: { [name: string]: StorageKey }\n      box: { [name: string]: StorageKey }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: { [name: string]: StorageMap }\n      local: { [name: string]: StorageMap }\n      box: { [name: string]: StorageMap }\n    }\n  }\n  /** Supported bare actions for the contract. An action is a combination of call/create and an OnComplete */\n  bareActions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** Information about the TEAL programs */\n  sourceInfo?: {\n    /** Approval program information */\n    approval: ProgramSourceInfo\n    /** Clear program information */\n    clear: ProgramSourceInfo\n  }\n  /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */\n  source?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** The compiled bytecode for the application. MUST be omitted if included as part of ARC23 */\n  byteCode?: {\n    /** The approval program */\n    approval: string\n    /** The clear program */\n    clear: string\n  }\n  /** Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present */\n  compilerInfo?: {\n    /** The name of the compiler */\n    compiler: 'algod' | 'puya'\n    /** Compiler version information */\n    compilerVersion: {\n      major: number\n      minor: number\n      patch: number\n      commitHash?: string\n    }\n  }\n  /** ARC-28 events that MAY be emitted by this contract */\n  events?: Array<Event>\n  /** A mapping of template variable names as they appear in the TEAL (not including TMPL_ prefix) to their respective types and values (if applicable) */\n  templateVariables?: {\n    [name: string]: {\n      /** The type of the template variable */\n      type: ABITypeName | AVMType | StructName\n      /** If given, the base64 encoded value used for the given app/program */\n      value?: string\n    }\n  }\n  /** The scratch variables used during runtime */\n  scratchVariables?: {\n    [name: string]: {\n      slot: number\n      type: ABITypeName | AVMType | StructName\n    }\n  }\n}\n\n/** Describes a method in the contract. This type is an extension of the type described in ARC-4 */\nexport type Arc56Method = {\n  /** The name of the method */\n  name: string\n  /** Optional, user-friendly description for the method */\n  desc?: string\n  /** The arguments of the method, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** The default value that clients should use. */\n    defaultValue?: {\n      /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n      data: string\n      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n      type?: ABITypeName | AVMType\n      /** Where the default value is coming from\n       * - box: The data key signifies the box key to read the value from\n       * - global: The data key signifies the global state key to read the value from\n       * - local: The data key signifies the local state key to read the value from (for the sender)\n       * - literal: the value is a literal and should be passed directly as the argument\n       * - method: The utf8 signature of the method in this contract to call to get the default value. If the method has arguments, they all must have default values. The method **MUST** be readonly so simulate can be used to get the default value\n       */\n      source: 'box' | 'global' | 'local' | 'literal' | 'method'\n    }\n  }>\n  /** Information about the method's return value */\n  returns: {\n    /** The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct. */\n    type: ABITypeName\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n    /** Optional, user-friendly description for the return value */\n    desc?: string\n  }\n  /** an action is a combination of call/create and an OnComplete */\n  actions: {\n    /** OnCompletes this method allows when appID === 0 */\n    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[]\n    /** OnCompletes this method allows when appID !== 0 */\n    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[]\n  }\n  /** If this method does not write anything to the ledger (ARC-22) */\n  readonly?: boolean\n  /** ARC-28 events that MAY be emitted by this method */\n  events?: Array<Event>\n  /** Information that clients can use when calling the method */\n  recommendations?: {\n    /** The number of inner transactions the caller should cover the fees for */\n    innerTransactionCount?: number\n    /** Recommended box references to include */\n    boxes?: {\n      /** The app ID for the box */\n      app?: number\n      /** The base64 encoded box key */\n      key: string\n      /** The number of bytes being read from the box */\n      readBytes: number\n      /** The number of bytes being written to the box */\n      writeBytes: number\n    }\n    /** Recommended foreign accounts */\n    accounts?: string[]\n    /** Recommended foreign apps */\n    apps?: number[]\n    /** Recommended foreign assets */\n    assets?: number[]\n  }\n}\n\n/** ARC-28 event */\nexport type Event = {\n  /** The name of the event */\n  name: string\n  /** Optional, user-friendly description for the event */\n  desc?: string\n  /** The arguments of the event, in order */\n  args: Array<{\n    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */\n    type: ABITypeName\n    /** Optional, user-friendly name for the argument */\n    name?: string\n    /** Optional, user-friendly description for the argument */\n    desc?: string\n    /** If the type is a struct, the name of the struct */\n    struct?: StructName\n  }>\n}\n\n/** An ABI-encoded type */\nexport type ABITypeName = string\n\n/** The name of a defined struct */\nexport type StructName = string\n\n/** Raw byteslice without the length prefixed that is specified in ARC-4 */\nexport type AVMBytes = 'AVMBytes'\n\n/** A utf-8 string without the length prefix that is specified in ARC-4 */\nexport type AVMString = 'AVMString'\n\n/** A 64-bit unsigned integer */\nexport type AVMUint64 = 'AVMUint64'\n\n/** A native AVM type */\nexport type AVMType = AVMBytes | AVMString | AVMUint64\n\n/** Information about a single field in a struct */\nexport type StructField = {\n  /** The name of the struct field */\n  name: string\n  /** The type of the struct field's value */\n  type: ABITypeName | StructName | StructField[]\n}\n\n/** Describes a single key in app storage */\nexport type StorageKey = {\n  /** Description of what this storage key holds */\n  desc?: string\n  /** The type of the key */\n  keyType: ABITypeName | AVMType | StructName\n\n  /** The type of the value */\n  valueType: ABITypeName | AVMType | StructName\n  /** The bytes of the key encoded as base64 */\n  key: string\n}\n\n/** Describes a mapping of key-value pairs in storage */\nexport type StorageMap = {\n  /** Description of what the key-value pairs in this mapping hold */\n  desc?: string\n  /** The type of the keys in the map */\n  keyType: ABITypeName | AVMType | StructName\n  /** The type of the values in the map */\n  valueType: ABITypeName | AVMType | StructName\n  /** The base64-encoded prefix of the map keys*/\n  prefix?: string\n}\n\ntype SourceInfo = {\n  /** The program counter value(s). Could be offset if pcOffsetMethod is not \"none\" */\n  pc: Array<number>\n  /** A human-readable string that describes the error when the program fails at the given PC */\n  errorMessage?: string\n  /** The TEAL line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  teal?: number\n  /** The original source file and line number that corresponds to the given PC. RECOMMENDED to be used for development purposes, but not required for clients */\n  source?: string\n}\n\nexport type ProgramSourceInfo = {\n  /** The source information for the program */\n  sourceInfo: SourceInfo[]\n  /** How the program counter offset is calculated\n   * - none: The pc values in sourceInfo are not offset\n   * - cblocks: The pc values in sourceInfo are offset by the PC of the first op following the last cblock at the top of the program\n   */\n  pcOffsetMethod: 'none' | 'cblocks'\n}\n\n/*************************/\n/** Storage Helper Functions */\n/*************************/\n\n/**\n * Resolves a storage type string (ABI type, AVM type, or struct name) into an ABIType or AVMType\n * @param typeStr The type string to resolve\n * @param structs The structs defined in the contract\n * @returns The parsed ABIType or AVMType string\n */\nfunction resolveStorageType(typeStr: string, structs: Record<string, StructField[]>): ABIType | AVMType {\n  // Check if it's an AVM type\n  if (typeStr === 'AVMBytes' || typeStr === 'AVMString' || typeStr === 'AVMUint64') {\n    return typeStr as AVMType\n  }\n\n  // Check if it's a struct type\n  if (structs[typeStr]) {\n    return ABIStructType.fromStruct(typeStr, structs)\n  }\n\n  // Otherwise parse as ABI type\n  try {\n    return ABIType.from(typeStr)\n  } catch (error) {\n    throw new Error(`Failed to parse storage type '${typeStr}': ${error}`)\n  }\n}\n\n/**\n * Converts a StorageKey to an ABIStorageKey with parsed types\n * @param storageKey The storage key to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageKey\n */\nfunction convertStorageKey(storageKey: StorageKey, structs: Record<string, StructField[]>): ABIStorageKey {\n  const keyType = resolveStorageType(storageKey.keyType, structs)\n  const valueType = resolveStorageType(storageKey.valueType, structs)\n\n  return {\n    key: storageKey.key,\n    keyType,\n    valueType,\n    desc: storageKey.desc,\n  }\n}\n\n/**\n * Converts a StorageMap to an ABIStorageMap with parsed types\n * @param storageMap The storage map to convert\n * @param structs The structs defined in the contract\n * @returns The converted ABIStorageMap\n */\nfunction convertStorageMap(storageMap: StorageMap, structs: Record<string, StructField[]>): ABIStorageMap {\n  const keyType = resolveStorageType(storageMap.keyType, structs)\n  const valueType = resolveStorageType(storageMap.valueType, structs)\n\n  return {\n    keyType,\n    valueType,\n    desc: storageMap.desc,\n    prefix: storageMap.prefix,\n  }\n}\n\n/**\n * Get a specific global storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getGlobalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.global[keyName]\n  if (!storageKey) {\n    throw new Error(`Global storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific local storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getLocalABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.local[keyName]\n  if (!storageKey) {\n    throw new Error(`Local storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get a specific box storage key with parsed ABI types\n * @param contract The ARC-56 contract\n * @param keyName The name of the storage key\n * @returns The ABIStorageKey with parsed types\n * @throws Error if the key is not found\n */\nexport function getBoxABIStorageKey(contract: Arc56Contract, keyName: string): ABIStorageKey {\n  const storageKey = contract.state.keys.box[keyName]\n  if (!storageKey) {\n    throw new Error(`Box storage key '${keyName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageKey(storageKey, contract.structs)\n}\n\n/**\n * Get all global storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getGlobalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.global)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getLocalABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.local)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage keys with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage key names to ABIStorageKey objects\n */\nexport function getBoxABIStorageKeys(contract: Arc56Contract): Record<string, ABIStorageKey> {\n  const result: Record<string, ABIStorageKey> = {}\n  for (const [name, storageKey] of Object.entries(contract.state.keys.box)) {\n    result[name] = convertStorageKey(storageKey, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get a specific global storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getGlobalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.global[mapName]\n  if (!storageMap) {\n    throw new Error(`Global storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific local storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getLocalABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.local[mapName]\n  if (!storageMap) {\n    throw new Error(`Local storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get a specific box storage map with parsed ABI types\n * @param contract The ARC-56 contract\n * @param mapName The name of the storage map\n * @returns The ABIStorageMap with parsed types\n * @throws Error if the map is not found\n */\nexport function getBoxABIStorageMap(contract: Arc56Contract, mapName: string): ABIStorageMap {\n  const storageMap = contract.state.maps.box[mapName]\n  if (!storageMap) {\n    throw new Error(`Box storage map '${mapName}' not found in contract '${contract.name}'`)\n  }\n  return convertStorageMap(storageMap, contract.structs)\n}\n\n/**\n * Get all global storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getGlobalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.global)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all local storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getLocalABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.local)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n\n/**\n * Get all box storage maps with parsed ABI types\n * @param contract The ARC-56 contract\n * @returns A record of storage map names to ABIStorageMap objects\n */\nexport function getBoxABIStorageMaps(contract: Arc56Contract): Record<string, ABIStorageMap> {\n  const result: Record<string, ABIStorageMap> = {}\n  for (const [name, storageMap] of Object.entries(contract.state.maps.box)) {\n    result[name] = convertStorageMap(storageMap, contract.structs)\n  }\n  return result\n}\n"],"mappings":";;;;;;;;;;;AA6TA,SAAS,mBAAmB,SAAiB,SAA2D;AAEtG,KAAI,YAAY,cAAc,YAAY,eAAe,YAAY,YACnE,QAAO;AAIT,KAAI,QAAQ,SACV,QAAO,cAAc,WAAW,SAAS,QAAQ;AAInD,KAAI;AACF,SAAO,QAAQ,KAAK,QAAQ;UACrB,OAAO;AACd,QAAM,IAAI,MAAM,iCAAiC,QAAQ,KAAK,QAAQ;;;;;;;;;AAU1E,SAAS,kBAAkB,YAAwB,SAAuD;CACxG,MAAM,UAAU,mBAAmB,WAAW,SAAS,QAAQ;CAC/D,MAAM,YAAY,mBAAmB,WAAW,WAAW,QAAQ;AAEnE,QAAO;EACL,KAAK,WAAW;EAChB;EACA;EACA,MAAM,WAAW;EAClB;;;;;;;;AASH,SAAS,kBAAkB,YAAwB,SAAuD;AAIxG,QAAO;EACL,SAJc,mBAAmB,WAAW,SAAS,QAAQ;EAK7D,WAJgB,mBAAmB,WAAW,WAAW,QAAQ;EAKjE,MAAM,WAAW;EACjB,QAAQ,WAAW;EACpB;;;;;;;;;AAUH,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;;;AAUT,SAAgB,uBAAuB,UAAyB,SAAgC;CAC9F,MAAM,aAAa,SAAS,MAAM,KAAK,OAAO;AAC9C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,uBAAuB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE7F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,sBAAsB,UAAyB,SAAgC;CAC7F,MAAM,aAAa,SAAS,MAAM,KAAK,MAAM;AAC7C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,sBAAsB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE5F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;;;AAUxD,SAAgB,oBAAoB,UAAyB,SAAgC;CAC3F,MAAM,aAAa,SAAS,MAAM,KAAK,IAAI;AAC3C,KAAI,CAAC,WACH,OAAM,IAAI,MAAM,oBAAoB,QAAQ,2BAA2B,SAAS,KAAK,GAAG;AAE1F,QAAO,kBAAkB,YAAY,SAAS,QAAQ;;;;;;;AAQxD,SAAgB,wBAAwB,UAAwD;CAC9F,MAAMC,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,OAAO,CACzE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,uBAAuB,UAAwD;CAC7F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,MAAM,CACxE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO;;;;;;;AAQT,SAAgB,qBAAqB,UAAwD;CAC3F,MAAMA,SAAwC,EAAE;AAChD,MAAK,MAAM,CAAC,MAAM,eAAe,OAAO,QAAQ,SAAS,MAAM,KAAK,IAAI,CACtE,QAAO,QAAQ,kBAAkB,YAAY,SAAS,QAAQ;AAEhE,QAAO"}

package/packages/algod_client/src/apis/api-service.d.ts

@@ -52,84 +52,66 @@ declare class AlgodApi {
   /**
    * Given an application ID and box name, it returns the round, box name, and value (each base64 encoded). Box names must be in the goal app call arg encoding form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.
    */
-  private _getApplicationBoxByName;
+  private _applicationBoxByName;
   /**
    * Given an application ID, return all Box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all Box names.
    */
-  getApplicationBoxes(applicationId: number | bigint, params?: {
+  applicationBoxes(applicationId: number | bigint, params?: {
     max?: number;
   }): Promise<BoxesResponse>;
   /**
    * Given a application ID, it returns application information including creator, approval and clear programs, global and local schemas, and global state.
    */
-  getApplicationById(applicationId: number | bigint): Promise<Application>;
+  applicationById(applicationId: number | bigint): Promise<Application>;
   /**
    * Given a asset ID, it returns asset information including creator, name, total supply and special addresses.
    */
-  getAssetById(assetId: number | bigint): Promise<Asset>;
-  getBlock(round: number | bigint, params?: {
+  assetById(assetId: number | bigint): Promise<Asset>;
+  block(round: number | bigint, params?: {
     headerOnly?: boolean;
   }): Promise<BlockResponse>;
-  getBlockHash(round: number | bigint): Promise<BlockHashResponse>;
+  blockHash(round: number | bigint): Promise<BlockHashResponse>;
   /**
    * Gets the current timestamp offset.
    */
-  getBlockTimeStampOffset(): Promise<GetBlockTimeStampOffsetResponse>;
-  getBlockTxIds(round: number | bigint): Promise<BlockTxidsResponse>;
+  blockTimeStampOffset(): Promise<GetBlockTimeStampOffsetResponse>;
+  blockTxIds(round: number | bigint): Promise<BlockTxidsResponse>;
   /**
    * Returns the entire genesis file in json.
    */
-  getGenesis(): Promise<Genesis>;
+  genesis(): Promise<Genesis>;
+  healthCheck(): Promise<void>;
   /**
    * Get ledger deltas for a round.
    */
-  getLedgerStateDelta(round: number | bigint): Promise<LedgerStateDelta>;
+  ledgerStateDelta(round: number | bigint): Promise<LedgerStateDelta>;
   /**
    * Get a ledger delta for a given transaction group.
    */
-  getLedgerStateDeltaForTransactionGroup(id: string): Promise<LedgerStateDelta>;
-  getLightBlockHeaderProof(round: number | bigint): Promise<LightBlockHeaderProof>;
+  ledgerStateDeltaForTransactionGroup(id: string): Promise<LedgerStateDelta>;
+  lightBlockHeaderProof(round: number | bigint): Promise<LightBlockHeaderProof>;
+  /**
+   * Given a transaction ID of a recently submitted transaction, it returns information about it.  There are several cases when this might succeed:
+   * - transaction committed (committed round > 0)
+   * - transaction still in the pool (committed round = 0, pool error = "")
+   * - transaction removed from pool due to error (committed round = 0, pool error != "")
+   * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
+   */
+  pendingTransactionInformation(txId: string): Promise<PendingTransactionResponse>;
   /**
    * Get the list of pending transactions, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
    */
-  getPendingTransactions(params?: {
+  pendingTransactions(params?: {
     max?: number;
   }): Promise<PendingTransactionsResponse>;
   /**
    * Get the list of pending transactions by address, sorted by priority, in decreasing order, truncated at the end at MAX. If MAX = 0, returns all pending transactions.
    */
-  getPendingTransactionsByAddress(address: ReadableAddress, params?: {
+  pendingTransactionsByAddress(address: ReadableAddress, params?: {
     max?: number;
   }): Promise<PendingTransactionsResponse>;
-  getReady(): Promise<void>;
-  getStateProof(round: number | bigint): Promise<StateProof>;
-  getStatus(): Promise<NodeStatusResponse>;
-  getSupply(): Promise<SupplyResponse>;
-  /**
-   * Gets the minimum sync round for the ledger.
-   */
-  getSyncRound(): Promise<GetSyncRoundResponse>;
-  /**
-   * Get ledger deltas for transaction groups in a given round.
-   */
-  getTransactionGroupLedgerStateDeltasForRound(round: number | bigint): Promise<TransactionGroupLedgerStateDeltasForRoundResponse>;
-  getTransactionProof(round: number | bigint, txId: string, params?: {
-    hashtype?: 'sha512_256' | 'sha256';
-  }): Promise<TransactionProof>;
-  /**
-   * Retrieves the supported API versions, binary build versions, and genesis information.
-   */
-  getVersion(): Promise<Version>;
-  healthCheck(): Promise<void>;
-  /**
-   * Given a transaction ID of a recently submitted transaction, it returns information about it.  There are several cases when this might succeed:
-   * - transaction committed (committed round > 0)
-   * - transaction still in the pool (committed round = 0, pool error = "")
-   * - transaction removed from pool due to error (committed round = 0, pool error != "")
-   * Or the transaction may have happened sufficiently long ago that the node no longer remembers it, and this will return an error.
-   */
-  pendingTransactionInformation(txId: string): Promise<PendingTransactionResponse>;
   private _rawTransaction;
+  ready(): Promise<void>;
   /**
    * Sets the timestamp offset (seconds) for blocks in dev mode. Providing an offset of 0 will unset this value and try to use the real clock for the timestamp.
    */
@@ -139,10 +121,17 @@ declare class AlgodApi {
    */
   setSyncRound(round: number | bigint): Promise<void>;
   simulateTransactions(body: SimulateRequest): Promise<SimulateResponse>;
+  stateProof(round: number | bigint): Promise<StateProof>;
+  status(): Promise<NodeStatusResponse>;
   /**
    * Waits for a block to appear after round {round} and returns the node's status at the time. There is a 1 minute timeout, when reached the current status is returned regardless of whether or not it is the round after the given round.
    */
   statusAfterBlock(round: number | bigint): Promise<NodeStatusResponse>;
+  supply(): Promise<SupplyResponse>;
+  /**
+   * Gets the minimum sync round for the ledger.
+   */
+  syncRound(): Promise<GetSyncRoundResponse>;
   /**
    * Given TEAL source code in plain text, return base64 encoded program bytes and base32 SHA512_256 hash of program bytes (Address style). This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
    */
@@ -153,11 +142,22 @@ declare class AlgodApi {
    * Given the program bytes, return the TEAL source code in plain text. This endpoint is only enabled when a node's configuration file sets EnableDeveloperAPI to true.
    */
   tealDisassemble(body: Uint8Array): Promise<DisassembleResponse>;
+  /**
+   * Get ledger deltas for transaction groups in a given round.
+   */
+  transactionGroupLedgerStateDeltasForRound(round: number | bigint): Promise<TransactionGroupLedgerStateDeltasForRoundResponse>;
   private _transactionParams;
+  transactionProof(round: number | bigint, txId: string, params?: {
+    hashtype?: 'sha512_256' | 'sha256';
+  }): Promise<TransactionProof>;
   /**
    * Unset the ledger sync round.
    */
   unsetSyncRound(): Promise<void>;
+  /**
+   * Retrieves the supported API versions, binary build versions, and genesis information.
+   */
+  version(): Promise<Version>;
   /**
    * Send a signed transaction or array of signed transactions to the network.
    */
@@ -165,7 +165,7 @@ declare class AlgodApi {
   /**
    * Given an application ID and box name, it returns the round, box name, and value.
    */
-  getApplicationBoxByName(applicationId: number | bigint, boxName: Uint8Array): Promise<Box>;
+  applicationBoxByName(applicationId: number | bigint, boxName: Uint8Array): Promise<Box>;
   /**
    * Returns the common needed parameters for a new transaction.
    */
@@ -173,7 +173,7 @@ declare class AlgodApi {
   /**
    * Returns the common needed parameters for a new transaction.
    */
-  getTransactionParams(): Promise<SuggestedParams>;
+  transactionParams(): Promise<SuggestedParams>;
   /**
    * Simulate an encoded signed transaction or array of encoded signed transactions.
    */