Merge pull request #540 from algorandfoundation/feat/updated_arc56

feat: updated arc56

Author: joe-p

examples/amm/tealscript_artifacts/ConstantProductAMM.arc56_draft.json

@@ -13,7 +13,7 @@ import path from 'path';
 import langspec from '../static/langspec.json';
 import { VERSION } from '../version';
 import { optimizeTeal } from './optimize';
-import { type ARC56Contract, type StructFields } from '../types/arc56.d';
+import { type ARC56Contract, type StructField } from '../types/arc56.d';
 
 const MULTI_OUTPUT_TYPES = ['split uint128', 'divmodw output', 'vrf return values', 'ecdsa pubkey'];
 
@@ -7663,14 +7663,14 @@ declare type AssetFreezeTxn = Required<AssetFreezeParams>;
 
   arc56Description(): ARC56Contract {
     const objectToStructFields = (typeInfo: TypeInfo & { kind: 'object' }) => {
-      const fields: StructFields = {};
+      const fields: StructField[] = [];
 
       // eslint-disable-next-line no-restricted-syntax
       for (const [field, type] of Object.entries(typeInfo.properties)) {
         if (type.kind === 'object') {
-          fields[field] = objectToStructFields(type);
+          fields.push({ name: field, type: objectToStructFields(type) });
         } else {
-          fields[field] = typeInfoToABIString(type);
+          fields.push({ name: field, type: typeInfoToABIString(type) });
         }
       }
 
@@ -7706,7 +7706,8 @@ declare type AssetFreezeTxn = Required<AssetFreezeParams>;
       structs: {},
       state,
       bareActions: { create: [], call: [] },
-      sourceInfo: this.sourceInfo,
+      // TODO: clear source mapping
+      sourceInfo: { approval: this.sourceInfo, clear: [] },
       source: {
         approval: Buffer.from(this.teal.approval.map((t) => t.teal).join('\n')).toString('base64'),
         clear: Buffer.from(this.teal.clear.map((t) => t.teal).join('\n')).toString('base64'),

examples/arc58/artifacts/AbstractedAccount.arc56_draft.json

@@ -1,130 +1,4 @@
-/** An ABI-encoded type */
-type ABIType = string;
-
-/** The name of a defined struct */
-type StructName = string;
-
-/** Raw byteslice without the length prefixed that is specified in ARC-4 */
-type AVMBytes = 'bytes';
-
-/** Mapping of named structs to the ABI type of their fields */
-interface StructFields {
-  [fieldName: string]: ABIType | StructFields;
-}
-
-/** Describes a single key in app storage */
-interface StorageKey {
-  /** Description of what this storage key holds */
-  desc?: string;
-  /** The type of the key */
-  keyType: ABIType | AVMBytes | StructName;
-  /** The type of the value */
-  valueType: ABIType | AVMBytes | StructName;
-  /** The bytes of the key encoded as base64 */
-  key: string;
-}
-
-interface StorageMap {
-  /** Description of what the key-value pairs in this mapping hold */
-  desc?: string;
-  /** The type of the keys in the map */
-  keyType: ABIType | AVMBytes | StructName;
-  /** The type of the values in the map */
-  valueType: ABIType | AVMBytes | StructName;
-  /** The prefix of the map, encoded as a utf-8 string */
-  prefix?: string;
-}
-
-interface SourceInfo {
-  /** The line of pre-compiled TEAL */
-  teal?: number;
-  /** The program counter offset(s) that correspond to this line of TEAL */
-  pc?: Array<number>;
-  /** A human-readable string that describes the error when the program fails at this given line of TEAL */
-  errorMessage?: string;
-}
-
-interface Event {
-  /** The name of the event */
-  name: string;
-  /** Optional, user-friendly description for the event */
-  desc?: string;
-  /** The arguments of the event, in order */
-  args: Array<{
-    /** The type of the argument */
-    type: ABIType;
-    /** Optional, user-friendly name for the argument */
-    name?: string;
-    /** Optional, user-friendly description for the argument */
-    desc?: string;
-    /** If the type is a struct, the name of the struct */
-    struct?: StructName;
-  }>;
-}
-
-/** Describes a method in the contract. This interface is an extension of the interface described in ARC-4 */
-interface Method {
-  /** The name of the method */
-  name: string;
-  /** Optional, user-friendly description for the method */
-  desc?: string;
-  /** The arguments of the method, in order */
-  args: Array<{
-    /** The type of the argument */
-    type: ABIType;
-    /** If the type is a struct, the name of the struct */
-    struct?: StructName;
-    /** Optional, user-friendly name for the argument */
-    name?: string;
-    /** Optional, user-friendly description for the argument */
-    desc?: string;
-    /** The default value that clients should use. MUST be base64 encoded bytes */
-    defaultValue?: string;
-  }>;
-  /** Information about the method's return value */
-  returns: {
-    /** The type of the return value, or "void" to indicate no return value. */
-    type: ABIType;
-    /** If the type is a struct, the name of the struct */
-    struct?: StructName;
-    /** Optional, user-friendly description for the return value */
-    desc?: string;
-  };
-  /** an action is a combination of call/create and an OnComplete */
-  actions: {
-    /** OnCompletes this method allows when appID === 0 */
-    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[];
-    /** OnCompletes this method allows when appID !== 0 */
-    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[];
-  };
-  /** If this method does not write anything to the ledger (ARC-22) */
-  readonly: boolean;
-  /** ARC-28 events that MAY be emitted by this method */
-  events?: Array<Event>;
-  /** Information that clients can use when calling the method */
-  recommendations?: {
-    /** The number of inner transactions the caller should cover the fees for */
-    innerTransactionCount?: number;
-    /** Recommended box references to include */
-    boxes?: {
-      /** The app ID for the box */
-      app?: number;
-      /** The base64 encoded box key */
-      key: string;
-      /** The number of bytes being read from the box */
-      readBytes: number;
-      /** The number of bytes being written to the box */
-      writeBytes: number;
-    };
-    /** Recommended foreign accounts */
-    accounts?: string[];
-    /** Recommended foreign apps */
-    apps?: number[];
-    /** Recommended foreign assets */
-    assets?: number[];
-  };
-}
-
+/* eslint-disable no-use-before-define */
 /** Describes the entire contract. This interface is an extension of the interface described in ARC-4 */
 export interface ARC56Contract {
   /** The ARCs used and/or supported by this contract. All contracts implicity support ARC4 and ARC56 */
@@ -134,22 +8,20 @@ export interface ARC56Contract {
   /** Optional, user-friendly description for the interface */
   desc?: string;
   /**
-   * Optional object listing the contract instances across different networks
+   * Optional object listing the contract instances across different networks.
+   * The key is the base64 genesis hash of the network, and the value contains
+   * information about the deployed contract in the network indicated by the
+   * key. A key containing the human-readable name of the network MAY be
+   * included, but the corresponding genesis hash key MUST also be define
    */
   networks?: {
-    /**
-     * The key is the base64 genesis hash of the network, and the value contains
-     * information about the deployed contract in the network indicated by the
-     * key. A key containing the human-readable name of the network MAY be
-     * included, but the corresponding genesis hash key MUST also be defined
-     */
     [network: string]: {
       /** The app ID of the deployed contract in this network */
       appID: number;
     };
   };
-  /** Named structs use by the application */
-  structs: { [structName: StructName]: StructFields };
+  /** Named structs use by the application. Each struct field appears in the same order as ABI encoding. */
+  structs: { [structName: StructName]: StructField[] };
   /** All of the methods that the contract implements */
   methods: Method[];
   state: {
@@ -184,8 +56,13 @@ export interface ARC56Contract {
     /** OnCompletes this method allows when appID !== 0 */
     call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[];
   };
-  /** Information about the TEAL */
-  sourceInfo?: SourceInfo[];
+  /** Information about the TEAL programs */
+  sourceInfo?: {
+    /** Approval program information */
+    approval: SourceInfo[];
+    /** Clear program information */
+    clear: SourceInfo[];
+  };
   /** The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23 */
   source?: {
     /** The approval program */
@@ -209,7 +86,7 @@ export interface ARC56Contract {
       major: number;
       minor: number;
       patch: number;
-      commit?: string;
+      commitHash?: string;
     };
   };
   /** ARC-28 events that MAY be emitted by this contract */
@@ -218,7 +95,7 @@ export interface ARC56Contract {
   templateVariables?: {
     [name: string]: {
       /** The type of the template variable */
-      type: ABIType | AVMBytes | StructName;
+      type: ABIType | AVMString | AVMBytes | StructName;
       /** If given, the the base64 encoded value used for the given app/program */
       value?: string;
     };
@@ -227,7 +104,155 @@ export interface ARC56Contract {
   scratchVariables?: {
     [name: string]: {
       slot: number;
-      type: ABIType | AVMBytes | StructName;
+      type: ABIType | AVMString | AVMBytes | StructName;
+    };
+  };
+}
+
+/** Describes a method in the contract. This interface is an extension of the interface described in ARC-4 */
+export interface Method {
+  /** The name of the method */
+  name: string;
+  /** Optional, user-friendly description for the method */
+  desc?: string;
+  /** The arguments of the method, in order */
+  args: Array<{
+    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */
+    type: ABIType;
+    /** If the type is a struct, the name of the struct */
+    struct?: StructName;
+    /** Optional, user-friendly name for the argument */
+    name?: string;
+    /** Optional, user-friendly description for the argument */
+    desc?: string;
+    /** The default value that clients should use. */
+    defaultValue?: {
+      /** Base64 encoded bytes or uint64 */
+      data: string | bigint;
+      /** How the data is encoded. This is the encoding for the data provided here, not the arg type */
+      type: ABIType | AVMBytes | AVMString;
+      /** Where the default value is coming from
+       * - box: The data key signifies the box key to read the value from
+       * - global: The data key signifies the global state key to read the value from
+       * - local: The data key signifies the local state key to read the value from (for the sender)
+       * - literal: the value is a literal and should be passed directly as the argument
+       */
+      source: 'box' | 'global' | 'local' | 'literal';
     };
+  }>;
+  /** Information about the method's return value */
+  returns: {
+    /** 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. */
+    type: ABIType;
+    /** If the type is a struct, the name of the struct */
+    struct?: StructName;
+    /** Optional, user-friendly description for the return value */
+    desc?: string;
   };
+  /** an action is a combination of call/create and an OnComplete */
+  actions: {
+    /** OnCompletes this method allows when appID === 0 */
+    create: ('NoOp' | 'OptIn' | 'DeleteApplication')[];
+    /** OnCompletes this method allows when appID !== 0 */
+    call: ('NoOp' | 'OptIn' | 'CloseOut' | 'ClearState' | 'UpdateApplication' | 'DeleteApplication')[];
+  };
+  /** If this method does not write anything to the ledger (ARC-22) */
+  readonly?: boolean;
+  /** ARC-28 events that MAY be emitted by this method */
+  events?: Array<Event>;
+  /** Information that clients can use when calling the method */
+  recommendations?: {
+    /** The number of inner transactions the caller should cover the fees for */
+    innerTransactionCount?: number;
+    /** Recommended box references to include */
+    boxes?: {
+      /** The app ID for the box */
+      app?: number;
+      /** The base64 encoded box key */
+      key: string;
+      /** The number of bytes being read from the box */
+      readBytes: number;
+      /** The number of bytes being written to the box */
+      writeBytes: number;
+    };
+    /** Recommended foreign accounts */
+    accounts?: string[];
+    /** Recommended foreign apps */
+    apps?: number[];
+    /** Recommended foreign assets */
+    assets?: number[];
+  };
+}
+
+export interface Event {
+  /** The name of the event */
+  name: string;
+  /** Optional, user-friendly description for the event */
+  desc?: string;
+  /** The arguments of the event, in order */
+  args: Array<{
+    /** The type of the argument. The `struct` field should also be checked to determine if this arg is a struct. */
+    type: ABIType;
+    /** Optional, user-friendly name for the argument */
+    name?: string;
+    /** Optional, user-friendly description for the argument */
+    desc?: string;
+    /** If the type is a struct, the name of the struct */
+    struct?: StructName;
+  }>;
+}
+
+/** An ABI-encoded type */
+type ABIType = string;
+
+/** The name of a defined struct */
+type StructName = string;
+
+/** Raw byteslice without the length prefixed that is specified in ARC-4 */
+type AVMBytes = 'AVMBytes';
+
+/** A string without the length prefix that is specified in ARC-4 */
+type AVMString = 'AVMString';
+
+/** Information about a single field in a struct */
+export interface StructField {
+  /** The name of the struct field */
+  name: string;
+  /** The type of the struct field's value */
+  type: ABIType | StructName | StructField[];
+}
+
+/** Describes a single key in app storage */
+export interface StorageKey {
+  /** Description of what this storage key holds */
+  desc?: string;
+  /** The type of the key */
+  keyType: ABIType | AVMString | AVMBytes | StructName;
+  /** The type of the value */
+  valueType: ABIType | AVMString | AVMBytes | StructName;
+  /** The bytes of the key encoded as base64 */
+  key: string;
+}
+
+/** Describes a mapping of key-value pairs in storage */
+export interface StorageMap {
+  /** Description of what the key-value pairs in this mapping hold */
+  desc?: string;
+  /** The type of the keys in the map */
+  keyType: ABIType | AVMString | AVMBytes | StructName;
+  /** The type of the values in the map */
+  valueType: ABIType | AVMString | AVMBytes | StructName;
+  /** The base64-encoded prefix of the map keys */
+  prefix?: string;
+}
+
+export interface SourceInfo {
+  /** The line of pre-compiled TEAL */
+  teal?: number;
+  /** The program counter offset(s) that correspond to this line of TEAL */
+  pc?: Array<number>;
+  /** A human-readable string that describes the error when the program fails at this given line of TEAL */
+  errorMessage?: string;
+  /** The line of the dissasembled TEAL this line of pre-compiled TEAL corresponds to */
+  disassembledTeal?: number;
 }