@algorandfoundation/algokit-client-generator 4.0.0-beta.1 → 4.0.0-beta.3

package/schema/arc56.schema.json.js

@@ -10,12 +10,35 @@ var definitions = {
 		type: "string"
 	},
 	AVMBytes: {
-		"const": "bytes",
+		"const": "AVMBytes",
 		description: "Raw byteslice without the length prefixed that is specified in ARC-4",
 		type: "string"
 	},
+	AVMString: {
+		"const": "AVMString",
+		description: "A utf-8 string without the length prefix that is specified in ARC-4",
+		type: "string"
+	},
+	AVMType: {
+		anyOf: [
+			{
+				$ref: "#/definitions/AVMBytes"
+			},
+			{
+				$ref: "#/definitions/AVMString"
+			},
+			{
+				$ref: "#/definitions/AVMUint64"
+			}
+		],
+		description: "A native AVM type"
+	},
+	AVMUint64: {
+		"const": "AVMUint64",
+		description: "A 64-bit unsigned integer",
+		type: "string"
+	},
 	Arc56Contract: {
-		additionalProperties: false,
 		description: "Describes the entire contract. This interface is an extension of the interface described in ARC-4",
 		properties: {
 			arcs: {
@@ -26,7 +49,6 @@ var definitions = {
 				type: "array"
 			},
 			bareActions: {
-				additionalProperties: false,
 				description: "Supported bare actions for the contract. An action is a combination of call/create and an OnComplete",
 				properties: {
 					call: {
@@ -64,7 +86,6 @@ var definitions = {
 				type: "object"
 			},
 			byteCode: {
-				additionalProperties: false,
 				description: "The compiled bytecode for the application. MUST be omitted if included as part of ARC23",
 				properties: {
 					approval: {
@@ -83,7 +104,6 @@ var definitions = {
 				type: "object"
 			},
 			compilerInfo: {
-				additionalProperties: false,
 				description: "Information used to get the given byteCode and/or PC values in sourceInfo. MUST be given if byteCode or PC values are present",
 				properties: {
 					compiler: {
@@ -95,10 +115,9 @@ var definitions = {
 						type: "string"
 					},
 					compilerVersion: {
-						additionalProperties: false,
 						description: "Compiler version information",
 						properties: {
-							commit: {
+							commitHash: {
 								type: "string"
 							},
 							major: {
@@ -149,8 +168,6 @@ var definitions = {
 			},
 			networks: {
 				additionalProperties: {
-					additionalProperties: false,
-					description: "The key is the base64 genesis hash of the network, and the value contains information about the deployed contract in the network indicated by the key. A key containing the human-readable name of the network MAY be included, but the corresponding genesis hash key MUST also be defined",
 					properties: {
 						appID: {
 							description: "The app ID of the deployed contract in this network",
@@ -162,12 +179,11 @@ var definitions = {
 					],
 					type: "object"
 				},
-				description: "Optional object listing the contract instances across different networks",
+				description: "Optional object listing the contract instances across different networks. The key is the base64 genesis hash of the network, and the value contains information about the deployed contract in the network indicated by the key. A key containing the human-readable name of the network MAY be included, but the corresponding genesis hash key MUST also be define",
 				type: "object"
 			},
 			scratchVariables: {
 				additionalProperties: {
-					additionalProperties: false,
 					properties: {
 						slot: {
 							type: "number"
@@ -178,7 +194,7 @@ var definitions = {
 									$ref: "#/definitions/ABIType"
 								},
 								{
-									$ref: "#/definitions/AVMBytes"
+									$ref: "#/definitions/AVMType"
 								},
 								{
 									$ref: "#/definitions/StructName"
@@ -196,7 +212,6 @@ var definitions = {
 				type: "object"
 			},
 			source: {
-				additionalProperties: false,
 				description: "The pre-compiled TEAL that may contain template variables. MUST be omitted if included as part of ARC23",
 				properties: {
 					approval: {
@@ -215,7 +230,6 @@ var definitions = {
 				type: "object"
 			},
 			sourceInfo: {
-				additionalProperties: false,
 				description: "Information about the TEAL programs",
 				properties: {
 					approval: {
@@ -240,10 +254,8 @@ var definitions = {
 				type: "object"
 			},
 			state: {
-				additionalProperties: false,
 				properties: {
 					keys: {
-						additionalProperties: false,
 						description: "Mapping of human-readable names to StorageKey objects",
 						properties: {
 							box: {
@@ -273,7 +285,6 @@ var definitions = {
 						type: "object"
 					},
 					maps: {
-						additionalProperties: false,
 						description: "Mapping of human-readable names to StorageMap objects",
 						properties: {
 							box: {
@@ -303,11 +314,9 @@ var definitions = {
 						type: "object"
 					},
 					schema: {
-						additionalProperties: false,
 						description: "Defines the values that should be used for GlobalNumUint, GlobalNumByteSlice, LocalNumUint, and LocalNumByteSlice when creating the application",
 						properties: {
 							global: {
-								additionalProperties: false,
 								properties: {
 									bytes: {
 										type: "number"
@@ -323,7 +332,6 @@ var definitions = {
 								type: "object"
 							},
 							local: {
-								additionalProperties: false,
 								properties: {
 									bytes: {
 										type: "number"
@@ -355,14 +363,16 @@ var definitions = {
 			},
 			structs: {
 				additionalProperties: {
-					$ref: "#/definitions/StructFields"
+					items: {
+						$ref: "#/definitions/StructField"
+					},
+					type: "array"
 				},
-				description: "Named structs use by the application",
+				description: "Named structs use by the application. Each struct field appears in the same order as ABI encoding.",
 				type: "object"
 			},
 			templateVariables: {
 				additionalProperties: {
-					additionalProperties: false,
 					properties: {
 						type: {
 							anyOf: [
@@ -370,7 +380,7 @@ var definitions = {
 									$ref: "#/definitions/ABIType"
 								},
 								{
-									$ref: "#/definitions/AVMBytes"
+									$ref: "#/definitions/AVMType"
 								},
 								{
 									$ref: "#/definitions/StructName"
@@ -403,13 +413,11 @@ var definitions = {
 		type: "object"
 	},
 	Event: {
-		additionalProperties: false,
 		description: "ARC-28 event",
 		properties: {
 			args: {
 				description: "The arguments of the event, in order",
 				items: {
-					additionalProperties: false,
 					properties: {
 						desc: {
 							description: "Optional, user-friendly description for the argument",
@@ -425,7 +433,7 @@ var definitions = {
 						},
 						type: {
 							$ref: "#/definitions/ABIType",
-							description: "The type of the argument"
+							description: "The type of the argument. The `struct` field should also be checked to determine if this return value is a struct."
 						}
 					},
 					required: [
@@ -451,11 +459,9 @@ var definitions = {
 		type: "object"
 	},
 	Method: {
-		additionalProperties: false,
 		description: "Describes a method in the contract. This interface is an extension of the interface described in ARC-4",
 		properties: {
 			actions: {
-				additionalProperties: false,
 				description: "an action is a combination of call/create and an OnComplete",
 				properties: {
 					call: {
@@ -495,11 +501,45 @@ var definitions = {
 			args: {
 				description: "The arguments of the method, in order",
 				items: {
-					additionalProperties: false,
 					properties: {
 						defaultValue: {
-							description: "The default value that clients should use. MUST be base64 encoded bytes",
-							type: "string"
+							description: "The default value that clients should use.",
+							properties: {
+								data: {
+									description: "Base64 encoded bytes or uint64",
+									type: [
+										"string",
+										"number"
+									]
+								},
+								source: {
+									description: "Where the default value is coming from\n- box: The data key signifies the box key to read the value from\n- global: The data key signifies the global state key to read the value from\n- local: The data key signifies the local state key to read the value from (for the sender)\n- literal: the value is a literal and should be passed directly as the argument",
+									"enum": [
+										"box",
+										"global",
+										"local",
+										"literal"
+									],
+									type: "string"
+								},
+								type: {
+									anyOf: [
+										{
+											$ref: "#/definitions/ABIType"
+										},
+										{
+											$ref: "#/definitions/AVMType"
+										}
+									],
+									description: "How the data is encoded. This is the encoding for the data provided here, not the arg type"
+								}
+							},
+							required: [
+								"data",
+								"type",
+								"source"
+							],
+							type: "object"
 						},
 						desc: {
 							description: "Optional, user-friendly description for the argument",
@@ -515,7 +555,7 @@ var definitions = {
 						},
 						type: {
 							$ref: "#/definitions/ABIType",
-							description: "The type of the argument"
+							description: "The type of the argument. The `struct` field should also be checked to determine if this arg is a struct."
 						}
 					},
 					required: [
@@ -545,7 +585,6 @@ var definitions = {
 				type: "boolean"
 			},
 			recommendations: {
-				additionalProperties: false,
 				description: "Information that clients can use when calling the method",
 				properties: {
 					accounts: {
@@ -570,7 +609,6 @@ var definitions = {
 						type: "array"
 					},
 					boxes: {
-						additionalProperties: false,
 						description: "Recommended box references to include",
 						properties: {
 							app: {
@@ -605,7 +643,6 @@ var definitions = {
 				type: "object"
 			},
 			returns: {
-				additionalProperties: false,
 				description: "Information about the method's return value",
 				properties: {
 					desc: {
@@ -618,7 +655,7 @@ var definitions = {
 					},
 					type: {
 						$ref: "#/definitions/ABIType",
-						description: "The type of the return value, or \"void\" to indicate no return value."
+						description: "The type of the return value, or \"void\" to indicate no return value. The `struct` field should also be checked to determine if this return value is a struct."
 					}
 				},
 				required: [
@@ -636,7 +673,6 @@ var definitions = {
 		type: "object"
 	},
 	SourceInfo: {
-		additionalProperties: true,
 		properties: {
 			disassembledTeal: {
 				description: "The line of the dissasembled TEAL this line of pre-compiled TEAL corresponds to",
@@ -661,7 +697,6 @@ var definitions = {
 		type: "object"
 	},
 	StorageKey: {
-		additionalProperties: false,
 		description: "Describes a single key in app storage",
 		properties: {
 			desc: {
@@ -678,7 +713,7 @@ var definitions = {
 						$ref: "#/definitions/ABIType"
 					},
 					{
-						$ref: "#/definitions/AVMBytes"
+						$ref: "#/definitions/AVMType"
 					},
 					{
 						$ref: "#/definitions/StructName"
@@ -692,7 +727,7 @@ var definitions = {
 						$ref: "#/definitions/ABIType"
 					},
 					{
-						$ref: "#/definitions/AVMBytes"
+						$ref: "#/definitions/AVMType"
 					},
 					{
 						$ref: "#/definitions/StructName"
@@ -709,7 +744,6 @@ var definitions = {
 		type: "object"
 	},
 	StorageMap: {
-		additionalProperties: false,
 		description: "Describes a mapping of key-value pairs in storage",
 		properties: {
 			desc: {
@@ -722,7 +756,7 @@ var definitions = {
 						$ref: "#/definitions/ABIType"
 					},
 					{
-						$ref: "#/definitions/AVMBytes"
+						$ref: "#/definitions/AVMType"
 					},
 					{
 						$ref: "#/definitions/StructName"
@@ -740,7 +774,7 @@ var definitions = {
 						$ref: "#/definitions/ABIType"
 					},
 					{
-						$ref: "#/definitions/AVMBytes"
+						$ref: "#/definitions/AVMType"
 					},
 					{
 						$ref: "#/definitions/StructName"
@@ -755,18 +789,35 @@ var definitions = {
 		],
 		type: "object"
 	},
-	StructFields: {
-		additionalProperties: {
-			anyOf: [
-				{
-					$ref: "#/definitions/ABIType"
-				},
-				{
-					$ref: "#/definitions/StructFields"
-				}
-			]
+	StructField: {
+		description: "Information about a single field in a struct",
+		properties: {
+			name: {
+				description: "The name of the struct field",
+				type: "string"
+			},
+			type: {
+				anyOf: [
+					{
+						$ref: "#/definitions/ABIType"
+					},
+					{
+						$ref: "#/definitions/StructName"
+					},
+					{
+						items: {
+							$ref: "#/definitions/StructField"
+						},
+						type: "array"
+					}
+				],
+				description: "The type of the struct field's value"
+			}
 		},
-		description: "Mapping of named structs to the ABI type of their fields",
+		required: [
+			"name",
+			"type"
+		],
 		type: "object"
 	},
 	StructName: {

package/schema/arc56.schema.json.js.map

@@ -1 +1 @@
-{"version":3,"file":"arc56.schema.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"arc56.schema.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}