@algorandfoundation/algokit-client-generator 2.6.0-beta.1 → 2.6.1-beta.1

package/schema/application.schema.json.mjs

@@ -0,0 +1,363 @@
+var $schema = "http://json-schema.org/draft-07/schema";
+var title = "AlgoAppSpec";
+var type = "object";
+var required = [
+	"contract",
+	"schema",
+	"source",
+	"state"
+];
+var additionalProperties = true;
+var properties = {
+	hints: {
+		type: "object",
+		additionalProperties: {
+			$ref: "#/definitions/Hint"
+		}
+	},
+	source: {
+		$ref: "#/definitions/AppSources"
+	},
+	contract: {
+		$ref: "contract.schema.json"
+	},
+	schema: {
+		$ref: "#/definitions/SchemaSpec"
+	},
+	state: {
+		$ref: "#/definitions/StateSchemaSpec"
+	},
+	bare_call_config: {
+		$ref: "#/definitions/CallConfig"
+	}
+};
+var definitions = {
+	AVMType: {
+		description: "AVM data type",
+		"enum": [
+			"uint64",
+			"bytes"
+		]
+	},
+	DeclaredSchemaValueSpec: {
+		type: "object",
+		required: [
+			"type",
+			"key"
+		],
+		additionalProperties: true,
+		properties: {
+			type: {
+				description: "The type of the value",
+				$ref: "#/definitions/AVMType"
+			},
+			key: {
+				description: "The name of the key",
+				type: "string"
+			},
+			descr: {
+				description: "A description of the variable",
+				type: "string"
+			},
+			"static": {
+				description: "Whether the value is set statically (at create time only) or dynamically",
+				type: "boolean"
+			}
+		}
+	},
+	ReservedSchemaValueSpec: {
+		type: "object",
+		required: [
+			"type"
+		],
+		properties: {
+			type: {
+				description: "The type of the value",
+				$ref: "#/definitions/AVMType"
+			},
+			descr: {
+				description: "A description of the variable",
+				type: "string"
+			},
+			max_keys: {
+				description: "The maximum number of slots to reserve",
+				type: "integer"
+			}
+		}
+	},
+	StateSchemaSpec: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"global",
+			"local"
+		],
+		properties: {
+			global: {
+				$ref: "#/definitions/StateSchema"
+			},
+			local: {
+				$ref: "#/definitions/StateSchema"
+			}
+		}
+	},
+	StateSchema: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"num_byte_slices",
+			"num_uints"
+		],
+		properties: {
+			num_uints: {
+				type: "integer"
+			},
+			num_byte_slices: {
+				type: "integer"
+			}
+		}
+	},
+	SchemaSpec: {
+		description: "The schema for global and local storage",
+		type: "object",
+		additionalProperties: true,
+		properties: {
+			global: {
+				$ref: "#/definitions/Schema"
+			},
+			local: {
+				$ref: "#/definitions/Schema"
+			}
+		}
+	},
+	Schema: {
+		type: "object",
+		additionalProperties: true,
+		properties: {
+			declared: {
+				type: "object",
+				additionalProperties: {
+					$ref: "#/definitions/DeclaredSchemaValueSpec"
+				}
+			},
+			reserved: {
+				type: "object",
+				additionalProperties: {
+					$ref: "#/definitions/ReservedSchemaValueSpec"
+				}
+			}
+		}
+	},
+	AppSources: {
+		type: "object",
+		additionalProperties: true,
+		properties: {
+			approval: {
+				type: "string"
+			},
+			clear: {
+				type: "string"
+			}
+		}
+	},
+	Hint: {
+		type: "object",
+		additionalProperties: true,
+		properties: {
+			read_only: {
+				type: "boolean"
+			},
+			structs: {
+				type: "object",
+				properties: {
+					output: {
+						$ref: "#/definitions/Struct"
+					}
+				},
+				additionalProperties: {
+					$ref: "#/definitions/Struct"
+				}
+			},
+			default_arguments: {
+				additionalProperties: {
+					$ref: "#/definitions/DefaultArgument"
+				}
+			},
+			call_config: {
+				$ref: "#/definitions/CallConfig"
+			}
+		}
+	},
+	CallConfig: {
+		type: "object",
+		additionalProperties: false,
+		properties: {
+			no_op: {
+				$ref: "#/definitions/CallConfigValue"
+			},
+			opt_in: {
+				$ref: "#/definitions/CallConfigValue"
+			},
+			close_out: {
+				$ref: "#/definitions/CallConfigValue"
+			},
+			update_application: {
+				$ref: "#/definitions/CallConfigValue"
+			},
+			delete_application: {
+				$ref: "#/definitions/CallConfigValue"
+			}
+		}
+	},
+	CallConfigValue: {
+		"enum": [
+			"NEVER",
+			"CALL",
+			"CREATE",
+			"ALL"
+		]
+	},
+	Struct: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"elements"
+		],
+		properties: {
+			name: {
+				type: "string"
+			},
+			elements: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/StructElement"
+				}
+			}
+		}
+	},
+	FieldName: {
+		type: "string"
+	},
+	ABIType: {
+		type: "string"
+	},
+	StructElement: {
+		type: "array",
+		minItems: 2,
+		items: [
+			{
+				$ref: "#/definitions/FieldName"
+			},
+			{
+				$ref: "#/definitions/ABIType"
+			}
+		]
+	},
+	DefaultArgument: {
+		description: "Defines a strategy for obtaining a default value for a given ABI arg.",
+		oneOf: [
+			{
+				type: "object",
+				required: [
+					"source",
+					"data"
+				],
+				additionalProperties: true,
+				properties: {
+					source: {
+						description: "The default value should be fetched by invoking an ABI method",
+						"enum": [
+							"abi-method"
+						]
+					},
+					data: {
+						description: "The contract of the ABI method to invoke.",
+						$ref: "contract.schema.json#/definitions/ContractMethod"
+					}
+				}
+			},
+			{
+				type: "object",
+				required: [
+					"source",
+					"data"
+				],
+				additionalProperties: true,
+				properties: {
+					source: {
+						description: "The default value should be fetched from global state",
+						"enum": [
+							"global-state"
+						]
+					},
+					data: {
+						description: "The key of the state variable",
+						type: "string"
+					}
+				}
+			},
+			{
+				type: "object",
+				required: [
+					"source",
+					"data"
+				],
+				additionalProperties: true,
+				properties: {
+					source: {
+						description: "The default value should be fetched from the local state of the sender user",
+						"enum": [
+							"local-state"
+						]
+					},
+					data: {
+						description: "The key of the state variable",
+						type: "string"
+					}
+				}
+			},
+			{
+				type: "object",
+				required: [
+					"source",
+					"data"
+				],
+				additionalProperties: true,
+				properties: {
+					source: {
+						description: "The default value is a constant.",
+						"enum": [
+							"constant"
+						]
+					},
+					data: {
+						description: "The static default value to use.",
+						anyOf: [
+							{
+								type: "string"
+							},
+							{
+								type: "number"
+							},
+							{
+								type: "integer"
+							}
+						]
+					}
+				}
+			}
+		]
+	}
+};
+var appJsonSchema = {
+	$schema: $schema,
+	title: title,
+	type: type,
+	required: required,
+	additionalProperties: additionalProperties,
+	properties: properties,
+	definitions: definitions
+};
+
+export { $schema, additionalProperties, appJsonSchema as default, definitions, properties, required, title, type };

package/schema/contract.schema.json.cjs

@@ -0,0 +1,159 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var $schema = "http://json-schema.org/draft-07/schema";
+var title = "AbiContract";
+var type = "object";
+var required = [
+	"name",
+	"methods"
+];
+var additionalProperties = true;
+var properties = {
+	name: {
+		type: "string"
+	},
+	desc: {
+		type: "string"
+	},
+	methods: {
+		type: "array",
+		items: {
+			$ref: "#/definitions/ContractMethod"
+		}
+	},
+	events: {
+		type: "array",
+		items: {
+			$ref: "#/definitions/Event"
+		}
+	},
+	networks: {
+		type: "object",
+		additionalProperties: {
+			type: "object",
+			required: [
+				"appID"
+			],
+			additionalProperties: true,
+			properties: {
+				appID: {
+					type: "number"
+				}
+			}
+		}
+	}
+};
+var definitions = {
+	ContractMethod: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"args",
+			"returns"
+		],
+		properties: {
+			name: {
+				type: "string"
+			},
+			args: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/ContractMethodArg"
+				}
+			},
+			desc: {
+				type: "string"
+			},
+			returns: {
+				type: "object",
+				additionalProperties: true,
+				required: [
+					"type"
+				],
+				properties: {
+					desc: {
+						type: "string"
+					},
+					type: {
+						$ref: "#/definitions/ABIType"
+					}
+				}
+			},
+			readonly: {
+				type: "boolean"
+			},
+			events: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/Event"
+				}
+			}
+		}
+	},
+	Event: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"args"
+		],
+		properties: {
+			name: {
+				type: "string"
+			},
+			args: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/ContractMethodArg"
+				}
+			},
+			desc: {
+				type: "string"
+			}
+		}
+	},
+	ContractMethodArg: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"type"
+		],
+		properties: {
+			desc: {
+				type: "string"
+			},
+			type: {
+				$ref: "#/definitions/ABIType"
+			},
+			name: {
+				type: "string"
+			}
+		}
+	},
+	ABIType: {
+		description: "Catch all for fixed length arrays and tuples",
+		type: "string"
+	}
+};
+var contractSchema = {
+	$schema: $schema,
+	title: title,
+	type: type,
+	required: required,
+	additionalProperties: additionalProperties,
+	properties: properties,
+	definitions: definitions
+};
+
+exports.$schema = $schema;
+exports.additionalProperties = additionalProperties;
+exports.default = contractSchema;
+exports.definitions = definitions;
+exports.properties = properties;
+exports.required = required;
+exports.title = title;
+exports.type = type;

package/schema/contract.schema.json.mjs

@@ -0,0 +1,148 @@
+var $schema = "http://json-schema.org/draft-07/schema";
+var title = "AbiContract";
+var type = "object";
+var required = [
+	"name",
+	"methods"
+];
+var additionalProperties = true;
+var properties = {
+	name: {
+		type: "string"
+	},
+	desc: {
+		type: "string"
+	},
+	methods: {
+		type: "array",
+		items: {
+			$ref: "#/definitions/ContractMethod"
+		}
+	},
+	events: {
+		type: "array",
+		items: {
+			$ref: "#/definitions/Event"
+		}
+	},
+	networks: {
+		type: "object",
+		additionalProperties: {
+			type: "object",
+			required: [
+				"appID"
+			],
+			additionalProperties: true,
+			properties: {
+				appID: {
+					type: "number"
+				}
+			}
+		}
+	}
+};
+var definitions = {
+	ContractMethod: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"args",
+			"returns"
+		],
+		properties: {
+			name: {
+				type: "string"
+			},
+			args: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/ContractMethodArg"
+				}
+			},
+			desc: {
+				type: "string"
+			},
+			returns: {
+				type: "object",
+				additionalProperties: true,
+				required: [
+					"type"
+				],
+				properties: {
+					desc: {
+						type: "string"
+					},
+					type: {
+						$ref: "#/definitions/ABIType"
+					}
+				}
+			},
+			readonly: {
+				type: "boolean"
+			},
+			events: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/Event"
+				}
+			}
+		}
+	},
+	Event: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"args"
+		],
+		properties: {
+			name: {
+				type: "string"
+			},
+			args: {
+				type: "array",
+				items: {
+					$ref: "#/definitions/ContractMethodArg"
+				}
+			},
+			desc: {
+				type: "string"
+			}
+		}
+	},
+	ContractMethodArg: {
+		type: "object",
+		additionalProperties: true,
+		required: [
+			"name",
+			"type"
+		],
+		properties: {
+			desc: {
+				type: "string"
+			},
+			type: {
+				$ref: "#/definitions/ABIType"
+			},
+			name: {
+				type: "string"
+			}
+		}
+	},
+	ABIType: {
+		description: "Catch all for fixed length arrays and tuples",
+		type: "string"
+	}
+};
+var contractSchema = {
+	$schema: $schema,
+	title: title,
+	type: type,
+	required: required,
+	additionalProperties: additionalProperties,
+	properties: properties,
+	definitions: definitions
+};
+
+export { $schema, additionalProperties, contractSchema as default, definitions, properties, required, title, type };

package/schema/load.cjs

@@ -0,0 +1,25 @@
+'use strict';
+
+var jsonschema = require('jsonschema');
+var boom = require('../util/boom.cjs');
+var application_schema = require('./application.schema.json.cjs');
+var contract_schema = require('./contract.schema.json.cjs');
+
+async function loadApplicationJson(appJsonPath) {
+    const fs = await import('fs');
+    if (!fs.existsSync(appJsonPath))
+        boom.boom(`Could not find application.json file at ${appJsonPath}`);
+    const file = JSON.parse(fs.readFileSync(appJsonPath, 'utf-8'));
+    return validateApplicationJson(file);
+}
+function validateApplicationJson(json) {
+    const validator = new jsonschema.Validator();
+    validator.addSchema(contract_schema.default, '/contract.schema.json');
+    const result = validator.validate(json, application_schema.default);
+    if (!result.valid)
+        boom.boom(result.toString());
+    return json;
+}
+
+exports.loadApplicationJson = loadApplicationJson;
+exports.validateApplicationJson = validateApplicationJson;

package/schema/load.d.ts

@@ -1,4 +1,3 @@
 import { AlgoAppSpec } from './application';
 export declare function loadApplicationJson(appJsonPath: string): Promise<AlgoAppSpec>;
 export declare function validateApplicationJson(json: unknown): AlgoAppSpec;
-//# sourceMappingURL=load.d.ts.map

package/schema/load.mjs

@@ -0,0 +1,22 @@
+import { Validator } from 'jsonschema';
+import { boom } from '../util/boom.mjs';
+import appJsonSchema from './application.schema.json.mjs';
+import contractSchema from './contract.schema.json.mjs';
+
+async function loadApplicationJson(appJsonPath) {
+    const fs = await import('fs');
+    if (!fs.existsSync(appJsonPath))
+        boom(`Could not find application.json file at ${appJsonPath}`);
+    const file = JSON.parse(fs.readFileSync(appJsonPath, 'utf-8'));
+    return validateApplicationJson(file);
+}
+function validateApplicationJson(json) {
+    const validator = new Validator();
+    validator.addSchema(contractSchema, '/contract.schema.json');
+    const result = validator.validate(json, appJsonSchema);
+    if (!result.valid)
+        boom(result.toString());
+    return json;
+}
+
+export { loadApplicationJson, validateApplicationJson };

package/tests/approval-tests.spec.d.ts

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=approval-tests.spec.d.ts.map

package/tests/util.d.ts

@@ -0,0 +1 @@
+export declare const setUpLocalnet: () => Promise<import("@algorandfoundation/algokit-utils/types/testing").AlgorandFixture>;