@aztec/foundation 0.62.0 → 0.63.1

package/dest/abi/abi.d.ts

@@ -1,22 +1,19 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
+import { z } from 'zod';
 import { type Fr } from '../fields/fields.js';
+import { type ZodFor } from '../schemas/types.js';
 import { type FunctionSelector } from './function_selector.js';
 import { type NoteSelector } from './note_selector.js';
-/**
- * A basic value.
- */
+/** A basic value. */
 export interface BasicValue<T extends string, V> {
-    /**
-     * The kind of the value.
-     */
+    /** The kind of the value. */
     kind: T;
     value: V;
 }
-/**
- * An exported value.
- */
+/** An exported value. */
 export type AbiValue = BasicValue<'boolean', boolean> | BasicValue<'string', string> | BasicValue<'array', AbiValue[]> | TupleValue | IntegerValue | StructValue;
+export declare const AbiValueSchema: z.ZodType<AbiValue>;
 export type TypedStructFieldValue<T> = {
     name: string;
     value: T;
@@ -32,185 +29,684 @@ export interface TupleValue {
 export interface IntegerValue extends BasicValue<'integer', string> {
     sign: boolean;
 }
-/**
- * A named type.
- */
-export interface ABIVariable {
-    /**
-     * The name of the variable.
-     */
-    name: string;
-    /**
-     * The type of the variable.
-     */
-    type: AbiType;
-}
-/**
- * Indicates whether a parameter is public or secret/private.
- */
-export type ABIParameterVisibility = 'public' | 'private' | 'databus';
-/**
- * A function parameter.
- */
-export interface ABIParameter extends ABIVariable {
-    /**
-     * Indicates whether a parameter is public or secret/private.
-     */
-    visibility: ABIParameterVisibility;
-}
-/**
- * A basic type.
- */
+/** Indicates whether a parameter is public or secret/private. */
+export declare const ABIParameterVisibility: readonly ["public", "private", "databus"];
+/** Indicates whether a parameter is public or secret/private. */
+export type ABIParameterVisibility = (typeof ABIParameterVisibility)[number];
+/** A basic type. */
 export interface BasicType<T extends string> {
-    /**
-     * The kind of the type.
-     */
+    /** The kind of the type. */
     kind: T;
 }
-/**
- * A variable type.
- */
+/** Sign for numeric types. */
+declare const Sign: readonly ["unsigned", "signed"];
+type Sign = (typeof Sign)[number];
+/** A variable type. */
 export type AbiType = BasicType<'field'> | BasicType<'boolean'> | IntegerType | ArrayType | StringType | StructType | TupleType;
-type Sign = 'unsigned' | 'signed';
-/**
- * An integer type.
- */
+export declare const AbiTypeSchema: z.ZodType<AbiType>;
+/** A named type. */
+export declare const ABIVariableSchema: z.ZodObject<{
+    /** The name of the variable. */
+    name: z.ZodString;
+    /** The type of the variable. */
+    type: z.ZodType<AbiType, z.ZodTypeDef, AbiType>;
+}, "strip", z.ZodTypeAny, {
+    type: AbiType;
+    name: string;
+}, {
+    type: AbiType;
+    name: string;
+}>;
+/** A named type. */
+export type ABIVariable = z.infer<typeof ABIVariableSchema>;
+/** A function parameter. */
+export declare const ABIParameterSchema: z.ZodIntersection<z.ZodObject<{
+    /** The name of the variable. */
+    name: z.ZodString;
+    /** The type of the variable. */
+    type: z.ZodType<AbiType, z.ZodTypeDef, AbiType>;
+}, "strip", z.ZodTypeAny, {
+    type: AbiType;
+    name: string;
+}, {
+    type: AbiType;
+    name: string;
+}>, z.ZodObject<{
+    /** Visibility of the parameter in the function. */
+    visibility: z.ZodEnum<["public", "private", "databus"]>;
+}, "strip", z.ZodTypeAny, {
+    visibility: "public" | "private" | "databus";
+}, {
+    visibility: "public" | "private" | "databus";
+}>>;
+/** A function parameter. */
+export type ABIParameter = z.infer<typeof ABIParameterSchema>;
+/** An integer type. */
 export interface IntegerType extends BasicType<'integer'> {
-    /**
-     * The sign of the integer.
-     */
+    /** The sign of the integer. */
     sign: Sign;
-    /**
-     * The width of the integer in bits.
-     */
+    /** The width of the integer in bits. */
     width: number;
 }
-/**
- * An array type.
- */
+/** An array type. */
 export interface ArrayType extends BasicType<'array'> {
-    /**
-     * The length of the array.
-     */
+    /** The length of the array. */
     length: number;
-    /**
-     * The type of the array elements.
-     */
+    /** The type of the array elements. */
     type: AbiType;
 }
-/**
- * A tuple type.
- */
+/** A tuple type. */
 export interface TupleType extends BasicType<'tuple'> {
-    /**
-     * The types of the tuple elements.
-     */
+    /** The types of the tuple elements. */
     fields: AbiType[];
 }
-/**
- * A string type.
- */
+/** A string type. */
 export interface StringType extends BasicType<'string'> {
-    /**
-     * The length of the string.
-     */
+    /** The length of the string. */
     length: number;
 }
-/**
- * A struct type.
- */
+/** A struct type. */
 export interface StructType extends BasicType<'struct'> {
-    /**
-     * The fields of the struct.
-     */
+    /** The fields of the struct. */
     fields: ABIVariable[];
-    /**
-     * Fully qualified name of the struct.
-     */
+    /** Fully qualified name of the struct. */
     path: string;
 }
-/**
- * Aztec.nr function types.
- */
+/** An error could be a custom error of any regular type or a string error. */
+export type AbiErrorType = {
+    error_kind: 'string';
+    string: string;
+} | {
+    error_kind: 'fmtstring';
+    length: number;
+    item_types: AbiType[];
+} | ({
+    error_kind: 'custom';
+} & AbiType);
+/** Aztec.nr function types. */
 export declare enum FunctionType {
     PRIVATE = "private",
     PUBLIC = "public",
     UNCONSTRAINED = "unconstrained"
 }
-/**
- * The abi entry of a function.
- */
+/** The abi entry of a function. */
 export interface FunctionAbi {
-    /**
-     * The name of the function.
-     */
+    /** The name of the function. */
     name: string;
-    /**
-     * Whether the function is secret.
-     */
+    /** Whether the function is secret. */
     functionType: FunctionType;
-    /**
-     * Whether the function is internal.
-     */
+    /** Whether the function is internal. */
     isInternal: boolean;
-    /**
-     * Whether the function can alter state or not
-     */
+    /** Whether the function can alter state or not */
     isStatic: boolean;
-    /**
-     * Function parameters.
-     */
+    /** Function parameters. */
     parameters: ABIParameter[];
-    /**
-     * The types of the return values.
-     */
+    /** The types of the return values. */
     returnTypes: AbiType[];
-    /**
-     * Whether the function is flagged as an initializer.
-     */
+    /** The types of the errors that the function can throw. */
+    errorTypes: Partial<Record<string, AbiErrorType>>;
+    /** Whether the function is flagged as an initializer. */
     isInitializer: boolean;
 }
-/**
- * The artifact entry of a function.
- */
+export declare const FunctionAbiSchema: z.ZodObject<{
+    name: z.ZodString;
+    functionType: z.ZodNativeEnum<typeof FunctionType>;
+    isInternal: z.ZodBoolean;
+    isStatic: z.ZodBoolean;
+    isInitializer: z.ZodBoolean;
+    parameters: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodType<AbiType, z.ZodTypeDef, AbiType>;
+        visibility: z.ZodEnum<["public", "private", "databus"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }, {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }>, "many">;
+    returnTypes: z.ZodArray<z.ZodType<AbiType, z.ZodTypeDef, AbiType>, "many">;
+    errorTypes: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
+        error_kind: z.ZodLiteral<"string">;
+        string: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        string: string;
+        error_kind: "string";
+    }, {
+        string: string;
+        error_kind: "string";
+    }>, z.ZodObject<{
+        error_kind: z.ZodLiteral<"fmtstring">;
+        length: z.ZodNumber;
+        item_types: z.ZodArray<z.ZodType<AbiType, z.ZodTypeDef, AbiType>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    }, {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    }>, z.ZodIntersection<z.ZodObject<{
+        error_kind: z.ZodLiteral<"custom">;
+    }, "strip", z.ZodTypeAny, {
+        error_kind: "custom";
+    }, {
+        error_kind: "custom";
+    }>, z.ZodType<AbiType, z.ZodTypeDef, AbiType>>]>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    parameters: {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }[];
+    functionType: FunctionType;
+    isInternal: boolean;
+    isStatic: boolean;
+    isInitializer: boolean;
+    returnTypes: AbiType[];
+    errorTypes: Record<string, {
+        string: string;
+        error_kind: "string";
+    } | {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    } | ({
+        error_kind: "custom";
+    } & AbiType)>;
+}, {
+    name: string;
+    parameters: {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }[];
+    functionType: FunctionType;
+    isInternal: boolean;
+    isStatic: boolean;
+    isInitializer: boolean;
+    returnTypes: AbiType[];
+    errorTypes: Record<string, {
+        string: string;
+        error_kind: "string";
+    } | {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    } | ({
+        error_kind: "custom";
+    } & AbiType)>;
+}>;
+/** Debug metadata for a function. */
+export interface FunctionDebugMetadata {
+    /** Maps opcodes to source code pointers */
+    debugSymbols: DebugInfo;
+    /** Maps the file IDs to the file contents to resolve pointers */
+    files: DebugFileMap;
+}
+export declare const FunctionDebugMetadataSchema: z.ZodObject<{
+    debugSymbols: z.ZodObject<{
+        locations: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+            span: z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                start: number;
+                end: number;
+            }, {
+                start: number;
+                end: number;
+            }>;
+            file: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }>, "many">>;
+        brillig_locations: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+            span: z.ZodObject<{
+                start: z.ZodNumber;
+                end: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                start: number;
+                end: number;
+            }, {
+                start: number;
+                end: number;
+            }>;
+            file: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }>, "many">>>;
+    }, "strip", z.ZodTypeAny, {
+        locations: Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>;
+        brillig_locations: Record<string, Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>>;
+    }, {
+        locations: Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>;
+        brillig_locations: Record<string, Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>>;
+    }>;
+    files: z.ZodRecord<z.ZodString, z.ZodObject<{
+        source: z.ZodString;
+        path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        path: string;
+        source: string;
+    }, {
+        path: string;
+        source: string;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    debugSymbols: {
+        locations: Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>;
+        brillig_locations: Record<string, Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>>;
+    };
+    files: Record<string, {
+        path: string;
+        source: string;
+    }>;
+}, {
+    debugSymbols: {
+        locations: Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>;
+        brillig_locations: Record<string, Record<string, {
+            span: {
+                start: number;
+                end: number;
+            };
+            file: number;
+        }[]>>;
+    };
+    files: Record<string, {
+        path: string;
+        source: string;
+    }>;
+}>;
+/** The artifact entry of a function. */
 export interface FunctionArtifact extends FunctionAbi {
     /** The ACIR bytecode of the function. */
     bytecode: Buffer;
-    /** The verification key of the function. */
+    /** The verification key of the function, base64 encoded, if it's a private fn. */
     verificationKey?: string;
     /** Maps opcodes to source code pointers */
     debugSymbols: string;
-    /**
-     * Public functions store their static assertion messages externally to the bytecode.
-     */
-    assertMessages?: Record<number, string>;
     /** Debug metadata for the function. */
     debug?: FunctionDebugMetadata;
 }
-/**
- * A file ID. It's assigned during compilation.
- */
+export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
+    name: z.ZodString;
+    functionType: z.ZodNativeEnum<typeof FunctionType>;
+    isInternal: z.ZodBoolean;
+    isStatic: z.ZodBoolean;
+    isInitializer: z.ZodBoolean;
+    parameters: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodType<AbiType, z.ZodTypeDef, AbiType>;
+        visibility: z.ZodEnum<["public", "private", "databus"]>;
+    }, "strip", z.ZodTypeAny, {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }, {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }>, "many">;
+    returnTypes: z.ZodArray<z.ZodType<AbiType, z.ZodTypeDef, AbiType>, "many">;
+    errorTypes: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<{
+        error_kind: z.ZodLiteral<"string">;
+        string: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        string: string;
+        error_kind: "string";
+    }, {
+        string: string;
+        error_kind: "string";
+    }>, z.ZodObject<{
+        error_kind: z.ZodLiteral<"fmtstring">;
+        length: z.ZodNumber;
+        item_types: z.ZodArray<z.ZodType<AbiType, z.ZodTypeDef, AbiType>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    }, {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    }>, z.ZodIntersection<z.ZodObject<{
+        error_kind: z.ZodLiteral<"custom">;
+    }, "strip", z.ZodTypeAny, {
+        error_kind: "custom";
+    }, {
+        error_kind: "custom";
+    }>, z.ZodType<AbiType, z.ZodTypeDef, AbiType>>]>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    parameters: {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }[];
+    functionType: FunctionType;
+    isInternal: boolean;
+    isStatic: boolean;
+    isInitializer: boolean;
+    returnTypes: AbiType[];
+    errorTypes: Record<string, {
+        string: string;
+        error_kind: "string";
+    } | {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    } | ({
+        error_kind: "custom";
+    } & AbiType)>;
+}, {
+    name: string;
+    parameters: {
+        type: AbiType;
+        name: string;
+        visibility: "public" | "private" | "databus";
+    }[];
+    functionType: FunctionType;
+    isInternal: boolean;
+    isStatic: boolean;
+    isInitializer: boolean;
+    returnTypes: AbiType[];
+    errorTypes: Record<string, {
+        string: string;
+        error_kind: "string";
+    } | {
+        length: number;
+        error_kind: "fmtstring";
+        item_types: AbiType[];
+    } | ({
+        error_kind: "custom";
+    } & AbiType)>;
+}>, z.ZodObject<{
+    bytecode: z.ZodUnion<[z.ZodEffects<z.ZodString, Buffer, string>, z.ZodEffects<z.ZodObject<{
+        type: z.ZodLiteral<"Buffer">;
+        data: z.ZodArray<z.ZodNumber, "many">;
+    }, "strip", z.ZodTypeAny, {
+        type: "Buffer";
+        data: number[];
+    }, {
+        type: "Buffer";
+        data: number[];
+    }>, Buffer, {
+        type: "Buffer";
+        data: number[];
+    }>]>;
+    verificationKey: z.ZodOptional<z.ZodString>;
+    debugSymbols: z.ZodString;
+    debug: z.ZodOptional<z.ZodObject<{
+        debugSymbols: z.ZodObject<{
+            locations: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+                span: z.ZodObject<{
+                    start: z.ZodNumber;
+                    end: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    start: number;
+                    end: number;
+                }, {
+                    start: number;
+                    end: number;
+                }>;
+                file: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }>, "many">>;
+            brillig_locations: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+                span: z.ZodObject<{
+                    start: z.ZodNumber;
+                    end: z.ZodNumber;
+                }, "strip", z.ZodTypeAny, {
+                    start: number;
+                    end: number;
+                }, {
+                    start: number;
+                    end: number;
+                }>;
+                file: z.ZodNumber;
+            }, "strip", z.ZodTypeAny, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }>, "many">>>;
+        }, "strip", z.ZodTypeAny, {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        }, {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        }>;
+        files: z.ZodRecord<z.ZodString, z.ZodObject<{
+            source: z.ZodString;
+            path: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            path: string;
+            source: string;
+        }, {
+            path: string;
+            source: string;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        debugSymbols: {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        };
+        files: Record<string, {
+            path: string;
+            source: string;
+        }>;
+    }, {
+        debugSymbols: {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        };
+        files: Record<string, {
+            path: string;
+            source: string;
+        }>;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    debugSymbols: string;
+    bytecode: Buffer;
+    debug?: {
+        debugSymbols: {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        };
+        files: Record<string, {
+            path: string;
+            source: string;
+        }>;
+    } | undefined;
+    verificationKey?: string | undefined;
+}, {
+    debugSymbols: string;
+    bytecode: string | {
+        type: "Buffer";
+        data: number[];
+    };
+    debug?: {
+        debugSymbols: {
+            locations: Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>;
+            brillig_locations: Record<string, Record<string, {
+                span: {
+                    start: number;
+                    end: number;
+                };
+                file: number;
+            }[]>>;
+        };
+        files: Record<string, {
+            path: string;
+            source: string;
+        }>;
+    } | undefined;
+    verificationKey?: string | undefined;
+}>>;
+/** A file ID. It's assigned during compilation. */
 export type FileId = number;
-/**
- * A pointer to a specific section of the source code.
- */
+/** A pointer to a specific section of the source code. */
 export interface SourceCodeLocation {
-    /**
-     * The section of the source code.
-     */
+    /** The section of the source code. */
     span: {
-        /**
-         * The byte where the section starts.
-         */
+        /** The byte where the section starts. */
         start: number;
-        /**
-         * The byte where the section ends.
-         */
+        /** The byte where the section ends. */
         end: number;
     };
-    /**
-     * The source code file pointed to.
-     */
+    /** The source code file pointed to. */
     file: FileId;
 }
 /**
@@ -220,58 +716,25 @@ export interface SourceCodeLocation {
 export type OpcodeLocation = string;
 export type BrilligFunctionId = number;
 export type OpcodeToLocationsMap = Record<OpcodeLocation, SourceCodeLocation[]>;
-/**
- * The debug information for a given function.
- */
+/** The debug information for a given function. */
 export interface DebugInfo {
-    /**
-     * A map of the opcode location to the source code location.
-     */
+    /** A map of the opcode location to the source code location. */
     locations: OpcodeToLocationsMap;
-    /**
-     * For each Brillig function, we have a map of the opcode location to the source code location.
-     */
+    /** For each Brillig function, we have a map of the opcode location to the source code location. */
     brillig_locations: Record<BrilligFunctionId, OpcodeToLocationsMap>;
 }
-/**
- * The debug information for a given program (a collection of functions)
- */
+/** The debug information for a given program (a collection of functions) */
 export interface ProgramDebugInfo {
-    /**
-     * A list of debug information that matches with each function in a program
-     */
+    /** A list of debug information that matches with each function in a program */
     debug_infos: Array<DebugInfo>;
 }
-/**
- * Maps a file ID to its metadata for debugging purposes.
- */
+/** Maps a file ID to its metadata for debugging purposes. */
 export type DebugFileMap = Record<FileId, {
-    /**
-     * The source code of the file.
-     */
+    /** The source code of the file. */
     source: string;
-    /**
-     * The path of the file.
-     */
+    /** The path of the file. */
     path: string;
 }>;
-/**
- * Type representing a note in use in the contract.
- */
-export type ContractNote = {
-    /**
-     * Note identifier
-     */
-    id: NoteSelector;
-    /**
-     * Type of the note (e.g., 'TransparentNote')
-     */
-    typ: string;
-    /**
-     * Fields of the note.
-     */
-    fields: NoteField[];
-};
 /** Type representing a field of a note (e.g. `amount` in `TokenNote`). */
 export type NoteField = {
     /** Name of the field (e.g. `amount`). */
@@ -281,71 +744,88 @@ export type NoteField = {
     /** Whether the field can be unset when creating the note (in the partial notes flow). */
     nullable: boolean;
 };
-/**
- * Type representing a field layout in the storage of a contract.
- */
+export declare const NoteFieldSchema: z.ZodObject<{
+    name: z.ZodString;
+    index: z.ZodNumber;
+    nullable: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    nullable: boolean;
+    index: number;
+}, {
+    name: string;
+    nullable: boolean;
+    index: number;
+}>;
+/** Type representing a note in use in the contract. */
+export type ContractNote = {
+    /** Note identifier */
+    id: NoteSelector;
+    /** Type of the note (e.g., 'TransparentNote') */
+    typ: string;
+    /** Fields of the note. */
+    fields: NoteField[];
+};
+export declare const ContractNoteSchema: z.ZodObject<{
+    id: ZodFor<NoteSelector>;
+    typ: z.ZodString;
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        index: z.ZodNumber;
+        nullable: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        nullable: boolean;
+        index: number;
+    }, {
+        name: string;
+        nullable: boolean;
+        index: number;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    fields: {
+        name: string;
+        nullable: boolean;
+        index: number;
+    }[];
+    id: NoteSelector;
+    typ: string;
+}, {
+    fields: {
+        name: string;
+        nullable: boolean;
+        index: number;
+    }[];
+    typ: string;
+    id?: any;
+}>;
+/** Type representing a field layout in the storage of a contract. */
 export type FieldLayout = {
-    /**
-     * Slot in which the field is stored.
-     */
+    /** Slot in which the field is stored. */
     slot: Fr;
 };
-/**
- * Defines artifact of a contract.
- */
+/** Defines artifact of a contract. */
 export interface ContractArtifact {
-    /**
-     * The name of the contract.
-     */
+    /** The name of the contract. */
     name: string;
-    /**
-     * The version of compiler used to create this artifact
-     */
+    /** The version of compiler used to create this artifact */
     aztecNrVersion?: string;
-    /**
-     * The functions of the contract.
-     */
+    /** The functions of the contract. */
     functions: FunctionArtifact[];
-    /**
-     * The outputs of the contract.
-     */
+    /** The outputs of the contract. */
     outputs: {
         structs: Record<string, AbiType[]>;
         globals: Record<string, AbiValue[]>;
     };
-    /**
-     * Storage layout
-     */
+    /** Storage layout */
     storageLayout: Record<string, FieldLayout>;
-    /**
-     * The notes used in the contract.
-     */
+    /** The notes used in the contract. */
     notes: Record<string, ContractNote>;
-    /**
-     * The map of file ID to the source code and path of the file.
-     */
+    /** The map of file ID to the source code and path of the file. */
     fileMap: DebugFileMap;
 }
-/**
- * Debug metadata for a function.
- */
-export interface FunctionDebugMetadata {
-    /**
-     * Maps opcodes to source code pointers
-     */
-    debugSymbols: DebugInfo;
-    /**
-     * Maps the file IDs to the file contents to resolve pointers
-     */
-    files: DebugFileMap;
-    /**
-     * Public functions store their static assertion messages externally to the bytecode.
-     */
-    assertMessages?: Record<number, string>;
-}
-/**
- * Gets a function artifact including debug metadata given its name or selector.
- */
+export declare const ContractArtifactSchema: ZodFor<ContractArtifact>;
+/** Gets a function artifact including debug metadata given its name or selector. */
 export declare function getFunctionArtifact(artifact: ContractArtifact, functionNameOrSelector: string | FunctionSelector): FunctionArtifact;
 /**
  * Gets the debug metadata of a given function from the contract artifact