@algorandfoundation/algokit-utils 10.0.0-alpha.3 → 10.0.0-alpha.32

package/logging.mjs

@@ -0,0 +1,42 @@
+//#region src/logging.ts
+/** A logger implementation that writes to console */
+const consoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: console.debug
+};
+const infoConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: () => {},
+	debug: () => {}
+};
+const verboseConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: console.info,
+	verbose: console.trace,
+	debug: console.debug
+};
+const warningConsoleLogger = {
+	error: console.error,
+	warn: console.warn,
+	info: () => {},
+	verbose: () => {},
+	debug: () => {}
+};
+/** A logger implementation that does nothing */
+const nullLogger = {
+	error: function(message, ...optionalParams) {},
+	warn: function(message, ...optionalParams) {},
+	info: function(message, ...optionalParams) {},
+	verbose: function(message, ...optionalParams) {},
+	debug: function(message, ...optionalParams) {}
+};
+
+//#endregion
+export { consoleLogger, infoConsoleLogger, nullLogger, verboseConsoleLogger, warningConsoleLogger };
+//# sourceMappingURL=logging.mjs.map

package/logging.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.mjs","names":["consoleLogger: Logger","infoConsoleLogger: Logger","verboseConsoleLogger: Logger","warningConsoleLogger: Logger","nullLogger: Logger"],"sources":["../src/logging.ts"],"sourcesContent":["/* eslint-disable unused-imports/no-unused-vars */\n/* eslint-disable no-console */\n\nimport type { Logger } from '@algorandfoundation/algokit-common'\nexport type { Logger } from '@algorandfoundation/algokit-common'\n\n/** A logger implementation that writes to console */\nexport const consoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: console.debug,\n}\n\nexport const infoConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: () => {},\n  debug: () => {},\n}\n\nexport const verboseConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: console.info,\n  verbose: console.trace,\n  debug: console.debug,\n}\n\nexport const warningConsoleLogger: Logger = {\n  error: console.error,\n  warn: console.warn,\n  info: () => {},\n  verbose: () => {},\n  debug: () => {},\n}\n\n/** A logger implementation that does nothing */\nexport const nullLogger: Logger = {\n  error: function (message: string, ...optionalParams: unknown[]): void {},\n  warn: function (message: string, ...optionalParams: unknown[]): void {},\n  info: function (message: string, ...optionalParams: unknown[]): void {},\n  verbose: function (message: string, ...optionalParams: unknown[]): void {},\n  debug: function (message: string, ...optionalParams: unknown[]): void {},\n}\n"],"mappings":";;AAOA,MAAaA,gBAAwB;CACnC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,OAAO,QAAQ;CAChB;AAED,MAAaC,oBAA4B;CACvC,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,eAAe;CACf,aAAa;CACd;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,MAAM,QAAQ;CACd,SAAS,QAAQ;CACjB,OAAO,QAAQ;CAChB;AAED,MAAaC,uBAA+B;CAC1C,OAAO,QAAQ;CACf,MAAM,QAAQ;CACd,YAAY;CACZ,eAAe;CACf,aAAa;CACd;;AAGD,MAAaC,aAAqB;CAChC,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACtE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,MAAM,SAAU,SAAiB,GAAG,gBAAiC;CACrE,SAAS,SAAU,SAAiB,GAAG,gBAAiC;CACxE,OAAO,SAAU,SAAiB,GAAG,gBAAiC;CACvE"}

package/logic-error.d.ts

@@ -0,0 +1,39 @@
+//#region src/logic-error.d.ts
+/**
+ * Details about a smart contract logic error
+ */
+interface LogicErrorDetails {
+  /** The ID of the transaction with the logic error */
+  txId: string;
+  /** The program counter where the error was */
+  pc: number;
+  /** The error message */
+  msg: string;
+  /** The full error description */
+  desc: string;
+  /** Any trace information included in the error */
+  traces: Record<string, unknown>[];
+}
+/** Wraps key functionality around processing logic errors */
+declare class LogicError extends Error {
+  /** Takes an error message and parses out the details of any logic errors in there.
+   * @param error The error message to parse
+   * @returns The logic error details if any, or undefined
+   */
+  static parseLogicError(error: any): LogicErrorDetails | undefined;
+  led: LogicErrorDetails;
+  program: string[];
+  lines: number;
+  teal_line: number;
+  stack?: string;
+  /**
+   * Create a new logic error object.
+   * @param errorDetails The details of the logic error
+   * @param program The TEAL source code, split by line
+   * @param getLineForPc The source map of the TEAL source code
+   */
+  constructor(errorDetails: LogicErrorDetails, program: string[], getLineForPc: (pc: number) => number | undefined);
+}
+//#endregion
+export { LogicError, LogicErrorDetails };
+//# sourceMappingURL=logic-error.d.ts.map

package/logic-error.js

@@ -0,0 +1,54 @@
+
+//#region src/logic-error.ts
+const LOGIC_ERROR = /transaction ([A-Z0-9]+): logic eval error: (.*). Details: .*pc=([0-9]+).*/;
+const INNER_LOGIC_ERROR = /inner tx (\d+) failed:.*?pc=([0-9]+)/;
+/** Wraps key functionality around processing logic errors */
+var LogicError = class extends Error {
+	/** Takes an error message and parses out the details of any logic errors in there.
+	* @param error The error message to parse
+	* @returns The logic error details if any, or undefined
+	*/
+	static parseLogicError(error) {
+		const errorMessage = error.message;
+		const res = LOGIC_ERROR.exec(errorMessage);
+		const innerRes = INNER_LOGIC_ERROR.exec(errorMessage);
+		if (res === null || res.length <= 3) return void 0;
+		return {
+			txId: res[1],
+			msg: res[2],
+			desc: errorMessage,
+			pc: parseInt(innerRes?.[2] ?? res[3] ?? "0"),
+			traces: error.traces
+		};
+	}
+	led;
+	program;
+	lines = 5;
+	teal_line = 0;
+	stack;
+	/**
+	* Create a new logic error object.
+	* @param errorDetails The details of the logic error
+	* @param program The TEAL source code, split by line
+	* @param getLineForPc The source map of the TEAL source code
+	*/
+	constructor(errorDetails, program, getLineForPc) {
+		super();
+		this.led = errorDetails;
+		this.program = program;
+		const line = getLineForPc(errorDetails.pc);
+		this.teal_line = line === void 0 ? 0 : line;
+		this.message = `${this.led.msg}. at:${line}. ${this.led.desc}`;
+		if (this.teal_line > 0) {
+			const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0;
+			const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length;
+			const stack_lines = program.slice(start, stop);
+			stack_lines[stack_lines.length / 2] += " <--- Error";
+			this.stack = stack_lines.join("\n");
+		}
+	}
+};
+
+//#endregion
+exports.LogicError = LogicError;
+//# sourceMappingURL=logic-error.js.map

package/logic-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logic-error.js","names":[],"sources":["../src/logic-error.ts"],"sourcesContent":["const LOGIC_ERROR = /transaction ([A-Z0-9]+): logic eval error: (.*). Details: .*pc=([0-9]+).*/\n// inner tx 0 failed: logic eval error: err opcode executed. Details: app=6248, pc=29, opcodes=tx\nconst INNER_LOGIC_ERROR = /inner tx (\\d+) failed:.*?pc=([0-9]+)/\n\n/**\n * Details about a smart contract logic error\n */\nexport interface LogicErrorDetails {\n  /** The ID of the transaction with the logic error */\n  txId: string\n  /** The program counter where the error was */\n  pc: number\n  /** The error message */\n  msg: string\n  /** The full error description */\n  desc: string\n  /** Any trace information included in the error */\n  traces: Record<string, unknown>[]\n}\n\n/** Wraps key functionality around processing logic errors */\nexport class LogicError extends Error {\n  /** Takes an error message and parses out the details of any logic errors in there.\n   * @param error The error message to parse\n   * @returns The logic error details if any, or undefined\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  static parseLogicError(error: any): LogicErrorDetails | undefined {\n    const errorMessage = error.message\n    const res = LOGIC_ERROR.exec(errorMessage)\n    const innerRes = INNER_LOGIC_ERROR.exec(errorMessage)\n\n    if (res === null || res.length <= 3) return undefined\n\n    return {\n      txId: res[1],\n      msg: res[2],\n      desc: errorMessage,\n      pc: parseInt(innerRes?.[2] ?? res[3] ?? '0'),\n      traces: error.traces,\n    } as LogicErrorDetails\n  }\n\n  public led: LogicErrorDetails\n  public program: string[]\n  public lines = 5\n  public teal_line = 0\n  override stack?: string\n\n  /**\n   * Create a new logic error object.\n   * @param errorDetails The details of the logic error\n   * @param program The TEAL source code, split by line\n   * @param getLineForPc The source map of the TEAL source code\n   */\n  constructor(errorDetails: LogicErrorDetails, program: string[], getLineForPc: (pc: number) => number | undefined) {\n    super()\n    this.led = errorDetails\n    this.program = program\n\n    const line = getLineForPc(errorDetails.pc)\n    this.teal_line = line === undefined ? 0 : line\n\n    this.message = `${this.led.msg}. at:${line}. ${this.led.desc}`\n\n    if (this.teal_line > 0) {\n      const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0\n      const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length\n\n      const stack_lines = program.slice(start, stop)\n\n      stack_lines[stack_lines.length / 2] += ' <--- Error'\n\n      this.stack = stack_lines.join('\\n')\n    }\n  }\n}\n"],"mappings":";;AAAA,MAAM,cAAc;AAEpB,MAAM,oBAAoB;;AAmB1B,IAAa,aAAb,cAAgC,MAAM;;;;;CAMpC,OAAO,gBAAgB,OAA2C;EAChE,MAAM,eAAe,MAAM;EAC3B,MAAM,MAAM,YAAY,KAAK,aAAa;EAC1C,MAAM,WAAW,kBAAkB,KAAK,aAAa;AAErD,MAAI,QAAQ,QAAQ,IAAI,UAAU,EAAG,QAAO;AAE5C,SAAO;GACL,MAAM,IAAI;GACV,KAAK,IAAI;GACT,MAAM;GACN,IAAI,SAAS,WAAW,MAAM,IAAI,MAAM,IAAI;GAC5C,QAAQ,MAAM;GACf;;CAGH,AAAO;CACP,AAAO;CACP,AAAO,QAAQ;CACf,AAAO,YAAY;CACnB,AAAS;;;;;;;CAQT,YAAY,cAAiC,SAAmB,cAAkD;AAChH,SAAO;AACP,OAAK,MAAM;AACX,OAAK,UAAU;EAEf,MAAM,OAAO,aAAa,aAAa,GAAG;AAC1C,OAAK,YAAY,SAAS,SAAY,IAAI;AAE1C,OAAK,UAAU,GAAG,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,KAAK,IAAI;AAExD,MAAI,KAAK,YAAY,GAAG;GACtB,MAAM,QAAQ,KAAK,YAAY,KAAK,QAAQ,KAAK,YAAY,KAAK,QAAQ;GAC1E,MAAM,OAAO,QAAQ,SAAS,KAAK,YAAY,KAAK,QAAQ,KAAK,YAAY,KAAK,QAAQ,QAAQ;GAElG,MAAM,cAAc,QAAQ,MAAM,OAAO,KAAK;AAE9C,eAAY,YAAY,SAAS,MAAM;AAEvC,QAAK,QAAQ,YAAY,KAAK,KAAK"}

package/logic-error.mjs

@@ -0,0 +1,53 @@
+//#region src/logic-error.ts
+const LOGIC_ERROR = /transaction ([A-Z0-9]+): logic eval error: (.*). Details: .*pc=([0-9]+).*/;
+const INNER_LOGIC_ERROR = /inner tx (\d+) failed:.*?pc=([0-9]+)/;
+/** Wraps key functionality around processing logic errors */
+var LogicError = class extends Error {
+	/** Takes an error message and parses out the details of any logic errors in there.
+	* @param error The error message to parse
+	* @returns The logic error details if any, or undefined
+	*/
+	static parseLogicError(error) {
+		const errorMessage = error.message;
+		const res = LOGIC_ERROR.exec(errorMessage);
+		const innerRes = INNER_LOGIC_ERROR.exec(errorMessage);
+		if (res === null || res.length <= 3) return void 0;
+		return {
+			txId: res[1],
+			msg: res[2],
+			desc: errorMessage,
+			pc: parseInt(innerRes?.[2] ?? res[3] ?? "0"),
+			traces: error.traces
+		};
+	}
+	led;
+	program;
+	lines = 5;
+	teal_line = 0;
+	stack;
+	/**
+	* Create a new logic error object.
+	* @param errorDetails The details of the logic error
+	* @param program The TEAL source code, split by line
+	* @param getLineForPc The source map of the TEAL source code
+	*/
+	constructor(errorDetails, program, getLineForPc) {
+		super();
+		this.led = errorDetails;
+		this.program = program;
+		const line = getLineForPc(errorDetails.pc);
+		this.teal_line = line === void 0 ? 0 : line;
+		this.message = `${this.led.msg}. at:${line}. ${this.led.desc}`;
+		if (this.teal_line > 0) {
+			const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0;
+			const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length;
+			const stack_lines = program.slice(start, stop);
+			stack_lines[stack_lines.length / 2] += " <--- Error";
+			this.stack = stack_lines.join("\n");
+		}
+	}
+};
+
+//#endregion
+export { LogicError };
+//# sourceMappingURL=logic-error.mjs.map

package/logic-error.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logic-error.mjs","names":[],"sources":["../src/logic-error.ts"],"sourcesContent":["const LOGIC_ERROR = /transaction ([A-Z0-9]+): logic eval error: (.*). Details: .*pc=([0-9]+).*/\n// inner tx 0 failed: logic eval error: err opcode executed. Details: app=6248, pc=29, opcodes=tx\nconst INNER_LOGIC_ERROR = /inner tx (\\d+) failed:.*?pc=([0-9]+)/\n\n/**\n * Details about a smart contract logic error\n */\nexport interface LogicErrorDetails {\n  /** The ID of the transaction with the logic error */\n  txId: string\n  /** The program counter where the error was */\n  pc: number\n  /** The error message */\n  msg: string\n  /** The full error description */\n  desc: string\n  /** Any trace information included in the error */\n  traces: Record<string, unknown>[]\n}\n\n/** Wraps key functionality around processing logic errors */\nexport class LogicError extends Error {\n  /** Takes an error message and parses out the details of any logic errors in there.\n   * @param error The error message to parse\n   * @returns The logic error details if any, or undefined\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  static parseLogicError(error: any): LogicErrorDetails | undefined {\n    const errorMessage = error.message\n    const res = LOGIC_ERROR.exec(errorMessage)\n    const innerRes = INNER_LOGIC_ERROR.exec(errorMessage)\n\n    if (res === null || res.length <= 3) return undefined\n\n    return {\n      txId: res[1],\n      msg: res[2],\n      desc: errorMessage,\n      pc: parseInt(innerRes?.[2] ?? res[3] ?? '0'),\n      traces: error.traces,\n    } as LogicErrorDetails\n  }\n\n  public led: LogicErrorDetails\n  public program: string[]\n  public lines = 5\n  public teal_line = 0\n  override stack?: string\n\n  /**\n   * Create a new logic error object.\n   * @param errorDetails The details of the logic error\n   * @param program The TEAL source code, split by line\n   * @param getLineForPc The source map of the TEAL source code\n   */\n  constructor(errorDetails: LogicErrorDetails, program: string[], getLineForPc: (pc: number) => number | undefined) {\n    super()\n    this.led = errorDetails\n    this.program = program\n\n    const line = getLineForPc(errorDetails.pc)\n    this.teal_line = line === undefined ? 0 : line\n\n    this.message = `${this.led.msg}. at:${line}. ${this.led.desc}`\n\n    if (this.teal_line > 0) {\n      const start = this.teal_line > this.lines ? this.teal_line - this.lines : 0\n      const stop = program.length > this.teal_line + this.lines ? this.teal_line + this.lines : program.length\n\n      const stack_lines = program.slice(start, stop)\n\n      stack_lines[stack_lines.length / 2] += ' <--- Error'\n\n      this.stack = stack_lines.join('\\n')\n    }\n  }\n}\n"],"mappings":";AAAA,MAAM,cAAc;AAEpB,MAAM,oBAAoB;;AAmB1B,IAAa,aAAb,cAAgC,MAAM;;;;;CAMpC,OAAO,gBAAgB,OAA2C;EAChE,MAAM,eAAe,MAAM;EAC3B,MAAM,MAAM,YAAY,KAAK,aAAa;EAC1C,MAAM,WAAW,kBAAkB,KAAK,aAAa;AAErD,MAAI,QAAQ,QAAQ,IAAI,UAAU,EAAG,QAAO;AAE5C,SAAO;GACL,MAAM,IAAI;GACV,KAAK,IAAI;GACT,MAAM;GACN,IAAI,SAAS,WAAW,MAAM,IAAI,MAAM,IAAI;GAC5C,QAAQ,MAAM;GACf;;CAGH,AAAO;CACP,AAAO;CACP,AAAO,QAAQ;CACf,AAAO,YAAY;CACnB,AAAS;;;;;;;CAQT,YAAY,cAAiC,SAAmB,cAAkD;AAChH,SAAO;AACP,OAAK,MAAM;AACX,OAAK,UAAU;EAEf,MAAM,OAAO,aAAa,aAAa,GAAG;AAC1C,OAAK,YAAY,SAAS,SAAY,IAAI;AAE1C,OAAK,UAAU,GAAG,KAAK,IAAI,IAAI,OAAO,KAAK,IAAI,KAAK,IAAI;AAExD,MAAI,KAAK,YAAY,GAAG;GACtB,MAAM,QAAQ,KAAK,YAAY,KAAK,QAAQ,KAAK,YAAY,KAAK,QAAQ;GAC1E,MAAM,OAAO,QAAQ,SAAS,KAAK,YAAY,KAAK,QAAQ,KAAK,YAAY,KAAK,QAAQ,QAAQ;GAElG,MAAM,cAAc,QAAQ,MAAM,OAAO,KAAK;AAE9C,eAAY,YAAY,SAAS,MAAM;AAEvC,QAAK,QAAQ,YAAY,KAAK,KAAK"}

package/network-client.d.ts

@@ -0,0 +1,43 @@
+//#region src/network-client.d.ts
+/** Config for an Algorand SDK client. */
+interface AlgoClientConfig {
+  /** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */
+  server: string;
+  /** The port to use e.g. 4001, 443, etc. */
+  port?: string | number;
+  /** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */
+  token?: string | {
+    [name: string]: string;
+  };
+}
+/** Configuration for algod, indexer and kmd clients. */
+interface AlgoConfig {
+  /** Algod client configuration */
+  algodConfig: AlgoClientConfig;
+  /** Indexer client configuration */
+  indexerConfig?: AlgoClientConfig;
+  /** Kmd configuration */
+  kmdConfig?: AlgoClientConfig;
+}
+/** Details of the current network. */
+interface NetworkDetails {
+  /** Whether or not the network is TestNet. */
+  isTestNet: boolean;
+  /** Whether or not the network is MainNet. */
+  isMainNet: boolean;
+  /** Whether or not the network is LocalNet. */
+  isLocalNet: boolean;
+  /** The genesis ID of the current network. */
+  genesisId: string;
+  /** The base64 genesis hash of the current network. */
+  genesisHash: string;
+}
+/**
+ * Returns true if the given network genesisId is associated with a LocalNet network.
+ * @param genesisId The network genesis ID
+ * @returns Whether the given genesis ID is associated with a LocalNet network
+ */
+declare function genesisIdIsLocalNet(genesisId: string): boolean;
+//#endregion
+export { AlgoClientConfig, AlgoConfig, NetworkDetails, genesisIdIsLocalNet };
+//# sourceMappingURL=network-client.d.ts.map

package/network-client.js

@@ -0,0 +1,14 @@
+
+//#region src/network-client.ts
+/**
+* Returns true if the given network genesisId is associated with a LocalNet network.
+* @param genesisId The network genesis ID
+* @returns Whether the given genesis ID is associated with a LocalNet network
+*/
+function genesisIdIsLocalNet(genesisId) {
+	return genesisId === "devnet-v1" || genesisId === "sandnet-v1" || genesisId === "dockernet-v1";
+}
+
+//#endregion
+exports.genesisIdIsLocalNet = genesisIdIsLocalNet;
+//# sourceMappingURL=network-client.js.map

package/network-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-client.js","names":[],"sources":["../src/network-client.ts"],"sourcesContent":["/** Config for an Algorand SDK client. */\nexport interface AlgoClientConfig {\n  /** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */\n  server: string\n  /** The port to use e.g. 4001, 443, etc. */\n  port?: string | number\n  /** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */\n  token?: string | { [name: string]: string }\n}\n\n/** Configuration for algod, indexer and kmd clients. */\nexport interface AlgoConfig {\n  /** Algod client configuration */\n  algodConfig: AlgoClientConfig\n  /** Indexer client configuration */\n  indexerConfig?: AlgoClientConfig\n  /** Kmd configuration */\n  kmdConfig?: AlgoClientConfig\n}\n\n/** Details of the current network. */\nexport interface NetworkDetails {\n  /** Whether or not the network is TestNet. */\n  isTestNet: boolean\n  /** Whether or not the network is MainNet. */\n  isMainNet: boolean\n  /** Whether or not the network is LocalNet. */\n  isLocalNet: boolean\n  /** The genesis ID of the current network. */\n  genesisId: string\n  /** The base64 genesis hash of the current network. */\n  genesisHash: string\n}\n\n/**\n * Returns true if the given network genesisId is associated with a LocalNet network.\n * @param genesisId The network genesis ID\n * @returns Whether the given genesis ID is associated with a LocalNet network\n */\nexport function genesisIdIsLocalNet(genesisId: string) {\n  return genesisId === 'devnet-v1' || genesisId === 'sandnet-v1' || genesisId === 'dockernet-v1'\n}\n"],"mappings":";;;;;;;AAuCA,SAAgB,oBAAoB,WAAmB;AACrD,QAAO,cAAc,eAAe,cAAc,gBAAgB,cAAc"}

package/network-client.mjs

@@ -0,0 +1,13 @@
+//#region src/network-client.ts
+/**
+* Returns true if the given network genesisId is associated with a LocalNet network.
+* @param genesisId The network genesis ID
+* @returns Whether the given genesis ID is associated with a LocalNet network
+*/
+function genesisIdIsLocalNet(genesisId) {
+	return genesisId === "devnet-v1" || genesisId === "sandnet-v1" || genesisId === "dockernet-v1";
+}
+
+//#endregion
+export { genesisIdIsLocalNet };
+//# sourceMappingURL=network-client.mjs.map

package/network-client.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"network-client.mjs","names":[],"sources":["../src/network-client.ts"],"sourcesContent":["/** Config for an Algorand SDK client. */\nexport interface AlgoClientConfig {\n  /** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */\n  server: string\n  /** The port to use e.g. 4001, 443, etc. */\n  port?: string | number\n  /** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */\n  token?: string | { [name: string]: string }\n}\n\n/** Configuration for algod, indexer and kmd clients. */\nexport interface AlgoConfig {\n  /** Algod client configuration */\n  algodConfig: AlgoClientConfig\n  /** Indexer client configuration */\n  indexerConfig?: AlgoClientConfig\n  /** Kmd configuration */\n  kmdConfig?: AlgoClientConfig\n}\n\n/** Details of the current network. */\nexport interface NetworkDetails {\n  /** Whether or not the network is TestNet. */\n  isTestNet: boolean\n  /** Whether or not the network is MainNet. */\n  isMainNet: boolean\n  /** Whether or not the network is LocalNet. */\n  isLocalNet: boolean\n  /** The genesis ID of the current network. */\n  genesisId: string\n  /** The base64 genesis hash of the current network. */\n  genesisHash: string\n}\n\n/**\n * Returns true if the given network genesisId is associated with a LocalNet network.\n * @param genesisId The network genesis ID\n * @returns Whether the given genesis ID is associated with a LocalNet network\n */\nexport function genesisIdIsLocalNet(genesisId: string) {\n  return genesisId === 'devnet-v1' || genesisId === 'sandnet-v1' || genesisId === 'dockernet-v1'\n}\n"],"mappings":";;;;;;AAuCA,SAAgB,oBAAoB,WAAmB;AACrD,QAAO,cAAc,eAAe,cAAc,gBAAgB,cAAc"}

package/package.json

@@ -6,11 +6,15 @@
     "**"
   ],
   "name": "@algorandfoundation/algokit-utils",
-  "version": "10.0.0-alpha.3",
+  "version": "10.0.0-alpha.32",
   "private": false,
   "description": "A set of core Algorand utilities written in TypeScript and released via npm that make it easier to build solutions on Algorand.",
   "author": "Algorand Foundation",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/algorandfoundation/algokit-utils-ts.git"
+  },
   "engines": {
     "node": ">=20.0"
   },
@@ -42,6 +46,11 @@
       "import": "./transact/index.mjs",
       "require": "./transact/index.js"
     },
+    "./transaction": {
+      "types": "./transaction/index.d.ts",
+      "import": "./transaction/index.mjs",
+      "require": "./transaction/index.js"
+    },
     "./algod-client": {
       "types": "./algod-client/index.d.ts",
       "import": "./algod-client/index.mjs",
@@ -62,10 +71,10 @@
       "import": "./algo25/index.mjs",
       "require": "./algo25/index.js"
     },
-    "./sdk": {
-      "types": "./sdk/index.d.ts",
-      "import": "./sdk/index.mjs",
-      "require": "./sdk/index.js"
+    "./*": {
+      "types": "./*.d.ts",
+      "import": "./*.mjs",
+      "require": "./*.js"
     },
     "./index.d.ts": "./index.d.ts",
     "./package.json": "./package.json"

package/packages/abi/src/abi-method.d.ts

@@ -61,7 +61,7 @@ type ABIReturn = {
   rawReturnValue?: undefined;
   returnValue?: undefined;
   method: ABIMethod;
-  decodeError: Error;
+  decodeError?: Error;
 };
 declare class ABIMethod {
   readonly name: string;

package/packages/abi/src/abi-method.js

@@ -139,7 +139,7 @@ function arc56MethodToABIMethod(method, appSpec) {
 	});
 	const returns = {
 		type: method.returns.type === "void" ? "void" : method.returns.struct ? require_abi_type.ABIStructType.fromStruct(method.returns.struct, appSpec.structs) : require_abi_type.ABIType.from(method.returns.type),
-		desc: method.returns.desc
+		description: method.returns.desc
 	};
 	return new ABIMethod({
 		name: method.name,

package/packages/abi/src/abi-method.js.map

@@ -1 +1 @@
-{"version":3,"file":"abi-method.js","names":["sha512","parseTupleContent","ABIType","convertedDefaultValue: ABIDefaultValue | undefined","ABIStructType","ABIUintType","ABIAddressType"],"sources":["../../../../packages/abi/src/abi-method.ts"],"sourcesContent":["import sha512 from 'js-sha512'\nimport { ABIAddressType, ABIStructType, ABIType, ABIUintType, parseTupleContent } from './abi-type'\nimport { ABIValue } from './abi-value'\nimport { ARC28Event } from './arc28-event'\nimport { AVMType, Arc56Contract, Arc56Method } from './arc56-contract'\n\nexport enum ABITransactionType {\n  Txn = 'txn',\n  Payment = 'pay',\n  KeyRegistration = 'keyreg',\n  AssetConfig = 'acfg',\n  AssetTransfer = 'axfer',\n  AssetFreeze = 'afrz',\n  AppCall = 'appl',\n}\nexport enum ABIReferenceType {\n  Account = 'account',\n  Application = 'application',\n  Asset = 'asset',\n}\nexport type ABIMethodArgType = ABIType | ABITransactionType | ABIReferenceType\nexport type ABIMethodReturnType = ABIType | 'void'\n\nexport type ABIMethodArg = {\n  type: ABIMethodArgType\n  name?: string\n  description?: string\n  defaultValue?: ABIDefaultValue\n}\n\nexport type ABIMethodReturn = {\n  type: ABIMethodReturnType\n  description?: string\n}\n\nexport type ABIDefaultValue = {\n  /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n  data: string\n  /** Where the default value is coming from */\n  source: DefaultValueSource\n  /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n  type?: ABIType | AVMType\n}\n\nexport enum DefaultValueSource {\n  Box = 'box',\n  Global = 'global',\n  Local = 'local',\n  Literal = 'literal',\n  Method = 'method',\n}\n\n/** Represents an ABI method return value with parsed data. */\nexport type ABIReturn =\n  | {\n      /** The method that was called. */\n      method: ABIMethod\n      /** The raw return value as bytes.\n       *\n       * This is the value from the last app call log with the first 4 bytes (the ABI return prefix) omitted.\n       */\n      rawReturnValue: Uint8Array\n      /** The parsed ABI return value. */\n      returnValue: ABIValue\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method: ABIMethod; decodeError: Error }\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | ABIValue\n}\n\nexport class ABIMethod {\n  readonly name: string\n  readonly description?: string\n  readonly args: ABIMethodArg[]\n  readonly returns: ABIMethodReturn\n  readonly events?: ARC28Event[]\n  readonly readonly?: boolean\n\n  constructor(params: {\n    name: string\n    description?: string\n    args: ABIMethodArg[]\n    returns: ABIMethodReturn\n    events?: ARC28Event[]\n    readonly?: boolean\n  }) {\n    this.name = params.name\n    this.description = params.description\n    this.args = params.args\n    this.returns = params.returns\n    this.events = params.events\n    this.readonly = params.readonly\n  }\n\n  /**\n   * Returns the signature of this ABI method.\n   * @returns The signature, e.g. `my_method(unit64,string)bytes`\n   */\n  getSignature(): string {\n    const args = this.args\n      .map((arg) => {\n        if (argTypeIsTransaction(arg.type) || argTypeIsReference(arg.type)) return arg.type\n        return arg.type.name\n      })\n      .join(',')\n    const returns = this.returns.type === 'void' ? 'void' : this.returns.type.name\n    return `${this.name}(${args})${returns}`\n  }\n\n  /**\n   * Returns the method selector of this ABI method.\n   * @returns The 4-byte method selector\n   */\n  getSelector(): Uint8Array {\n    const hash = sha512.sha512_256.array(this.getSignature())\n    return new Uint8Array(hash.slice(0, 4))\n  }\n\n  /**\n   * Returns the ABI method object for a given method signature.\n   * @param signature The method signature\n   * e.g. `my_method(unit64,string)bytes`\n   * @returns The `ABIMethod`\n   */\n  static fromSignature(signature: string): ABIMethod {\n    const argsStart = signature.indexOf('(')\n    if (argsStart === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    let argsEnd = -1\n    let depth = 0\n    for (let i = argsStart; i < signature.length; i++) {\n      const char = signature[i]\n\n      if (char === '(') {\n        depth += 1\n      } else if (char === ')') {\n        if (depth === 0) {\n          // unpaired parenthesis\n          break\n        }\n\n        depth -= 1\n        if (depth === 0) {\n          argsEnd = i\n          break\n        }\n      }\n    }\n\n    if (argsEnd === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    const name = signature.slice(0, argsStart)\n    const args = parseTupleContent(signature.slice(argsStart + 1, argsEnd)).map((n: string) => {\n      if (argTypeIsTransaction(n as ABIMethodArgType) || argTypeIsReference(n as ABIMethodArgType)) {\n        return { type: n as ABIMethodArgType } satisfies ABIMethodArg\n      }\n      return { type: ABIType.from(n) } satisfies ABIMethodArg\n    })\n    const returnType = signature.slice(argsEnd + 1)\n    const returns = { type: returnType === 'void' ? ('void' as const) : ABIType.from(returnType) } satisfies ABIMethodReturn\n\n    return new ABIMethod({\n      name,\n      args,\n      returns,\n    })\n  }\n}\n\n/**\n * Returns the ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `ABIMethod`\n */\nexport function getABIMethod(methodNameOrSignature: string, appSpec: Arc56Contract): ABIMethod {\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => getArc56MethodSignature(m))\n          .join(', ')}`,\n      )\n    }\n    return arc56MethodToABIMethod(methods[0], appSpec)\n  } else {\n    const method = appSpec.methods.find((m) => getArc56MethodSignature(m) === methodNameOrSignature)\n    if (!method) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    return arc56MethodToABIMethod(method, appSpec)\n  }\n}\n\nexport function arc56MethodToABIMethod(method: Arc56Method, appSpec: Arc56Contract): ABIMethod {\n  if (typeof method.name !== 'string' || typeof method.returns !== 'object' || !Array.isArray(method.args)) {\n    throw new Error('Invalid ABIMethod parameters')\n  }\n\n  const args = method.args.map(({ type, name, desc, struct, defaultValue }) => {\n    const convertedDefaultValue: ABIDefaultValue | undefined = defaultValue\n      ? {\n          data: defaultValue.data,\n          source: defaultValue.source as DefaultValueSource,\n          type: defaultValue.type ? (isAVMType(defaultValue.type) ? defaultValue.type : ABIType.from(defaultValue.type)) : undefined,\n        }\n      : undefined\n\n    if (argTypeIsTransaction(type as ABIMethodArgType) || argTypeIsReference(type as ABIMethodArgType)) {\n      return {\n        type: type as ABIMethodArgType,\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    if (struct) {\n      return {\n        type: ABIStructType.fromStruct(struct, appSpec.structs),\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    return {\n      type: ABIType.from(type),\n      name,\n      description: desc,\n      defaultValue: convertedDefaultValue,\n    } satisfies ABIMethodArg\n  })\n\n  const returns = {\n    type:\n      method.returns.type === ('void' as const)\n        ? ('void' as const)\n        : method.returns.struct\n          ? ABIStructType.fromStruct(method.returns.struct, appSpec.structs)\n          : ABIType.from(method.returns.type),\n    desc: method.returns.desc,\n  }\n\n  return new ABIMethod({\n    name: method.name,\n    description: method.desc,\n    args,\n    returns,\n    events: method.events,\n    readonly: method.readonly,\n  })\n}\n\nexport function argTypeIsTransaction(type: ABIMethodArgType): type is ABITransactionType {\n  return (\n    typeof type === 'string' &&\n    (type === ABITransactionType.Txn ||\n      type === ABITransactionType.Payment ||\n      type === ABITransactionType.KeyRegistration ||\n      type === ABITransactionType.AssetConfig ||\n      type === ABITransactionType.AssetTransfer ||\n      type === ABITransactionType.AssetFreeze ||\n      type === ABITransactionType.AppCall)\n  )\n}\n\nexport function argTypeIsReference(type: ABIMethodArgType): type is ABIReferenceType {\n  return (\n    typeof type === 'string' &&\n    (type === ABIReferenceType.Account || type === ABIReferenceType.Application || type === ABIReferenceType.Asset)\n  )\n}\n\nexport function argTypeIsAbiType(type: ABIMethodArgType): type is ABIType {\n  return !argTypeIsTransaction(type) && !argTypeIsReference(type)\n}\n\nfunction getArc56MethodSignature(method: Arc56Method): string {\n  const args = method.args.map((arg) => arg.type).join(',')\n  const returns = method.returns.type\n  return `${method.name}(${args})${returns}`\n}\n\nexport function decodeAVMValue(avmType: AVMType, bytes: Uint8Array): ABIValue {\n  switch (avmType) {\n    case 'AVMString':\n      return Buffer.from(bytes).toString('utf-8')\n    case 'AVMBytes':\n      return bytes\n    case 'AVMUint64':\n      return ABIType.from('uint64').decode(bytes)\n  }\n}\n\nexport function encodeAVMValue(avmType: AVMType, value: ABIValue): Uint8Array {\n  switch (avmType) {\n    case 'AVMString':\n      return ABIType.from('string').encode(value)\n    case 'AVMBytes':\n      if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n      if (typeof value !== 'object' || !(value instanceof Uint8Array))\n        throw new Error(`Expected bytes value for AVMBytes, but got ${value}`)\n      return value\n    case 'AVMUint64':\n      return ABIType.from('uint64').encode(value)\n  }\n}\n\nexport function isAVMType(type: unknown): type is AVMType {\n  return typeof type === 'string' && (type === 'AVMString' || type === 'AVMBytes' || type === 'AVMUint64')\n}\n\nexport function getABIDecodedValue(type: AVMType | ABIType | ABIReferenceType, bytes: Uint8Array): ABIValue {\n  if (type === ABIReferenceType.Asset || type === ABIReferenceType.Application) {\n    return new ABIUintType(64).decode(bytes)\n  } else if (type === ABIReferenceType.Account) {\n    return new ABIAddressType().decode(bytes)\n  } else if (isAVMType(type)) {\n    return decodeAVMValue(type, bytes)\n  }\n  return type.decode(bytes)\n}\n\nexport function getABIEncodedValue(type: AVMType | ABIType, value: ABIValue): Uint8Array {\n  return isAVMType(type) ? encodeAVMValue(type, value) : type.encode(value)\n}\n"],"mappings":";;;;;;AAMA,IAAY,oEAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;;;AAEF,IAAY,gEAAL;AACL;AACA;AACA;;;AAuDF,IAAa,YAAb,MAAa,UAAU;CACrB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,QAOT;AACD,OAAK,OAAO,OAAO;AACnB,OAAK,cAAc,OAAO;AAC1B,OAAK,OAAO,OAAO;AACnB,OAAK,UAAU,OAAO;AACtB,OAAK,SAAS,OAAO;AACrB,OAAK,WAAW,OAAO;;;;;;CAOzB,eAAuB;EACrB,MAAM,OAAO,KAAK,KACf,KAAK,QAAQ;AACZ,OAAI,qBAAqB,IAAI,KAAK,IAAI,mBAAmB,IAAI,KAAK,CAAE,QAAO,IAAI;AAC/E,UAAO,IAAI,KAAK;IAChB,CACD,KAAK,IAAI;AAEZ,SAAO,GAAG,KAAK,KAAK,GAAG,KAAK,GADZ,KAAK,QAAQ,SAAS,SAAS,SAAS,KAAK,QAAQ,KAAK;;;;;;CAQ5E,cAA0B;EACxB,MAAM,OAAOA,kBAAO,WAAW,MAAM,KAAK,cAAc,CAAC;AACzD,SAAO,IAAI,WAAW,KAAK,MAAM,GAAG,EAAE,CAAC;;;;;;;;CASzC,OAAO,cAAc,WAA8B;EACjD,MAAM,YAAY,UAAU,QAAQ,IAAI;AACxC,MAAI,cAAc,GAChB,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,IAAI,UAAU;EACd,IAAI,QAAQ;AACZ,OAAK,IAAI,IAAI,WAAW,IAAI,UAAU,QAAQ,KAAK;GACjD,MAAM,OAAO,UAAU;AAEvB,OAAI,SAAS,IACX,UAAS;YACA,SAAS,KAAK;AACvB,QAAI,UAAU,EAEZ;AAGF,aAAS;AACT,QAAI,UAAU,GAAG;AACf,eAAU;AACV;;;;AAKN,MAAI,YAAY,GACd,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,MAAM,OAAO,UAAU,MAAM,GAAG,UAAU;EAC1C,MAAM,OAAOC,mCAAkB,UAAU,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,KAAK,MAAc;AACzF,OAAI,qBAAqB,EAAsB,IAAI,mBAAmB,EAAsB,CAC1F,QAAO,EAAE,MAAM,GAAuB;AAExC,UAAO,EAAE,MAAMC,yBAAQ,KAAK,EAAE,EAAE;IAChC;EACF,MAAM,aAAa,UAAU,MAAM,UAAU,EAAE;AAG/C,SAAO,IAAI,UAAU;GACnB;GACA;GACA,SALc,EAAE,MAAM,eAAe,SAAU,SAAmBA,yBAAQ,KAAK,WAAW,EAAE;GAM7F,CAAC;;;;;;;;;;AAWN,SAAgB,aAAa,uBAA+B,SAAmC;AAC7F,KAAI,CAAC,sBAAsB,SAAS,IAAI,EAAE;EACxC,MAAM,UAAU,QAAQ,QAAQ,QAAQ,MAAM,EAAE,SAAS,sBAAsB;AAC/E,MAAI,QAAQ,WAAW,EAAG,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACnH,MAAI,QAAQ,SAAS,EACnB,OAAM,IAAI,MACR,6BAA6B,sBAAsB,eACjD,QAAQ,KACT,oFAAoF,QAAQ,QAC1F,KAAK,MAAM,wBAAwB,EAAE,CAAC,CACtC,KAAK,KAAK,GACd;AAEH,SAAO,uBAAuB,QAAQ,IAAI,QAAQ;QAC7C;EACL,MAAM,SAAS,QAAQ,QAAQ,MAAM,MAAM,wBAAwB,EAAE,KAAK,sBAAsB;AAChG,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACtG,SAAO,uBAAuB,QAAQ,QAAQ;;;AAIlD,SAAgB,uBAAuB,QAAqB,SAAmC;AAC7F,KAAI,OAAO,OAAO,SAAS,YAAY,OAAO,OAAO,YAAY,YAAY,CAAC,MAAM,QAAQ,OAAO,KAAK,CACtG,OAAM,IAAI,MAAM,+BAA+B;CAGjD,MAAM,OAAO,OAAO,KAAK,KAAK,EAAE,MAAM,MAAM,MAAM,QAAQ,mBAAmB;EAC3E,MAAMC,wBAAqD,eACvD;GACE,MAAM,aAAa;GACnB,QAAQ,aAAa;GACrB,MAAM,aAAa,OAAQ,UAAU,aAAa,KAAK,GAAG,aAAa,OAAOD,yBAAQ,KAAK,aAAa,KAAK,GAAI;GAClH,GACD;AAEJ,MAAI,qBAAqB,KAAyB,IAAI,mBAAmB,KAAyB,CAChG,QAAO;GACC;GACN;GACA,aAAa;GACb,cAAc;GACf;AAGH,MAAI,OACF,QAAO;GACL,MAAME,+BAAc,WAAW,QAAQ,QAAQ,QAAQ;GACvD;GACA,aAAa;GACb,cAAc;GACf;AAGH,SAAO;GACL,MAAMF,yBAAQ,KAAK,KAAK;GACxB;GACA,aAAa;GACb,cAAc;GACf;GACD;CAEF,MAAM,UAAU;EACd,MACE,OAAO,QAAQ,SAAU,SACpB,SACD,OAAO,QAAQ,SACbE,+BAAc,WAAW,OAAO,QAAQ,QAAQ,QAAQ,QAAQ,GAChEF,yBAAQ,KAAK,OAAO,QAAQ,KAAK;EACzC,MAAM,OAAO,QAAQ;EACtB;AAED,QAAO,IAAI,UAAU;EACnB,MAAM,OAAO;EACb,aAAa,OAAO;EACpB;EACA;EACA,QAAQ,OAAO;EACf,UAAU,OAAO;EAClB,CAAC;;AAGJ,SAAgB,qBAAqB,MAAoD;AACvF,QACE,OAAO,SAAS,aACf,SAAS,mBAAmB,OAC3B,SAAS,mBAAmB,WAC5B,SAAS,mBAAmB,mBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB,iBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB;;AAIlC,SAAgB,mBAAmB,MAAkD;AACnF,QACE,OAAO,SAAS,aACf,SAAS,iBAAiB,WAAW,SAAS,iBAAiB,eAAe,SAAS,iBAAiB;;AAI7G,SAAgB,iBAAiB,MAAyC;AACxE,QAAO,CAAC,qBAAqB,KAAK,IAAI,CAAC,mBAAmB,KAAK;;AAGjE,SAAS,wBAAwB,QAA6B;CAC5D,MAAM,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI;AAEzD,QAAO,GAAG,OAAO,KAAK,GAAG,KAAK,GADd,OAAO,QAAQ;;AAIjC,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ;EAC7C,KAAK,WACH,QAAO;EACT,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;EAC7C,KAAK;AACH,OAAI,OAAO,UAAU,SAAU,QAAO,OAAO,KAAK,OAAO,QAAQ;AACjE,OAAI,OAAO,UAAU,YAAY,EAAE,iBAAiB,YAClD,OAAM,IAAI,MAAM,8CAA8C,QAAQ;AACxE,UAAO;EACT,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,UAAU,MAAgC;AACxD,QAAO,OAAO,SAAS,aAAa,SAAS,eAAe,SAAS,cAAc,SAAS;;AAG9F,SAAgB,mBAAmB,MAA4C,OAA6B;AAC1G,KAAI,SAAS,iBAAiB,SAAS,SAAS,iBAAiB,YAC/D,QAAO,IAAIG,6BAAY,GAAG,CAAC,OAAO,MAAM;UAC/B,SAAS,iBAAiB,QACnC,QAAO,IAAIC,iCAAgB,CAAC,OAAO,MAAM;UAChC,UAAU,KAAK,CACxB,QAAO,eAAe,MAAM,MAAM;AAEpC,QAAO,KAAK,OAAO,MAAM;;AAG3B,SAAgB,mBAAmB,MAAyB,OAA6B;AACvF,QAAO,UAAU,KAAK,GAAG,eAAe,MAAM,MAAM,GAAG,KAAK,OAAO,MAAM"}
+{"version":3,"file":"abi-method.js","names":["sha512","parseTupleContent","ABIType","convertedDefaultValue: ABIDefaultValue | undefined","ABIStructType","ABIUintType","ABIAddressType"],"sources":["../../../../packages/abi/src/abi-method.ts"],"sourcesContent":["import sha512 from 'js-sha512'\nimport { ABIAddressType, ABIStructType, ABIType, ABIUintType, parseTupleContent } from './abi-type'\nimport { ABIValue } from './abi-value'\nimport { ARC28Event } from './arc28-event'\nimport { AVMType, Arc56Contract, Arc56Method } from './arc56-contract'\n\nexport enum ABITransactionType {\n  Txn = 'txn',\n  Payment = 'pay',\n  KeyRegistration = 'keyreg',\n  AssetConfig = 'acfg',\n  AssetTransfer = 'axfer',\n  AssetFreeze = 'afrz',\n  AppCall = 'appl',\n}\nexport enum ABIReferenceType {\n  Account = 'account',\n  Application = 'application',\n  Asset = 'asset',\n}\nexport type ABIMethodArgType = ABIType | ABITransactionType | ABIReferenceType\nexport type ABIMethodReturnType = ABIType | 'void'\n\nexport type ABIMethodArg = {\n  type: ABIMethodArgType\n  name?: string\n  description?: string\n  defaultValue?: ABIDefaultValue\n}\n\nexport type ABIMethodReturn = {\n  type: ABIMethodReturnType\n  description?: string\n}\n\nexport type ABIDefaultValue = {\n  /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n  data: string\n  /** Where the default value is coming from */\n  source: DefaultValueSource\n  /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n  type?: ABIType | AVMType\n}\n\nexport enum DefaultValueSource {\n  Box = 'box',\n  Global = 'global',\n  Local = 'local',\n  Literal = 'literal',\n  Method = 'method',\n}\n\n/** Represents an ABI method return value with parsed data. */\nexport type ABIReturn =\n  | {\n      /** The method that was called. */\n      method: ABIMethod\n      /** The raw return value as bytes.\n       *\n       * This is the value from the last app call log with the first 4 bytes (the ABI return prefix) omitted.\n       */\n      rawReturnValue: Uint8Array\n      /** The parsed ABI return value. */\n      returnValue: ABIValue\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method: ABIMethod; decodeError?: Error }\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | ABIValue\n}\n\nexport class ABIMethod {\n  readonly name: string\n  readonly description?: string\n  readonly args: ABIMethodArg[]\n  readonly returns: ABIMethodReturn\n  readonly events?: ARC28Event[]\n  readonly readonly?: boolean\n\n  constructor(params: {\n    name: string\n    description?: string\n    args: ABIMethodArg[]\n    returns: ABIMethodReturn\n    events?: ARC28Event[]\n    readonly?: boolean\n  }) {\n    this.name = params.name\n    this.description = params.description\n    this.args = params.args\n    this.returns = params.returns\n    this.events = params.events\n    this.readonly = params.readonly\n  }\n\n  /**\n   * Returns the signature of this ABI method.\n   * @returns The signature, e.g. `my_method(unit64,string)bytes`\n   */\n  getSignature(): string {\n    const args = this.args\n      .map((arg) => {\n        if (argTypeIsTransaction(arg.type) || argTypeIsReference(arg.type)) return arg.type\n        return arg.type.name\n      })\n      .join(',')\n    const returns = this.returns.type === 'void' ? 'void' : this.returns.type.name\n    return `${this.name}(${args})${returns}`\n  }\n\n  /**\n   * Returns the method selector of this ABI method.\n   * @returns The 4-byte method selector\n   */\n  getSelector(): Uint8Array {\n    const hash = sha512.sha512_256.array(this.getSignature())\n    return new Uint8Array(hash.slice(0, 4))\n  }\n\n  /**\n   * Returns the ABI method object for a given method signature.\n   * @param signature The method signature\n   * e.g. `my_method(unit64,string)bytes`\n   * @returns The `ABIMethod`\n   */\n  static fromSignature(signature: string): ABIMethod {\n    const argsStart = signature.indexOf('(')\n    if (argsStart === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    let argsEnd = -1\n    let depth = 0\n    for (let i = argsStart; i < signature.length; i++) {\n      const char = signature[i]\n\n      if (char === '(') {\n        depth += 1\n      } else if (char === ')') {\n        if (depth === 0) {\n          // unpaired parenthesis\n          break\n        }\n\n        depth -= 1\n        if (depth === 0) {\n          argsEnd = i\n          break\n        }\n      }\n    }\n\n    if (argsEnd === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    const name = signature.slice(0, argsStart)\n    const args = parseTupleContent(signature.slice(argsStart + 1, argsEnd)).map((n: string) => {\n      if (argTypeIsTransaction(n as ABIMethodArgType) || argTypeIsReference(n as ABIMethodArgType)) {\n        return { type: n as ABIMethodArgType } satisfies ABIMethodArg\n      }\n      return { type: ABIType.from(n) } satisfies ABIMethodArg\n    })\n    const returnType = signature.slice(argsEnd + 1)\n    const returns = { type: returnType === 'void' ? ('void' as const) : ABIType.from(returnType) } satisfies ABIMethodReturn\n\n    return new ABIMethod({\n      name,\n      args,\n      returns,\n    })\n  }\n}\n\n/**\n * Returns the ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `ABIMethod`\n */\nexport function getABIMethod(methodNameOrSignature: string, appSpec: Arc56Contract): ABIMethod {\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => getArc56MethodSignature(m))\n          .join(', ')}`,\n      )\n    }\n    return arc56MethodToABIMethod(methods[0], appSpec)\n  } else {\n    const method = appSpec.methods.find((m) => getArc56MethodSignature(m) === methodNameOrSignature)\n    if (!method) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    return arc56MethodToABIMethod(method, appSpec)\n  }\n}\n\nexport function arc56MethodToABIMethod(method: Arc56Method, appSpec: Arc56Contract): ABIMethod {\n  if (typeof method.name !== 'string' || typeof method.returns !== 'object' || !Array.isArray(method.args)) {\n    throw new Error('Invalid ABIMethod parameters')\n  }\n\n  const args = method.args.map(({ type, name, desc, struct, defaultValue }) => {\n    const convertedDefaultValue: ABIDefaultValue | undefined = defaultValue\n      ? {\n          data: defaultValue.data,\n          source: defaultValue.source as DefaultValueSource,\n          type: defaultValue.type ? (isAVMType(defaultValue.type) ? defaultValue.type : ABIType.from(defaultValue.type)) : undefined,\n        }\n      : undefined\n\n    if (argTypeIsTransaction(type as ABIMethodArgType) || argTypeIsReference(type as ABIMethodArgType)) {\n      return {\n        type: type as ABIMethodArgType,\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    if (struct) {\n      return {\n        type: ABIStructType.fromStruct(struct, appSpec.structs),\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    return {\n      type: ABIType.from(type),\n      name,\n      description: desc,\n      defaultValue: convertedDefaultValue,\n    } satisfies ABIMethodArg\n  })\n\n  const returns = {\n    type:\n      method.returns.type === ('void' as const)\n        ? ('void' as const)\n        : method.returns.struct\n          ? ABIStructType.fromStruct(method.returns.struct, appSpec.structs)\n          : ABIType.from(method.returns.type),\n    description: method.returns.desc,\n  } satisfies ABIMethodReturn\n\n  return new ABIMethod({\n    name: method.name,\n    description: method.desc,\n    args,\n    returns,\n    events: method.events,\n    readonly: method.readonly,\n  })\n}\n\nexport function argTypeIsTransaction(type: ABIMethodArgType): type is ABITransactionType {\n  return (\n    typeof type === 'string' &&\n    (type === ABITransactionType.Txn ||\n      type === ABITransactionType.Payment ||\n      type === ABITransactionType.KeyRegistration ||\n      type === ABITransactionType.AssetConfig ||\n      type === ABITransactionType.AssetTransfer ||\n      type === ABITransactionType.AssetFreeze ||\n      type === ABITransactionType.AppCall)\n  )\n}\n\nexport function argTypeIsReference(type: ABIMethodArgType): type is ABIReferenceType {\n  return (\n    typeof type === 'string' &&\n    (type === ABIReferenceType.Account || type === ABIReferenceType.Application || type === ABIReferenceType.Asset)\n  )\n}\n\nexport function argTypeIsAbiType(type: ABIMethodArgType): type is ABIType {\n  return !argTypeIsTransaction(type) && !argTypeIsReference(type)\n}\n\nfunction getArc56MethodSignature(method: Arc56Method): string {\n  const args = method.args.map((arg) => arg.type).join(',')\n  const returns = method.returns.type\n  return `${method.name}(${args})${returns}`\n}\n\nexport function decodeAVMValue(avmType: AVMType, bytes: Uint8Array): ABIValue {\n  switch (avmType) {\n    case 'AVMString':\n      return Buffer.from(bytes).toString('utf-8')\n    case 'AVMBytes':\n      return bytes\n    case 'AVMUint64':\n      return ABIType.from('uint64').decode(bytes)\n  }\n}\n\nexport function encodeAVMValue(avmType: AVMType, value: ABIValue): Uint8Array {\n  switch (avmType) {\n    case 'AVMString':\n      return ABIType.from('string').encode(value)\n    case 'AVMBytes':\n      if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n      if (typeof value !== 'object' || !(value instanceof Uint8Array))\n        throw new Error(`Expected bytes value for AVMBytes, but got ${value}`)\n      return value\n    case 'AVMUint64':\n      return ABIType.from('uint64').encode(value)\n  }\n}\n\nexport function isAVMType(type: unknown): type is AVMType {\n  return typeof type === 'string' && (type === 'AVMString' || type === 'AVMBytes' || type === 'AVMUint64')\n}\n\nexport function getABIDecodedValue(type: AVMType | ABIType | ABIReferenceType, bytes: Uint8Array): ABIValue {\n  if (type === ABIReferenceType.Asset || type === ABIReferenceType.Application) {\n    return new ABIUintType(64).decode(bytes)\n  } else if (type === ABIReferenceType.Account) {\n    return new ABIAddressType().decode(bytes)\n  } else if (isAVMType(type)) {\n    return decodeAVMValue(type, bytes)\n  }\n  return type.decode(bytes)\n}\n\nexport function getABIEncodedValue(type: AVMType | ABIType, value: ABIValue): Uint8Array {\n  return isAVMType(type) ? encodeAVMValue(type, value) : type.encode(value)\n}\n"],"mappings":";;;;;;AAMA,IAAY,oEAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;;;AAEF,IAAY,gEAAL;AACL;AACA;AACA;;;AAuDF,IAAa,YAAb,MAAa,UAAU;CACrB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,QAOT;AACD,OAAK,OAAO,OAAO;AACnB,OAAK,cAAc,OAAO;AAC1B,OAAK,OAAO,OAAO;AACnB,OAAK,UAAU,OAAO;AACtB,OAAK,SAAS,OAAO;AACrB,OAAK,WAAW,OAAO;;;;;;CAOzB,eAAuB;EACrB,MAAM,OAAO,KAAK,KACf,KAAK,QAAQ;AACZ,OAAI,qBAAqB,IAAI,KAAK,IAAI,mBAAmB,IAAI,KAAK,CAAE,QAAO,IAAI;AAC/E,UAAO,IAAI,KAAK;IAChB,CACD,KAAK,IAAI;AAEZ,SAAO,GAAG,KAAK,KAAK,GAAG,KAAK,GADZ,KAAK,QAAQ,SAAS,SAAS,SAAS,KAAK,QAAQ,KAAK;;;;;;CAQ5E,cAA0B;EACxB,MAAM,OAAOA,kBAAO,WAAW,MAAM,KAAK,cAAc,CAAC;AACzD,SAAO,IAAI,WAAW,KAAK,MAAM,GAAG,EAAE,CAAC;;;;;;;;CASzC,OAAO,cAAc,WAA8B;EACjD,MAAM,YAAY,UAAU,QAAQ,IAAI;AACxC,MAAI,cAAc,GAChB,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,IAAI,UAAU;EACd,IAAI,QAAQ;AACZ,OAAK,IAAI,IAAI,WAAW,IAAI,UAAU,QAAQ,KAAK;GACjD,MAAM,OAAO,UAAU;AAEvB,OAAI,SAAS,IACX,UAAS;YACA,SAAS,KAAK;AACvB,QAAI,UAAU,EAEZ;AAGF,aAAS;AACT,QAAI,UAAU,GAAG;AACf,eAAU;AACV;;;;AAKN,MAAI,YAAY,GACd,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,MAAM,OAAO,UAAU,MAAM,GAAG,UAAU;EAC1C,MAAM,OAAOC,mCAAkB,UAAU,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,KAAK,MAAc;AACzF,OAAI,qBAAqB,EAAsB,IAAI,mBAAmB,EAAsB,CAC1F,QAAO,EAAE,MAAM,GAAuB;AAExC,UAAO,EAAE,MAAMC,yBAAQ,KAAK,EAAE,EAAE;IAChC;EACF,MAAM,aAAa,UAAU,MAAM,UAAU,EAAE;AAG/C,SAAO,IAAI,UAAU;GACnB;GACA;GACA,SALc,EAAE,MAAM,eAAe,SAAU,SAAmBA,yBAAQ,KAAK,WAAW,EAAE;GAM7F,CAAC;;;;;;;;;;AAWN,SAAgB,aAAa,uBAA+B,SAAmC;AAC7F,KAAI,CAAC,sBAAsB,SAAS,IAAI,EAAE;EACxC,MAAM,UAAU,QAAQ,QAAQ,QAAQ,MAAM,EAAE,SAAS,sBAAsB;AAC/E,MAAI,QAAQ,WAAW,EAAG,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACnH,MAAI,QAAQ,SAAS,EACnB,OAAM,IAAI,MACR,6BAA6B,sBAAsB,eACjD,QAAQ,KACT,oFAAoF,QAAQ,QAC1F,KAAK,MAAM,wBAAwB,EAAE,CAAC,CACtC,KAAK,KAAK,GACd;AAEH,SAAO,uBAAuB,QAAQ,IAAI,QAAQ;QAC7C;EACL,MAAM,SAAS,QAAQ,QAAQ,MAAM,MAAM,wBAAwB,EAAE,KAAK,sBAAsB;AAChG,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACtG,SAAO,uBAAuB,QAAQ,QAAQ;;;AAIlD,SAAgB,uBAAuB,QAAqB,SAAmC;AAC7F,KAAI,OAAO,OAAO,SAAS,YAAY,OAAO,OAAO,YAAY,YAAY,CAAC,MAAM,QAAQ,OAAO,KAAK,CACtG,OAAM,IAAI,MAAM,+BAA+B;CAGjD,MAAM,OAAO,OAAO,KAAK,KAAK,EAAE,MAAM,MAAM,MAAM,QAAQ,mBAAmB;EAC3E,MAAMC,wBAAqD,eACvD;GACE,MAAM,aAAa;GACnB,QAAQ,aAAa;GACrB,MAAM,aAAa,OAAQ,UAAU,aAAa,KAAK,GAAG,aAAa,OAAOD,yBAAQ,KAAK,aAAa,KAAK,GAAI;GAClH,GACD;AAEJ,MAAI,qBAAqB,KAAyB,IAAI,mBAAmB,KAAyB,CAChG,QAAO;GACC;GACN;GACA,aAAa;GACb,cAAc;GACf;AAGH,MAAI,OACF,QAAO;GACL,MAAME,+BAAc,WAAW,QAAQ,QAAQ,QAAQ;GACvD;GACA,aAAa;GACb,cAAc;GACf;AAGH,SAAO;GACL,MAAMF,yBAAQ,KAAK,KAAK;GACxB;GACA,aAAa;GACb,cAAc;GACf;GACD;CAEF,MAAM,UAAU;EACd,MACE,OAAO,QAAQ,SAAU,SACpB,SACD,OAAO,QAAQ,SACbE,+BAAc,WAAW,OAAO,QAAQ,QAAQ,QAAQ,QAAQ,GAChEF,yBAAQ,KAAK,OAAO,QAAQ,KAAK;EACzC,aAAa,OAAO,QAAQ;EAC7B;AAED,QAAO,IAAI,UAAU;EACnB,MAAM,OAAO;EACb,aAAa,OAAO;EACpB;EACA;EACA,QAAQ,OAAO;EACf,UAAU,OAAO;EAClB,CAAC;;AAGJ,SAAgB,qBAAqB,MAAoD;AACvF,QACE,OAAO,SAAS,aACf,SAAS,mBAAmB,OAC3B,SAAS,mBAAmB,WAC5B,SAAS,mBAAmB,mBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB,iBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB;;AAIlC,SAAgB,mBAAmB,MAAkD;AACnF,QACE,OAAO,SAAS,aACf,SAAS,iBAAiB,WAAW,SAAS,iBAAiB,eAAe,SAAS,iBAAiB;;AAI7G,SAAgB,iBAAiB,MAAyC;AACxE,QAAO,CAAC,qBAAqB,KAAK,IAAI,CAAC,mBAAmB,KAAK;;AAGjE,SAAS,wBAAwB,QAA6B;CAC5D,MAAM,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI;AAEzD,QAAO,GAAG,OAAO,KAAK,GAAG,KAAK,GADd,OAAO,QAAQ;;AAIjC,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ;EAC7C,KAAK,WACH,QAAO;EACT,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;EAC7C,KAAK;AACH,OAAI,OAAO,UAAU,SAAU,QAAO,OAAO,KAAK,OAAO,QAAQ;AACjE,OAAI,OAAO,UAAU,YAAY,EAAE,iBAAiB,YAClD,OAAM,IAAI,MAAM,8CAA8C,QAAQ;AACxE,UAAO;EACT,KAAK,YACH,QAAOA,yBAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,UAAU,MAAgC;AACxD,QAAO,OAAO,SAAS,aAAa,SAAS,eAAe,SAAS,cAAc,SAAS;;AAG9F,SAAgB,mBAAmB,MAA4C,OAA6B;AAC1G,KAAI,SAAS,iBAAiB,SAAS,SAAS,iBAAiB,YAC/D,QAAO,IAAIG,6BAAY,GAAG,CAAC,OAAO,MAAM;UAC/B,SAAS,iBAAiB,QACnC,QAAO,IAAIC,iCAAgB,CAAC,OAAO,MAAM;UAChC,UAAU,KAAK,CACxB,QAAO,eAAe,MAAM,MAAM;AAEpC,QAAO,KAAK,OAAO,MAAM;;AAG3B,SAAgB,mBAAmB,MAAyB,OAA6B;AACvF,QAAO,UAAU,KAAK,GAAG,eAAe,MAAM,MAAM,GAAG,KAAK,OAAO,MAAM"}

package/packages/abi/src/abi-method.mjs

@@ -137,7 +137,7 @@ function arc56MethodToABIMethod(method, appSpec) {
 	});
 	const returns = {
 		type: method.returns.type === "void" ? "void" : method.returns.struct ? ABIStructType.fromStruct(method.returns.struct, appSpec.structs) : ABIType.from(method.returns.type),
-		desc: method.returns.desc
+		description: method.returns.desc
 	};
 	return new ABIMethod({
 		name: method.name,

package/packages/abi/src/abi-method.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"abi-method.mjs","names":["convertedDefaultValue: ABIDefaultValue | undefined"],"sources":["../../../../packages/abi/src/abi-method.ts"],"sourcesContent":["import sha512 from 'js-sha512'\nimport { ABIAddressType, ABIStructType, ABIType, ABIUintType, parseTupleContent } from './abi-type'\nimport { ABIValue } from './abi-value'\nimport { ARC28Event } from './arc28-event'\nimport { AVMType, Arc56Contract, Arc56Method } from './arc56-contract'\n\nexport enum ABITransactionType {\n  Txn = 'txn',\n  Payment = 'pay',\n  KeyRegistration = 'keyreg',\n  AssetConfig = 'acfg',\n  AssetTransfer = 'axfer',\n  AssetFreeze = 'afrz',\n  AppCall = 'appl',\n}\nexport enum ABIReferenceType {\n  Account = 'account',\n  Application = 'application',\n  Asset = 'asset',\n}\nexport type ABIMethodArgType = ABIType | ABITransactionType | ABIReferenceType\nexport type ABIMethodReturnType = ABIType | 'void'\n\nexport type ABIMethodArg = {\n  type: ABIMethodArgType\n  name?: string\n  description?: string\n  defaultValue?: ABIDefaultValue\n}\n\nexport type ABIMethodReturn = {\n  type: ABIMethodReturnType\n  description?: string\n}\n\nexport type ABIDefaultValue = {\n  /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n  data: string\n  /** Where the default value is coming from */\n  source: DefaultValueSource\n  /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n  type?: ABIType | AVMType\n}\n\nexport enum DefaultValueSource {\n  Box = 'box',\n  Global = 'global',\n  Local = 'local',\n  Literal = 'literal',\n  Method = 'method',\n}\n\n/** Represents an ABI method return value with parsed data. */\nexport type ABIReturn =\n  | {\n      /** The method that was called. */\n      method: ABIMethod\n      /** The raw return value as bytes.\n       *\n       * This is the value from the last app call log with the first 4 bytes (the ABI return prefix) omitted.\n       */\n      rawReturnValue: Uint8Array\n      /** The parsed ABI return value. */\n      returnValue: ABIValue\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method: ABIMethod; decodeError: Error }\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | ABIValue\n}\n\nexport class ABIMethod {\n  readonly name: string\n  readonly description?: string\n  readonly args: ABIMethodArg[]\n  readonly returns: ABIMethodReturn\n  readonly events?: ARC28Event[]\n  readonly readonly?: boolean\n\n  constructor(params: {\n    name: string\n    description?: string\n    args: ABIMethodArg[]\n    returns: ABIMethodReturn\n    events?: ARC28Event[]\n    readonly?: boolean\n  }) {\n    this.name = params.name\n    this.description = params.description\n    this.args = params.args\n    this.returns = params.returns\n    this.events = params.events\n    this.readonly = params.readonly\n  }\n\n  /**\n   * Returns the signature of this ABI method.\n   * @returns The signature, e.g. `my_method(unit64,string)bytes`\n   */\n  getSignature(): string {\n    const args = this.args\n      .map((arg) => {\n        if (argTypeIsTransaction(arg.type) || argTypeIsReference(arg.type)) return arg.type\n        return arg.type.name\n      })\n      .join(',')\n    const returns = this.returns.type === 'void' ? 'void' : this.returns.type.name\n    return `${this.name}(${args})${returns}`\n  }\n\n  /**\n   * Returns the method selector of this ABI method.\n   * @returns The 4-byte method selector\n   */\n  getSelector(): Uint8Array {\n    const hash = sha512.sha512_256.array(this.getSignature())\n    return new Uint8Array(hash.slice(0, 4))\n  }\n\n  /**\n   * Returns the ABI method object for a given method signature.\n   * @param signature The method signature\n   * e.g. `my_method(unit64,string)bytes`\n   * @returns The `ABIMethod`\n   */\n  static fromSignature(signature: string): ABIMethod {\n    const argsStart = signature.indexOf('(')\n    if (argsStart === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    let argsEnd = -1\n    let depth = 0\n    for (let i = argsStart; i < signature.length; i++) {\n      const char = signature[i]\n\n      if (char === '(') {\n        depth += 1\n      } else if (char === ')') {\n        if (depth === 0) {\n          // unpaired parenthesis\n          break\n        }\n\n        depth -= 1\n        if (depth === 0) {\n          argsEnd = i\n          break\n        }\n      }\n    }\n\n    if (argsEnd === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    const name = signature.slice(0, argsStart)\n    const args = parseTupleContent(signature.slice(argsStart + 1, argsEnd)).map((n: string) => {\n      if (argTypeIsTransaction(n as ABIMethodArgType) || argTypeIsReference(n as ABIMethodArgType)) {\n        return { type: n as ABIMethodArgType } satisfies ABIMethodArg\n      }\n      return { type: ABIType.from(n) } satisfies ABIMethodArg\n    })\n    const returnType = signature.slice(argsEnd + 1)\n    const returns = { type: returnType === 'void' ? ('void' as const) : ABIType.from(returnType) } satisfies ABIMethodReturn\n\n    return new ABIMethod({\n      name,\n      args,\n      returns,\n    })\n  }\n}\n\n/**\n * Returns the ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `ABIMethod`\n */\nexport function getABIMethod(methodNameOrSignature: string, appSpec: Arc56Contract): ABIMethod {\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => getArc56MethodSignature(m))\n          .join(', ')}`,\n      )\n    }\n    return arc56MethodToABIMethod(methods[0], appSpec)\n  } else {\n    const method = appSpec.methods.find((m) => getArc56MethodSignature(m) === methodNameOrSignature)\n    if (!method) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    return arc56MethodToABIMethod(method, appSpec)\n  }\n}\n\nexport function arc56MethodToABIMethod(method: Arc56Method, appSpec: Arc56Contract): ABIMethod {\n  if (typeof method.name !== 'string' || typeof method.returns !== 'object' || !Array.isArray(method.args)) {\n    throw new Error('Invalid ABIMethod parameters')\n  }\n\n  const args = method.args.map(({ type, name, desc, struct, defaultValue }) => {\n    const convertedDefaultValue: ABIDefaultValue | undefined = defaultValue\n      ? {\n          data: defaultValue.data,\n          source: defaultValue.source as DefaultValueSource,\n          type: defaultValue.type ? (isAVMType(defaultValue.type) ? defaultValue.type : ABIType.from(defaultValue.type)) : undefined,\n        }\n      : undefined\n\n    if (argTypeIsTransaction(type as ABIMethodArgType) || argTypeIsReference(type as ABIMethodArgType)) {\n      return {\n        type: type as ABIMethodArgType,\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    if (struct) {\n      return {\n        type: ABIStructType.fromStruct(struct, appSpec.structs),\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    return {\n      type: ABIType.from(type),\n      name,\n      description: desc,\n      defaultValue: convertedDefaultValue,\n    } satisfies ABIMethodArg\n  })\n\n  const returns = {\n    type:\n      method.returns.type === ('void' as const)\n        ? ('void' as const)\n        : method.returns.struct\n          ? ABIStructType.fromStruct(method.returns.struct, appSpec.structs)\n          : ABIType.from(method.returns.type),\n    desc: method.returns.desc,\n  }\n\n  return new ABIMethod({\n    name: method.name,\n    description: method.desc,\n    args,\n    returns,\n    events: method.events,\n    readonly: method.readonly,\n  })\n}\n\nexport function argTypeIsTransaction(type: ABIMethodArgType): type is ABITransactionType {\n  return (\n    typeof type === 'string' &&\n    (type === ABITransactionType.Txn ||\n      type === ABITransactionType.Payment ||\n      type === ABITransactionType.KeyRegistration ||\n      type === ABITransactionType.AssetConfig ||\n      type === ABITransactionType.AssetTransfer ||\n      type === ABITransactionType.AssetFreeze ||\n      type === ABITransactionType.AppCall)\n  )\n}\n\nexport function argTypeIsReference(type: ABIMethodArgType): type is ABIReferenceType {\n  return (\n    typeof type === 'string' &&\n    (type === ABIReferenceType.Account || type === ABIReferenceType.Application || type === ABIReferenceType.Asset)\n  )\n}\n\nexport function argTypeIsAbiType(type: ABIMethodArgType): type is ABIType {\n  return !argTypeIsTransaction(type) && !argTypeIsReference(type)\n}\n\nfunction getArc56MethodSignature(method: Arc56Method): string {\n  const args = method.args.map((arg) => arg.type).join(',')\n  const returns = method.returns.type\n  return `${method.name}(${args})${returns}`\n}\n\nexport function decodeAVMValue(avmType: AVMType, bytes: Uint8Array): ABIValue {\n  switch (avmType) {\n    case 'AVMString':\n      return Buffer.from(bytes).toString('utf-8')\n    case 'AVMBytes':\n      return bytes\n    case 'AVMUint64':\n      return ABIType.from('uint64').decode(bytes)\n  }\n}\n\nexport function encodeAVMValue(avmType: AVMType, value: ABIValue): Uint8Array {\n  switch (avmType) {\n    case 'AVMString':\n      return ABIType.from('string').encode(value)\n    case 'AVMBytes':\n      if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n      if (typeof value !== 'object' || !(value instanceof Uint8Array))\n        throw new Error(`Expected bytes value for AVMBytes, but got ${value}`)\n      return value\n    case 'AVMUint64':\n      return ABIType.from('uint64').encode(value)\n  }\n}\n\nexport function isAVMType(type: unknown): type is AVMType {\n  return typeof type === 'string' && (type === 'AVMString' || type === 'AVMBytes' || type === 'AVMUint64')\n}\n\nexport function getABIDecodedValue(type: AVMType | ABIType | ABIReferenceType, bytes: Uint8Array): ABIValue {\n  if (type === ABIReferenceType.Asset || type === ABIReferenceType.Application) {\n    return new ABIUintType(64).decode(bytes)\n  } else if (type === ABIReferenceType.Account) {\n    return new ABIAddressType().decode(bytes)\n  } else if (isAVMType(type)) {\n    return decodeAVMValue(type, bytes)\n  }\n  return type.decode(bytes)\n}\n\nexport function getABIEncodedValue(type: AVMType | ABIType, value: ABIValue): Uint8Array {\n  return isAVMType(type) ? encodeAVMValue(type, value) : type.encode(value)\n}\n"],"mappings":";;;;AAMA,IAAY,oEAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;;;AAEF,IAAY,gEAAL;AACL;AACA;AACA;;;AAuDF,IAAa,YAAb,MAAa,UAAU;CACrB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,QAOT;AACD,OAAK,OAAO,OAAO;AACnB,OAAK,cAAc,OAAO;AAC1B,OAAK,OAAO,OAAO;AACnB,OAAK,UAAU,OAAO;AACtB,OAAK,SAAS,OAAO;AACrB,OAAK,WAAW,OAAO;;;;;;CAOzB,eAAuB;EACrB,MAAM,OAAO,KAAK,KACf,KAAK,QAAQ;AACZ,OAAI,qBAAqB,IAAI,KAAK,IAAI,mBAAmB,IAAI,KAAK,CAAE,QAAO,IAAI;AAC/E,UAAO,IAAI,KAAK;IAChB,CACD,KAAK,IAAI;AAEZ,SAAO,GAAG,KAAK,KAAK,GAAG,KAAK,GADZ,KAAK,QAAQ,SAAS,SAAS,SAAS,KAAK,QAAQ,KAAK;;;;;;CAQ5E,cAA0B;EACxB,MAAM,OAAO,OAAO,WAAW,MAAM,KAAK,cAAc,CAAC;AACzD,SAAO,IAAI,WAAW,KAAK,MAAM,GAAG,EAAE,CAAC;;;;;;;;CASzC,OAAO,cAAc,WAA8B;EACjD,MAAM,YAAY,UAAU,QAAQ,IAAI;AACxC,MAAI,cAAc,GAChB,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,IAAI,UAAU;EACd,IAAI,QAAQ;AACZ,OAAK,IAAI,IAAI,WAAW,IAAI,UAAU,QAAQ,KAAK;GACjD,MAAM,OAAO,UAAU;AAEvB,OAAI,SAAS,IACX,UAAS;YACA,SAAS,KAAK;AACvB,QAAI,UAAU,EAEZ;AAGF,aAAS;AACT,QAAI,UAAU,GAAG;AACf,eAAU;AACV;;;;AAKN,MAAI,YAAY,GACd,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,MAAM,OAAO,UAAU,MAAM,GAAG,UAAU;EAC1C,MAAM,OAAO,kBAAkB,UAAU,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,KAAK,MAAc;AACzF,OAAI,qBAAqB,EAAsB,IAAI,mBAAmB,EAAsB,CAC1F,QAAO,EAAE,MAAM,GAAuB;AAExC,UAAO,EAAE,MAAM,QAAQ,KAAK,EAAE,EAAE;IAChC;EACF,MAAM,aAAa,UAAU,MAAM,UAAU,EAAE;AAG/C,SAAO,IAAI,UAAU;GACnB;GACA;GACA,SALc,EAAE,MAAM,eAAe,SAAU,SAAmB,QAAQ,KAAK,WAAW,EAAE;GAM7F,CAAC;;;;;;;;;;AAWN,SAAgB,aAAa,uBAA+B,SAAmC;AAC7F,KAAI,CAAC,sBAAsB,SAAS,IAAI,EAAE;EACxC,MAAM,UAAU,QAAQ,QAAQ,QAAQ,MAAM,EAAE,SAAS,sBAAsB;AAC/E,MAAI,QAAQ,WAAW,EAAG,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACnH,MAAI,QAAQ,SAAS,EACnB,OAAM,IAAI,MACR,6BAA6B,sBAAsB,eACjD,QAAQ,KACT,oFAAoF,QAAQ,QAC1F,KAAK,MAAM,wBAAwB,EAAE,CAAC,CACtC,KAAK,KAAK,GACd;AAEH,SAAO,uBAAuB,QAAQ,IAAI,QAAQ;QAC7C;EACL,MAAM,SAAS,QAAQ,QAAQ,MAAM,MAAM,wBAAwB,EAAE,KAAK,sBAAsB;AAChG,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACtG,SAAO,uBAAuB,QAAQ,QAAQ;;;AAIlD,SAAgB,uBAAuB,QAAqB,SAAmC;AAC7F,KAAI,OAAO,OAAO,SAAS,YAAY,OAAO,OAAO,YAAY,YAAY,CAAC,MAAM,QAAQ,OAAO,KAAK,CACtG,OAAM,IAAI,MAAM,+BAA+B;CAGjD,MAAM,OAAO,OAAO,KAAK,KAAK,EAAE,MAAM,MAAM,MAAM,QAAQ,mBAAmB;EAC3E,MAAMA,wBAAqD,eACvD;GACE,MAAM,aAAa;GACnB,QAAQ,aAAa;GACrB,MAAM,aAAa,OAAQ,UAAU,aAAa,KAAK,GAAG,aAAa,OAAO,QAAQ,KAAK,aAAa,KAAK,GAAI;GAClH,GACD;AAEJ,MAAI,qBAAqB,KAAyB,IAAI,mBAAmB,KAAyB,CAChG,QAAO;GACC;GACN;GACA,aAAa;GACb,cAAc;GACf;AAGH,MAAI,OACF,QAAO;GACL,MAAM,cAAc,WAAW,QAAQ,QAAQ,QAAQ;GACvD;GACA,aAAa;GACb,cAAc;GACf;AAGH,SAAO;GACL,MAAM,QAAQ,KAAK,KAAK;GACxB;GACA,aAAa;GACb,cAAc;GACf;GACD;CAEF,MAAM,UAAU;EACd,MACE,OAAO,QAAQ,SAAU,SACpB,SACD,OAAO,QAAQ,SACb,cAAc,WAAW,OAAO,QAAQ,QAAQ,QAAQ,QAAQ,GAChE,QAAQ,KAAK,OAAO,QAAQ,KAAK;EACzC,MAAM,OAAO,QAAQ;EACtB;AAED,QAAO,IAAI,UAAU;EACnB,MAAM,OAAO;EACb,aAAa,OAAO;EACpB;EACA;EACA,QAAQ,OAAO;EACf,UAAU,OAAO;EAClB,CAAC;;AAGJ,SAAgB,qBAAqB,MAAoD;AACvF,QACE,OAAO,SAAS,aACf,SAAS,mBAAmB,OAC3B,SAAS,mBAAmB,WAC5B,SAAS,mBAAmB,mBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB,iBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB;;AAIlC,SAAgB,mBAAmB,MAAkD;AACnF,QACE,OAAO,SAAS,aACf,SAAS,iBAAiB,WAAW,SAAS,iBAAiB,eAAe,SAAS,iBAAiB;;AAI7G,SAAgB,iBAAiB,MAAyC;AACxE,QAAO,CAAC,qBAAqB,KAAK,IAAI,CAAC,mBAAmB,KAAK;;AAGjE,SAAS,wBAAwB,QAA6B;CAC5D,MAAM,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI;AAEzD,QAAO,GAAG,OAAO,KAAK,GAAG,KAAK,GADd,OAAO,QAAQ;;AAIjC,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ;EAC7C,KAAK,WACH,QAAO;EACT,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;EAC7C,KAAK;AACH,OAAI,OAAO,UAAU,SAAU,QAAO,OAAO,KAAK,OAAO,QAAQ;AACjE,OAAI,OAAO,UAAU,YAAY,EAAE,iBAAiB,YAClD,OAAM,IAAI,MAAM,8CAA8C,QAAQ;AACxE,UAAO;EACT,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,UAAU,MAAgC;AACxD,QAAO,OAAO,SAAS,aAAa,SAAS,eAAe,SAAS,cAAc,SAAS;;AAG9F,SAAgB,mBAAmB,MAA4C,OAA6B;AAC1G,KAAI,SAAS,iBAAiB,SAAS,SAAS,iBAAiB,YAC/D,QAAO,IAAI,YAAY,GAAG,CAAC,OAAO,MAAM;UAC/B,SAAS,iBAAiB,QACnC,QAAO,IAAI,gBAAgB,CAAC,OAAO,MAAM;UAChC,UAAU,KAAK,CACxB,QAAO,eAAe,MAAM,MAAM;AAEpC,QAAO,KAAK,OAAO,MAAM;;AAG3B,SAAgB,mBAAmB,MAAyB,OAA6B;AACvF,QAAO,UAAU,KAAK,GAAG,eAAe,MAAM,MAAM,GAAG,KAAK,OAAO,MAAM"}
+{"version":3,"file":"abi-method.mjs","names":["convertedDefaultValue: ABIDefaultValue | undefined"],"sources":["../../../../packages/abi/src/abi-method.ts"],"sourcesContent":["import sha512 from 'js-sha512'\nimport { ABIAddressType, ABIStructType, ABIType, ABIUintType, parseTupleContent } from './abi-type'\nimport { ABIValue } from './abi-value'\nimport { ARC28Event } from './arc28-event'\nimport { AVMType, Arc56Contract, Arc56Method } from './arc56-contract'\n\nexport enum ABITransactionType {\n  Txn = 'txn',\n  Payment = 'pay',\n  KeyRegistration = 'keyreg',\n  AssetConfig = 'acfg',\n  AssetTransfer = 'axfer',\n  AssetFreeze = 'afrz',\n  AppCall = 'appl',\n}\nexport enum ABIReferenceType {\n  Account = 'account',\n  Application = 'application',\n  Asset = 'asset',\n}\nexport type ABIMethodArgType = ABIType | ABITransactionType | ABIReferenceType\nexport type ABIMethodReturnType = ABIType | 'void'\n\nexport type ABIMethodArg = {\n  type: ABIMethodArgType\n  name?: string\n  description?: string\n  defaultValue?: ABIDefaultValue\n}\n\nexport type ABIMethodReturn = {\n  type: ABIMethodReturnType\n  description?: string\n}\n\nexport type ABIDefaultValue = {\n  /** Base64 encoded bytes, base64 ARC4 encoded uint64, or UTF-8 method selector */\n  data: string\n  /** Where the default value is coming from */\n  source: DefaultValueSource\n  /** How the data is encoded. This is the encoding for the data provided here, not the arg type */\n  type?: ABIType | AVMType\n}\n\nexport enum DefaultValueSource {\n  Box = 'box',\n  Global = 'global',\n  Local = 'local',\n  Literal = 'literal',\n  Method = 'method',\n}\n\n/** Represents an ABI method return value with parsed data. */\nexport type ABIReturn =\n  | {\n      /** The method that was called. */\n      method: ABIMethod\n      /** The raw return value as bytes.\n       *\n       * This is the value from the last app call log with the first 4 bytes (the ABI return prefix) omitted.\n       */\n      rawReturnValue: Uint8Array\n      /** The parsed ABI return value. */\n      returnValue: ABIValue\n      decodeError: undefined\n    }\n  | { rawReturnValue?: undefined; returnValue?: undefined; method: ABIMethod; decodeError?: Error }\n\n/** Decoded ARC-56 struct as a struct rather than a tuple. */\nexport type ABIStruct = {\n  [key: string]: ABIStruct | ABIValue\n}\n\nexport class ABIMethod {\n  readonly name: string\n  readonly description?: string\n  readonly args: ABIMethodArg[]\n  readonly returns: ABIMethodReturn\n  readonly events?: ARC28Event[]\n  readonly readonly?: boolean\n\n  constructor(params: {\n    name: string\n    description?: string\n    args: ABIMethodArg[]\n    returns: ABIMethodReturn\n    events?: ARC28Event[]\n    readonly?: boolean\n  }) {\n    this.name = params.name\n    this.description = params.description\n    this.args = params.args\n    this.returns = params.returns\n    this.events = params.events\n    this.readonly = params.readonly\n  }\n\n  /**\n   * Returns the signature of this ABI method.\n   * @returns The signature, e.g. `my_method(unit64,string)bytes`\n   */\n  getSignature(): string {\n    const args = this.args\n      .map((arg) => {\n        if (argTypeIsTransaction(arg.type) || argTypeIsReference(arg.type)) return arg.type\n        return arg.type.name\n      })\n      .join(',')\n    const returns = this.returns.type === 'void' ? 'void' : this.returns.type.name\n    return `${this.name}(${args})${returns}`\n  }\n\n  /**\n   * Returns the method selector of this ABI method.\n   * @returns The 4-byte method selector\n   */\n  getSelector(): Uint8Array {\n    const hash = sha512.sha512_256.array(this.getSignature())\n    return new Uint8Array(hash.slice(0, 4))\n  }\n\n  /**\n   * Returns the ABI method object for a given method signature.\n   * @param signature The method signature\n   * e.g. `my_method(unit64,string)bytes`\n   * @returns The `ABIMethod`\n   */\n  static fromSignature(signature: string): ABIMethod {\n    const argsStart = signature.indexOf('(')\n    if (argsStart === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    let argsEnd = -1\n    let depth = 0\n    for (let i = argsStart; i < signature.length; i++) {\n      const char = signature[i]\n\n      if (char === '(') {\n        depth += 1\n      } else if (char === ')') {\n        if (depth === 0) {\n          // unpaired parenthesis\n          break\n        }\n\n        depth -= 1\n        if (depth === 0) {\n          argsEnd = i\n          break\n        }\n      }\n    }\n\n    if (argsEnd === -1) {\n      throw new Error(`Invalid method signature: ${signature}`)\n    }\n\n    const name = signature.slice(0, argsStart)\n    const args = parseTupleContent(signature.slice(argsStart + 1, argsEnd)).map((n: string) => {\n      if (argTypeIsTransaction(n as ABIMethodArgType) || argTypeIsReference(n as ABIMethodArgType)) {\n        return { type: n as ABIMethodArgType } satisfies ABIMethodArg\n      }\n      return { type: ABIType.from(n) } satisfies ABIMethodArg\n    })\n    const returnType = signature.slice(argsEnd + 1)\n    const returns = { type: returnType === 'void' ? ('void' as const) : ABIType.from(returnType) } satisfies ABIMethodReturn\n\n    return new ABIMethod({\n      name,\n      args,\n      returns,\n    })\n  }\n}\n\n/**\n * Returns the ABI method object for a given method name or signature and ARC-56 app spec.\n * @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.\n * e.g. `my_method` or `my_method(unit64,string)bytes`\n * @param appSpec The app spec for the app\n * @returns The `ABIMethod`\n */\nexport function getABIMethod(methodNameOrSignature: string, appSpec: Arc56Contract): ABIMethod {\n  if (!methodNameOrSignature.includes('(')) {\n    const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature)\n    if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    if (methods.length > 1) {\n      throw new Error(\n        `Received a call to method ${methodNameOrSignature} in contract ${\n          appSpec.name\n        }, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods\n          .map((m) => getArc56MethodSignature(m))\n          .join(', ')}`,\n      )\n    }\n    return arc56MethodToABIMethod(methods[0], appSpec)\n  } else {\n    const method = appSpec.methods.find((m) => getArc56MethodSignature(m) === methodNameOrSignature)\n    if (!method) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`)\n    return arc56MethodToABIMethod(method, appSpec)\n  }\n}\n\nexport function arc56MethodToABIMethod(method: Arc56Method, appSpec: Arc56Contract): ABIMethod {\n  if (typeof method.name !== 'string' || typeof method.returns !== 'object' || !Array.isArray(method.args)) {\n    throw new Error('Invalid ABIMethod parameters')\n  }\n\n  const args = method.args.map(({ type, name, desc, struct, defaultValue }) => {\n    const convertedDefaultValue: ABIDefaultValue | undefined = defaultValue\n      ? {\n          data: defaultValue.data,\n          source: defaultValue.source as DefaultValueSource,\n          type: defaultValue.type ? (isAVMType(defaultValue.type) ? defaultValue.type : ABIType.from(defaultValue.type)) : undefined,\n        }\n      : undefined\n\n    if (argTypeIsTransaction(type as ABIMethodArgType) || argTypeIsReference(type as ABIMethodArgType)) {\n      return {\n        type: type as ABIMethodArgType,\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    if (struct) {\n      return {\n        type: ABIStructType.fromStruct(struct, appSpec.structs),\n        name,\n        description: desc,\n        defaultValue: convertedDefaultValue,\n      } satisfies ABIMethodArg\n    }\n\n    return {\n      type: ABIType.from(type),\n      name,\n      description: desc,\n      defaultValue: convertedDefaultValue,\n    } satisfies ABIMethodArg\n  })\n\n  const returns = {\n    type:\n      method.returns.type === ('void' as const)\n        ? ('void' as const)\n        : method.returns.struct\n          ? ABIStructType.fromStruct(method.returns.struct, appSpec.structs)\n          : ABIType.from(method.returns.type),\n    description: method.returns.desc,\n  } satisfies ABIMethodReturn\n\n  return new ABIMethod({\n    name: method.name,\n    description: method.desc,\n    args,\n    returns,\n    events: method.events,\n    readonly: method.readonly,\n  })\n}\n\nexport function argTypeIsTransaction(type: ABIMethodArgType): type is ABITransactionType {\n  return (\n    typeof type === 'string' &&\n    (type === ABITransactionType.Txn ||\n      type === ABITransactionType.Payment ||\n      type === ABITransactionType.KeyRegistration ||\n      type === ABITransactionType.AssetConfig ||\n      type === ABITransactionType.AssetTransfer ||\n      type === ABITransactionType.AssetFreeze ||\n      type === ABITransactionType.AppCall)\n  )\n}\n\nexport function argTypeIsReference(type: ABIMethodArgType): type is ABIReferenceType {\n  return (\n    typeof type === 'string' &&\n    (type === ABIReferenceType.Account || type === ABIReferenceType.Application || type === ABIReferenceType.Asset)\n  )\n}\n\nexport function argTypeIsAbiType(type: ABIMethodArgType): type is ABIType {\n  return !argTypeIsTransaction(type) && !argTypeIsReference(type)\n}\n\nfunction getArc56MethodSignature(method: Arc56Method): string {\n  const args = method.args.map((arg) => arg.type).join(',')\n  const returns = method.returns.type\n  return `${method.name}(${args})${returns}`\n}\n\nexport function decodeAVMValue(avmType: AVMType, bytes: Uint8Array): ABIValue {\n  switch (avmType) {\n    case 'AVMString':\n      return Buffer.from(bytes).toString('utf-8')\n    case 'AVMBytes':\n      return bytes\n    case 'AVMUint64':\n      return ABIType.from('uint64').decode(bytes)\n  }\n}\n\nexport function encodeAVMValue(avmType: AVMType, value: ABIValue): Uint8Array {\n  switch (avmType) {\n    case 'AVMString':\n      return ABIType.from('string').encode(value)\n    case 'AVMBytes':\n      if (typeof value === 'string') return Buffer.from(value, 'utf-8')\n      if (typeof value !== 'object' || !(value instanceof Uint8Array))\n        throw new Error(`Expected bytes value for AVMBytes, but got ${value}`)\n      return value\n    case 'AVMUint64':\n      return ABIType.from('uint64').encode(value)\n  }\n}\n\nexport function isAVMType(type: unknown): type is AVMType {\n  return typeof type === 'string' && (type === 'AVMString' || type === 'AVMBytes' || type === 'AVMUint64')\n}\n\nexport function getABIDecodedValue(type: AVMType | ABIType | ABIReferenceType, bytes: Uint8Array): ABIValue {\n  if (type === ABIReferenceType.Asset || type === ABIReferenceType.Application) {\n    return new ABIUintType(64).decode(bytes)\n  } else if (type === ABIReferenceType.Account) {\n    return new ABIAddressType().decode(bytes)\n  } else if (isAVMType(type)) {\n    return decodeAVMValue(type, bytes)\n  }\n  return type.decode(bytes)\n}\n\nexport function getABIEncodedValue(type: AVMType | ABIType, value: ABIValue): Uint8Array {\n  return isAVMType(type) ? encodeAVMValue(type, value) : type.encode(value)\n}\n"],"mappings":";;;;AAMA,IAAY,oEAAL;AACL;AACA;AACA;AACA;AACA;AACA;AACA;;;AAEF,IAAY,gEAAL;AACL;AACA;AACA;;;AAuDF,IAAa,YAAb,MAAa,UAAU;CACrB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,QAOT;AACD,OAAK,OAAO,OAAO;AACnB,OAAK,cAAc,OAAO;AAC1B,OAAK,OAAO,OAAO;AACnB,OAAK,UAAU,OAAO;AACtB,OAAK,SAAS,OAAO;AACrB,OAAK,WAAW,OAAO;;;;;;CAOzB,eAAuB;EACrB,MAAM,OAAO,KAAK,KACf,KAAK,QAAQ;AACZ,OAAI,qBAAqB,IAAI,KAAK,IAAI,mBAAmB,IAAI,KAAK,CAAE,QAAO,IAAI;AAC/E,UAAO,IAAI,KAAK;IAChB,CACD,KAAK,IAAI;AAEZ,SAAO,GAAG,KAAK,KAAK,GAAG,KAAK,GADZ,KAAK,QAAQ,SAAS,SAAS,SAAS,KAAK,QAAQ,KAAK;;;;;;CAQ5E,cAA0B;EACxB,MAAM,OAAO,OAAO,WAAW,MAAM,KAAK,cAAc,CAAC;AACzD,SAAO,IAAI,WAAW,KAAK,MAAM,GAAG,EAAE,CAAC;;;;;;;;CASzC,OAAO,cAAc,WAA8B;EACjD,MAAM,YAAY,UAAU,QAAQ,IAAI;AACxC,MAAI,cAAc,GAChB,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,IAAI,UAAU;EACd,IAAI,QAAQ;AACZ,OAAK,IAAI,IAAI,WAAW,IAAI,UAAU,QAAQ,KAAK;GACjD,MAAM,OAAO,UAAU;AAEvB,OAAI,SAAS,IACX,UAAS;YACA,SAAS,KAAK;AACvB,QAAI,UAAU,EAEZ;AAGF,aAAS;AACT,QAAI,UAAU,GAAG;AACf,eAAU;AACV;;;;AAKN,MAAI,YAAY,GACd,OAAM,IAAI,MAAM,6BAA6B,YAAY;EAG3D,MAAM,OAAO,UAAU,MAAM,GAAG,UAAU;EAC1C,MAAM,OAAO,kBAAkB,UAAU,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,KAAK,MAAc;AACzF,OAAI,qBAAqB,EAAsB,IAAI,mBAAmB,EAAsB,CAC1F,QAAO,EAAE,MAAM,GAAuB;AAExC,UAAO,EAAE,MAAM,QAAQ,KAAK,EAAE,EAAE;IAChC;EACF,MAAM,aAAa,UAAU,MAAM,UAAU,EAAE;AAG/C,SAAO,IAAI,UAAU;GACnB;GACA;GACA,SALc,EAAE,MAAM,eAAe,SAAU,SAAmB,QAAQ,KAAK,WAAW,EAAE;GAM7F,CAAC;;;;;;;;;;AAWN,SAAgB,aAAa,uBAA+B,SAAmC;AAC7F,KAAI,CAAC,sBAAsB,SAAS,IAAI,EAAE;EACxC,MAAM,UAAU,QAAQ,QAAQ,QAAQ,MAAM,EAAE,SAAS,sBAAsB;AAC/E,MAAI,QAAQ,WAAW,EAAG,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACnH,MAAI,QAAQ,SAAS,EACnB,OAAM,IAAI,MACR,6BAA6B,sBAAsB,eACjD,QAAQ,KACT,oFAAoF,QAAQ,QAC1F,KAAK,MAAM,wBAAwB,EAAE,CAAC,CACtC,KAAK,KAAK,GACd;AAEH,SAAO,uBAAuB,QAAQ,IAAI,QAAQ;QAC7C;EACL,MAAM,SAAS,QAAQ,QAAQ,MAAM,MAAM,wBAAwB,EAAE,KAAK,sBAAsB;AAChG,MAAI,CAAC,OAAQ,OAAM,IAAI,MAAM,yBAAyB,sBAAsB,MAAM,QAAQ,KAAK,OAAO;AACtG,SAAO,uBAAuB,QAAQ,QAAQ;;;AAIlD,SAAgB,uBAAuB,QAAqB,SAAmC;AAC7F,KAAI,OAAO,OAAO,SAAS,YAAY,OAAO,OAAO,YAAY,YAAY,CAAC,MAAM,QAAQ,OAAO,KAAK,CACtG,OAAM,IAAI,MAAM,+BAA+B;CAGjD,MAAM,OAAO,OAAO,KAAK,KAAK,EAAE,MAAM,MAAM,MAAM,QAAQ,mBAAmB;EAC3E,MAAMA,wBAAqD,eACvD;GACE,MAAM,aAAa;GACnB,QAAQ,aAAa;GACrB,MAAM,aAAa,OAAQ,UAAU,aAAa,KAAK,GAAG,aAAa,OAAO,QAAQ,KAAK,aAAa,KAAK,GAAI;GAClH,GACD;AAEJ,MAAI,qBAAqB,KAAyB,IAAI,mBAAmB,KAAyB,CAChG,QAAO;GACC;GACN;GACA,aAAa;GACb,cAAc;GACf;AAGH,MAAI,OACF,QAAO;GACL,MAAM,cAAc,WAAW,QAAQ,QAAQ,QAAQ;GACvD;GACA,aAAa;GACb,cAAc;GACf;AAGH,SAAO;GACL,MAAM,QAAQ,KAAK,KAAK;GACxB;GACA,aAAa;GACb,cAAc;GACf;GACD;CAEF,MAAM,UAAU;EACd,MACE,OAAO,QAAQ,SAAU,SACpB,SACD,OAAO,QAAQ,SACb,cAAc,WAAW,OAAO,QAAQ,QAAQ,QAAQ,QAAQ,GAChE,QAAQ,KAAK,OAAO,QAAQ,KAAK;EACzC,aAAa,OAAO,QAAQ;EAC7B;AAED,QAAO,IAAI,UAAU;EACnB,MAAM,OAAO;EACb,aAAa,OAAO;EACpB;EACA;EACA,QAAQ,OAAO;EACf,UAAU,OAAO;EAClB,CAAC;;AAGJ,SAAgB,qBAAqB,MAAoD;AACvF,QACE,OAAO,SAAS,aACf,SAAS,mBAAmB,OAC3B,SAAS,mBAAmB,WAC5B,SAAS,mBAAmB,mBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB,iBAC5B,SAAS,mBAAmB,eAC5B,SAAS,mBAAmB;;AAIlC,SAAgB,mBAAmB,MAAkD;AACnF,QACE,OAAO,SAAS,aACf,SAAS,iBAAiB,WAAW,SAAS,iBAAiB,eAAe,SAAS,iBAAiB;;AAI7G,SAAgB,iBAAiB,MAAyC;AACxE,QAAO,CAAC,qBAAqB,KAAK,IAAI,CAAC,mBAAmB,KAAK;;AAGjE,SAAS,wBAAwB,QAA6B;CAC5D,MAAM,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI;AAEzD,QAAO,GAAG,OAAO,KAAK,GAAG,KAAK,GADd,OAAO,QAAQ;;AAIjC,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,OAAO,KAAK,MAAM,CAAC,SAAS,QAAQ;EAC7C,KAAK,WACH,QAAO;EACT,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,eAAe,SAAkB,OAA6B;AAC5E,SAAQ,SAAR;EACE,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;EAC7C,KAAK;AACH,OAAI,OAAO,UAAU,SAAU,QAAO,OAAO,KAAK,OAAO,QAAQ;AACjE,OAAI,OAAO,UAAU,YAAY,EAAE,iBAAiB,YAClD,OAAM,IAAI,MAAM,8CAA8C,QAAQ;AACxE,UAAO;EACT,KAAK,YACH,QAAO,QAAQ,KAAK,SAAS,CAAC,OAAO,MAAM;;;AAIjD,SAAgB,UAAU,MAAgC;AACxD,QAAO,OAAO,SAAS,aAAa,SAAS,eAAe,SAAS,cAAc,SAAS;;AAG9F,SAAgB,mBAAmB,MAA4C,OAA6B;AAC1G,KAAI,SAAS,iBAAiB,SAAS,SAAS,iBAAiB,YAC/D,QAAO,IAAI,YAAY,GAAG,CAAC,OAAO,MAAM;UAC/B,SAAS,iBAAiB,QACnC,QAAO,IAAI,gBAAgB,CAAC,OAAO,MAAM;UAChC,UAAU,KAAK,CACxB,QAAO,eAAe,MAAM,MAAM;AAEpC,QAAO,KAAK,OAAO,MAAM;;AAG3B,SAAgB,mBAAmB,MAAyB,OAA6B;AACvF,QAAO,UAAU,KAAK,GAAG,eAAe,MAAM,MAAM,GAAG,KAAK,OAAO,MAAM"}

package/packages/abi/src/abi-type.d.ts

@@ -114,7 +114,7 @@ declare class ABIAddressType extends ABIType {
   isDynamic(): boolean;
   byteLen(): number;
   encode(value: ABIValue): Uint8Array;
-  decode(bytes: Uint8Array): ABIValue;
+  decode(bytes: Uint8Array): string;
 }
 /**
  * A boolean ABI type.
@@ -244,8 +244,6 @@ declare class ABIStructType extends ABIType {
   static fromStruct(structName: string, structs: Record<string, StructField[]>): ABIStructType;
   encode(value: ABIValue): Uint8Array;
   decode(bytes: Uint8Array): ABIStructValue;
-  private getTupleValueFromStructValue;
-  private getStructValueFromTupleValue;
 }
 declare function parseTupleContent(content: string): string[];
 //#endregion

package/packages/abi/src/abi-type.js

@@ -2,6 +2,7 @@ const require_array = require('../../common/src/array.js');
 const require_constants = require('../../common/src/constants.js');
 const require_address = require('../../common/src/address.js');
 const require_bigint = require('./bigint.js');
+const require_utils = require('./utils.js');
 
 //#region packages/abi/src/abi-type.ts
 const STATIC_ARRAY_REGEX = /^([a-z\d[\](),]+)\[(0|[1-9][\d]*)]$/;
@@ -167,10 +168,11 @@ var ABIAddressType = class ABIAddressType extends ABIType {
 	encode(value) {
 		if (typeof value === "string") return require_address.Address.fromString(value).publicKey;
 		if (value instanceof require_address.Address) return value.publicKey;
+		if (value instanceof Uint8Array && value.length === 32) return value;
 		throw new Error(`Cannot encode value as address: ${value}`);
 	}
 	decode(bytes) {
-		return new require_address.Address(bytes);
+		return new require_address.Address(bytes).toString();
 	}
 };
 /**
@@ -526,46 +528,15 @@ var ABIStructType = class ABIStructType extends ABIType {
 		})));
 	}
 	encode(value) {
-		if (typeof value !== "object" || Array.isArray(value) || value instanceof Uint8Array || value instanceof require_address.Address) throw new Error(`Cannot encode value as ${this.name}: ${value}`);
+		if (value instanceof Uint8Array || value instanceof require_address.Address || typeof value !== "object") throw new Error(`Cannot encode value as ${this.name}: ${value}`);
 		const tupleType = this.toABITupleType();
-		const tupleValue = this.getTupleValueFromStructValue(value);
+		if (Array.isArray(value)) return tupleType.encode(value);
+		const tupleValue = require_utils.getTupleValueFromStructValue(this, value);
 		return tupleType.encode(tupleValue);
 	}
 	decode(bytes) {
 		const tupleValue = this.toABITupleType().decode(bytes);
-		return this.getStructValueFromTupleValue(tupleValue);
-	}
-	getTupleValueFromStructValue(structValue) {
-		const getTupleValueFromStructFields = (structFields, values) => {
-			return structFields.map(({ type }, index) => {
-				if (Array.isArray(type)) {
-					const value = values[index];
-					return getTupleValueFromStructFields(type, Object.values(value));
-				}
-				if (type instanceof ABIStructType) {
-					const value = values[index];
-					return getTupleValueFromStructFields(type.structFields, Object.values(value));
-				}
-				return values[index];
-			});
-		};
-		return getTupleValueFromStructFields(this.structFields, Object.values(structValue));
-	}
-	getStructValueFromTupleValue(tupleValue) {
-		const getStructFieldValues = (structFields, values) => {
-			return Object.fromEntries(structFields.map(({ name, type }, index) => {
-				if (Array.isArray(type)) {
-					const value = values[index];
-					return [name, getStructFieldValues(type, value)];
-				}
-				if (type instanceof ABIStructType) {
-					const value = values[index];
-					return [name, getStructFieldValues(type.structFields, value)];
-				}
-				return [name, values[index]];
-			}));
-		};
-		return getStructFieldValues(this.structFields, tupleValue);
+		return require_utils.getStructValueFromTupleValue(this, tupleValue);
 	}
 };
 function compressBools(values) {