@aztec/stdlib 0.86.0 → 0.87.0

package/dest/abi/abi.d.ts

@@ -1,5 +1,3 @@
-/// <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';
@@ -250,86 +248,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 +363,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 +384,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;
@@ -492,7 +512,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, {
@@ -501,7 +521,7 @@ export declare const FunctionArtifactSchema: z.ZodIntersection<z.ZodObject<{
     }, {
         type: "Buffer";
         data: number[];
-    }>, Buffer, {
+    }>, Buffer<ArrayBuffer>, {
         type: "Buffer";
         data: number[];
     }>]>;
@@ -509,86 +529,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;
+                locations: {
+                    value: {
+                        span: {
+                            start: number;
+                            end: number;
+                        };
+                        file: number;
+                    };
+                    parent: number | null;
+                }[];
             }, {
-                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">>>;
+                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;
@@ -602,20 +644,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;
@@ -623,20 +665,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;
@@ -645,23 +687,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;
@@ -677,20 +719,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;
@@ -700,9 +742,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. */
@@ -719,11 +761,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>;
 }