@algorandfoundation/algokit-utils 9.2.0-beta.7 → 10.0.0-alpha.1

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

@@ -0,0 +1,196 @@
+import { ABIAddressType, ABIStructType, ABIType, ABIUintType, parseTupleContent } from "./abi-type.mjs";
+import sha512 from "js-sha512";
+
+//#region packages/abi/src/abi-method.ts
+let ABITransactionType = /* @__PURE__ */ function(ABITransactionType$1) {
+	ABITransactionType$1["Txn"] = "txn";
+	ABITransactionType$1["Payment"] = "pay";
+	ABITransactionType$1["KeyRegistration"] = "keyreg";
+	ABITransactionType$1["AssetConfig"] = "acfg";
+	ABITransactionType$1["AssetTransfer"] = "axfer";
+	ABITransactionType$1["AssetFreeze"] = "afrz";
+	ABITransactionType$1["AppCall"] = "appl";
+	return ABITransactionType$1;
+}({});
+let ABIReferenceType = /* @__PURE__ */ function(ABIReferenceType$1) {
+	ABIReferenceType$1["Account"] = "account";
+	ABIReferenceType$1["Application"] = "application";
+	ABIReferenceType$1["Asset"] = "asset";
+	return ABIReferenceType$1;
+}({});
+var ABIMethod = class ABIMethod {
+	name;
+	description;
+	args;
+	returns;
+	events;
+	readonly;
+	constructor(params) {
+		this.name = params.name;
+		this.description = params.description;
+		this.args = params.args;
+		this.returns = params.returns;
+		this.events = params.events;
+		this.readonly = params.readonly;
+	}
+	/**
+	* Returns the signature of this ABI method.
+	* @returns The signature, e.g. `my_method(unit64,string)bytes`
+	*/
+	getSignature() {
+		const args = this.args.map((arg) => {
+			if (argTypeIsTransaction(arg.type) || argTypeIsReference(arg.type)) return arg.type;
+			return arg.type.name;
+		}).join(",");
+		return `${this.name}(${args})${this.returns.type === "void" ? "void" : this.returns.type.name}`;
+	}
+	/**
+	* Returns the method selector of this ABI method.
+	* @returns The 4-byte method selector
+	*/
+	getSelector() {
+		const hash = sha512.sha512_256.array(this.getSignature());
+		return new Uint8Array(hash.slice(0, 4));
+	}
+	/**
+	* Returns the ABI method object for a given method signature.
+	* @param signature The method signature
+	* e.g. `my_method(unit64,string)bytes`
+	* @returns The `ABIMethod`
+	*/
+	static fromSignature(signature) {
+		const argsStart = signature.indexOf("(");
+		if (argsStart === -1) throw new Error(`Invalid method signature: ${signature}`);
+		let argsEnd = -1;
+		let depth = 0;
+		for (let i = argsStart; i < signature.length; i++) {
+			const char = signature[i];
+			if (char === "(") depth += 1;
+			else if (char === ")") {
+				if (depth === 0) break;
+				depth -= 1;
+				if (depth === 0) {
+					argsEnd = i;
+					break;
+				}
+			}
+		}
+		if (argsEnd === -1) throw new Error(`Invalid method signature: ${signature}`);
+		const name = signature.slice(0, argsStart);
+		const args = parseTupleContent(signature.slice(argsStart + 1, argsEnd)).map((n) => {
+			if (argTypeIsTransaction(n) || argTypeIsReference(n)) return { type: n };
+			return { type: ABIType.from(n) };
+		});
+		const returnType = signature.slice(argsEnd + 1);
+		return new ABIMethod({
+			name,
+			args,
+			returns: { type: returnType === "void" ? "void" : ABIType.from(returnType) }
+		});
+	}
+};
+/**
+* Returns the ABI method object for a given method name or signature and ARC-56 app spec.
+* @param methodNameOrSignature The method name or method signature to call if an ABI call is being emitted.
+* e.g. `my_method` or `my_method(unit64,string)bytes`
+* @param appSpec The app spec for the app
+* @returns The `ABIMethod`
+*/
+function getABIMethod(methodNameOrSignature, appSpec) {
+	if (!methodNameOrSignature.includes("(")) {
+		const methods = appSpec.methods.filter((m) => m.name === methodNameOrSignature);
+		if (methods.length === 0) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+		if (methods.length > 1) throw new Error(`Received a call to method ${methodNameOrSignature} in contract ${appSpec.name}, but this resolved to multiple methods; please pass in an ABI signature instead: ${appSpec.methods.map((m) => getArc56MethodSignature(m)).join(", ")}`);
+		return arc56MethodToABIMethod(methods[0], appSpec);
+	} else {
+		const method = appSpec.methods.find((m) => getArc56MethodSignature(m) === methodNameOrSignature);
+		if (!method) throw new Error(`Unable to find method ${methodNameOrSignature} in ${appSpec.name} app.`);
+		return arc56MethodToABIMethod(method, appSpec);
+	}
+}
+function arc56MethodToABIMethod(method, appSpec) {
+	if (typeof method.name !== "string" || typeof method.returns !== "object" || !Array.isArray(method.args)) throw new Error("Invalid ABIMethod parameters");
+	const args = method.args.map(({ type, name, desc, struct, defaultValue }) => {
+		const convertedDefaultValue = defaultValue ? {
+			data: defaultValue.data,
+			source: defaultValue.source,
+			type: defaultValue.type ? isAVMType(defaultValue.type) ? defaultValue.type : ABIType.from(defaultValue.type) : void 0
+		} : void 0;
+		if (argTypeIsTransaction(type) || argTypeIsReference(type)) return {
+			type,
+			name,
+			description: desc,
+			defaultValue: convertedDefaultValue
+		};
+		if (struct) return {
+			type: ABIStructType.fromStruct(struct, appSpec.structs),
+			name,
+			description: desc,
+			defaultValue: convertedDefaultValue
+		};
+		return {
+			type: ABIType.from(type),
+			name,
+			description: desc,
+			defaultValue: convertedDefaultValue
+		};
+	});
+	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
+	};
+	return new ABIMethod({
+		name: method.name,
+		description: method.desc,
+		args,
+		returns,
+		events: method.events,
+		readonly: method.readonly
+	});
+}
+function argTypeIsTransaction(type) {
+	return typeof type === "string" && (type === ABITransactionType.Txn || type === ABITransactionType.Payment || type === ABITransactionType.KeyRegistration || type === ABITransactionType.AssetConfig || type === ABITransactionType.AssetTransfer || type === ABITransactionType.AssetFreeze || type === ABITransactionType.AppCall);
+}
+function argTypeIsReference(type) {
+	return typeof type === "string" && (type === ABIReferenceType.Account || type === ABIReferenceType.Application || type === ABIReferenceType.Asset);
+}
+function argTypeIsAbiType(type) {
+	return !argTypeIsTransaction(type) && !argTypeIsReference(type);
+}
+function getArc56MethodSignature(method) {
+	const args = method.args.map((arg) => arg.type).join(",");
+	return `${method.name}(${args})${method.returns.type}`;
+}
+function decodeAVMValue(avmType, bytes) {
+	switch (avmType) {
+		case "AVMString": return Buffer.from(bytes).toString("utf-8");
+		case "AVMBytes": return bytes;
+		case "AVMUint64": return ABIType.from("uint64").decode(bytes);
+	}
+}
+function encodeAVMValue(avmType, value) {
+	switch (avmType) {
+		case "AVMString": return ABIType.from("string").encode(value);
+		case "AVMBytes":
+			if (typeof value === "string") return Buffer.from(value, "utf-8");
+			if (typeof value !== "object" || !(value instanceof Uint8Array)) throw new Error(`Expected bytes value for AVMBytes, but got ${value}`);
+			return value;
+		case "AVMUint64": return ABIType.from("uint64").encode(value);
+	}
+}
+function isAVMType(type) {
+	return typeof type === "string" && (type === "AVMString" || type === "AVMBytes" || type === "AVMUint64");
+}
+function getABIDecodedValue(type, bytes) {
+	if (type === ABIReferenceType.Asset || type === ABIReferenceType.Application) return new ABIUintType(64).decode(bytes);
+	else if (type === ABIReferenceType.Account) return new ABIAddressType().decode(bytes);
+	else if (isAVMType(type)) return decodeAVMValue(type, bytes);
+	return type.decode(bytes);
+}
+function getABIEncodedValue(type, value) {
+	return isAVMType(type) ? encodeAVMValue(type, value) : type.encode(value);
+}
+
+//#endregion
+export { ABIMethod, ABIReferenceType, ABITransactionType, arc56MethodToABIMethod, argTypeIsAbiType, argTypeIsReference, argTypeIsTransaction, decodeAVMValue, getABIDecodedValue, getABIEncodedValue, getABIMethod, isAVMType };
+//# sourceMappingURL=abi-method.mjs.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,253 @@
+import { ABIStructValue, ABIValue } from "./abi-value.js";
+import { StructField } from "./arc56-contract.js";
+
+//#region packages/abi/src/abi-type.d.ts
+
+/**
+ * Information about a single field in a struct
+ */
+type ABIStructField = {
+  /** The name of the struct field */
+  name: string;
+  /** The type of the struct field's value */
+  type: ABIType | ABIStructField[];
+};
+/**
+ * Represents an Algorand ABI type for encoding and decoding values as defined in [ARC-0004](https://arc.algorand.foundation/ARCs/arc-0004#types).
+ *
+ * This is the abstract base class for all ABI types.
+ */
+declare abstract class ABIType {
+  /**
+   * Returns the ARC-4 type name string representation.
+   * @returns The ARC-4 type string
+   */
+  abstract get name(): string;
+  /**
+   * Returns a user-friendly display name for this type.
+   * @returns The display name for this type
+   */
+  get displayName(): string;
+  /**
+   * Returns the ARC-4 type name string representation.
+   * @returns The ARC-4 type string
+   */
+  toString(): string;
+  /**
+   * Checks if this ABI type is equal to another.
+   * @param other The other ABI type to compare with
+   * @returns True if the types are equal, false otherwise
+   */
+  abstract equals(other: ABIType): boolean;
+  /**
+   * Checks if this ABI type is dynamic (variable-length).
+   * @returns True if the type is dynamic, false otherwise
+   */
+  abstract isDynamic(): boolean;
+  /**
+   * Gets the byte length of the encoded type for static types.
+   * @returns The number of bytes needed to encode this type
+   * @throws Error if the type is dynamic
+   */
+  abstract byteLen(): number;
+  /**
+   * Encodes a value according to this ABI type.
+   * @param value The value to encode
+   * @returns The encoded bytes
+   */
+  abstract encode(value: ABIValue): Uint8Array;
+  /**
+   * Decodes bytes according to this ABI type.
+   * @param bytes The bytes to decode
+   * @returns The decoded value
+   */
+  abstract decode(bytes: Uint8Array): ABIValue;
+  /**
+   * Creates an ABI type from an ARC-4 type string.
+   * @param str The ARC-4 type string (e.g., "uint256", "bool", "(uint8,address)")
+   * @returns The corresponding ABI type
+   */
+  static from(str: string): ABIType;
+}
+/**
+ * An unsigned integer ABI type of a specific bit size.
+ */
+declare class ABIUintType extends ABIType {
+  readonly bitSize: number;
+  /**
+   * Creates a new unsigned integer type.
+   * @param bitSize The bit size (must be a multiple of 8, between 8 and 512)
+   */
+  constructor(bitSize: number);
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * A fixed-point number ABI type of a specific bit size and precision.
+ */
+declare class ABIUfixedType extends ABIType {
+  readonly bitSize: number;
+  readonly precision: number;
+  /**
+   * Creates a new fixed-point type.
+   * @param bitSize The bit size (must be a multiple of 8, between 8 and 512)
+   * @param precision The decimal precision (must be between 1 and 160)
+   */
+  constructor(bitSize: number, precision: number);
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * An Algorand address ABI type.
+ */
+declare class ABIAddressType extends ABIType {
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * A boolean ABI type.
+ */
+declare class ABIBoolType extends ABIType {
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * A single byte ABI type.
+ */
+declare class ABIByteType extends ABIType {
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * A dynamic-length string ABI type.
+ */
+declare class ABIStringType extends ABIType {
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue;
+}
+/**
+ * A tuple ABI type containing other ABI types.
+ */
+declare class ABITupleType extends ABIType {
+  readonly childTypes: ABIType[];
+  /**
+   * Creates a new tuple type.
+   * @param childTypes The types of the tuple elements
+   */
+  constructor(childTypes: ABIType[]);
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue[];
+}
+/**
+ * A static-length array ABI type.
+ */
+declare class ABIArrayStaticType extends ABIType {
+  readonly childType: ABIType;
+  readonly length: number;
+  /**
+   * Creates a new static array type.
+   * @param childType The type of the array elements
+   * @param length The fixed length of the array
+   */
+  constructor(childType: ABIType, length: number);
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  /**
+   * Converts this static array type to an equivalent tuple type.
+   * @returns The equivalent tuple type
+   */
+  toABITupleType(): ABITupleType;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue[] | Uint8Array;
+}
+/**
+ * A dynamic-length array ABI type.
+ */
+declare class ABIArrayDynamicType extends ABIType {
+  readonly childType: ABIType;
+  /**
+   * Creates a new dynamic array type.
+   * @param childType The type of the array elements
+   */
+  constructor(childType: ABIType);
+  get name(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  /**
+   * Converts this dynamic array type to an equivalent tuple type of a given length.
+   * @param length The number of elements
+   * @returns The equivalent tuple type
+   */
+  toABITupleType(length: number): ABITupleType;
+  encode(value: ABIValue): Uint8Array;
+  decode(bytes: Uint8Array): ABIValue[] | Uint8Array;
+}
+/**
+ * A struct ABI type with named fields.
+ */
+declare class ABIStructType extends ABIType {
+  readonly structName: string;
+  readonly structFields: ABIStructField[];
+  /**
+   * Creates a new struct type.
+   * @param structName The name of the struct
+   * @param structFields The fields of the struct
+   */
+  constructor(structName: string, structFields: ABIStructField[]);
+  get name(): string;
+  get displayName(): string;
+  equals(other: ABIType): boolean;
+  isDynamic(): boolean;
+  byteLen(): number;
+  /**
+   * Converts this struct type to an equivalent tuple type.
+   * @returns The equivalent tuple type
+   */
+  toABITupleType(): ABITupleType;
+  /**
+   * Creates an ABIStructType from struct name and struct definitions.
+   * @param structName The name of the struct
+   * @param structs A record of struct definitions
+   * @returns The struct type
+   */
+  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
+export { ABIAddressType, ABIArrayDynamicType, ABIArrayStaticType, ABIBoolType, ABIByteType, ABIStringType, ABIStructField, ABIStructType, ABITupleType, ABIType, ABIUfixedType, ABIUintType, parseTupleContent };
+//# sourceMappingURL=abi-type.d.ts.map