@aztec/pxe 0.0.0-test.1 → 0.0.1-commit.b655e406

package/dest/contract_function_simulator/oracle/note_packing_utils.js

@@ -0,0 +1,49 @@
+import { Fr } from '@aztec/foundation/fields';
+// TS equivalent of the `NoteMetadata::from_raw_data` function in `aztec/src/note/note_metadata.nr`
+function fromRawData(nonzeroNoteHashCounter, maybeNoteNonce) {
+    if (nonzeroNoteHashCounter) {
+        if (maybeNoteNonce.equals(Fr.ZERO)) {
+            return {
+                stage: 1,
+                maybeNoteNonce
+            }; // PENDING_SAME_PHASE
+        } else {
+            return {
+                stage: 2,
+                maybeNoteNonce
+            }; // PENDING_PREVIOUS_PHASE
+        }
+    } else if (!maybeNoteNonce.equals(Fr.ZERO)) {
+        return {
+            stage: 3,
+            maybeNoteNonce
+        }; // SETTLED
+    } else {
+        throw new Error('Note has a zero note hash counter and no nonce - existence cannot be proven');
+    }
+}
+/**
+ * Packs a note in a format that is compatible with the default Packable implementation of the retrieved note.
+ *
+ * @dev Unlike the default Packable implementation, this function first constructs the note metadata from the inputs
+ * and only after that it packs the retrieved note. Hence it doesn't map one to one with `RetrievedNote::pack()`.
+ *
+ * @param contractAddress - The address of the contract that owns the note
+ * @param noteNonce - The nonce injected into the note hash preimage by kernels.
+ * @param index - Optional index in the note hash tree. If undefined, indicates a transient note
+ * @param note - The note content containing the actual note data
+ * @returns The packed note as an array of field elements
+ */ export function packAsRetrievedNote({ contractAddress, noteNonce, index, note }) {
+    // If index is undefined, the note is transient which implies that the nonzero_note_hash_counter has to be true
+    const noteIsTransient = index === undefined;
+    const nonzeroNoteHashCounter = noteIsTransient ? true : false;
+    // To pack the note as retrieved note we first need to reconstruct the note metadata.
+    const noteMetadata = fromRawData(nonzeroNoteHashCounter, noteNonce);
+    // Pack metadata first (stage and maybe_note_nonce), followed by the rest
+    return [
+        ...note.items,
+        contractAddress,
+        new Fr(noteMetadata.stage),
+        noteMetadata.maybeNoteNonce
+    ];
+}

package/dest/contract_function_simulator/oracle/oracle.d.ts

@@ -0,0 +1,57 @@
+import { type ACIRCallback, type ACVMField } from '@aztec/simulator/client';
+import type { IMiscOracle, IPrivateExecutionOracle, IUtilityExecutionOracle } from './interfaces.js';
+export declare class UnavailableOracleError extends Error {
+    constructor(oracleName: string);
+}
+/**
+ * A data source that has all the apis required by Aztec.nr.
+ */
+export declare class Oracle {
+    private handler;
+    constructor(handler: IMiscOracle | IUtilityExecutionOracle | IPrivateExecutionOracle);
+    private handlerAsMisc;
+    private handlerAsUtility;
+    private handlerAsPrivate;
+    toACIRCallback(): ACIRCallback;
+    utilityAssertCompatibleOracleVersion([version]: ACVMField[]): Promise<never[]>;
+    utilityGetRandomField(): Promise<ACVMField[]>;
+    privateStoreInExecutionCache(_length: ACVMField[], values: ACVMField[], [hash]: ACVMField[]): Promise<ACVMField[]>;
+    privateLoadFromExecutionCache([returnsHash]: ACVMField[]): Promise<ACVMField[][]>;
+    utilityGetUtilityContext(): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetKeyValidationRequest([pkMHash]: ACVMField[]): Promise<ACVMField[]>;
+    utilityGetContractInstance([address]: ACVMField[]): Promise<ACVMField[]>;
+    utilityGetMembershipWitness([blockNumber]: ACVMField[], [treeId]: ACVMField[], [leafValue]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetNullifierMembershipWitness([blockNumber]: ACVMField[], [nullifier]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetLowNullifierMembershipWitness([blockNumber]: ACVMField[], [nullifier]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetPublicDataWitness([blockNumber]: ACVMField[], [leafSlot]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetBlockHeader([blockNumber]: ACVMField[]): Promise<ACVMField[]>;
+    utilityGetAuthWitness([messageHash]: ACVMField[]): Promise<ACVMField[][]>;
+    utilityGetPublicKeysAndPartialAddress([address]: ACVMField[]): Promise<ACVMField[][]>;
+    utilityGetNotes([storageSlot]: ACVMField[], [numSelects]: ACVMField[], selectByIndexes: ACVMField[], selectByOffsets: ACVMField[], selectByLengths: ACVMField[], selectValues: ACVMField[], selectComparators: ACVMField[], sortByIndexes: ACVMField[], sortByOffsets: ACVMField[], sortByLengths: ACVMField[], sortOrder: ACVMField[], [limit]: ACVMField[], [offset]: ACVMField[], [status]: ACVMField[], [maxNotes]: ACVMField[], [packedRetrievedNoteLength]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    privateNotifyCreatedNote([storageSlot]: ACVMField[], [noteTypeId]: ACVMField[], note: ACVMField[], [noteHash]: ACVMField[], [counter]: ACVMField[]): Promise<ACVMField[]>;
+    privateNotifyNullifiedNote([innerNullifier]: ACVMField[], [noteHash]: ACVMField[], [counter]: ACVMField[]): Promise<ACVMField[]>;
+    privateNotifyCreatedNullifier([innerNullifier]: ACVMField[]): Promise<ACVMField[]>;
+    utilityCheckNullifierExists([innerNullifier]: ACVMField[]): Promise<ACVMField[]>;
+    utilityGetL1ToL2MembershipWitness([contractAddress]: ACVMField[], [messageHash]: ACVMField[], [secret]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityStorageRead([contractAddress]: ACVMField[], [startStorageSlot]: ACVMField[], [blockNumber]: ACVMField[], [numberOfElements]: ACVMField[]): Promise<ACVMField[][]>;
+    privateNotifyCreatedContractClassLog([contractAddress]: ACVMField[], message: ACVMField[], [length]: ACVMField[], [counter]: ACVMField[]): Promise<ACVMField[]>;
+    utilityDebugLog(level: ACVMField[], message: ACVMField[], _ignoredFieldsSize: ACVMField[], fields: ACVMField[]): Promise<ACVMField[]>;
+    privateCallPrivateFunction([contractAddress]: ACVMField[], [functionSelector]: ACVMField[], [argsHash]: ACVMField[], [sideEffectCounter]: ACVMField[], [isStaticCall]: ACVMField[]): Promise<ACVMField[][]>;
+    privateNotifyEnqueuedPublicFunctionCall([contractAddress]: ACVMField[], [calldataHash]: ACVMField[], [sideEffectCounter]: ACVMField[], [isStaticCall]: ACVMField[]): Promise<ACVMField[]>;
+    privateNotifySetPublicTeardownFunctionCall([contractAddress]: ACVMField[], [calldataHash]: ACVMField[], [sideEffectCounter]: ACVMField[], [isStaticCall]: ACVMField[]): Promise<ACVMField[]>;
+    privateNotifySetMinRevertibleSideEffectCounter([minRevertibleSideEffectCounter]: ACVMField[]): Promise<ACVMField[]>;
+    privateGetNextAppTagAsSender([sender]: ACVMField[], [recipient]: ACVMField[]): Promise<ACVMField[]>;
+    utilityFetchTaggedLogs([pendingTaggedLogArrayBaseSlot]: ACVMField[]): Promise<ACVMField[]>;
+    utilityValidateEnqueuedNotesAndEvents([contractAddress]: ACVMField[], [noteValidationRequestsArrayBaseSlot]: ACVMField[], [eventValidationRequestsArrayBaseSlot]: ACVMField[]): Promise<ACVMField[]>;
+    utilityBulkRetrieveLogs([contractAddress]: ACVMField[], [logRetrievalRequestsArrayBaseSlot]: ACVMField[], [logRetrievalResponsesArrayBaseSlot]: ACVMField[]): Promise<ACVMField[]>;
+    utilityStoreCapsule([contractAddress]: ACVMField[], [slot]: ACVMField[], capsule: ACVMField[]): Promise<ACVMField[]>;
+    utilityLoadCapsule([contractAddress]: ACVMField[], [slot]: ACVMField[], [tSize]: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityDeleteCapsule([contractAddress]: ACVMField[], [slot]: ACVMField[]): Promise<ACVMField[]>;
+    utilityCopyCapsule([contractAddress]: ACVMField[], [srcSlot]: ACVMField[], [dstSlot]: ACVMField[], [numEntries]: ACVMField[]): Promise<ACVMField[]>;
+    utilityAes128Decrypt(ciphertextBVecStorage: ACVMField[], [ciphertextLength]: ACVMField[], iv: ACVMField[], symKey: ACVMField[]): Promise<(ACVMField | ACVMField[])[]>;
+    utilityGetSharedSecret([address]: ACVMField[], [ephPKField0]: ACVMField[], [ephPKField1]: ACVMField[], [ephPKField2]: ACVMField[]): Promise<ACVMField[]>;
+    utilityEmitOffchainEffect(data: ACVMField[]): Promise<never[]>;
+    privateGetSenderForTags(): Promise<ACVMField[]>;
+    privateSetSenderForTags([senderForTags]: ACVMField[]): Promise<ACVMField[]>;
+}
+//# sourceMappingURL=oracle.d.ts.map

package/dest/contract_function_simulator/oracle/oracle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oracle.d.ts","sourceRoot":"","sources":["../../../src/contract_function_simulator/oracle/oracle.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,SAAS,EAMf,MAAM,yBAAyB,CAAC;AAMjC,OAAO,KAAK,EAAE,WAAW,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAC;AAGrG,qBAAa,sBAAuB,SAAQ,KAAK;gBACnC,UAAU,EAAE,MAAM;CAG/B;AAED;;GAEG;AACH,qBAAa,MAAM;IACL,OAAO,CAAC,OAAO;gBAAP,OAAO,EAAE,WAAW,GAAG,uBAAuB,GAAG,uBAAuB;IAE5F,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,gBAAgB;IAQxB,OAAO,CAAC,gBAAgB;IAQxB,cAAc,IAAI,YAAY;IAsC9B,oCAAoC,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE;IAK3D,qBAAqB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAM7C,4BAA4B,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAK5G,6BAA6B,CAAC,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IAKjF,wBAAwB,IAAI,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAKhE,8BAA8B,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAM5E,0BAA0B,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAcxE,2BAA2B,CAC/B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EACrB,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,GACvB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAkBjC,oCAAoC,CACxC,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,GACvB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAcjC,uCAAuC,CAC3C,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,GACvB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAgBjC,2BAA2B,CAC/B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,GACtB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAWjC,qBAAqB,CAAC,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAUvE,qBAAqB,CAAC,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IASzE,qCAAqC,CAAC,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IAQrF,eAAe,CACnB,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,EACzB,eAAe,EAAE,SAAS,EAAE,EAC5B,eAAe,EAAE,SAAS,EAAE,EAC5B,eAAe,EAAE,SAAS,EAAE,EAC5B,YAAY,EAAE,SAAS,EAAE,EACzB,iBAAiB,EAAE,SAAS,EAAE,EAC9B,aAAa,EAAE,SAAS,EAAE,EAC1B,aAAa,EAAE,SAAS,EAAE,EAC1B,aAAa,EAAE,SAAS,EAAE,EAC1B,SAAS,EAAE,SAAS,EAAE,EACtB,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,EACpB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EACrB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EACrB,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,EACvB,CAAC,yBAAyB,CAAC,EAAE,SAAS,EAAE,GACvC,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IA6BvC,wBAAwB,CACtB,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,EACzB,IAAI,EAAE,SAAS,EAAE,EACjB,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,EACvB,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GACrB,OAAO,CAAC,SAAS,EAAE,CAAC;IAWjB,0BAA0B,CAC9B,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,EAC7B,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,EACvB,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GACrB,OAAO,CAAC,SAAS,EAAE,CAAC;IASjB,6BAA6B,CAAC,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAKlF,2BAA2B,CAAC,CAAC,cAAc,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAKhF,iCAAiC,CACrC,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,GACpB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IASjC,kBAAkB,CACtB,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,EAC/B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,GAC9B,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IAUzB,oCAAoC,CAClC,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,OAAO,EAAE,SAAS,EAAE,EACpB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EACrB,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,GACrB,OAAO,CAAC,SAAS,EAAE,CAAC;IAQvB,eAAe,CACb,KAAK,EAAE,SAAS,EAAE,EAClB,OAAO,EAAE,SAAS,EAAE,EACpB,kBAAkB,EAAE,SAAS,EAAE,EAC/B,MAAM,EAAE,SAAS,EAAE,GAClB,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjB,0BAA0B,CAC9B,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,EAC/B,CAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,EACvB,CAAC,iBAAiB,CAAC,EAAE,SAAS,EAAE,EAChC,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,GAC1B,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC;IAWnB,uCAAuC,CAC3C,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,EAC3B,CAAC,iBAAiB,CAAC,EAAE,SAAS,EAAE,EAChC,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,GAC1B,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjB,0CAA0C,CAC9C,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,EAC3B,CAAC,iBAAiB,CAAC,EAAE,SAAS,EAAE,EAChC,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,GAC1B,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjB,8CAA8C,CAAC,CAAC,8BAA8B,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAC1G,SAAS,EAAE,CACZ;IAOK,4BAA4B,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAQnG,sBAAsB,CAAC,CAAC,6BAA6B,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAK1F,qCAAqC,CACzC,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,mCAAmC,CAAC,EAAE,SAAS,EAAE,EAClD,CAAC,oCAAoC,CAAC,EAAE,SAAS,EAAE,GAClD,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjB,uBAAuB,CAC3B,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,iCAAiC,CAAC,EAAE,SAAS,EAAE,EAChD,CAAC,kCAAkC,CAAC,EAAE,SAAS,EAAE,GAChD,OAAO,CAAC,SAAS,EAAE,CAAC;IASjB,mBAAmB,CACvB,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,EACnB,OAAO,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,SAAS,EAAE,CAAC;IASjB,kBAAkB,CACtB,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,EACnB,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,GACnB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IAiBjC,oBAAoB,CAAC,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAQ/F,kBAAkB,CACtB,CAAC,eAAe,CAAC,EAAE,SAAS,EAAE,EAC9B,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,EACtB,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,EACtB,CAAC,UAAU,CAAC,EAAE,SAAS,EAAE,GACxB,OAAO,CAAC,SAAS,EAAE,CAAC;IAUjB,oBAAoB,CACxB,qBAAqB,EAAE,SAAS,EAAE,EAClC,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,EAC/B,EAAE,EAAE,SAAS,EAAE,EACf,MAAM,EAAE,SAAS,EAAE,GAClB,OAAO,CAAC,CAAC,SAAS,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC;IASjC,sBAAsB,CAC1B,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,EACtB,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,EAC1B,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,GACzB,OAAO,CAAC,SAAS,EAAE,CAAC;IAQjB,yBAAyB,CAAC,IAAI,EAAE,SAAS,EAAE;IAK3C,uBAAuB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;IAM/C,uBAAuB,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;CAIlF"}

package/dest/contract_function_simulator/oracle/oracle.js

@@ -0,0 +1,328 @@
+import { Fr, Point } from '@aztec/foundation/fields';
+import { arrayOfArraysToBoundedVecOfArrays, bufferToBoundedVec, fromUintArray, fromUintBoundedVec, toACVMField } from '@aztec/simulator/client';
+import { FunctionSelector, NoteSelector } from '@aztec/stdlib/abi';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { ContractClassLog, ContractClassLogFields } from '@aztec/stdlib/logs';
+import { MerkleTreeId } from '@aztec/stdlib/trees';
+import { packAsRetrievedNote } from './note_packing_utils.js';
+export class UnavailableOracleError extends Error {
+    constructor(oracleName){
+        super(`${oracleName} oracles not available with the current handler`);
+    }
+}
+/**
+ * A data source that has all the apis required by Aztec.nr.
+ */ export class Oracle {
+    handler;
+    constructor(handler){
+        this.handler = handler;
+    }
+    handlerAsMisc() {
+        if (!('isMisc' in this.handler)) {
+            throw new UnavailableOracleError('Misc');
+        }
+        return this.handler;
+    }
+    handlerAsUtility() {
+        if (!('isUtility' in this.handler)) {
+            throw new UnavailableOracleError('Utility');
+        }
+        return this.handler;
+    }
+    handlerAsPrivate() {
+        if (!('isPrivate' in this.handler)) {
+            throw new UnavailableOracleError('Private');
+        }
+        return this.handler;
+    }
+    toACIRCallback() {
+        const excludedProps = [
+            'handler',
+            'constructor',
+            'toACIRCallback',
+            'handlerAsMisc',
+            'handlerAsUtility',
+            'handlerAsPrivate'
+        ];
+        // Get all the oracle function names
+        const oracleNames = Object.getOwnPropertyNames(Oracle.prototype).filter((name)=>!excludedProps.includes(name));
+        // Validate oracle names - these must be prefixed with either "private" or "utility" to indicate their scope
+        // and must correspond to a function on the Oracle class.
+        oracleNames.forEach((name)=>{
+            if (!name.startsWith('private') && !name.startsWith('utility')) {
+                throw new Error(`Oracle function "${name}" must be prefixed with either "private" or "utility" to indicate its scope`);
+            }
+            const method = this[name];
+            if (typeof method !== 'function') {
+                throw new Error(`Oracle property "${name}" must be a function`);
+            }
+        });
+        // Build callback object and return it
+        return oracleNames.reduce((acc, name)=>{
+            const method = this[name];
+            acc[name] = method.bind(this);
+            return acc;
+        }, {});
+    }
+    utilityAssertCompatibleOracleVersion([version]) {
+        this.handlerAsMisc().utilityAssertCompatibleOracleVersion(Fr.fromString(version).toNumber());
+        return Promise.resolve([]);
+    }
+    utilityGetRandomField() {
+        const val = this.handlerAsMisc().utilityGetRandomField();
+        return Promise.resolve([
+            toACVMField(val)
+        ]);
+    }
+    // Since the argument is a slice, noir automatically adds a length field to oracle call.
+    privateStoreInExecutionCache(_length, values, [hash]) {
+        this.handlerAsPrivate().privateStoreInExecutionCache(values.map(Fr.fromString), Fr.fromString(hash));
+        return Promise.resolve([]);
+    }
+    async privateLoadFromExecutionCache([returnsHash]) {
+        const values = await this.handlerAsPrivate().privateLoadFromExecutionCache(Fr.fromString(returnsHash));
+        return [
+            values.map(toACVMField)
+        ];
+    }
+    async utilityGetUtilityContext() {
+        const context = await this.handlerAsUtility().utilityGetUtilityContext();
+        return context.toNoirRepresentation();
+    }
+    async utilityGetKeyValidationRequest([pkMHash]) {
+        const keyValidationRequest = await this.handlerAsUtility().utilityGetKeyValidationRequest(Fr.fromString(pkMHash));
+        return keyValidationRequest.toFields().map(toACVMField);
+    }
+    async utilityGetContractInstance([address]) {
+        const instance = await this.handlerAsUtility().utilityGetContractInstance(AztecAddress.fromField(Fr.fromString(address)));
+        return [
+            instance.salt,
+            instance.deployer,
+            instance.currentContractClassId,
+            instance.initializationHash,
+            ...instance.publicKeys.toFields()
+        ].map(toACVMField);
+    }
+    async utilityGetMembershipWitness([blockNumber], [treeId], [leafValue]) {
+        const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
+        const parsedTreeId = Fr.fromString(treeId).toNumber();
+        const parsedLeafValue = Fr.fromString(leafValue);
+        const witness = await this.handlerAsUtility().utilityGetMembershipWitness(parsedBlockNumber, parsedTreeId, parsedLeafValue);
+        if (!witness) {
+            throw new Error(`Leaf ${leafValue} not found in the tree ${MerkleTreeId[parsedTreeId]} at block ${parsedBlockNumber}.`);
+        }
+        return [
+            toACVMField(witness[0]),
+            witness.slice(1).map(toACVMField)
+        ];
+    }
+    async utilityGetNullifierMembershipWitness([blockNumber], [nullifier]) {
+        const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
+        const parsedNullifier = Fr.fromString(nullifier);
+        const witness = await this.handlerAsUtility().utilityGetNullifierMembershipWitness(parsedBlockNumber, parsedNullifier);
+        if (!witness) {
+            throw new Error(`Nullifier witness not found for nullifier ${parsedNullifier} at block ${parsedBlockNumber}.`);
+        }
+        return witness.toNoirRepresentation();
+    }
+    async utilityGetLowNullifierMembershipWitness([blockNumber], [nullifier]) {
+        const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
+        const parsedNullifier = Fr.fromString(nullifier);
+        const witness = await this.handlerAsUtility().utilityGetLowNullifierMembershipWitness(parsedBlockNumber, parsedNullifier);
+        if (!witness) {
+            throw new Error(`Low nullifier witness not found for nullifier ${parsedNullifier} at block ${parsedBlockNumber}.`);
+        }
+        return witness.toNoirRepresentation();
+    }
+    async utilityGetPublicDataWitness([blockNumber], [leafSlot]) {
+        const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
+        const parsedLeafSlot = Fr.fromString(leafSlot);
+        const witness = await this.handlerAsUtility().utilityGetPublicDataWitness(parsedBlockNumber, parsedLeafSlot);
+        if (!witness) {
+            throw new Error(`Public data witness not found for slot ${parsedLeafSlot} at block ${parsedBlockNumber}.`);
+        }
+        return witness.toNoirRepresentation();
+    }
+    async utilityGetBlockHeader([blockNumber]) {
+        const parsedBlockNumber = Fr.fromString(blockNumber).toNumber();
+        const header = await this.handlerAsUtility().utilityGetBlockHeader(parsedBlockNumber);
+        if (!header) {
+            throw new Error(`Block header not found for block ${parsedBlockNumber}.`);
+        }
+        return header.toFields().map(toACVMField);
+    }
+    async utilityGetAuthWitness([messageHash]) {
+        const messageHashField = Fr.fromString(messageHash);
+        const witness = await this.handlerAsUtility().utilityGetAuthWitness(messageHashField);
+        if (!witness) {
+            throw new Error(`Unknown auth witness for message hash ${messageHashField}`);
+        }
+        return [
+            witness.map(toACVMField)
+        ];
+    }
+    async utilityGetPublicKeysAndPartialAddress([address]) {
+        const parsedAddress = AztecAddress.fromField(Fr.fromString(address));
+        const { publicKeys, partialAddress } = await this.handlerAsUtility().utilityGetPublicKeysAndPartialAddress(parsedAddress);
+        return [
+            [
+                ...publicKeys.toFields(),
+                partialAddress
+            ].map(toACVMField)
+        ];
+    }
+    async utilityGetNotes([storageSlot], [numSelects], selectByIndexes, selectByOffsets, selectByLengths, selectValues, selectComparators, sortByIndexes, sortByOffsets, sortByLengths, sortOrder, [limit], [offset], [status], [maxNotes], [packedRetrievedNoteLength]) {
+        const noteDatas = await this.handlerAsUtility().utilityGetNotes(Fr.fromString(storageSlot), +numSelects, selectByIndexes.map((s)=>+s), selectByOffsets.map((s)=>+s), selectByLengths.map((s)=>+s), selectValues.map(Fr.fromString), selectComparators.map((s)=>+s), sortByIndexes.map((s)=>+s), sortByOffsets.map((s)=>+s), sortByLengths.map((s)=>+s), sortOrder.map((s)=>+s), +limit, +offset, +status);
+        const returnDataAsArrayOfPackedRetrievedNotes = noteDatas.map(packAsRetrievedNote);
+        // Now we convert each sub-array to an array of ACVMField
+        const returnDataAsArrayOfACVMFieldArrays = returnDataAsArrayOfPackedRetrievedNotes.map((subArray)=>subArray.map(toACVMField));
+        // At last we convert the array of arrays to a bounded vec of arrays
+        return arrayOfArraysToBoundedVecOfArrays(returnDataAsArrayOfACVMFieldArrays, +maxNotes, +packedRetrievedNoteLength);
+    }
+    privateNotifyCreatedNote([storageSlot], [noteTypeId], note, [noteHash], [counter]) {
+        this.handlerAsPrivate().privateNotifyCreatedNote(Fr.fromString(storageSlot), NoteSelector.fromField(Fr.fromString(noteTypeId)), note.map(Fr.fromString), Fr.fromString(noteHash), +counter);
+        return Promise.resolve([]);
+    }
+    async privateNotifyNullifiedNote([innerNullifier], [noteHash], [counter]) {
+        await this.handlerAsPrivate().privateNotifyNullifiedNote(Fr.fromString(innerNullifier), Fr.fromString(noteHash), +counter);
+        return [];
+    }
+    async privateNotifyCreatedNullifier([innerNullifier]) {
+        await this.handlerAsPrivate().privateNotifyCreatedNullifier(Fr.fromString(innerNullifier));
+        return [];
+    }
+    async utilityCheckNullifierExists([innerNullifier]) {
+        const exists = await this.handlerAsUtility().utilityCheckNullifierExists(Fr.fromString(innerNullifier));
+        return [
+            toACVMField(exists)
+        ];
+    }
+    async utilityGetL1ToL2MembershipWitness([contractAddress], [messageHash], [secret]) {
+        const message = await this.handlerAsUtility().utilityGetL1ToL2MembershipWitness(AztecAddress.fromString(contractAddress), Fr.fromString(messageHash), Fr.fromString(secret));
+        return message.toNoirRepresentation();
+    }
+    async utilityStorageRead([contractAddress], [startStorageSlot], [blockNumber], [numberOfElements]) {
+        const values = await this.handlerAsUtility().utilityStorageRead(new AztecAddress(Fr.fromString(contractAddress)), Fr.fromString(startStorageSlot), +blockNumber, +numberOfElements);
+        return [
+            values.map(toACVMField)
+        ];
+    }
+    privateNotifyCreatedContractClassLog([contractAddress], message, [length], [counter]) {
+        const logFields = new ContractClassLogFields(message.map(Fr.fromString));
+        const log = new ContractClassLog(new AztecAddress(Fr.fromString(contractAddress)), logFields, +length);
+        this.handlerAsPrivate().privateNotifyCreatedContractClassLog(log, +counter);
+        return Promise.resolve([]);
+    }
+    utilityDebugLog(level, message, _ignoredFieldsSize, fields) {
+        const levelFr = Fr.fromString(level[0]);
+        const messageStr = message.map((acvmField)=>String.fromCharCode(Fr.fromString(acvmField).toNumber())).join('');
+        const fieldsFr = fields.map(Fr.fromString);
+        this.handlerAsMisc().utilityDebugLog(levelFr.toNumber(), messageStr, fieldsFr);
+        return Promise.resolve([]);
+    }
+    // This function's name is directly hardcoded in `circuit_recorder.ts`. Don't forget to update it there if you
+    // change the name here.
+    async privateCallPrivateFunction([contractAddress], [functionSelector], [argsHash], [sideEffectCounter], [isStaticCall]) {
+        const { endSideEffectCounter, returnsHash } = await this.handlerAsPrivate().privateCallPrivateFunction(AztecAddress.fromField(Fr.fromString(contractAddress)), FunctionSelector.fromField(Fr.fromString(functionSelector)), Fr.fromString(argsHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
+        return [
+            [
+                endSideEffectCounter,
+                returnsHash
+            ].map(toACVMField)
+        ];
+    }
+    async privateNotifyEnqueuedPublicFunctionCall([contractAddress], [calldataHash], [sideEffectCounter], [isStaticCall]) {
+        await this.handlerAsPrivate().privateNotifyEnqueuedPublicFunctionCall(AztecAddress.fromString(contractAddress), Fr.fromString(calldataHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
+        return [];
+    }
+    async privateNotifySetPublicTeardownFunctionCall([contractAddress], [calldataHash], [sideEffectCounter], [isStaticCall]) {
+        await this.handlerAsPrivate().privateNotifySetPublicTeardownFunctionCall(AztecAddress.fromString(contractAddress), Fr.fromString(calldataHash), Fr.fromString(sideEffectCounter).toNumber(), Fr.fromString(isStaticCall).toBool());
+        return [];
+    }
+    async privateNotifySetMinRevertibleSideEffectCounter([minRevertibleSideEffectCounter]) {
+        await this.handlerAsPrivate().privateNotifySetMinRevertibleSideEffectCounter(Fr.fromString(minRevertibleSideEffectCounter).toNumber());
+        return Promise.resolve([]);
+    }
+    async privateGetNextAppTagAsSender([sender], [recipient]) {
+        const tag = await this.handlerAsPrivate().privateGetNextAppTagAsSender(AztecAddress.fromString(sender), AztecAddress.fromString(recipient));
+        return [
+            toACVMField(tag.value)
+        ];
+    }
+    async utilityFetchTaggedLogs([pendingTaggedLogArrayBaseSlot]) {
+        await this.handlerAsUtility().utilityFetchTaggedLogs(Fr.fromString(pendingTaggedLogArrayBaseSlot));
+        return [];
+    }
+    async utilityValidateEnqueuedNotesAndEvents([contractAddress], [noteValidationRequestsArrayBaseSlot], [eventValidationRequestsArrayBaseSlot]) {
+        await this.handlerAsUtility().utilityValidateEnqueuedNotesAndEvents(AztecAddress.fromString(contractAddress), Fr.fromString(noteValidationRequestsArrayBaseSlot), Fr.fromString(eventValidationRequestsArrayBaseSlot));
+        return [];
+    }
+    async utilityBulkRetrieveLogs([contractAddress], [logRetrievalRequestsArrayBaseSlot], [logRetrievalResponsesArrayBaseSlot]) {
+        await this.handlerAsUtility().utilityBulkRetrieveLogs(AztecAddress.fromString(contractAddress), Fr.fromString(logRetrievalRequestsArrayBaseSlot), Fr.fromString(logRetrievalResponsesArrayBaseSlot));
+        return [];
+    }
+    async utilityStoreCapsule([contractAddress], [slot], capsule) {
+        await this.handlerAsUtility().utilityStoreCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot), capsule.map(Fr.fromString));
+        return [];
+    }
+    async utilityLoadCapsule([contractAddress], [slot], [tSize]) {
+        const values = await this.handlerAsUtility().utilityLoadCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot));
+        // We are going to return a Noir Option struct to represent the possibility of null values. Options are a struct
+        // with two fields: `some` (a boolean) and `value` (a field array in this case).
+        if (values === null) {
+            // No data was found so we set `some` to 0 and pad `value` with zeros get the correct return size.
+            return [
+                toACVMField(0),
+                Array(Fr.fromString(tSize).toNumber()).fill(toACVMField(0))
+            ];
+        } else {
+            // Data was found so we set `some` to 1 and return it along with `value`.
+            return [
+                toACVMField(1),
+                values.map(toACVMField)
+            ];
+        }
+    }
+    async utilityDeleteCapsule([contractAddress], [slot]) {
+        await this.handlerAsUtility().utilityDeleteCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(slot));
+        return [];
+    }
+    async utilityCopyCapsule([contractAddress], [srcSlot], [dstSlot], [numEntries]) {
+        await this.handlerAsUtility().utilityCopyCapsule(AztecAddress.fromField(Fr.fromString(contractAddress)), Fr.fromString(srcSlot), Fr.fromString(dstSlot), Fr.fromString(numEntries).toNumber());
+        return [];
+    }
+    async utilityAes128Decrypt(ciphertextBVecStorage, [ciphertextLength], iv, symKey) {
+        const ciphertext = fromUintBoundedVec(ciphertextBVecStorage, ciphertextLength, 8);
+        const ivBuffer = fromUintArray(iv, 8);
+        const symKeyBuffer = fromUintArray(symKey, 8);
+        const plaintext = await this.handlerAsUtility().utilityAes128Decrypt(ciphertext, ivBuffer, symKeyBuffer);
+        return bufferToBoundedVec(plaintext, ciphertextBVecStorage.length);
+    }
+    async utilityGetSharedSecret([address], [ephPKField0], [ephPKField1], [ephPKField2]) {
+        const secret = await this.handlerAsUtility().utilityGetSharedSecret(AztecAddress.fromField(Fr.fromString(address)), Point.fromFields([
+            ephPKField0,
+            ephPKField1,
+            ephPKField2
+        ].map(Fr.fromString)));
+        return secret.toFields().map(toACVMField);
+    }
+    async utilityEmitOffchainEffect(data) {
+        await this.handlerAsPrivate().utilityEmitOffchainEffect(data.map(Fr.fromString));
+        return [];
+    }
+    async privateGetSenderForTags() {
+        const sender = await this.handlerAsPrivate().privateGetSenderForTags();
+        // Return [1, address] for Some(address), [0, 0] for None
+        return sender ? [
+            toACVMField(1n),
+            toACVMField(sender)
+        ] : [
+            toACVMField(0n),
+            toACVMField(0n)
+        ];
+    }
+    async privateSetSenderForTags([senderForTags]) {
+        await this.handlerAsPrivate().privateSetSenderForTags(AztecAddress.fromField(Fr.fromString(senderForTags)));
+        return [];
+    }
+}

package/dest/contract_function_simulator/oracle/private_execution.d.ts

@@ -0,0 +1,48 @@
+import { Fr } from '@aztec/foundation/fields';
+import { type ACVMWitness, type CircuitSimulator } from '@aztec/simulator/client';
+import { type FunctionArtifact, type FunctionArtifactWithContractName, type FunctionSelector } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstance } from '@aztec/stdlib/contract';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import { PrivateCircuitPublicInputs } from '@aztec/stdlib/kernel';
+import { BlockHeader, PrivateCallExecutionResult } from '@aztec/stdlib/tx';
+import type { UInt64 } from '@aztec/stdlib/types';
+import type { ExecutionDataProvider } from '../execution_data_provider.js';
+import type { PrivateExecutionOracle } from './private_execution_oracle.js';
+/**
+ * Execute a private function and return the execution result.
+ * This does not execute any kernel circuits; only the user functions.
+ *
+ * If this private function execution results in any nested private function calls,
+ * those nested calls are made via oracle calls to the `privateCallPrivateFunction` oracle,
+ * which in turn makes corresponding further calls to this function.
+ */
+export declare function executePrivateFunction(simulator: CircuitSimulator, privateExecutionOracle: PrivateExecutionOracle, artifact: FunctionArtifactWithContractName, contractAddress: AztecAddress, functionSelector: FunctionSelector, log?: import("@aztec/foundation/log").Logger): Promise<PrivateCallExecutionResult>;
+/**
+ * Get the private circuit public inputs from the partial witness.
+ * @param artifact - The function artifact
+ * @param partialWitness - The partial witness, result of simulating the function.
+ * @returns - The public inputs.
+ */
+export declare function extractPrivateCircuitPublicInputs(artifact: FunctionArtifact, partialWitness: ACVMWitness): PrivateCircuitPublicInputs;
+/**
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
+ * from the instance is used.
+ * @param contractAddress - The address of the contract to read the class id for.
+ * @param instance - The instance of the contract.
+ * @param executionDataProvider - The execution data provider.
+ * @param blockNumber - The block number at which to load the DelayedPublicMutable storing the class id.
+ * @param timestamp - The timestamp at which to obtain the class id from the DelayedPublicMutable.
+ * @returns The current class id.
+ */
+export declare function readCurrentClassId(contractAddress: AztecAddress, instance: ContractInstance, executionDataProvider: ExecutionDataProvider | AztecNode, blockNumber: number, timestamp: UInt64): Promise<Fr>;
+/**
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in the execution data
+ * provider (i.e. PXE).
+ * @param contractAddress - The address of the contract to verify class id for.
+ * @param executionDataProvider - The execution data provider.
+ * @param header - The header of the block at which to verify the current class id. If not provided, the anchor block
+ * header of the execution data provider is used.
+ */
+export declare function verifyCurrentClassId(contractAddress: AztecAddress, executionDataProvider: ExecutionDataProvider, header?: BlockHeader): Promise<void>;
+//# sourceMappingURL=private_execution.d.ts.map

package/dest/contract_function_simulator/oracle/private_execution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"private_execution.d.ts","sourceRoot":"","sources":["../../../src/contract_function_simulator/oracle/private_execution.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAI9C,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,gBAAgB,EAKtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACL,KAAK,gBAAgB,EACrB,KAAK,gCAAgC,EACrC,KAAK,gBAAgB,EAEtB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAElE,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AAE3E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;;;;;;GAOG;AACH,wBAAsB,sBAAsB,CAC1C,SAAS,EAAE,gBAAgB,EAC3B,sBAAsB,EAAE,sBAAsB,EAC9C,QAAQ,EAAE,gCAAgC,EAC1C,eAAe,EAAE,YAAY,EAC7B,gBAAgB,EAAE,gBAAgB,EAClC,GAAG,yCAA8C,GAChD,OAAO,CAAC,0BAA0B,CAAC,CA6ErC;AAED;;;;;GAKG;AACH,wBAAgB,iCAAiC,CAC/C,QAAQ,EAAE,gBAAgB,EAC1B,cAAc,EAAE,WAAW,GAC1B,0BAA0B,CAa5B;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CACtC,eAAe,EAAE,YAAY,EAC7B,QAAQ,EAAE,gBAAgB,EAC1B,qBAAqB,EAAE,qBAAqB,GAAG,SAAS,EACxD,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,eAWlB;AAED;;;;;;;GAOG;AACH,wBAAsB,oBAAoB,CACxC,eAAe,EAAE,YAAY,EAC7B,qBAAqB,EAAE,qBAAqB,EAC5C,MAAM,CAAC,EAAE,WAAW,iBAiBrB"}

package/dest/contract_function_simulator/oracle/private_execution.js

@@ -0,0 +1,123 @@
+import { PRIVATE_CIRCUIT_PUBLIC_INPUTS_LENGTH, PRIVATE_CONTEXT_INPUTS_LENGTH } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
+import { createLogger } from '@aztec/foundation/log';
+import { Timer } from '@aztec/foundation/timer';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { ExecutionError, extractCallStack, resolveAssertionMessageFromError, witnessMapToFields } from '@aztec/simulator/client';
+import { countArgumentsSize } from '@aztec/stdlib/abi';
+import { DelayedPublicMutableValues, DelayedPublicMutableValuesWithHash } from '@aztec/stdlib/delayed-public-mutable';
+import { PrivateCircuitPublicInputs } from '@aztec/stdlib/kernel';
+import { PrivateCallExecutionResult } from '@aztec/stdlib/tx';
+import { Oracle } from './oracle.js';
+/**
+ * Execute a private function and return the execution result.
+ * This does not execute any kernel circuits; only the user functions.
+ *
+ * If this private function execution results in any nested private function calls,
+ * those nested calls are made via oracle calls to the `privateCallPrivateFunction` oracle,
+ * which in turn makes corresponding further calls to this function.
+ */ export async function executePrivateFunction(simulator, privateExecutionOracle, artifact, contractAddress, functionSelector, log = createLogger('simulator:private_execution')) {
+    const functionName = await privateExecutionOracle.getDebugFunctionName();
+    log.verbose(`Executing private function ${functionName}`, {
+        contract: contractAddress
+    });
+    const initialWitness = privateExecutionOracle.getInitialWitness(artifact);
+    const acvmCallback = new Oracle(privateExecutionOracle);
+    const timer = new Timer();
+    const acirExecutionResult = await simulator.executeUserCircuit(initialWitness, artifact, acvmCallback.toACIRCallback()).catch((err)=>{
+        err.message = resolveAssertionMessageFromError(err, artifact);
+        throw new ExecutionError(err.message, {
+            contractAddress,
+            functionSelector
+        }, extractCallStack(err, artifact.debug), {
+            cause: err
+        });
+    });
+    const duration = timer.ms();
+    const partialWitness = acirExecutionResult.partialWitness;
+    const publicInputs = extractPrivateCircuitPublicInputs(artifact, partialWitness);
+    // TODO (alexg) estimate this size
+    const initialWitnessSize = witnessMapToFields(initialWitness).length * Fr.SIZE_IN_BYTES;
+    log.debug(`Ran external function ${contractAddress.toString()}:${functionSelector}`, {
+        circuitName: 'app-circuit',
+        duration,
+        eventName: 'circuit-witness-generation',
+        inputSize: initialWitnessSize,
+        outputSize: publicInputs.toBuffer().length,
+        appCircuitName: functionName
+    });
+    const contractClassLogs = privateExecutionOracle.getContractClassLogs();
+    const rawReturnValues = await privateExecutionOracle.privateLoadFromExecutionCache(publicInputs.returnsHash);
+    const noteHashLeafIndexMap = privateExecutionOracle.getNoteHashLeafIndexMap();
+    const newNotes = privateExecutionOracle.getNewNotes();
+    const noteHashNullifierCounterMap = privateExecutionOracle.getNoteHashNullifierCounterMap();
+    const offchainEffects = privateExecutionOracle.getOffchainEffects();
+    const preTags = privateExecutionOracle.getUsedPreTags();
+    const nestedExecutionResults = privateExecutionOracle.getNestedExecutionResults();
+    let timerSubtractionList = nestedExecutionResults;
+    let witgenTime = duration;
+    // Due to the recursive nature of execution, we have to subtract the time taken by nested calls
+    while(timerSubtractionList.length > 0){
+        witgenTime -= timerSubtractionList.reduce((acc, nested)=>acc + (nested.profileResult?.timings.witgen ?? 0), 0);
+        timerSubtractionList = timerSubtractionList.flatMap((nested)=>nested.nestedExecutionResults ?? []);
+    }
+    log.debug(`Returning from call to ${contractAddress.toString()}:${functionSelector}`);
+    return new PrivateCallExecutionResult(artifact.bytecode, Buffer.from(artifact.verificationKey, 'base64'), partialWitness, publicInputs, noteHashLeafIndexMap, newNotes, noteHashNullifierCounterMap, rawReturnValues, offchainEffects, preTags, nestedExecutionResults, contractClassLogs, {
+        timings: {
+            witgen: witgenTime,
+            oracles: acirExecutionResult.oracles
+        }
+    });
+}
+/**
+ * Get the private circuit public inputs from the partial witness.
+ * @param artifact - The function artifact
+ * @param partialWitness - The partial witness, result of simulating the function.
+ * @returns - The public inputs.
+ */ export function extractPrivateCircuitPublicInputs(artifact, partialWitness) {
+    const parametersSize = countArgumentsSize(artifact) + PRIVATE_CONTEXT_INPUTS_LENGTH;
+    const returnsSize = PRIVATE_CIRCUIT_PUBLIC_INPUTS_LENGTH;
+    const returnData = [];
+    // Return values always appear in the witness after arguments.
+    for(let i = parametersSize; i < parametersSize + returnsSize; i++){
+        const returnedField = partialWitness.get(i);
+        if (returnedField === undefined) {
+            throw new Error(`Missing return value for index ${i}`);
+        }
+        returnData.push(Fr.fromString(returnedField));
+    }
+    return PrivateCircuitPublicInputs.fromFields(returnData);
+}
+/**
+ * Read the current class id of a contract from the execution data provider or AztecNode. If not found, class id
+ * from the instance is used.
+ * @param contractAddress - The address of the contract to read the class id for.
+ * @param instance - The instance of the contract.
+ * @param executionDataProvider - The execution data provider.
+ * @param blockNumber - The block number at which to load the DelayedPublicMutable storing the class id.
+ * @param timestamp - The timestamp at which to obtain the class id from the DelayedPublicMutable.
+ * @returns The current class id.
+ */ export async function readCurrentClassId(contractAddress, instance, executionDataProvider, blockNumber, timestamp) {
+    const { delayedPublicMutableSlot } = await DelayedPublicMutableValuesWithHash.getContractUpdateSlots(contractAddress);
+    const delayedPublicMutableValues = await DelayedPublicMutableValues.readFromTree(delayedPublicMutableSlot, (slot)=>executionDataProvider.getPublicStorageAt(blockNumber, ProtocolContractAddress.ContractInstanceRegistry, slot));
+    let currentClassId = delayedPublicMutableValues.svc.getCurrentAt(timestamp)[0];
+    if (currentClassId.isZero()) {
+        currentClassId = instance.originalContractClassId;
+    }
+    return currentClassId;
+}
+/**
+ * Verify that the current class id of a contract obtained from AztecNode is the same as the one in the execution data
+ * provider (i.e. PXE).
+ * @param contractAddress - The address of the contract to verify class id for.
+ * @param executionDataProvider - The execution data provider.
+ * @param header - The header of the block at which to verify the current class id. If not provided, the anchor block
+ * header of the execution data provider is used.
+ */ export async function verifyCurrentClassId(contractAddress, executionDataProvider, header) {
+    header = header ?? await executionDataProvider.getAnchorBlockHeader();
+    const instance = await executionDataProvider.getContractInstance(contractAddress);
+    const currentClassId = await readCurrentClassId(contractAddress, instance, executionDataProvider, header.globalVariables.blockNumber, header.globalVariables.timestamp);
+    if (!instance.currentContractClassId.equals(currentClassId)) {
+        throw new Error(`Contract ${contractAddress} is outdated, current class id is ${currentClassId}, local class id is ${instance.currentContractClassId}`);
+    }
+}