@algorandfoundation/algokit-utils 9.2.1 → 9.2.2-beta.1

package/types/app-spec.d.ts

@@ -1,7 +1,7 @@
-import { Arc56Contract } from "./app-arc56.js";
-import algosdk from "algosdk";
-
-//#region src/types/app-spec.d.ts
+import algosdk from 'algosdk';
+import { Arc56Contract } from './app-arc56';
+import ABIContractParams = algosdk.ABIContractParams;
+import ABIMethodParams = algosdk.ABIMethodParams;
 /**
  * Converts an ARC-32 Application Specification to an ARC-56 Contract
  * @param appSpec The ARC-32 Application Specification
@@ -11,30 +11,30 @@ import algosdk from "algosdk";
  * const arc56AppSpec = arc32ToArc56(arc32AppSpec)
  * ```
  */
-declare function arc32ToArc56(appSpec: AppSpec): Arc56Contract;
+export declare function arc32ToArc56(appSpec: AppSpec): Arc56Contract;
 /** An ARC-0032 Application Specification see https://github.com/algorandfoundation/ARCs/pull/150 */
-interface AppSpec {
-  /** Method call hints */
-  hints: HintSpec;
-  /** The TEAL source */
-  source: AppSources;
-  /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */
-  contract: ABIContractParams;
-  /** The values that make up the local and global state */
-  schema: SchemaSpec;
-  /** The rolled-up schema allocation values for local and global state */
-  state: StateSchemaSpec;
-  /** The config of all BARE calls (i.e. non ABI calls with no args) */
-  bare_call_config: CallConfig;
+export interface AppSpec {
+    /** Method call hints */
+    hints: HintSpec;
+    /** The TEAL source */
+    source: AppSources;
+    /** The ABI-0004 contract definition see https://github.com/algorandfoundation/ARCs/blob/main/ARCs/arc-0004.md */
+    contract: ABIContractParams;
+    /** The values that make up the local and global state */
+    schema: SchemaSpec;
+    /** The rolled-up schema allocation values for local and global state */
+    state: StateSchemaSpec;
+    /** The config of all BARE calls (i.e. non ABI calls with no args) */
+    bare_call_config: CallConfig;
 }
 /** A lookup of encoded method call spec to hint */
-type HintSpec = Record<string, Hint>;
+export type HintSpec = Record<string, Hint>;
 /** The TEAL source of a contract */
-interface AppSources {
-  /** The TEAL source of the approval program */
-  approval: string;
-  /** The TEAL source of the clear program */
-  clear: string;
+export interface AppSources {
+    /** The TEAL source of the approval program */
+    approval: string;
+    /** The TEAL source of the clear program */
+    clear: string;
 }
 /** The various call configs:
  *  * `NEVER`: Will not be called
@@ -42,126 +42,125 @@ interface AppSources {
  *  * `CREATE`: Can be called during a create call i.e. app id = 0
  *  * `ALL`: Can be during a create OR non-create call
  **/
-type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL';
+export type CallConfigValue = 'NEVER' | 'CALL' | 'CREATE' | 'ALL';
 /** Call configuration for a method */
-interface CallConfig {
-  /** NoOp call config */
-  no_op?: CallConfigValue;
-  /** Opt-in call config */
-  opt_in?: CallConfigValue;
-  /** Close out call config */
-  close_out?: CallConfigValue;
-  /** Update call config */
-  update_application?: CallConfigValue;
-  /** Delete call config */
-  delete_application?: CallConfigValue;
+export interface CallConfig {
+    /** NoOp call config */
+    no_op?: CallConfigValue;
+    /** Opt-in call config */
+    opt_in?: CallConfigValue;
+    /** Close out call config */
+    close_out?: CallConfigValue;
+    /** Update call config */
+    update_application?: CallConfigValue;
+    /** Delete call config */
+    delete_application?: CallConfigValue;
 }
 /** Hint information for a given method call to allow client generation */
-interface Hint {
-  /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */
-  structs?: Record<string, Struct>;
-  read_only?: boolean;
-  default_arguments?: Record<string, DefaultArgument>;
-  call_config: CallConfig;
+export interface Hint {
+    /** Any user-defined struct/tuple types used in the method call, keyed by parameter name or `output` for return type */
+    structs?: Record<string, Struct>;
+    read_only?: boolean;
+    default_arguments?: Record<string, DefaultArgument>;
+    call_config: CallConfig;
 }
 /** The name of a field */
-type FieldName = string;
+export type FieldName = string;
 /** The string name of an ABI type */
-type ABIType = string;
+export type ABIType = string;
 /** The elements of the struct/tuple: `FieldName`, `ABIType` */
-type StructElement = [FieldName, ABIType];
+export type StructElement = [FieldName, ABIType];
 /** A user-defined struct/tuple type */
-interface Struct {
-  /** The name of the type */
-  name: string;
-  /** The elements (in order) that make up the struct/tuple */
-  elements: StructElement[];
+export interface Struct {
+    /** The name of the type */
+    name: string;
+    /** The elements (in order) that make up the struct/tuple */
+    elements: StructElement[];
 }
 /**
  * Defines a strategy for obtaining a default value for a given ABI arg.
  */
-type DefaultArgument = {
-  /**
-   * The default value should be fetched by invoking an ABI method
-   */
-  source: 'abi-method';
-  data: ABIMethodParams;
+export type DefaultArgument = {
+    /**
+     * The default value should be fetched by invoking an ABI method
+     */
+    source: 'abi-method';
+    data: ABIMethodParams;
 } | {
-  /**
-   * The default value should be fetched from global state
-   */
-  source: 'global-state';
-  /**
-   * The key of the state variable
-   */
-  data: string;
+    /**
+     * The default value should be fetched from global state
+     */
+    source: 'global-state';
+    /**
+     * The key of the state variable
+     */
+    data: string;
 } | {
-  /**
-   * The default value should be fetched from the local state of the sender user
-   */
-  source: 'local-state';
-  /**
-   * The key of the state variable
-   */
-  data: string;
+    /**
+     * The default value should be fetched from the local state of the sender user
+     */
+    source: 'local-state';
+    /**
+     * The key of the state variable
+     */
+    data: string;
 } | {
-  /**
-   * The default value is a constant.
-   */
-  source: 'constant';
-  /**
-   * The static default value to use.
-   */
-  data: string | number;
+    /**
+     * The default value is a constant.
+     */
+    source: 'constant';
+    /**
+     * The static default value to use.
+     */
+    data: string | number;
 };
 /** AVM data type */
-type AVMType = 'uint64' | 'bytes';
+export type AVMType = 'uint64' | 'bytes';
 /** Declared schema value specification */
-interface DeclaredSchemaValueSpec {
-  /** The type of value */
-  type: AVMType;
-  /** The name of the key */
-  key: string;
-  /** A description of the variable */
-  descr?: string;
-  /** Whether or not the value is set statically (at create time only) or dynamically */
-  static?: boolean;
+export interface DeclaredSchemaValueSpec {
+    /** The type of value */
+    type: AVMType;
+    /** The name of the key */
+    key: string;
+    /** A description of the variable */
+    descr?: string;
+    /** Whether or not the value is set statically (at create time only) or dynamically */
+    static?: boolean;
 }
 /** Reserved schema value specification */
-interface ReservedSchemaValueSpec {
-  /** The type of value */
-  type: AVMType;
-  /** The description of the reserved storage space */
-  descr: string;
-  /** The maximum number of slots to reserve */
-  max_keys: number;
+export interface ReservedSchemaValueSpec {
+    /** The type of value */
+    type: AVMType;
+    /** The description of the reserved storage space */
+    descr: string;
+    /** The maximum number of slots to reserve */
+    max_keys: number;
 }
 /** The schema for global and local storage */
-interface SchemaSpec {
-  /** The local storage schema */
-  local: Schema;
-  /** The global storage schema */
-  global: Schema;
+export interface SchemaSpec {
+    /** The local storage schema */
+    local: Schema;
+    /** The global storage schema */
+    global: Schema;
 }
 /** The storage schema definition */
-interface Schema {
-  /** Declared storage schema */
-  declared: Record<string, DeclaredSchemaValueSpec>;
-  /** Reserved storage schema */
-  reserved: Record<string, ReservedSchemaValueSpec>;
+export interface Schema {
+    /** Declared storage schema */
+    declared: Record<string, DeclaredSchemaValueSpec>;
+    /** Reserved storage schema */
+    reserved: Record<string, ReservedSchemaValueSpec>;
 }
 /** The rolled-up schema allocation specification for local and global state */
-interface StateSchemaSpec {
-  /** Global storage spec */
-  global: StateSchema;
-  /** Local storage spec */
-  local: StateSchema;
+export interface StateSchemaSpec {
+    /** Global storage spec */
+    global: StateSchema;
+    /** Local storage spec */
+    local: StateSchema;
 }
 /** Schema spec summary for global or local storage */
-type StateSchema = {
-  /** Number of uint slots */num_uints: number; /** Number of byte slots */
-  num_byte_slices: number;
+export type StateSchema = {
+    /** Number of uint slots */
+    num_uints: number;
+    /** Number of byte slots */
+    num_byte_slices: number;
 };
-//#endregion
-export { ABIType, AVMType, AppSources, AppSpec, CallConfig, CallConfigValue, DeclaredSchemaValueSpec, DefaultArgument, FieldName, Hint, HintSpec, ReservedSchemaValueSpec, Schema, SchemaSpec, StateSchema, StateSchemaSpec, Struct, StructElement, arc32ToArc56 };
-//# sourceMappingURL=app-spec.d.ts.map