@aztec/stdlib 0.0.0-test.1 → 0.0.1-fake-ceab37513c

package/dest/abi/abi.d.ts

@@ -1,10 +1,7 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import type { Fr } from '@aztec/foundation/fields';
 import { type ZodFor } from '@aztec/foundation/schemas';
 import { z } from 'zod';
 import { FunctionSelector } from './function_selector.js';
-import { NoteSelector } from './note_selector.js';
 /** A basic value. */
 export interface BasicValue<T extends string, V> {
     /** The kind of the value. */
@@ -127,7 +124,7 @@ export type AbiErrorType = {
 export declare enum FunctionType {
     PRIVATE = "private",
     PUBLIC = "public",
-    UNCONSTRAINED = "unconstrained"
+    UTILITY = "utility"
 }
 /** The abi entry of a function. */
 export interface FunctionAbi {
@@ -250,86 +247,108 @@ export interface FunctionDebugMetadata {
 }
 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;
+        location_tree: z.ZodObject<{
+            locations: z.ZodArray<z.ZodObject<{
+                parent: z.ZodNullable<z.ZodNumber>;
+                value: 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;
+                }>;
             }, "strip", z.ZodTypeAny, {
-                start: number;
-                end: number;
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
             }, {
-                start: number;
-                end: number;
-            }>;
-            file: z.ZodNumber;
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }>, "many">;
         }, "strip", z.ZodTypeAny, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
         }, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
-        }>, "many">>>;
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
+        }>;
+        acir_locations: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        brillig_locations: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodNumber>>;
     }, "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;
-        }[]>>;
+        location_tree: {
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
+        };
+        acir_locations: Record<string, number>;
+        brillig_locations: Record<string, Record<string, number>>;
     }, {
-        locations: Record<string, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
-        }[]>;
-        brillig_locations: Record<string, Record<string, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
-        }[]>>;
+        location_tree: {
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
+        };
+        acir_locations: Record<string, number>;
+        brillig_locations: Record<string, Record<string, number>>;
     }>;
     files: z.ZodRecord<z.ZodString, z.ZodObject<{
         source: z.ZodString;
@@ -343,20 +362,20 @@ export declare const FunctionDebugMetadataSchema: z.ZodObject<{
     }>>;
 }, "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;
-        }[]>>;
+        location_tree: {
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
+        };
+        acir_locations: Record<string, number>;
+        brillig_locations: Record<string, Record<string, number>>;
     };
     files: Record<string, {
         path: string;
@@ -364,20 +383,20 @@ export declare const FunctionDebugMetadataSchema: z.ZodObject<{
     }>;
 }, {
     debugSymbols: {
-        locations: Record<string, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
-        }[]>;
-        brillig_locations: Record<string, Record<string, {
-            span: {
-                start: number;
-                end: number;
-            };
-            file: number;
-        }[]>>;
+        location_tree: {
+            locations: {
+                value: {
+                    span: {
+                        start: number;
+                        end: number;
+                    };
+                    file: number;
+                };
+                parent: number | null;
+            }[];
+        };
+        acir_locations: Record<string, number>;
+        brillig_locations: Record<string, Record<string, number>>;
     };
     files: Record<string, {
         path: string;
@@ -395,6 +414,10 @@ export interface FunctionArtifact extends FunctionAbi {
     /** Debug metadata for the function. */
     debug?: FunctionDebugMetadata;
 }
+export interface FunctionArtifactWithContractName extends FunctionArtifact {
+    /** The name of the contract. */
+    contractName: string;
+}
 export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     name: z.ZodString;
     functionType: z.ZodNativeEnum<typeof FunctionType>;
@@ -488,7 +511,7 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
         error_kind: "custom";
     } & AbiType)>;
 }>, z.ZodObject<{
-    bytecode: z.ZodUnion<[z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, Buffer, string>, z.ZodEffects<z.ZodObject<{
+    bytecode: z.ZodUnion<[z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, Buffer<ArrayBuffer>, string>, z.ZodEffects<z.ZodObject<{
         type: z.ZodLiteral<"Buffer">;
         data: z.ZodArray<z.ZodNumber, "many">;
     }, "strip", z.ZodTypeAny, {
@@ -497,7 +520,7 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     }, {
         type: "Buffer";
         data: number[];
-    }>, Buffer, {
+    }>, Buffer<ArrayBuffer>, {
         type: "Buffer";
         data: number[];
     }>]>;
@@ -505,86 +528,108 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     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;
+            location_tree: z.ZodObject<{
+                locations: z.ZodArray<z.ZodObject<{
+                    parent: z.ZodNullable<z.ZodNumber>;
+                    value: 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;
+                    }>;
                 }, "strip", z.ZodTypeAny, {
-                    start: number;
-                    end: number;
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
                 }, {
-                    start: number;
-                    end: number;
-                }>;
-                file: z.ZodNumber;
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }>, "many">;
             }, "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;
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
             }, {
-                span: {
-                    start: number;
-                    end: number;
-                };
-                file: number;
-            }>, "many">>>;
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            }>;
+            acir_locations: z.ZodRecord<z.ZodString, z.ZodNumber>;
+            brillig_locations: z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodNumber>>;
         }, "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;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         }, {
-            locations: Record<string, {
-                span: {
-                    start: number;
-                    end: number;
-                };
-                file: number;
-            }[]>;
-            brillig_locations: Record<string, Record<string, {
-                span: {
-                    start: number;
-                    end: number;
-                };
-                file: number;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         }>;
         files: z.ZodRecord<z.ZodString, z.ZodObject<{
             source: z.ZodString;
@@ -598,20 +643,20 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
         }>>;
     }, "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;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         };
         files: Record<string, {
             path: string;
@@ -619,20 +664,20 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
         }>;
     }, {
         debugSymbols: {
-            locations: Record<string, {
-                span: {
-                    start: number;
-                    end: number;
-                };
-                file: number;
-            }[]>;
-            brillig_locations: Record<string, Record<string, {
-                span: {
-                    start: number;
-                    end: number;
-                };
-                file: number;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         };
         files: Record<string, {
             path: string;
@@ -641,23 +686,23 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     }>>;
 }, "strip", z.ZodTypeAny, {
     debugSymbols: string;
-    bytecode: Buffer;
+    bytecode: Buffer<ArrayBuffer>;
     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;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         };
         files: Record<string, {
             path: string;
@@ -673,20 +718,20 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     };
     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;
-            }[]>>;
+            location_tree: {
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
+            };
+            acir_locations: Record<string, number>;
+            brillig_locations: Record<string, Record<string, number>>;
         };
         files: Record<string, {
             path: string;
@@ -696,9 +741,9 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     verificationKey?: string | undefined;
 }>>;
 /** A file ID. It's assigned during compilation. */
-export type FileId = number;
+type FileId = number;
 /** A pointer to a specific section of the source code. */
-export interface SourceCodeLocation {
+interface SourceCodeLocation {
     /** The section of the source code. */
     span: {
         /** The byte where the section starts. */
@@ -715,11 +760,19 @@ export interface SourceCodeLocation {
  */
 export type OpcodeLocation = string;
 export type BrilligFunctionId = number;
-export type OpcodeToLocationsMap = Record<OpcodeLocation, SourceCodeLocation[]>;
+export type OpcodeToLocationsMap = Record<OpcodeLocation, number>;
+export type LocationNodeDebugInfo = {
+    parent: number | null;
+    value: SourceCodeLocation;
+};
+export type LocationTree = {
+    locations: LocationNodeDebugInfo[];
+};
 /** The debug information for a given function. */
 export interface DebugInfo {
     /** A map of the opcode location to the source code location. */
-    locations: OpcodeToLocationsMap;
+    location_tree: LocationTree;
+    acir_locations: OpcodeToLocationsMap;
     /** For each Brillig function, we have a map of the opcode location to the source code location. */
     brillig_locations: Record<BrilligFunctionId, OpcodeToLocationsMap>;
 }
@@ -735,70 +788,6 @@ export type DebugFileMap = Record<FileId, {
     /** The path of the file. */
     path: string;
 }>;
-/** Type representing a field of a note (e.g. `amount` in `TokenNote`). */
-export type NoteField = {
-    /** Name of the field (e.g. `amount`). */
-    name: string;
-    /** Index where the note field starts in the serialized note array. */
-    index: number;
-    /** Whether the field can be unset when creating the note (in the partial notes flow). */
-    nullable: boolean;
-};
-export declare const NoteFieldSchema: z.ZodObject<{
-    name: z.ZodString;
-    index: z.ZodNumber;
-    nullable: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    index: number;
-    nullable: boolean;
-}, {
-    name: string;
-    index: number;
-    nullable: boolean;
-}>;
-/** 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: z.ZodType<NoteSelector, any, string>;
-    typ: z.ZodString;
-    fields: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        index: z.ZodNumber;
-        nullable: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        name: string;
-        index: number;
-        nullable: boolean;
-    }, {
-        name: string;
-        index: number;
-        nullable: boolean;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    fields: {
-        name: string;
-        index: number;
-        nullable: boolean;
-    }[];
-    id: NoteSelector;
-    typ: string;
-}, {
-    fields: {
-        name: string;
-        index: number;
-        nullable: boolean;
-    }[];
-    id: string;
-    typ: string;
-}>;
 /** Type representing a field layout in the storage of a contract. */
 export type FieldLayout = {
     /** Slot in which the field is stored. */
@@ -808,10 +797,10 @@ export type FieldLayout = {
 export interface ContractArtifact {
     /** The name of the contract. */
     name: string;
-    /** The version of compiler used to create this artifact */
-    aztecNrVersion?: string;
-    /** The functions of the contract. */
+    /** The functions of the contract. Includes private and utility functions, plus the public dispatch function. */
     functions: FunctionArtifact[];
+    /** The public functions of the contract, excluding dispatch. */
+    nonDispatchPublicFunctions: FunctionAbi[];
     /** The outputs of the contract. */
     outputs: {
         structs: Record<string, AbiType[]>;
@@ -819,15 +808,16 @@ export interface ContractArtifact {
     };
     /** Storage layout */
     storageLayout: Record<string, FieldLayout>;
-    /** The notes used in the contract. */
-    notes: Record<string, ContractNote>;
     /** The map of file ID to the source code and path of the file. */
     fileMap: DebugFileMap;
 }
 export declare const ContractArtifactSchema: ZodFor<ContractArtifact>;
 export declare function getFunctionArtifactByName(artifact: ContractArtifact, functionName: string): FunctionArtifact;
 /** Gets a function artifact including debug metadata given its name or selector. */
-export declare function getFunctionArtifact(artifact: ContractArtifact, functionNameOrSelector: string | FunctionSelector): Promise<FunctionArtifact>;
+export declare function getFunctionArtifact(artifact: ContractArtifact, functionNameOrSelector: string | FunctionSelector): Promise<FunctionArtifactWithContractName>;
+/** Gets all function abis */
+export declare function getAllFunctionAbis(artifact: ContractArtifact): FunctionAbi[];
+export declare function parseDebugSymbols(debugSymbols: string): DebugInfo[];
 /**
  * Gets the debug metadata of a given function from the contract artifact
  * @param artifact - The contract build artifact
@@ -842,12 +832,15 @@ export declare function getFunctionDebugMetadata(contractArtifact: ContractArtif
  * @param contractArtifact - The contract artifact.
  * @returns An initializer function, or none if there are no functions flagged as initializers in the contract.
  */
-export declare function getDefaultInitializer(contractArtifact: ContractArtifact): FunctionArtifact | undefined;
+export declare function getDefaultInitializer(contractArtifact: ContractArtifact): FunctionAbi | undefined;
 /**
  * Returns an initializer from the contract.
  * @param initializerNameOrArtifact - The name of the constructor, or the artifact of the constructor, or undefined
  * to pick the default initializer.
  */
-export declare function getInitializer(contract: ContractArtifact, initializerNameOrArtifact: string | undefined | FunctionArtifact): FunctionArtifact | undefined;
+export declare function getInitializer(contract: ContractArtifact, initializerNameOrArtifact: string | undefined | FunctionArtifact): FunctionAbi | undefined;
+export declare function emptyFunctionAbi(): FunctionAbi;
+export declare function emptyFunctionArtifact(): FunctionArtifact;
+export declare function emptyContractArtifact(): ContractArtifact;
 export {};
 //# sourceMappingURL=abi.d.ts.map