@algorandfoundation/algokit-client-generator 6.0.1 → 7.0.0-alpha.1

package/client/app-client-context.d.ts

@@ -0,0 +1,122 @@
+import { Arc56Contract, ABIType, ABIReferenceType, ABITransactionType, AVMType } from '@algorandfoundation/algokit-utils/abi';
+import { Sanitizer } from '../util/sanitization';
+export type AppClientContext = {
+    name: SanitizableString;
+    methods: AppClientMethodContext[];
+    abiMethods: AbiMethodClientContext[];
+    state: {
+        keys: {
+            global: {
+                [name: string]: StorageKeyContext;
+            };
+            local: {
+                [name: string]: StorageKeyContext;
+            };
+            box: {
+                [name: string]: StorageKeyContext;
+            };
+        };
+        /** Mapping of human-readable names to StorageMap objects */
+        maps: {
+            global: {
+                [name: string]: StorageMapContext;
+            };
+            local: {
+                [name: string]: StorageMapContext;
+            };
+            box: {
+                [name: string]: StorageMapContext;
+            };
+        };
+    };
+    structs: Record<string, StructContext>;
+    createMethods: AppClientMethodContext[];
+    updateMethods: AppClientMethodContext[];
+    deleteMethods: AppClientMethodContext[];
+    optInMethods: AppClientMethodContext[];
+    closeOutMethods: AppClientMethodContext[];
+    clearStateMethods: AppClientMethodContext[];
+    noOpMethods: AppClientMethodContext[];
+    bareMethod: BareMethodClientContext;
+    templateVariables: Record<string, TemplateVariableContext>;
+};
+export type AppClientMethodContext = AbiMethodClientContext | BareMethodClientContext;
+export declare function isAbiMethod(method: AppClientMethodContext): method is AbiMethodClientContext;
+export type StructContext = {
+    type: TypeContext;
+    tsObjDef: string;
+    tsTupDef: string;
+};
+export type StorageKeyContext = {
+    desc?: string;
+    keyType: TypeContext;
+    valueType: TypeContext;
+    key: string;
+};
+/** Describes a mapping of key-value pairs in storage */
+export type StorageMapContext = {
+    desc?: string;
+    keyType: TypeContext;
+    valueType: TypeContext;
+    prefix?: string;
+};
+export type TypeContext = {
+    type: ABIType | AVMType;
+    isAvmBytes?: boolean;
+    tsInType: string;
+    tsOutType: string;
+};
+export type TemplateVariableContext = {
+    type: TypeContext;
+    value: string | undefined;
+};
+export type AbiMethodClientContext = {
+    isBare: false;
+    desc: string | undefined;
+    name: SanitizableString;
+    baseNameIsUnique: boolean;
+    uniqueName: SanitizableString;
+    signature: string;
+    args: MethodArgClientContext[];
+    returns: MethodReturnClientContext;
+    createActions: MethodOcas;
+    callActions: MethodOcas;
+    readonly: boolean;
+};
+export type BareMethodClientContext = {
+    isBare: true;
+    createActions: MethodOcas;
+    callActions: MethodOcas;
+};
+export type MethodOcas = {
+    raw: string[];
+    any: boolean;
+    noOp: boolean;
+    optIn: boolean;
+    closeOut: boolean;
+    clearState: boolean;
+    updateApplication: boolean;
+    deleteApplication: boolean;
+    inputType: {
+        isOptional: boolean;
+        typeLiteral: string | undefined;
+    };
+};
+export type MethodArgClientContext = {
+    name: SanitizableString | undefined;
+    desc: string | undefined;
+    type: ABIType | ABIReferenceType | ABITransactionType;
+    tsInType: string;
+    defaultValue: unknown;
+};
+export type MethodReturnClientContext = {
+    tsOutType: string;
+    type: ABIType | undefined;
+    desc: string | undefined;
+};
+export type SanitizableString = {
+    original: string;
+} & {
+    [key in keyof Sanitizer]: ReturnType<Sanitizer[key]>;
+};
+export declare function createAppClientContext(appSpec: Arc56Contract, sanitizer: Sanitizer): AppClientContext;

package/client/deploy-types.d.ts

@@ -1,13 +1,3 @@
 import { DocumentParts } from '../output/writer';
-import { MethodIdentifier } from './helpers/get-call-config-summary';
 import { GeneratorContext } from './generator-context';
-import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
-export declare function getCreateOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract): {
-    type: {};
-    isOptional: boolean | undefined;
-};
-export declare function getCallOnCompleteOptions(method: MethodIdentifier, app: Arc56Contract): {
-    type: {};
-    isOptional: boolean | undefined;
-};
-export declare function deployTypes({ app, callConfig, sanitizer, methodSignatureToUniqueName }: GeneratorContext): DocumentParts;
+export declare function deployTypes({ app, sanitizer }: GeneratorContext): DocumentParts;

package/client/generate.d.ts

@@ -1,4 +1,4 @@
 import { DocumentParts } from '../output/writer';
 import { GeneratorOptions } from './generator-context';
-import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/abi';
 export declare function generate(app: Arc56Contract, options?: Partial<GeneratorOptions>): DocumentParts;

package/client/generator-context.d.ts

@@ -1,6 +1,6 @@
-import { CallConfigSummary } from './helpers/get-call-config-summary';
 import { Sanitizer } from '../util/sanitization';
-import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/abi';
+import { AppClientContext } from './app-client-context';
 declare const GenerateMode: {
     readonly FULL: "full";
     readonly MINIMAL: "minimal";
@@ -8,10 +8,8 @@ declare const GenerateMode: {
 export type GenerateMode = (typeof GenerateMode)[keyof typeof GenerateMode];
 export declare const generateModes: ("full" | "minimal")[];
 export type GeneratorContext = {
-    app: Arc56Contract;
     name: string;
-    callConfig: CallConfigSummary;
-    methodSignatureToUniqueName: Record<string, string>;
+    app: AppClientContext;
     sanitizer: Sanitizer;
     mode: GenerateMode;
 };

package/client/helpers/contains-non-void-method.d.ts

@@ -1,2 +1,2 @@
-import { Method } from '@algorandfoundation/algokit-utils/types/app-arc56';
-export declare const containsNonVoidMethod: (methods: Method[]) => boolean;
+import { AppClientMethodContext } from '../app-client-context';
+export declare const containsNonVoidMethod: (methods: AppClientMethodContext[]) => boolean;

package/client/helpers/get-equivalent-type.d.ts

@@ -1,6 +1,4 @@
-import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
+import { ABIReferenceType, ABIType, AVMType, ABITransactionType } from '@algorandfoundation/algokit-utils/abi';
 import { Sanitizer } from '../../util/sanitization';
-export declare function getEquivalentType(abiTypeStr: string, ioType: 'input' | 'output', ctx: {
-    app: Arc56Contract;
-    sanitizer: Sanitizer;
-}): string;
+export declare function getEquivalentType(algoType: ABIType | ABIReferenceType | ABITransactionType | AVMType | 'void', ioType: 'input' | 'output', sanitizer: Sanitizer): string;
+export declare function abiTypeToTs(abiType: ABIType, ioType: 'input' | 'output', sanitizer: Sanitizer): string;

package/client/imports.d.ts

@@ -1,3 +1,2 @@
 import { DocumentParts } from '../output/writer';
-import { GeneratorContext } from './generator-context';
-export declare function imports(ctx: GeneratorContext): DocumentParts;
+export declare function imports(): DocumentParts;

package/package.json

@@ -6,7 +6,7 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-client-generator",
-  "version": "6.0.1",
+  "version": "7.0.0-alpha.1",
   "description": "Generates a TypeScript client for interacting with, and deploying ARC-0032 smart contracts on the Algorand Blockchain.",
   "module": "index.mjs",
   "private": false,
@@ -27,8 +27,7 @@
     "jsonschema": "^1.5.0"
   },
   "peerDependencies": {
-    "@algorandfoundation/algokit-utils": "^9.0.0",
-    "algosdk": "^3.2.0"
+    "@algorandfoundation/algokit-utils": "^10.0.0-alpha.20"
   },
   "publishConfig": {
     "access": "public"

package/schema/load.d.ts

@@ -1,3 +1,3 @@
-import { Arc56Contract } from '@algorandfoundation/algokit-utils/types/app-arc56';
+import { Arc56Contract } from '@algorandfoundation/algokit-utils/abi';
 export declare function loadApplicationJson(appJsonPath: string): Promise<Arc56Contract>;
 export declare function validateApplicationJson(json: unknown, appJsonPath: string): Arc56Contract;

package/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sources":["../../src/cli.ts"],"sourcesContent":["import { Command, Option } from 'commander'\nimport { loadApplicationJson } from './schema/load'\nimport * as path from 'path'\nimport { generate } from './client/generate'\nimport { writeDocumentPartsToStream } from './output/writer'\nimport { colorConsole } from './util/color-console'\nimport { GenerateMode, generateModes, GeneratorOptions } from './client/generator-context'\n\nexport function cli(workingDirectory: string, args: string[]) {\n  // Pre 13 commander allowed `-pn` however the latest version doesn't. Rewrite it to `--pn` for backwards compatibility.\n  const processedArgs = args.map((arg) => (arg === '-pn' ? '--pn' : arg))\n  const program = new Command()\n  program\n    .command('generate')\n    .description('Generates a TypeScript client for the given application.json file')\n    .requiredOption('-a --application <path>', 'Specifies the application.json file')\n    .requiredOption('-o --output <path>', 'Specifies the output file path')\n    .option('--pn --preserve-names', 'Preserve names from application.json spec instead of sanitizing them')\n    .addOption(\n      new Option(\n        '-m --mode <mode>',\n        \"Generate client in specified mode. The 'full' mode includes all features, 'minimal' generates a smaller client without deployment features.\",\n      )\n        .choices(generateModes)\n        .default('full'),\n    )\n    .allowExcessArguments(true) // Maintains backwards compatibility with pre 13 commanded\n    .action(\n      async ({\n        application,\n        output,\n        preserveNames,\n        mode,\n      }: {\n        application: string\n        output: string\n        preserveNames?: boolean\n        mode?: GenerateMode\n      }): Promise<void> => {\n        await generateClientCommand({\n          application,\n          output,\n          preserveNames: Boolean(preserveNames),\n          mode: (mode ?? 'full') as GenerateMode,\n          workingDirectory,\n        })\n        colorConsole.success`Operation completed successfully`\n      },\n    )\n    .configureOutput({\n      writeErr(str: string) {\n        colorConsole.error`${str}`\n      },\n    })\n  try {\n    program.parse(processedArgs)\n  } catch (err) {\n    if (err instanceof Error) {\n      colorConsole.error`Unhandled error: \\n\\n${err.stack}`\n    } else {\n      colorConsole.error`Unhandled error: \\n\\n${err}`\n    }\n    process.exit(-1)\n  }\n}\n\nexport async function generateClientCommand({\n  application,\n  output,\n  preserveNames,\n  mode,\n  workingDirectory,\n}: {\n  application: string\n  output: string\n  workingDirectory: string\n} & GeneratorOptions): Promise<void> {\n  const fs = await import('fs')\n\n  const resolvedAppJsonPath = path.resolve(workingDirectory, application)\n  const resolvedOutPath = path.resolve(workingDirectory, output)\n  const resolvedOutDir = path.dirname(resolvedOutPath)\n  colorConsole.info`Reading application.json file from path ${resolvedAppJsonPath}`\n  const spec = await loadApplicationJson(resolvedAppJsonPath)\n  colorConsole.info`Generating TS client for ${spec.name}`\n  const parts = generate(spec, { preserveNames, mode })\n  if (!fs.existsSync(resolvedOutDir)) {\n    colorConsole.warn`Output directory ${resolvedOutDir} does not exist and will be created.`\n    fs.mkdirSync(resolvedOutDir, { recursive: true })\n  }\n  colorConsole.info`Writing TS client to ${resolvedOutPath}`\n  const file = await createAwaitableWriteStream(resolvedOutPath)\n  writeDocumentPartsToStream(parts, file)\n  await file.finish()\n}\n\nasync function createAwaitableWriteStream(path: string) {\n  const fs = await import('fs')\n  const stream = fs.createWriteStream(path, {\n    flags: 'w',\n  })\n  const finish = new Promise<void>((resolve, reject) => {\n    stream.on('error', (err) => {\n      reject(err)\n    })\n    stream.on('finish', () => {\n      resolve()\n    })\n  })\n  return {\n    write(chunk: string): void {\n      stream.write(chunk)\n    },\n    finish() {\n      stream.end()\n      return finish\n    },\n  }\n}\n"],"names":["Command","Option","generateModes","colorConsole","path","loadApplicationJson","generate","writeDocumentPartsToStream"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAQM,SAAU,GAAG,CAAC,gBAAwB,EAAE,IAAc,EAAA;;IAE1D,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,KAAK,GAAG,MAAM,GAAG,GAAG,CAAC,CAAC;AACvE,IAAA,MAAM,OAAO,GAAG,IAAIA,iBAAO,EAAE;IAC7B;SACG,OAAO,CAAC,UAAU;SAClB,WAAW,CAAC,mEAAmE;AAC/E,SAAA,cAAc,CAAC,yBAAyB,EAAE,qCAAqC;AAC/E,SAAA,cAAc,CAAC,oBAAoB,EAAE,gCAAgC;AACrE,SAAA,MAAM,CAAC,uBAAuB,EAAE,sEAAsE;AACtG,SAAA,SAAS,CACR,IAAIC,gBAAM,CACR,kBAAkB,EAClB,6IAA6I;SAE5I,OAAO,CAACC,8BAAa;SACrB,OAAO,CAAC,MAAM,CAAC;AAEnB,SAAA,oBAAoB,CAAC,IAAI,CAAC;AAC1B,SAAA,MAAM,CACL,OAAO,EACL,WAAW,EACX,MAAM,EACN,aAAa,EACb,IAAI,GAML,KAAmB;AAClB,QAAA,MAAM,qBAAqB,CAAC;YAC1B,WAAW;YACX,MAAM;AACN,YAAA,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC;AACrC,YAAA,IAAI,GAAG,IAAI,IAAI,MAAM,CAAiB;YACtC,gBAAgB;AACjB,SAAA,CAAC;AACF,QAAAC,yBAAY,CAAC,OAAO,CAAA,CAAA,gCAAA,CAAkC;AACxD,IAAA,CAAC;AAEF,SAAA,eAAe,CAAC;AACf,QAAA,QAAQ,CAAC,GAAW,EAAA;AAClB,YAAAA,yBAAY,CAAC,KAAK,CAAA,CAAA,EAAG,GAAG,EAAE;QAC5B,CAAC;AACF,KAAA,CAAC;AACJ,IAAA,IAAI;AACF,QAAA,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;IAC9B;IAAE,OAAO,GAAG,EAAE;AACZ,QAAA,IAAI,GAAG,YAAY,KAAK,EAAE;YACxBA,yBAAY,CAAC,KAAK,CAAA,CAAA,qBAAA,EAAwB,GAAG,CAAC,KAAK,EAAE;QACvD;aAAO;AACL,YAAAA,yBAAY,CAAC,KAAK,CAAA,CAAA,qBAAA,EAAwB,GAAG,EAAE;QACjD;AACA,QAAA,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAClB;AACF;AAEO,eAAe,qBAAqB,CAAC,EAC1C,WAAW,EACX,MAAM,EACN,aAAa,EACb,IAAI,EACJ,gBAAgB,GAKE,EAAA;AAClB,IAAA,MAAM,EAAE,GAAG,MAAM,OAAO,IAAI,CAAC;IAE7B,MAAM,mBAAmB,GAAGC,eAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACvE,MAAM,eAAe,GAAGA,eAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC9D,MAAM,cAAc,GAAGA,eAAI,CAAC,OAAO,CAAC,eAAe,CAAC;AACpD,IAAAD,yBAAY,CAAC,IAAI,CAAA,CAAA,wCAAA,EAA2C,mBAAmB,EAAE;AACjF,IAAA,MAAM,IAAI,GAAG,MAAME,wBAAmB,CAAC,mBAAmB,CAAC;IAC3DF,yBAAY,CAAC,IAAI,CAAA,CAAA,yBAAA,EAA4B,IAAI,CAAC,IAAI,EAAE;AACxD,IAAA,MAAM,KAAK,GAAGG,iBAAQ,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IACrD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;AAClC,QAAAH,yBAAY,CAAC,IAAI,CAAA,CAAA,iBAAA,EAAoB,cAAc,sCAAsC;QACzF,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACnD;AACA,IAAAA,yBAAY,CAAC,IAAI,CAAA,CAAA,qBAAA,EAAwB,eAAe,EAAE;AAC1D,IAAA,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,eAAe,CAAC;AAC9D,IAAAI,iCAA0B,CAAC,KAAK,EAAE,IAAI,CAAC;AACvC,IAAA,MAAM,IAAI,CAAC,MAAM,EAAE;AACrB;AAEA,eAAe,0BAA0B,CAAC,IAAY,EAAA;AACpD,IAAA,MAAM,EAAE,GAAG,MAAM,OAAO,IAAI,CAAC;AAC7B,IAAA,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE;AACxC,QAAA,KAAK,EAAE,GAAG;AACX,KAAA,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;QACnD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,KAAI;YACzB,MAAM,CAAC,GAAG,CAAC;AACb,QAAA,CAAC,CAAC;AACF,QAAA,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAK;AACvB,YAAA,OAAO,EAAE;AACX,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;IACF,OAAO;AACL,QAAA,KAAK,CAAC,KAAa,EAAA;AACjB,YAAA,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,MAAM,GAAA;YACJ,MAAM,CAAC,GAAG,EAAE;AACZ,YAAA,OAAO,MAAM;QACf,CAAC;KACF;AACH;;;;;"}

package/src/cli.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.mjs","sources":["../../src/cli.ts"],"sourcesContent":["import { Command, Option } from 'commander'\nimport { loadApplicationJson } from './schema/load'\nimport * as path from 'path'\nimport { generate } from './client/generate'\nimport { writeDocumentPartsToStream } from './output/writer'\nimport { colorConsole } from './util/color-console'\nimport { GenerateMode, generateModes, GeneratorOptions } from './client/generator-context'\n\nexport function cli(workingDirectory: string, args: string[]) {\n  // Pre 13 commander allowed `-pn` however the latest version doesn't. Rewrite it to `--pn` for backwards compatibility.\n  const processedArgs = args.map((arg) => (arg === '-pn' ? '--pn' : arg))\n  const program = new Command()\n  program\n    .command('generate')\n    .description('Generates a TypeScript client for the given application.json file')\n    .requiredOption('-a --application <path>', 'Specifies the application.json file')\n    .requiredOption('-o --output <path>', 'Specifies the output file path')\n    .option('--pn --preserve-names', 'Preserve names from application.json spec instead of sanitizing them')\n    .addOption(\n      new Option(\n        '-m --mode <mode>',\n        \"Generate client in specified mode. The 'full' mode includes all features, 'minimal' generates a smaller client without deployment features.\",\n      )\n        .choices(generateModes)\n        .default('full'),\n    )\n    .allowExcessArguments(true) // Maintains backwards compatibility with pre 13 commanded\n    .action(\n      async ({\n        application,\n        output,\n        preserveNames,\n        mode,\n      }: {\n        application: string\n        output: string\n        preserveNames?: boolean\n        mode?: GenerateMode\n      }): Promise<void> => {\n        await generateClientCommand({\n          application,\n          output,\n          preserveNames: Boolean(preserveNames),\n          mode: (mode ?? 'full') as GenerateMode,\n          workingDirectory,\n        })\n        colorConsole.success`Operation completed successfully`\n      },\n    )\n    .configureOutput({\n      writeErr(str: string) {\n        colorConsole.error`${str}`\n      },\n    })\n  try {\n    program.parse(processedArgs)\n  } catch (err) {\n    if (err instanceof Error) {\n      colorConsole.error`Unhandled error: \\n\\n${err.stack}`\n    } else {\n      colorConsole.error`Unhandled error: \\n\\n${err}`\n    }\n    process.exit(-1)\n  }\n}\n\nexport async function generateClientCommand({\n  application,\n  output,\n  preserveNames,\n  mode,\n  workingDirectory,\n}: {\n  application: string\n  output: string\n  workingDirectory: string\n} & GeneratorOptions): Promise<void> {\n  const fs = await import('fs')\n\n  const resolvedAppJsonPath = path.resolve(workingDirectory, application)\n  const resolvedOutPath = path.resolve(workingDirectory, output)\n  const resolvedOutDir = path.dirname(resolvedOutPath)\n  colorConsole.info`Reading application.json file from path ${resolvedAppJsonPath}`\n  const spec = await loadApplicationJson(resolvedAppJsonPath)\n  colorConsole.info`Generating TS client for ${spec.name}`\n  const parts = generate(spec, { preserveNames, mode })\n  if (!fs.existsSync(resolvedOutDir)) {\n    colorConsole.warn`Output directory ${resolvedOutDir} does not exist and will be created.`\n    fs.mkdirSync(resolvedOutDir, { recursive: true })\n  }\n  colorConsole.info`Writing TS client to ${resolvedOutPath}`\n  const file = await createAwaitableWriteStream(resolvedOutPath)\n  writeDocumentPartsToStream(parts, file)\n  await file.finish()\n}\n\nasync function createAwaitableWriteStream(path: string) {\n  const fs = await import('fs')\n  const stream = fs.createWriteStream(path, {\n    flags: 'w',\n  })\n  const finish = new Promise<void>((resolve, reject) => {\n    stream.on('error', (err) => {\n      reject(err)\n    })\n    stream.on('finish', () => {\n      resolve()\n    })\n  })\n  return {\n    write(chunk: string): void {\n      stream.write(chunk)\n    },\n    finish() {\n      stream.end()\n      return finish\n    },\n  }\n}\n"],"names":[],"mappings":";;;;;;;;AAQM,SAAU,GAAG,CAAC,gBAAwB,EAAE,IAAc,EAAA;;IAE1D,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,GAAG,KAAK,KAAK,GAAG,MAAM,GAAG,GAAG,CAAC,CAAC;AACvE,IAAA,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE;IAC7B;SACG,OAAO,CAAC,UAAU;SAClB,WAAW,CAAC,mEAAmE;AAC/E,SAAA,cAAc,CAAC,yBAAyB,EAAE,qCAAqC;AAC/E,SAAA,cAAc,CAAC,oBAAoB,EAAE,gCAAgC;AACrE,SAAA,MAAM,CAAC,uBAAuB,EAAE,sEAAsE;AACtG,SAAA,SAAS,CACR,IAAI,MAAM,CACR,kBAAkB,EAClB,6IAA6I;SAE5I,OAAO,CAAC,aAAa;SACrB,OAAO,CAAC,MAAM,CAAC;AAEnB,SAAA,oBAAoB,CAAC,IAAI,CAAC;AAC1B,SAAA,MAAM,CACL,OAAO,EACL,WAAW,EACX,MAAM,EACN,aAAa,EACb,IAAI,GAML,KAAmB;AAClB,QAAA,MAAM,qBAAqB,CAAC;YAC1B,WAAW;YACX,MAAM;AACN,YAAA,aAAa,EAAE,OAAO,CAAC,aAAa,CAAC;AACrC,YAAA,IAAI,GAAG,IAAI,IAAI,MAAM,CAAiB;YACtC,gBAAgB;AACjB,SAAA,CAAC;AACF,QAAA,YAAY,CAAC,OAAO,CAAA,CAAA,gCAAA,CAAkC;AACxD,IAAA,CAAC;AAEF,SAAA,eAAe,CAAC;AACf,QAAA,QAAQ,CAAC,GAAW,EAAA;AAClB,YAAA,YAAY,CAAC,KAAK,CAAA,CAAA,EAAG,GAAG,EAAE;QAC5B,CAAC;AACF,KAAA,CAAC;AACJ,IAAA,IAAI;AACF,QAAA,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC;IAC9B;IAAE,OAAO,GAAG,EAAE;AACZ,QAAA,IAAI,GAAG,YAAY,KAAK,EAAE;YACxB,YAAY,CAAC,KAAK,CAAA,CAAA,qBAAA,EAAwB,GAAG,CAAC,KAAK,EAAE;QACvD;aAAO;AACL,YAAA,YAAY,CAAC,KAAK,CAAA,CAAA,qBAAA,EAAwB,GAAG,EAAE;QACjD;AACA,QAAA,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAClB;AACF;AAEO,eAAe,qBAAqB,CAAC,EAC1C,WAAW,EACX,MAAM,EACN,aAAa,EACb,IAAI,EACJ,gBAAgB,GAKE,EAAA;AAClB,IAAA,MAAM,EAAE,GAAG,MAAM,OAAO,IAAI,CAAC;IAE7B,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,WAAW,CAAC;IACvE,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAC9D,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC;AACpD,IAAA,YAAY,CAAC,IAAI,CAAA,CAAA,wCAAA,EAA2C,mBAAmB,EAAE;AACjF,IAAA,MAAM,IAAI,GAAG,MAAM,mBAAmB,CAAC,mBAAmB,CAAC;IAC3D,YAAY,CAAC,IAAI,CAAA,CAAA,yBAAA,EAA4B,IAAI,CAAC,IAAI,EAAE;AACxD,IAAA,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;IACrD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE;AAClC,QAAA,YAAY,CAAC,IAAI,CAAA,CAAA,iBAAA,EAAoB,cAAc,sCAAsC;QACzF,EAAE,CAAC,SAAS,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IACnD;AACA,IAAA,YAAY,CAAC,IAAI,CAAA,CAAA,qBAAA,EAAwB,eAAe,EAAE;AAC1D,IAAA,MAAM,IAAI,GAAG,MAAM,0BAA0B,CAAC,eAAe,CAAC;AAC9D,IAAA,0BAA0B,CAAC,KAAK,EAAE,IAAI,CAAC;AACvC,IAAA,MAAM,IAAI,CAAC,MAAM,EAAE;AACrB;AAEA,eAAe,0BAA0B,CAAC,IAAY,EAAA;AACpD,IAAA,MAAM,EAAE,GAAG,MAAM,OAAO,IAAI,CAAC;AAC7B,IAAA,MAAM,MAAM,GAAG,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE;AACxC,QAAA,KAAK,EAAE,GAAG;AACX,KAAA,CAAC;IACF,MAAM,MAAM,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,KAAI;QACnD,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,KAAI;YACzB,MAAM,CAAC,GAAG,CAAC;AACb,QAAA,CAAC,CAAC;AACF,QAAA,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAK;AACvB,YAAA,OAAO,EAAE;AACX,QAAA,CAAC,CAAC;AACJ,IAAA,CAAC,CAAC;IACF,OAAO;AACL,QAAA,KAAK,CAAC,KAAa,EAAA;AACjB,YAAA,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,MAAM,GAAA;YACJ,MAAM,CAAC,GAAG,EAAE;AACZ,YAAA,OAAO,MAAM;QACf,CAAC;KACF;AACH;;;;"}

package/src/client/app-client-context.js

@@ -0,0 +1,211 @@
+'use strict';
+
+var abi = require('@algorandfoundation/algokit-utils/abi');
+var getEquivalentType = require('./helpers/get-equivalent-type.js');
+var tinyInvariant = require('../../node_modules/tiny-invariant/dist/esm/tiny-invariant.js');
+
+function isAbiMethod(method) {
+    return !method.isBare;
+}
+function createAppClientContext(appSpec, sanitizer) {
+    const methods = [];
+    for (const m of appSpec.methods) {
+        const abiMethod = abi.arc56MethodToABIMethod(m, appSpec);
+        const baseNameIsUnique = appSpec.methods.filter((o) => o.name === m.name).length === 1;
+        methods.push({
+            isBare: false,
+            name: createSanitizableString(m.name, sanitizer),
+            desc: m.desc,
+            baseNameIsUnique,
+            uniqueName: createSanitizableString(baseNameIsUnique ? m.name : abiMethod.getSignature(), sanitizer),
+            args: abiMethod.args.map((a) => {
+                return {
+                    name: a.name ? createSanitizableString(a.name, sanitizer) : undefined,
+                    desc: a.description,
+                    type: a.type,
+                    tsInType: getEquivalentType.getEquivalentType(a.type, 'input', sanitizer),
+                    defaultValue: Boolean(a.defaultValue),
+                };
+            }),
+            callActions: buildOcas(m.actions.call),
+            createActions: buildOcas(m.actions.create),
+            readonly: Boolean(m.readonly),
+            signature: abiMethod.getSignature(),
+            returns: {
+                tsOutType: getEquivalentType.getEquivalentType(abiMethod.returns.type, 'output', sanitizer),
+                type: abiMethod.returns.type === 'void' ? undefined : abiMethod.returns.type,
+                desc: abiMethod.returns.description,
+            },
+        });
+    }
+    const bareMethod = {
+        isBare: true,
+        createActions: buildOcas(appSpec.bareActions.create),
+        callActions: buildOcas(appSpec.bareActions.call),
+    };
+    if (bareMethod.createActions.any || bareMethod.callActions.any) {
+        methods.push(bareMethod);
+    }
+    return {
+        name: createSanitizableString(appSpec.name, sanitizer),
+        methods,
+        bareMethod,
+        createMethods: methods.filter((m) => m.createActions.any),
+        updateMethods: methods.filter((m) => m.callActions.updateApplication),
+        deleteMethods: methods.filter((m) => m.callActions.deleteApplication),
+        noOpMethods: methods.filter((m) => m.callActions.noOp),
+        optInMethods: methods.filter((m) => m.callActions.optIn),
+        closeOutMethods: methods.filter((m) => m.callActions.closeOut),
+        clearStateMethods: methods.filter((m) => m.callActions.clearState),
+        abiMethods: methods.filter(isAbiMethod),
+        state: {
+            maps: {
+                global: buildStorageMap(appSpec.state.maps.global, appSpec, sanitizer),
+                local: buildStorageMap(appSpec.state.maps.local, appSpec, sanitizer),
+                box: buildStorageMap(appSpec.state.maps.box, appSpec, sanitizer),
+            },
+            keys: {
+                global: buildStorageKey(appSpec.state.keys.global, appSpec, sanitizer),
+                local: buildStorageKey(appSpec.state.keys.local, appSpec, sanitizer),
+                box: buildStorageKey(appSpec.state.keys.box, appSpec, sanitizer),
+            },
+        },
+        structs: mapRecord(appSpec.structs, (def, name) => buildStructCtx(name, appSpec, sanitizer)),
+        templateVariables: mapRecord(appSpec.templateVariables ?? {}, (v) => ({
+            value: v.value,
+            type: buildTypeContext(v.type, appSpec, sanitizer),
+        })),
+    };
+}
+function buildStructCtx(name, appSpec, sanitizer) {
+    const typeCtx = buildTypeContext(name, appSpec, sanitizer);
+    const abiType = typeCtx.type;
+    tinyInvariant.default(abiType instanceof abi.ABIStructType);
+    return {
+        type: typeCtx,
+        tsObjDef: buildStructObjDef(abiType.structFields, appSpec, sanitizer, 1),
+        tsTupDef: `[${Array.from(buildStructTupleDef(abiType.structFields, appSpec, sanitizer)).join(', ')}]`,
+    };
+}
+function buildStructObjDef(fields, appSpec, sanitizer, indent) {
+    const indentStr = '  '.repeat(indent);
+    const closingIndent = '  '.repeat(indent - 1);
+    const lines = [];
+    for (const field of fields) {
+        const typeDef = Array.isArray(field.type)
+            ? buildStructObjDef(field.type, appSpec, sanitizer, indent + 1)
+            : getEquivalentType.abiTypeToTs(field.type, 'output', sanitizer);
+        lines.push(`${indentStr}${sanitizer.makeSafePropertyIdentifier(field.name)}: ${typeDef}`);
+    }
+    return `{\n${lines.join(',\n')}\n${closingIndent}}`;
+}
+function* buildStructTupleDef(fields, appSpec, sanitizer) {
+    for (const field of fields) {
+        let typeDef;
+        if (Array.isArray(field.type)) {
+            typeDef = `[${Array.from(buildStructTupleDef(field.type, appSpec, sanitizer)).join(', ')}]`;
+        }
+        else {
+            typeDef = getEquivalentType.abiTypeToTs(field.type, 'output', sanitizer);
+        }
+        yield `${typeDef}`;
+    }
+}
+function buildStorageMap(maps, appSpec, sanitizer) {
+    return mapRecord(maps, (v) => ({
+        desc: v.desc,
+        valueType: buildTypeContext(v.valueType, appSpec, sanitizer),
+        keyType: buildTypeContext(v.keyType, appSpec, sanitizer),
+        prefix: v.prefix,
+    }));
+}
+function buildStorageKey(keys, appSpec, sanitizer) {
+    return mapRecord(keys, (v) => ({
+        desc: v.desc,
+        valueType: buildTypeContext(v.valueType, appSpec, sanitizer),
+        keyType: buildTypeContext(v.valueType, appSpec, sanitizer),
+        key: v.key,
+    }));
+}
+function mapRecord(input, mapper) {
+    return Object.fromEntries(Object.entries(input).map(([k, v]) => [k, mapper(v, k)]));
+}
+function createSanitizableString(name, sanitizer) {
+    return new Proxy({}, {
+        get(target, property) {
+            if (property === 'toString')
+                return () => name;
+            if (property === 'original')
+                return name;
+            if (property in sanitizer) {
+                return sanitizer[property](name);
+            }
+        },
+    });
+}
+function buildOcas(actions) {
+    const isOptional = actions.includes('NoOp') || actions.length === 1;
+    const typeLiteral = actions.length
+        ? `{ onComplete${isOptional ? '?' : ''}: ${actions.map((oc) => `OnApplicationComplete.${oc}`).join(' | ')} }`
+        : undefined;
+    return {
+        raw: actions,
+        any: Boolean(actions.length),
+        noOp: actions.includes('NoOp'),
+        optIn: actions.includes('OptIn'),
+        closeOut: actions.includes('CloseOut'),
+        clearState: actions.includes('ClearState'),
+        updateApplication: actions.includes('UpdateApplication'),
+        deleteApplication: actions.includes('DeleteApplication'),
+        inputType: {
+            isOptional,
+            typeLiteral,
+        },
+    };
+}
+function buildTypeContext(typeName, appSpec, sanitizer) {
+    switch (typeName) {
+        case 'AVMBytes':
+            return {
+                isAvmBytes: true,
+                type: typeName,
+                tsInType: 'Uint8Array | string',
+                tsOutType: 'Uint8Array',
+            };
+        case 'AVMString':
+            return {
+                type: typeName,
+                tsInType: 'string',
+                tsOutType: 'string',
+            };
+        case 'AVMUint64':
+            return {
+                type: typeName,
+                tsInType: 'bigint',
+                tsOutType: 'bigint',
+            };
+    }
+    if (typeName in appSpec.structs) {
+        return {
+            type: abi.ABIStructType.fromStruct(typeName, appSpec.structs),
+            tsInType: sanitizer.makeSafeTypeIdentifier(typeName),
+            tsOutType: sanitizer.makeSafeTypeIdentifier(typeName),
+        };
+    }
+    // Otherwise parse as ABI type
+    try {
+        const abiType = abi.ABIType.from(typeName);
+        return {
+            type: abiType,
+            tsInType: getEquivalentType.abiTypeToTs(abiType, 'input', sanitizer),
+            tsOutType: getEquivalentType.abiTypeToTs(abiType, 'output', sanitizer),
+        };
+    }
+    catch (error) {
+        throw new Error(`Failed to parse storage type '${typeName}': ${error}`);
+    }
+}
+
+exports.createAppClientContext = createAppClientContext;
+exports.isAbiMethod = isAbiMethod;
+//# sourceMappingURL=app-client-context.js.map

package/src/client/app-client-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-client-context.js","sources":["../../../src/client/app-client-context.ts"],"sourcesContent":["import {\n  arc56MethodToABIMethod,\n  Arc56Contract,\n  ABIType,\n  ABIReferenceType,\n  ABITransactionType,\n  AVMType,\n  ABIStructField,\n  ABIStructType,\n  StorageKey,\n  StorageMap,\n} from '@algorandfoundation/algokit-utils/abi'\nimport { Sanitizer } from '../util/sanitization'\nimport { abiTypeToTs, getEquivalentType } from './helpers/get-equivalent-type'\nimport invariant from 'tiny-invariant'\n\nexport type AppClientContext = {\n  name: SanitizableString\n\n  methods: AppClientMethodContext[]\n  abiMethods: AbiMethodClientContext[]\n\n  state: {\n    keys: {\n      global: {\n        [name: string]: StorageKeyContext\n      }\n      local: {\n        [name: string]: StorageKeyContext\n      }\n      box: {\n        [name: string]: StorageKeyContext\n      }\n    }\n    /** Mapping of human-readable names to StorageMap objects */\n    maps: {\n      global: {\n        [name: string]: StorageMapContext\n      }\n      local: {\n        [name: string]: StorageMapContext\n      }\n      box: {\n        [name: string]: StorageMapContext\n      }\n    }\n  }\n\n  structs: Record<string, StructContext>\n\n  createMethods: AppClientMethodContext[]\n  updateMethods: AppClientMethodContext[]\n  deleteMethods: AppClientMethodContext[]\n  optInMethods: AppClientMethodContext[]\n  closeOutMethods: AppClientMethodContext[]\n  clearStateMethods: AppClientMethodContext[]\n  noOpMethods: AppClientMethodContext[]\n\n  bareMethod: BareMethodClientContext\n\n  templateVariables: Record<string, TemplateVariableContext>\n}\n\nexport type AppClientMethodContext = AbiMethodClientContext | BareMethodClientContext\n\nexport function isAbiMethod(method: AppClientMethodContext): method is AbiMethodClientContext {\n  return !method.isBare\n}\n\nexport type StructContext = {\n  type: TypeContext\n  tsObjDef: string\n  tsTupDef: string\n}\n\nexport type StorageKeyContext = {\n  desc?: string\n  keyType: TypeContext\n  valueType: TypeContext\n  key: string\n}\n/** Describes a mapping of key-value pairs in storage */\nexport type StorageMapContext = {\n  desc?: string\n  keyType: TypeContext\n  valueType: TypeContext\n  prefix?: string\n}\n\nexport type TypeContext = {\n  type: ABIType | AVMType\n  isAvmBytes?: boolean\n  tsInType: string\n  tsOutType: string\n}\n\nexport type TemplateVariableContext = {\n  type: TypeContext\n  value: string | undefined\n}\n\nexport type AbiMethodClientContext = {\n  isBare: false\n  desc: string | undefined\n  name: SanitizableString\n  baseNameIsUnique: boolean\n  uniqueName: SanitizableString\n  signature: string\n  args: MethodArgClientContext[]\n  returns: MethodReturnClientContext\n  createActions: MethodOcas\n  callActions: MethodOcas\n  readonly: boolean\n}\nexport type BareMethodClientContext = {\n  isBare: true\n  //desc: string | undefined\n  createActions: MethodOcas\n  callActions: MethodOcas\n  //readonly: boolean\n}\n\nexport type MethodOcas = {\n  raw: string[]\n  any: boolean\n  noOp: boolean\n  optIn: boolean\n  closeOut: boolean\n  clearState: boolean\n  updateApplication: boolean\n  deleteApplication: boolean\n\n  inputType: {\n    isOptional: boolean\n    typeLiteral: string | undefined\n  }\n}\n\nexport type MethodArgClientContext = {\n  name: SanitizableString | undefined\n  desc: string | undefined\n  type: ABIType | ABIReferenceType | ABITransactionType\n  tsInType: string\n  defaultValue: unknown\n}\n\nexport type MethodReturnClientContext = {\n  tsOutType: string\n  type: ABIType | undefined\n  desc: string | undefined\n}\n\nexport type SanitizableString = {\n  original: string\n} & {\n  [key in keyof Sanitizer]: ReturnType<Sanitizer[key]>\n}\n\nexport function createAppClientContext(appSpec: Arc56Contract, sanitizer: Sanitizer): AppClientContext {\n  const methods: AppClientMethodContext[] = []\n\n  for (const m of appSpec.methods) {\n    const abiMethod = arc56MethodToABIMethod(m, appSpec)\n    const baseNameIsUnique = appSpec.methods.filter((o) => o.name === m.name).length === 1\n    methods.push({\n      isBare: false,\n      name: createSanitizableString(m.name, sanitizer),\n      desc: m.desc,\n      baseNameIsUnique,\n      uniqueName: createSanitizableString(baseNameIsUnique ? m.name : abiMethod.getSignature(), sanitizer),\n      args: abiMethod.args.map((a): MethodArgClientContext => {\n        return {\n          name: a.name ? createSanitizableString(a.name, sanitizer) : undefined,\n          desc: a.description,\n          type: a.type,\n          tsInType: getEquivalentType(a.type, 'input', sanitizer),\n          defaultValue: Boolean(a.defaultValue),\n        }\n      }),\n      callActions: buildOcas(m.actions.call),\n      createActions: buildOcas(m.actions.create),\n      readonly: Boolean(m.readonly),\n      signature: abiMethod.getSignature(),\n      returns: {\n        tsOutType: getEquivalentType(abiMethod.returns.type, 'output', sanitizer),\n        type: abiMethod.returns.type === 'void' ? undefined : abiMethod.returns.type,\n        desc: abiMethod.returns.description,\n      },\n    })\n  }\n\n  const bareMethod: BareMethodClientContext = {\n    isBare: true,\n    createActions: buildOcas(appSpec.bareActions.create),\n    callActions: buildOcas(appSpec.bareActions.call),\n  }\n  if (bareMethod.createActions.any || bareMethod.callActions.any) {\n    methods.push(bareMethod)\n  }\n\n  return {\n    name: createSanitizableString(appSpec.name, sanitizer),\n    methods,\n    bareMethod,\n    createMethods: methods.filter((m) => m.createActions.any),\n    updateMethods: methods.filter((m) => m.callActions.updateApplication),\n    deleteMethods: methods.filter((m) => m.callActions.deleteApplication),\n    noOpMethods: methods.filter((m) => m.callActions.noOp),\n    optInMethods: methods.filter((m) => m.callActions.optIn),\n    closeOutMethods: methods.filter((m) => m.callActions.closeOut),\n    clearStateMethods: methods.filter((m) => m.callActions.clearState),\n    abiMethods: methods.filter(isAbiMethod),\n\n    state: {\n      maps: {\n        global: buildStorageMap(appSpec.state.maps.global, appSpec, sanitizer),\n        local: buildStorageMap(appSpec.state.maps.local, appSpec, sanitizer),\n        box: buildStorageMap(appSpec.state.maps.box, appSpec, sanitizer),\n      },\n      keys: {\n        global: buildStorageKey(appSpec.state.keys.global, appSpec, sanitizer),\n        local: buildStorageKey(appSpec.state.keys.local, appSpec, sanitizer),\n        box: buildStorageKey(appSpec.state.keys.box, appSpec, sanitizer),\n      },\n    },\n\n    structs: mapRecord(appSpec.structs, (def, name) => buildStructCtx(name, appSpec, sanitizer)),\n\n    templateVariables: mapRecord(appSpec.templateVariables ?? {}, (v) => ({\n      value: v.value,\n      type: buildTypeContext(v.type, appSpec, sanitizer),\n    })),\n  }\n}\n\nfunction buildStructCtx(name: string, appSpec: Arc56Contract, sanitizer: Sanitizer): StructContext {\n  const typeCtx = buildTypeContext(name, appSpec, sanitizer)\n\n  const abiType = typeCtx.type\n  invariant(abiType instanceof ABIStructType)\n\n  return {\n    type: typeCtx,\n    tsObjDef: buildStructObjDef(abiType.structFields, appSpec, sanitizer, 1),\n    tsTupDef: `[${Array.from(buildStructTupleDef(abiType.structFields, appSpec, sanitizer)).join(', ')}]`,\n  }\n}\n\nfunction buildStructObjDef(fields: ABIStructField[], appSpec: Arc56Contract, sanitizer: Sanitizer, indent: number): string {\n  const indentStr = '  '.repeat(indent)\n  const closingIndent = '  '.repeat(indent - 1)\n  const lines: string[] = []\n\n  for (const field of fields) {\n    const typeDef = Array.isArray(field.type)\n      ? buildStructObjDef(field.type, appSpec, sanitizer, indent + 1)\n      : abiTypeToTs(field.type, 'output', sanitizer)\n    lines.push(`${indentStr}${sanitizer.makeSafePropertyIdentifier(field.name)}: ${typeDef}`)\n  }\n\n  return `{\\n${lines.join(',\\n')}\\n${closingIndent}}`\n}\nfunction* buildStructTupleDef(fields: ABIStructField[], appSpec: Arc56Contract, sanitizer: Sanitizer) {\n  for (const field of fields) {\n    let typeDef: string\n    if (Array.isArray(field.type)) {\n      typeDef = `[${Array.from(buildStructTupleDef(field.type, appSpec, sanitizer)).join(', ')}]`\n    } else {\n      typeDef = abiTypeToTs(field.type, 'output', sanitizer)\n    }\n    yield `${typeDef}`\n  }\n}\n\nfunction buildStorageMap(\n  maps: Record<string, StorageMap>,\n  appSpec: Arc56Contract,\n  sanitizer: Sanitizer,\n): Record<string, StorageMapContext> {\n  return mapRecord(maps, (v) => ({\n    desc: v.desc,\n    valueType: buildTypeContext(v.valueType, appSpec, sanitizer),\n    keyType: buildTypeContext(v.keyType, appSpec, sanitizer),\n    prefix: v.prefix,\n  }))\n}\nfunction buildStorageKey(\n  keys: Record<string, StorageKey>,\n  appSpec: Arc56Contract,\n  sanitizer: Sanitizer,\n): Record<string, StorageKeyContext> {\n  return mapRecord(keys, (v) => ({\n    desc: v.desc,\n    valueType: buildTypeContext(v.valueType, appSpec, sanitizer),\n    keyType: buildTypeContext(v.valueType, appSpec, sanitizer),\n    key: v.key,\n  }))\n}\n\nfunction mapRecord<TIn, TOut>(input: Record<string, TIn>, mapper: (value: TIn, key: string) => TOut): Record<string, TOut> {\n  return Object.fromEntries(Object.entries(input).map(([k, v]) => [k, mapper(v, k)]))\n}\n\nfunction createSanitizableString(name: string, sanitizer: Sanitizer): SanitizableString {\n  return new Proxy<SanitizableString>({} as SanitizableString, {\n    get(target, property) {\n      if (property === 'toString') return () => name\n      if (property === 'original') return name\n      if (property in sanitizer) {\n        return sanitizer[property as keyof Sanitizer](name)\n      }\n    },\n  })\n}\n\nfunction buildOcas(actions: string[]): MethodOcas {\n  const isOptional = actions.includes('NoOp') || actions.length === 1\n  const typeLiteral = actions.length\n    ? `{ onComplete${isOptional ? '?' : ''}: ${actions.map((oc) => `OnApplicationComplete.${oc}`).join(' | ')} }`\n    : undefined\n\n  return {\n    raw: actions,\n    any: Boolean(actions.length),\n    noOp: actions.includes('NoOp'),\n    optIn: actions.includes('OptIn'),\n    closeOut: actions.includes('CloseOut'),\n    clearState: actions.includes('ClearState'),\n    updateApplication: actions.includes('UpdateApplication'),\n    deleteApplication: actions.includes('DeleteApplication'),\n\n    inputType: {\n      isOptional,\n      typeLiteral,\n    },\n  }\n}\n\nfunction buildTypeContext(typeName: string, appSpec: Arc56Contract, sanitizer: Sanitizer): TypeContext {\n  switch (typeName) {\n    case 'AVMBytes':\n      return {\n        isAvmBytes: true,\n        type: typeName,\n        tsInType: 'Uint8Array | string',\n        tsOutType: 'Uint8Array',\n      }\n    case 'AVMString':\n      return {\n        type: typeName,\n        tsInType: 'string',\n        tsOutType: 'string',\n      }\n    case 'AVMUint64':\n      return {\n        type: typeName,\n        tsInType: 'bigint',\n        tsOutType: 'bigint',\n      }\n  }\n  if (typeName in appSpec.structs) {\n    return {\n      type: ABIStructType.fromStruct(typeName, appSpec.structs),\n      tsInType: sanitizer.makeSafeTypeIdentifier(typeName),\n      tsOutType: sanitizer.makeSafeTypeIdentifier(typeName),\n    }\n  }\n  // Otherwise parse as ABI type\n  try {\n    const abiType = ABIType.from(typeName)\n    return {\n      type: abiType,\n      tsInType: abiTypeToTs(abiType, 'input', sanitizer),\n      tsOutType: abiTypeToTs(abiType, 'output', sanitizer),\n    }\n  } catch (error) {\n    throw new Error(`Failed to parse storage type '${typeName}': ${error}`)\n  }\n}\n"],"names":["arc56MethodToABIMethod","getEquivalentType","invariant","ABIStructType","abiTypeToTs","ABIType"],"mappings":";;;;;;AAiEM,SAAU,WAAW,CAAC,MAA8B,EAAA;AACxD,IAAA,OAAO,CAAC,MAAM,CAAC,MAAM;AACvB;AA2FM,SAAU,sBAAsB,CAAC,OAAsB,EAAE,SAAoB,EAAA;IACjF,MAAM,OAAO,GAA6B,EAAE;AAE5C,IAAA,KAAK,MAAM,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE;QAC/B,MAAM,SAAS,GAAGA,0BAAsB,CAAC,CAAC,EAAE,OAAO,CAAC;QACpD,MAAM,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;QACtF,OAAO,CAAC,IAAI,CAAC;AACX,YAAA,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC;YAChD,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,gBAAgB;AAChB,YAAA,UAAU,EAAE,uBAAuB,CAAC,gBAAgB,GAAG,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC,YAAY,EAAE,EAAE,SAAS,CAAC;YACpG,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAA4B;gBACrD,OAAO;AACL,oBAAA,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,uBAAuB,CAAC,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,SAAS;oBACrE,IAAI,EAAE,CAAC,CAAC,WAAW;oBACnB,IAAI,EAAE,CAAC,CAAC,IAAI;oBACZ,QAAQ,EAAEC,mCAAiB,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC;AACvD,oBAAA,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,YAAY,CAAC;iBACtC;AACH,YAAA,CAAC,CAAC;YACF,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;YACtC,aAAa,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;AAC1C,YAAA,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC7B,YAAA,SAAS,EAAE,SAAS,CAAC,YAAY,EAAE;AACnC,YAAA,OAAO,EAAE;AACP,gBAAA,SAAS,EAAEA,mCAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC;AACzE,gBAAA,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI;AAC5E,gBAAA,IAAI,EAAE,SAAS,CAAC,OAAO,CAAC,WAAW;AACpC,aAAA;AACF,SAAA,CAAC;IACJ;AAEA,IAAA,MAAM,UAAU,GAA4B;AAC1C,QAAA,MAAM,EAAE,IAAI;QACZ,aAAa,EAAE,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC;QACpD,WAAW,EAAE,SAAS,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC;KACjD;AACD,IAAA,IAAI,UAAU,CAAC,aAAa,CAAC,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE;AAC9D,QAAA,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC;IAC1B;IAEA,OAAO;QACL,IAAI,EAAE,uBAAuB,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC;QACtD,OAAO;QACP,UAAU;AACV,QAAA,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC;AACzD,QAAA,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC;AACrE,QAAA,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,iBAAiB,CAAC;AACrE,QAAA,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;AACtD,QAAA,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;AACxD,QAAA,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,QAAQ,CAAC;AAC9D,QAAA,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,UAAU,CAAC;AAClE,QAAA,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC;AAEvC,QAAA,KAAK,EAAE;AACL,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC;AACtE,gBAAA,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC;AACpE,gBAAA,GAAG,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC;AACjE,aAAA;AACD,YAAA,IAAI,EAAE;AACJ,gBAAA,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,CAAC;AACtE,gBAAA,KAAK,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,CAAC;AACpE,gBAAA,GAAG,EAAE,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC;AACjE,aAAA;AACF,SAAA;QAED,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAE5F,QAAA,iBAAiB,EAAE,SAAS,CAAC,OAAO,CAAC,iBAAiB,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM;YACpE,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC;AACnD,SAAA,CAAC,CAAC;KACJ;AACH;AAEA,SAAS,cAAc,CAAC,IAAY,EAAE,OAAsB,EAAE,SAAoB,EAAA;IAChF,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC;AAE1D,IAAA,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI;AAC5B,IAAAC,qBAAS,CAAC,OAAO,YAAYC,iBAAa,CAAC;IAE3C,OAAO;AACL,QAAA,IAAI,EAAE,OAAO;AACb,QAAA,QAAQ,EAAE,iBAAiB,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACxE,QAAQ,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAA,CAAG;KACtG;AACH;AAEA,SAAS,iBAAiB,CAAC,MAAwB,EAAE,OAAsB,EAAE,SAAoB,EAAE,MAAc,EAAA;IAC/G,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IACrC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAC7C,MAAM,KAAK,GAAa,EAAE;AAE1B,IAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;QAC1B,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI;AACtC,cAAE,iBAAiB,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;cAC5DC,6BAAW,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC;AAChD,QAAA,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA,EAAG,SAAS,CAAC,0BAA0B,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,OAAO,CAAA,CAAE,CAAC;IAC3F;IAEA,OAAO,CAAA,GAAA,EAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA,EAAA,EAAK,aAAa,CAAA,CAAA,CAAG;AACrD;AACA,UAAU,mBAAmB,CAAC,MAAwB,EAAE,OAAsB,EAAE,SAAoB,EAAA;AAClG,IAAA,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;AAC1B,QAAA,IAAI,OAAe;QACnB,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;YAC7B,OAAO,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA,CAAA,CAAG;QAC7F;aAAO;YACL,OAAO,GAAGA,6BAAW,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC;QACxD;QACA,MAAM,CAAA,EAAG,OAAO,CAAA,CAAE;IACpB;AACF;AAEA,SAAS,eAAe,CACtB,IAAgC,EAChC,OAAsB,EACtB,SAAoB,EAAA;IAEpB,OAAO,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM;QAC7B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC;QAC5D,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC;QACxD,MAAM,EAAE,CAAC,CAAC,MAAM;AACjB,KAAA,CAAC,CAAC;AACL;AACA,SAAS,eAAe,CACtB,IAAgC,EAChC,OAAsB,EACtB,SAAoB,EAAA;IAEpB,OAAO,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM;QAC7B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,SAAS,EAAE,gBAAgB,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC;QAC5D,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,EAAE,SAAS,CAAC;QAC1D,GAAG,EAAE,CAAC,CAAC,GAAG;AACX,KAAA,CAAC,CAAC;AACL;AAEA,SAAS,SAAS,CAAY,KAA0B,EAAE,MAAyC,EAAA;AACjG,IAAA,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AACrF;AAEA,SAAS,uBAAuB,CAAC,IAAY,EAAE,SAAoB,EAAA;AACjE,IAAA,OAAO,IAAI,KAAK,CAAoB,EAAuB,EAAE;QAC3D,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAA;YAClB,IAAI,QAAQ,KAAK,UAAU;AAAE,gBAAA,OAAO,MAAM,IAAI;YAC9C,IAAI,QAAQ,KAAK,UAAU;AAAE,gBAAA,OAAO,IAAI;AACxC,YAAA,IAAI,QAAQ,IAAI,SAAS,EAAE;AACzB,gBAAA,OAAO,SAAS,CAAC,QAA2B,CAAC,CAAC,IAAI,CAAC;YACrD;QACF,CAAC;AACF,KAAA,CAAC;AACJ;AAEA,SAAS,SAAS,CAAC,OAAiB,EAAA;AAClC,IAAA,MAAM,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;AACnE,IAAA,MAAM,WAAW,GAAG,OAAO,CAAC;AAC1B,UAAE,CAAA,YAAA,EAAe,UAAU,GAAG,GAAG,GAAG,EAAE,CAAA,EAAA,EAAK,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAA,sBAAA,EAAyB,EAAE,CAAA,CAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA,EAAA;UACvG,SAAS;IAEb,OAAO;AACL,QAAA,GAAG,EAAE,OAAO;AACZ,QAAA,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;AAC5B,QAAA,IAAI,EAAE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;AAC9B,QAAA,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;AAChC,QAAA,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC;AACtC,QAAA,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;AAC1C,QAAA,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;AACxD,QAAA,iBAAiB,EAAE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;AAExD,QAAA,SAAS,EAAE;YACT,UAAU;YACV,WAAW;AACZ,SAAA;KACF;AACH;AAEA,SAAS,gBAAgB,CAAC,QAAgB,EAAE,OAAsB,EAAE,SAAoB,EAAA;IACtF,QAAQ,QAAQ;AACd,QAAA,KAAK,UAAU;YACb,OAAO;AACL,gBAAA,UAAU,EAAE,IAAI;AAChB,gBAAA,IAAI,EAAE,QAAQ;AACd,gBAAA,QAAQ,EAAE,qBAAqB;AAC/B,gBAAA,SAAS,EAAE,YAAY;aACxB;AACH,QAAA,KAAK,WAAW;YACd,OAAO;AACL,gBAAA,IAAI,EAAE,QAAQ;AACd,gBAAA,QAAQ,EAAE,QAAQ;AAClB,gBAAA,SAAS,EAAE,QAAQ;aACpB;AACH,QAAA,KAAK,WAAW;YACd,OAAO;AACL,gBAAA,IAAI,EAAE,QAAQ;AACd,gBAAA,QAAQ,EAAE,QAAQ;AAClB,gBAAA,SAAS,EAAE,QAAQ;aACpB;;AAEL,IAAA,IAAI,QAAQ,IAAI,OAAO,CAAC,OAAO,EAAE;QAC/B,OAAO;YACL,IAAI,EAAED,iBAAa,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC;AACzD,YAAA,QAAQ,EAAE,SAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC;AACpD,YAAA,SAAS,EAAE,SAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC;SACtD;IACH;;AAEA,IAAA,IAAI;QACF,MAAM,OAAO,GAAGE,WAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QACtC,OAAO;AACL,YAAA,IAAI,EAAE,OAAO;YACb,QAAQ,EAAED,6BAAW,CAAC,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC;YAClD,SAAS,EAAEA,6BAAW,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC;SACrD;IACH;IAAE,OAAO,KAAK,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,CAAA,8BAAA,EAAiC,QAAQ,CAAA,GAAA,EAAM,KAAK,CAAA,CAAE,CAAC;IACzE;AACF;;;;;"}