# @aztec/stdlib Version: v3.0.0-devnet.6-patch.1 ## Quick Import Reference ```typescript import { AllContractDeploymentData, AppendOnlyTreeSnapshot, AttestationTimeoutError, AuthWitness, AuthorizationSelector, // ... and more } from '@aztec/stdlib'; ``` ## Classes ### AllContractDeploymentData Class containing both revertible and non-revertible registration/deployment data. **Constructor** ```typescript new AllContractDeploymentData(nonRevertibleContractDeploymentData: ContractDeploymentData, revertibleContractDeploymentData: ContractDeploymentData) ``` **Properties** - `readonly nonRevertibleContractDeploymentData: ContractDeploymentData` - `readonly revertibleContractDeploymentData: ContractDeploymentData` **Methods** - `static fromTx(tx: Tx) => AllContractDeploymentData` - Extracts all contract registration/deployment data from a tx separated by revertibility. This includes contract class logs and private logs. This method handles both private-only transactions and transactions with public calls, properly splitting logs between revertible and non-revertible categories. - `getNonRevertibleContractDeploymentData() => ContractDeploymentData` - `getRevertibleContractDeploymentData() => ContractDeploymentData` ### AppendOnlyTreeSnapshot Snapshot of an append only tree. Used in circuits to verify that tree insertions are performed correctly. **Constructor** ```typescript new AppendOnlyTreeSnapshot(root: Fr, nextAvailableLeafIndex: number) ``` **Properties** - `nextAvailableLeafIndex: number` - `root: Fr` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => AppendOnlyTreeSnapshot` - `equals(other: this) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => AppendOnlyTreeSnapshot` - `static fromFields(fields: Fr[] | FieldReader) => AppendOnlyTreeSnapshot` - `static fromPlainObject(obj: any) => AppendOnlyTreeSnapshot` - Creates an AppendOnlyTreeSnapshot instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromString(str: string) => AppendOnlyTreeSnapshot` - `getSize() => number` - `isEmpty() => boolean` - `static random() => AppendOnlyTreeSnapshot` - `toAbi() => []` - `toBuffer() => any` - `toFields() => Fr[]` - `toString() => string` ### AttestationTimeoutError Extends: `ValidatorError` **Constructor** ```typescript new AttestationTimeoutError(collectedCount: number, requiredCount: number, slot: SlotNumber) ``` **Properties** - `cause?: unknown` - `readonly collectedCount: number` - `message: string` - `name: string` - `readonly requiredCount: number` - `readonly slot: SlotNumber` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### AuthWitness An authentication witness. Used to authorize an action by a user. **Constructor** ```typescript new AuthWitness(requestHash: Fr, witness: number | Fr[]) ``` **Properties** - `readonly requestHash: Fr` - `static schema: unknown` - `readonly witness: Fr[]` - Authentication witness for the hash **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => AuthWitness` - `static fromString(str: string) => AuthWitness` - `static random() => AuthWitness` - `toBuffer() => any` - `toJSON() => string` - `toString() => string` ### AuthorizationSelector An authorization selector is the first 4 bytes of the hash of an authorization struct signature. Extends: `Selector` **Constructor** ```typescript new AuthorizationSelector(value: number) ``` **Properties** - `_branding: "AuthorizationSelector"` - Brand. - `static schema: unknown` - `static SIZE: number` - The size of the selector in bytes. - `value: number` **Methods** - `[custom]() => string` - `static empty() => AuthorizationSelector` - Creates an empty selector. - `equals(other: Selector) => boolean` - Checks if this selector is equal to another. - `static fromBuffer(buffer: Buffer | BufferReader) => AuthorizationSelector` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromField(fr: Fr) => AuthorizationSelector` - Converts a field to selector. - `static fromSignature(signature: string) => Promise` - Creates a selector from a signature. - `static fromString(selector: string) => AuthorizationSelector` - Create a Selector instance from a hex-encoded string. - `isEmpty() => boolean` - Checks if the selector is empty (all bytes are 0). - `static random() => AuthorizationSelector` - Creates a random selector. - `toBuffer(bufferSize?: number) => Buffer` - Serialize as a buffer. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toJSON() => string` - `toString() => string` - Serialize as a hex string. ### AvmAccumulatedData **Constructor** ```typescript new AvmAccumulatedData(noteHashes: [], nullifiers: [], l2ToL1Msgs: [], publicLogs: FlatPublicLogs, publicDataWrites: []) ``` **Properties** - `l2ToL1Msgs: []` - `noteHashes: []` - `nullifiers: []` - `publicDataWrites: []` - `publicLogs: FlatPublicLogs` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => AvmAccumulatedData` - `static fromBuffer(buffer: Buffer | BufferReader) => AvmAccumulatedData` - `static fromFields(fields: Fr[] | FieldReader) => AvmAccumulatedData` - `static fromPlainObject(obj: any) => AvmAccumulatedData` - Creates an AvmAccumulatedData instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromString(str: string) => AvmAccumulatedData` - `getArrayLengths() => AvmAccumulatedDataArrayLengths` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` - `toString() => string` ### AvmAccumulatedDataArrayLengths Represents the lengths of arrays in AVM accumulated data **Constructor** ```typescript new AvmAccumulatedDataArrayLengths(noteHashes: number, nullifiers: number, l2ToL1Msgs: number, publicDataWrites: number) ``` **Properties** - `l2ToL1Msgs: number` - `noteHashes: number` - `nullifiers: number` - `publicDataWrites: number` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => AvmAccumulatedDataArrayLengths` - `static fromBuffer(buffer: Buffer | BufferReader) => AvmAccumulatedDataArrayLengths` - `static fromFields(fields: Fr[] | FieldReader) => AvmAccumulatedDataArrayLengths` - `static fromPlainObject(obj: any) => AvmAccumulatedDataArrayLengths` - Creates an AvmAccumulatedDataArrayLengths instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `toBuffer() => any` - `toFields() => Fr[]` ### AvmAppendLeavesHint **Constructor** ```typescript new AvmAppendLeavesHint(hintKey: AppendOnlyTreeSnapshot, stateAfter: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, leaves: Fr[]) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly leaves: Fr[]` - `static schema: unknown` - `readonly stateAfter: AppendOnlyTreeSnapshot` - `readonly treeId: MerkleTreeId` **Methods** - `static fromPlainObject(obj: any) => AvmAppendLeavesHint` - Creates an AvmAppendLeavesHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmBytecodeCommitmentHint **Constructor** ```typescript new AvmBytecodeCommitmentHint(hintKey: number, classId: Fr, commitment: Fr) ``` **Properties** - `readonly classId: Fr` - `readonly commitment: Fr` - `readonly hintKey: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => AvmBytecodeCommitmentHint` - Creates an AvmBytecodeCommitmentHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmCircuitInputs **Constructor** ```typescript new AvmCircuitInputs(hints: AvmExecutionHints, publicInputs: AvmCircuitPublicInputs) ``` **Properties** - `readonly hints: AvmExecutionHints` - `publicInputs: AvmCircuitPublicInputs` - `static schema: unknown` **Methods** - `static empty() => AvmCircuitInputs` - `static fromBuffer(buf: Buffer) => AvmCircuitInputs` - `static fromPlainObject(obj: any) => AvmCircuitInputs` - `serializeWithMessagePack() => Buffer` - `toBuffer() => Buffer` ### AvmCircuitPublicInputs **Constructor** ```typescript new AvmCircuitPublicInputs(globalVariables: GlobalVariables, protocolContracts: ProtocolContracts, startTreeSnapshots: TreeSnapshots, startGasUsed: Gas, gasSettings: GasSettings, effectiveGasFees: GasFees, feePayer: AztecAddress, proverId: Fr, publicCallRequestArrayLengths: PublicCallRequestArrayLengths, publicSetupCallRequests: [], publicAppLogicCallRequests: [], publicTeardownCallRequest: PublicCallRequest, previousNonRevertibleAccumulatedDataArrayLengths: PrivateToAvmAccumulatedDataArrayLengths, previousRevertibleAccumulatedDataArrayLengths: PrivateToAvmAccumulatedDataArrayLengths, previousNonRevertibleAccumulatedData: PrivateToAvmAccumulatedData, previousRevertibleAccumulatedData: PrivateToAvmAccumulatedData, endTreeSnapshots: TreeSnapshots, endGasUsed: Gas, accumulatedDataArrayLengths: AvmAccumulatedDataArrayLengths, accumulatedData: AvmAccumulatedData, transactionFee: Fr, reverted: boolean) ``` **Properties** - `accumulatedData: AvmAccumulatedData` - `accumulatedDataArrayLengths: AvmAccumulatedDataArrayLengths` - `effectiveGasFees: GasFees` - `endGasUsed: Gas` - `endTreeSnapshots: TreeSnapshots` - `feePayer: AztecAddress` - `gasSettings: GasSettings` - `globalVariables: GlobalVariables` - `previousNonRevertibleAccumulatedData: PrivateToAvmAccumulatedData` - `previousNonRevertibleAccumulatedDataArrayLengths: PrivateToAvmAccumulatedDataArrayLengths` - `previousRevertibleAccumulatedData: PrivateToAvmAccumulatedData` - `previousRevertibleAccumulatedDataArrayLengths: PrivateToAvmAccumulatedDataArrayLengths` - `protocolContracts: ProtocolContracts` - `proverId: Fr` - `publicAppLogicCallRequests: []` - `publicCallRequestArrayLengths: PublicCallRequestArrayLengths` - `publicSetupCallRequests: []` - `publicTeardownCallRequest: PublicCallRequest` - `reverted: boolean` - `static schema: unknown` - `startGasUsed: Gas` - `startTreeSnapshots: TreeSnapshots` - `transactionFee: Fr` **Methods** - `[custom]() => string` - `static empty() => AvmCircuitPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => AvmCircuitPublicInputs` - `static fromFields(fields: Fr[] | FieldReader) => AvmCircuitPublicInputs` - `static fromPlainObject(obj: any) => AvmCircuitPublicInputs` - Creates an AvmCircuitPublicInputs instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromString(str: string) => AvmCircuitPublicInputs` - `serializeWithMessagePack() => Buffer` - `toBuffer() => any` - `toFields() => number | boolean | Fr | Fr[] | AztecAddress[]` - `toString() => string` ### AvmCommitCheckpointHint Extends: `AvmCheckpointActionNoStateChangeHint` **Constructor** ```typescript new AvmCommitCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmContractClassHint **Constructor** ```typescript new AvmContractClassHint(hintKey: number, classId: Fr, artifactHash: Fr, privateFunctionsRoot: Fr, packedBytecode: Buffer) ``` **Properties** - `readonly artifactHash: Fr` - `readonly classId: Fr` - `readonly hintKey: number` - `readonly packedBytecode: Buffer` - `readonly privateFunctionsRoot: Fr` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => AvmContractClassHint` - Creates an AvmContractClassHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmContractDbCommitCheckpointHint Extends: `AvmCheckpointActionNoStateChangeHint` **Constructor** ```typescript new AvmContractDbCommitCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmContractDbCreateCheckpointHint Extends: `AvmCheckpointActionNoStateChangeHint` **Constructor** ```typescript new AvmContractDbCreateCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmContractDbRevertCheckpointHint Extends: `AvmCheckpointActionNoStateChangeHint` **Constructor** ```typescript new AvmContractDbRevertCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmContractInstanceHint **Constructor** ```typescript new AvmContractInstanceHint(hintKey: number, address: AztecAddress, salt: Fr, deployer: AztecAddress, currentContractClassId: Fr, originalContractClassId: Fr, initializationHash: Fr, publicKeys: PublicKeys) ``` **Properties** - `readonly address: AztecAddress` - `readonly currentContractClassId: Fr` - `readonly deployer: AztecAddress` - `readonly hintKey: number` - `readonly initializationHash: Fr` - `readonly originalContractClassId: Fr` - `readonly publicKeys: PublicKeys` - `readonly salt: Fr` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => AvmContractInstanceHint` - Creates an AvmContractInstanceHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmCreateCheckpointHint Extends: `AvmCheckpointActionNoStateChangeHint` **Constructor** ```typescript new AvmCreateCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmDebugFunctionNameHint **Constructor** ```typescript new AvmDebugFunctionNameHint(address: AztecAddress, selector: Fr, name: string) ``` **Properties** - `readonly address: AztecAddress` - `readonly name: string` - `static schema: unknown` - `readonly selector: Fr` **Methods** - `static fromPlainObject(obj: any) => AvmDebugFunctionNameHint` - Creates an AvmDebugFunctionNameHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmExecutionHints **Constructor** ```typescript new AvmExecutionHints(globalVariables: GlobalVariables, tx: AvmTxHint, protocolContracts: ProtocolContracts, contractInstances?: AvmContractInstanceHint[], contractClasses?: AvmContractClassHint[], bytecodeCommitments?: AvmBytecodeCommitmentHint[], debugFunctionNames?: AvmDebugFunctionNameHint[], contractDbCreateCheckpointHints?: AvmContractDbCreateCheckpointHint[], contractDbCommitCheckpointHints?: AvmContractDbCommitCheckpointHint[], contractDbRevertCheckpointHints?: AvmContractDbRevertCheckpointHint[], startingTreeRoots?: TreeSnapshots, getSiblingPathHints?: AvmGetSiblingPathHint[], getPreviousValueIndexHints?: AvmGetPreviousValueIndexHint[], getLeafPreimageHintsPublicDataTree?: AvmGetLeafPreimageHintPublicDataTree[], getLeafPreimageHintsNullifierTree?: AvmGetLeafPreimageHintNullifierTree[], getLeafValueHints?: AvmGetLeafValueHint[], sequentialInsertHintsPublicDataTree?: AvmSequentialInsertHintPublicDataTree[], sequentialInsertHintsNullifierTree?: AvmSequentialInsertHintNullifierTree[], appendLeavesHints?: AvmAppendLeavesHint[], createCheckpointHints?: AvmCreateCheckpointHint[], commitCheckpointHints?: AvmCommitCheckpointHint[], revertCheckpointHints?: AvmRevertCheckpointHint[]) ``` **Properties** - `readonly appendLeavesHints: AvmAppendLeavesHint[]` - `readonly bytecodeCommitments: AvmBytecodeCommitmentHint[]` - `readonly commitCheckpointHints: AvmCommitCheckpointHint[]` - `readonly contractClasses: AvmContractClassHint[]` - `readonly contractDbCommitCheckpointHints: AvmContractDbCommitCheckpointHint[]` - `readonly contractDbCreateCheckpointHints: AvmContractDbCreateCheckpointHint[]` - `readonly contractDbRevertCheckpointHints: AvmContractDbRevertCheckpointHint[]` - `readonly contractInstances: AvmContractInstanceHint[]` - `readonly createCheckpointHints: AvmCreateCheckpointHint[]` - `readonly debugFunctionNames: AvmDebugFunctionNameHint[]` - `readonly getLeafPreimageHintsNullifierTree: AvmGetLeafPreimageHintNullifierTree[]` - `readonly getLeafPreimageHintsPublicDataTree: AvmGetLeafPreimageHintPublicDataTree[]` - `readonly getLeafValueHints: AvmGetLeafValueHint[]` - `readonly getPreviousValueIndexHints: AvmGetPreviousValueIndexHint[]` - `readonly getSiblingPathHints: AvmGetSiblingPathHint[]` - `readonly globalVariables: GlobalVariables` - `protocolContracts: ProtocolContracts` - `readonly revertCheckpointHints: AvmRevertCheckpointHint[]` - `static schema: unknown` - `readonly sequentialInsertHintsNullifierTree: AvmSequentialInsertHintNullifierTree[]` - `readonly sequentialInsertHintsPublicDataTree: AvmSequentialInsertHintPublicDataTree[]` - `startingTreeRoots: TreeSnapshots` - `tx: AvmTxHint` **Methods** - `static empty() => AvmExecutionHints` - `static fromPlainObject(obj: any) => AvmExecutionHints` - Creates an AvmExecutionHints from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmFastSimulationInputs **Constructor** ```typescript new AvmFastSimulationInputs(wsRevision: WorldStateRevision, config: PublicSimulatorConfig, tx: AvmTxHint, globalVariables: GlobalVariables, protocolContracts: ProtocolContracts) ``` **Properties** - `readonly config: PublicSimulatorConfig` - `globalVariables: GlobalVariables` - `protocolContracts: ProtocolContracts` - `static schema: unknown` - `tx: AvmTxHint` - `readonly wsRevision: WorldStateRevision` **Methods** - `static empty() => AvmFastSimulationInputs` - `serializeWithMessagePack() => Buffer` ### AvmGetLeafPreimageHintNullifierTree Extends: `AvmGetLeafPreimageHintNullifierTree_base` **Constructor** ```typescript new AvmGetLeafPreimageHintNullifierTree(hintKey: AppendOnlyTreeSnapshot, index: bigint, leafPreimage: IndexedTreeLeafPreimages) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly index: bigint` - `readonly leafPreimage: IndexedTreeLeafPreimages` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmGetLeafPreimageHintPublicDataTree Extends: `AvmGetLeafPreimageHintPublicDataTree_base` **Constructor** ```typescript new AvmGetLeafPreimageHintPublicDataTree(hintKey: AppendOnlyTreeSnapshot, index: bigint, leafPreimage: IndexedTreeLeafPreimages) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly index: bigint` - `readonly leafPreimage: IndexedTreeLeafPreimages` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmGetLeafValueHint **Constructor** ```typescript new AvmGetLeafValueHint(hintKey: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, index: bigint, value: Fr) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly index: bigint` - `static schema: unknown` - `readonly treeId: MerkleTreeId` - `readonly value: Fr` **Methods** - `static fromPlainObject(obj: any) => AvmGetLeafValueHint` - Creates an AvmGetLeafValueHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmGetPreviousValueIndexHint **Constructor** ```typescript new AvmGetPreviousValueIndexHint(hintKey: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, value: Fr, index: bigint, alreadyPresent: boolean) ``` **Properties** - `readonly alreadyPresent: boolean` - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly index: bigint` - `static schema: unknown` - `readonly treeId: MerkleTreeId` - `readonly value: Fr` **Methods** - `static fromPlainObject(obj: any) => AvmGetPreviousValueIndexHint` - Creates an AvmGetPreviousValueIndexHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmGetSiblingPathHint **Constructor** ```typescript new AvmGetSiblingPathHint(hintKey: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, index: bigint, path: Fr[]) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly index: bigint` - `readonly path: Fr[]` - `static schema: unknown` - `readonly treeId: MerkleTreeId` **Methods** - `static fromPlainObject(obj: any) => AvmGetSiblingPathHint` - Creates an AvmGetSiblingPathHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmRevertCheckpointHint **Constructor** ```typescript new AvmRevertCheckpointHint(actionCounter: number, oldCheckpointId: number, newCheckpointId: number, stateBefore: TreeSnapshots, stateAfter: TreeSnapshots) ``` **Properties** - `readonly actionCounter: number` - `readonly newCheckpointId: number` - `readonly oldCheckpointId: number` - `static schema: unknown` - `readonly stateAfter: TreeSnapshots` - `readonly stateBefore: TreeSnapshots` **Methods** - `static create(actionCounter: number, oldCheckpointId: number, newCheckpointId: number, stateBefore: Record, stateAfter: Record) => AvmRevertCheckpointHint` - `static fromPlainObject(obj: any) => AvmRevertCheckpointHint` - Creates an AvmRevertCheckpointHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmSequentialInsertHintNullifierTree Extends: `AvmSequentialInsertHintNullifierTree_base` **Constructor** ```typescript new AvmSequentialInsertHintNullifierTree(hintKey: AppendOnlyTreeSnapshot, stateAfter: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, leaf: NullifierLeaf | PublicDataTreeLeaf, lowLeavesWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }, insertionWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly insertionWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }` - `readonly leaf: NullifierLeaf | PublicDataTreeLeaf` - `readonly lowLeavesWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }` - `static schema: unknown` - `readonly stateAfter: AppendOnlyTreeSnapshot` - `readonly treeId: MerkleTreeId` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmSequentialInsertHintPublicDataTree Extends: `AvmSequentialInsertHintPublicDataTree_base` **Constructor** ```typescript new AvmSequentialInsertHintPublicDataTree(hintKey: AppendOnlyTreeSnapshot, stateAfter: AppendOnlyTreeSnapshot, treeId: MerkleTreeId, leaf: NullifierLeaf | PublicDataTreeLeaf, lowLeavesWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }, insertionWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }) ``` **Properties** - `readonly hintKey: AppendOnlyTreeSnapshot` - `readonly insertionWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }` - `readonly leaf: NullifierLeaf | PublicDataTreeLeaf` - `readonly lowLeavesWitnessData: { index: bigint; leaf: IndexedTreeLeafPreimages; path: Fr[] }` - `static schema: unknown` - `readonly stateAfter: AppendOnlyTreeSnapshot` - `readonly treeId: MerkleTreeId` **Methods** - `static fromPlainObject(obj: any) => any` - Creates an instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### AvmTxHint **Constructor** ```typescript new AvmTxHint(hash: string, gasSettings: GasSettings, effectiveGasFees: GasFees, nonRevertibleContractDeploymentData: ContractDeploymentData, revertibleContractDeploymentData: ContractDeploymentData, nonRevertibleAccumulatedData: { l2ToL1Messages: ScopedL2ToL1Message[]; noteHashes: Fr[]; nullifiers: Fr[] }, revertibleAccumulatedData: { l2ToL1Messages: ScopedL2ToL1Message[]; noteHashes: Fr[]; nullifiers: Fr[] }, setupEnqueuedCalls: PublicCallRequestWithCalldata[], appLogicEnqueuedCalls: PublicCallRequestWithCalldata[], teardownEnqueuedCall: PublicCallRequestWithCalldata, gasUsedByPrivate: Gas, feePayer: AztecAddress) ``` **Properties** - `readonly appLogicEnqueuedCalls: PublicCallRequestWithCalldata[]` - `readonly effectiveGasFees: GasFees` - `readonly feePayer: AztecAddress` - `readonly gasSettings: GasSettings` - `readonly gasUsedByPrivate: Gas` - `readonly hash: string` - `readonly nonRevertibleAccumulatedData: { l2ToL1Messages: ScopedL2ToL1Message[]; noteHashes: Fr[]; nullifiers: Fr[] }` - `readonly nonRevertibleContractDeploymentData: ContractDeploymentData` - `readonly revertibleAccumulatedData: { l2ToL1Messages: ScopedL2ToL1Message[]; noteHashes: Fr[]; nullifiers: Fr[] }` - `readonly revertibleContractDeploymentData: ContractDeploymentData` - `static schema: unknown` - `readonly setupEnqueuedCalls: PublicCallRequestWithCalldata[]` - `readonly teardownEnqueuedCall: PublicCallRequestWithCalldata` **Methods** - `static empty() => AvmTxHint` - `static fromPlainObject(obj: any) => AvmTxHint` - Creates an AvmTxHint from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromTx(tx: Tx, gasFees: GasFees) => AvmTxHint` ### AztecAddress AztecAddress represents a 32-byte address in the Aztec Protocol. It provides methods to create, manipulate, and compare addresses, as well as conversion to and from strings, buffers, and other formats. Addresses are the x coordinate of a point in the Grumpkin curve, and therefore their maximum is determined by the field modulus. An address with a value that is not the x coordinate of a point in the curve is a called an 'invalid address'. These addresses have a greatly reduced feature set, as they cannot own secrets nor have messages encrypted to them, making them quite useless. We need to be able to represent them however as they can be encountered in the wild. **Constructor** ```typescript new AztecAddress(buffer: Buffer | Fr) ``` **Properties** - `_branding: "AztecAddress"` - Brand. - `static schema: unknown` - `size: unknown` - `static SIZE_IN_BYTES: number` - `static ZERO: AztecAddress` **Methods** - `[custom]() => string` - `equals(other: AztecAddress) => boolean` - `static fromBigInt(value: bigint) => AztecAddress` - `static fromBuffer(buffer: Buffer | BufferReader) => AztecAddress` - `static fromField(fr: Fr) => AztecAddress` - `static fromFields(fields: Fr[] | FieldReader) => AztecAddress` - `static fromNumber(value: number) => AztecAddress` - `static fromPlainObject(obj: any) => AztecAddress` - Creates an AztecAddress from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). Handles buffers, strings, or existing instances. - `static fromString(buf: string) => AztecAddress` - `static isAddress(str: string) => boolean` - `isValid() => Promise` - `isZero() => boolean` - `static random() => Promise` - `toAddressPoint() => Promise` - `toBigInt() => bigint` - `toBuffer() => any` - `toField() => Fr` - `toJSON() => string` - `toString() => string` - `static zero() => AztecAddress` ### BlockAttestation BlockAttestation A validator that has attested to seeing the contents of a block will produce a block attestation over the header of the block Extends: `Gossipable` **Constructor** ```typescript new BlockAttestation(payload: ConsensusPayload, signature: Signature, proposerSignature: Signature) ``` **Properties** - `archive: unknown` - `static p2pTopic: TopicType` - The p2p topic identifier, this determines how the message is handled - `readonly payload: ConsensusPayload` - `readonly proposerSignature: Signature` - `static schema: unknown` - `readonly signature: Signature` - `slotNumber: unknown` **Methods** - `static empty() => BlockAttestation` - `static fromBuffer(buf: Buffer | BufferReader) => BlockAttestation` - `generateP2PMessageIdentifier() => Promise` - `getPayload() => Buffer` - `getProposer() => EthAddress` - Lazily evaluate and cache the proposer of the block - `getSender() => EthAddress` - Lazily evaluate and cache the signer of the attestation - `getSize() => number` - Get the size of the gossipable object. This is used for metrics recording. - `p2pMessageLoggingIdentifier() => Promise` - A digest of the message information **used for logging only**. The identifier used for deduplication is `getMsgIdFn` as defined in `encoding.ts` which is a hash over topic and data. - `static random() => BlockAttestation` - `toBuffer() => Buffer` - `toInspect() => { payload: { archive: string; header: { blockHeadersHash: string; coinbase: string; ... } }; proposerSignature: string; signature: string }` - `toMessage() => Buffer` ### BlockAttestationHash Extends: `Buffer32` **Constructor** ```typescript new BlockAttestationHash(hash: Buffer) ``` **Properties** - `buffer: Buffer` - `static SIZE: number` - The size of the hash in bytes. - `static ZERO: Buffer32` - Buffer32 with value zero. **Methods** - `[custom]() => string` - `equals(hash: Buffer32) => boolean` - Checks if this hash and another hash are equal. - `static fromBigInt(hash: bigint) => Buffer32` - Creates a Buffer32 from a bigint. - `static fromBuffer(buffer: Buffer | BufferReader) => Buffer32` - Creates a Buffer32 from a buffer. - `static fromBuffer28(buffer: Buffer) => Buffer32` - Converts this hash from a buffer of 28 bytes. Verifies the input is 28 bytes. - `static fromField(hash: Fr) => Buffer32` - `static fromNumber(num: number) => Buffer32` - Converts a number into a Buffer32 object. - `static fromString(str: string) => Buffer32` - Converts a string into a Buffer32 object. - `isZero() => boolean` - Returns true if this hash is zero. - `static random() => Buffer32` - Generates a random Buffer32. - `toBigInt() => bigint` - Convert this hash to a big int. - `toBuffer() => any` - Returns the raw buffer of the hash. - `toJSON() => string` - `toString() => string` - Convert this hash to a hex string. ### BlockConstantData Constants that are the same for the entire block. **Constructor** ```typescript new BlockConstantData(lastArchive: AppendOnlyTreeSnapshot, l1ToL2TreeSnapshot: AppendOnlyTreeSnapshot, vkTreeRoot: Fr, protocolContractsHash: Fr, globalVariables: GlobalVariables, proverId: Fr) ``` **Properties** - `globalVariables: GlobalVariables` - `l1ToL2TreeSnapshot: AppendOnlyTreeSnapshot` - `lastArchive: AppendOnlyTreeSnapshot` - `protocolContractsHash: Fr` - `proverId: Fr` - `vkTreeRoot: Fr` **Methods** - `static empty() => BlockConstantData` - `static from(fields: FieldsOf) => BlockConstantData` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockConstantData` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` ### BlockHeader A header of an L2 block. **Constructor** ```typescript new BlockHeader(lastArchive: AppendOnlyTreeSnapshot, state: StateReference, spongeBlobHash: Fr, globalVariables: GlobalVariables, totalFees: Fr, totalManaUsed: Fr) ``` **Properties** - `globalVariables: GlobalVariables` - `lastArchive: AppendOnlyTreeSnapshot` - `static schema: unknown` - `spongeBlobHash: Fr` - `state: StateReference` - `totalFees: Fr` - `totalManaUsed: Fr` **Methods** - `[custom]() => string` - `clone() => BlockHeader` - `static empty(fields?: Partial>) => BlockHeader` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => BlockHeader` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockHeader` - `static fromFields(fields: Fr[] | FieldReader) => BlockHeader` - `static fromString(str: string) => BlockHeader` - `getBlockNumber() => BlockNumber` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `getSlot() => SlotNumber` - `hash() => Promise` - `isEmpty() => boolean` - `static random(overrides?: Partial> & Partial>) => BlockHeader` - `toBuffer() => any` - `toFields() => Fr[]` - `toInspect() => { globalVariables: { blockNumber: BlockNumber; chainId: number; ... }; lastArchive: string; ... }` - `toString() => string` - Serializes this instance into a string. ### BlockMergeRollupPrivateInputs Represents inputs of the block merge rollup circuit. **Constructor** ```typescript new BlockMergeRollupPrivateInputs(previousRollups: []) ``` **Properties** - `previousRollups: []` - `static schema: unknown` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => BlockMergeRollupPrivateInputs` - Deserializes the inputs from a buffer. - `static fromString(str: string) => BlockMergeRollupPrivateInputs` - Deserializes the inputs from a hex string. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a hex representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### BlockProofError Extends: `Error` **Constructor** ```typescript new BlockProofError(message: string, txHashes: TxHash[]) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. - `readonly txHashes: TxHash[]` **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static isBlockProofError(err: any) => boolean` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### BlockProposal BlockProposal A block proposal is created by the leader of the chain proposing a sequence of transactions to be included in the head of the chain Extends: `Gossipable` **Constructor** ```typescript new BlockProposal(payload: ConsensusPayload, signature: Signature, txHashes: TxHash[], txs?: Tx[]) ``` **Properties** - `archive: unknown` - `static p2pTopic: TopicType` - The p2p topic identifier, this determines how the message is handled - `readonly payload: ConsensusPayload` - `readonly signature: Signature` - `slotNumber: unknown` - `readonly txHashes: TxHash[]` - `readonly txs?: Tx[]` **Methods** - `static createProposalFromSigner(payload: ConsensusPayload, txHashes: TxHash[], txs: Tx[], payloadSigner: (payload: Buffer32) => Promise) => Promise` - `static fromBuffer(buf: Buffer | BufferReader) => BlockProposal` - `generateP2PMessageIdentifier() => Promise` - `getPayload() => any` - `getSender() => EthAddress` - Get Sender Lazily evaluate the sender of the proposal; result is cached - `getSize() => number` - Get the size of the gossipable object. This is used for metrics recording. - `p2pMessageLoggingIdentifier() => Promise` - A digest of the message information **used for logging only**. The identifier used for deduplication is `getMsgIdFn` as defined in `encoding.ts` which is a hash over topic and data. - `toBlockInfo() => Omit` - `toBuffer() => Buffer` - `toMessage() => Buffer` ### BlockProposalHash Extends: `Buffer32` **Constructor** ```typescript new BlockProposalHash(hash: Buffer) ``` **Properties** - `buffer: Buffer` - `static SIZE: number` - The size of the hash in bytes. - `static ZERO: Buffer32` - Buffer32 with value zero. **Methods** - `[custom]() => string` - `equals(hash: Buffer32) => boolean` - Checks if this hash and another hash are equal. - `static fromBigInt(hash: bigint) => Buffer32` - Creates a Buffer32 from a bigint. - `static fromBuffer(buffer: Buffer | BufferReader) => Buffer32` - Creates a Buffer32 from a buffer. - `static fromBuffer28(buffer: Buffer) => Buffer32` - Converts this hash from a buffer of 28 bytes. Verifies the input is 28 bytes. - `static fromField(hash: Fr) => Buffer32` - `static fromNumber(num: number) => Buffer32` - Converts a number into a Buffer32 object. - `static fromString(str: string) => Buffer32` - Converts a string into a Buffer32 object. - `isZero() => boolean` - Returns true if this hash is zero. - `static random() => Buffer32` - Generates a random Buffer32. - `toBigInt() => bigint` - Convert this hash to a big int. - `toBuffer() => any` - Returns the raw buffer of the hash. - `toJSON() => string` - `toString() => string` - Convert this hash to a hex string. ### BlockRollupPublicInputs Output of the block root and block merge rollup circuits. **Constructor** ```typescript new BlockRollupPublicInputs(constants: CheckpointConstantData, previousArchive: AppendOnlyTreeSnapshot, newArchive: AppendOnlyTreeSnapshot, startState: StateReference, endState: StateReference, startSpongeBlob: SpongeBlob, endSpongeBlob: SpongeBlob, startTimestamp: bigint, endTimestamp: bigint, blockHeadersHash: Fr, inHash: Fr, outHash: Fr, accumulatedFees: Fr, accumulatedManaUsed: Fr) ``` **Properties** - `accumulatedFees: Fr` - `accumulatedManaUsed: Fr` - `blockHeadersHash: Fr` - `constants: CheckpointConstantData` - `endSpongeBlob: SpongeBlob` - `endState: StateReference` - `endTimestamp: bigint` - `inHash: Fr` - `newArchive: AppendOnlyTreeSnapshot` - `outHash: Fr` - `previousArchive: AppendOnlyTreeSnapshot` - `static schema: unknown` - `startSpongeBlob: SpongeBlob` - `startState: StateReference` - `startTimestamp: bigint` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRollupPublicInputs` - `static fromString(str: string) => BlockRollupPublicInputs` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### BlockRootEmptyTxFirstRollupPrivateInputs **Constructor** ```typescript new BlockRootEmptyTxFirstRollupPrivateInputs(l1ToL2Roots: UltraHonkProofData, previousArchive: AppendOnlyTreeSnapshot, previousState: StateReference, constants: CheckpointConstantData, timestamp: bigint, newL1ToL2MessageSubtreeRootSiblingPath: [], newArchiveSiblingPath: []) ``` **Properties** - `constants: CheckpointConstantData` - `l1ToL2Roots: UltraHonkProofData` - `newArchiveSiblingPath: []` - `newL1ToL2MessageSubtreeRootSiblingPath: []` - `previousArchive: AppendOnlyTreeSnapshot` - `previousState: StateReference` - `static schema: unknown` - `timestamp: bigint` **Methods** - `static from(fields: FieldsOf) => BlockRootEmptyTxFirstRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRootEmptyTxFirstRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` ### BlockRootFirstRollupPrivateInputs **Constructor** ```typescript new BlockRootFirstRollupPrivateInputs(l1ToL2Roots: UltraHonkProofData, previousRollups: [], previousL1ToL2: AppendOnlyTreeSnapshot, newL1ToL2MessageSubtreeRootSiblingPath: [], newArchiveSiblingPath: []) ``` **Properties** - `l1ToL2Roots: UltraHonkProofData` - `newArchiveSiblingPath: []` - `newL1ToL2MessageSubtreeRootSiblingPath: []` - `previousL1ToL2: AppendOnlyTreeSnapshot` - `previousRollups: []` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => BlockRootFirstRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRootFirstRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` ### BlockRootRollupPrivateInputs **Constructor** ```typescript new BlockRootRollupPrivateInputs(previousRollups: [], newArchiveSiblingPath: []) ``` **Properties** - `newArchiveSiblingPath: []` - `previousRollups: []` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => BlockRootRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRootRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` ### BlockRootSingleTxFirstRollupPrivateInputs **Constructor** ```typescript new BlockRootSingleTxFirstRollupPrivateInputs(l1ToL2Roots: UltraHonkProofData, previousRollup: RollupHonkProofData, previousL1ToL2: AppendOnlyTreeSnapshot, newL1ToL2MessageSubtreeRootSiblingPath: [], newArchiveSiblingPath: []) ``` **Properties** - `l1ToL2Roots: UltraHonkProofData` - `newArchiveSiblingPath: []` - `newL1ToL2MessageSubtreeRootSiblingPath: []` - `previousL1ToL2: AppendOnlyTreeSnapshot` - `previousRollup: RollupHonkProofData` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => BlockRootSingleTxFirstRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRootSingleTxFirstRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` ### BlockRootSingleTxRollupPrivateInputs **Constructor** ```typescript new BlockRootSingleTxRollupPrivateInputs(previousRollup: RollupHonkProofData, newArchiveSiblingPath: []) ``` **Properties** - `newArchiveSiblingPath: []` - `previousRollup: RollupHonkProofData` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => BlockRootSingleTxRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => BlockRootSingleTxRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` ### Body **Constructor** ```typescript new Body(txEffects: TxEffect[]) ``` **Properties** - `static schema: unknown` - `txEffects: TxEffect[]` **Methods** - `[custom]() => string` - `static empty() => Body` - `equals(other: Body) => boolean` - `static fromBuffer(buf: Buffer | BufferReader) => Body` - Deserializes a block from a buffer - `static fromTxBlobData(txBlobData: TxBlobData[]) => Body` - Decodes a block from blob fields. - `static random(__namedParameters?: { makeTxOptions?: (txIndex: number) => Partial<{ maxEffects?: number; numContractClassLogs?: number; ... }>; txsPerBlock?: number } & Partial<{ maxEffects?: number; numContractClassLogs?: number; ... }>) => Promise` - `toBuffer() => any` - Serializes a block body - `toTxBlobData() => TxBlobData[]` - Returns a flat packed array of fields of all tx effects - used for blobs. ### CallContext Call context. **Constructor** ```typescript new CallContext(msgSender: AztecAddress, contractAddress: AztecAddress, functionSelector: FunctionSelector, isStaticCall: boolean) ``` **Properties** - `contractAddress: AztecAddress` - `functionSelector: FunctionSelector` - `isStaticCall: boolean` - `msgSender: AztecAddress` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => CallContext` - Returns a new instance of CallContext with zero msg sender, storage contract address. - `equals(callContext: CallContext) => boolean` - `static from(fields: FieldsOf) => CallContext` - `static fromBuffer(buffer: Buffer | BufferReader) => CallContext` - Deserialize this from a buffer. - `static fromFields(fields: Fr[] | FieldReader) => CallContext` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `static random() => Promise` - `toBuffer() => any` - Serialize this as a buffer. - `toFields() => Fr[]` ### CallStackMetadata **Constructor** ```typescript new CallStackMetadata(phase: TxExecutionPhase, contractAddress: Fr, callerPc: number, calldata: Fr[], isStaticCall: boolean, gasLimit: Gas, output: Fr[], internalCallStackAtExit: number[], haltingMessage: string, reverted: boolean, nested: CallStackMetadata[], numNestedCalls: number) ``` **Properties** - `calldata: Fr[]` - `callerPc: number` - `contractAddress: Fr` - `gasLimit: Gas` - `haltingMessage: string` - `internalCallStackAtExit: number[]` - `isStaticCall: boolean` - `nested: CallStackMetadata[]` - `numNestedCalls: number` - `output: Fr[]` - `phase: TxExecutionPhase` - `reverted: boolean` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => CallStackMetadata` - Creates a CallStackMetadata from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getRevertReason() => SimulationError` ### Capsule Read-only data that is passed to the contract through an oracle during a transaction execution. Check whether this is always used to represent a transient capsule and if so, rename to TransientCapsule. **Constructor** ```typescript new Capsule(contractAddress: AztecAddress, storageSlot: Fr, data: Fr[]) ``` **Properties** - `readonly contractAddress: AztecAddress` - `readonly data: Fr[]` - `static schema: unknown` - `readonly storageSlot: Fr` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => Capsule` - `static fromString(str: string) => Capsule` - `toBuffer() => any` - `toJSON() => string` - `toString() => string` ### Checkpoint **Constructor** ```typescript new Checkpoint(archive: AppendOnlyTreeSnapshot, header: CheckpointHeader, blocks: L2BlockNew[], number: CheckpointNumber) ``` **Properties** - `archive: AppendOnlyTreeSnapshot` - `blocks: L2BlockNew[]` - `header: CheckpointHeader` - `number: CheckpointNumber` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => Checkpoint` - `static fromBuffer(buf: Buffer | BufferReader) => Checkpoint` - `static getFields(fields: FieldsOf) => readonly []` - `getState() => StateReference` - `hash() => Fr` - `static random(checkpointNumber?: CheckpointNumber, __namedParameters?: { numBlocks?: number; startBlockNumber?: number } & Partial> & Partial>> & Partial<{ checkpointNumber?: CheckpointNumber; indexWithinCheckpoint?: number; ... } & Partial> & Partial>>>) => Promise` - `toBlobFields() => Fr[]` - `toBuffer() => any` ### CheckpointConstantData Constants that are the same for the entire checkpoint. **Constructor** ```typescript new CheckpointConstantData(chainId: Fr, version: Fr, vkTreeRoot: Fr, protocolContractsHash: Fr, proverId: Fr, slotNumber: SlotNumber, coinbase: EthAddress, feeRecipient: AztecAddress, gasFees: GasFees) ``` **Properties** - `chainId: Fr` - `coinbase: EthAddress` - `feeRecipient: AztecAddress` - `gasFees: GasFees` - `protocolContractsHash: Fr` - `proverId: Fr` - `slotNumber: SlotNumber` - `version: Fr` - `vkTreeRoot: Fr` **Methods** - `[custom]() => string` - `static empty() => CheckpointConstantData` - `static from(fields: FieldsOf) => CheckpointConstantData` - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointConstantData` - `static getFields(fields: FieldsOf) => readonly []` - `getSlotNumber() => SlotNumber` - Returns the slot number as a SlotNumber branded type. - `toBuffer() => any` - `toInspect() => { chainId: number; coinbase: string; ... }` ### CheckpointHeader **Constructor** ```typescript new CheckpointHeader(lastArchiveRoot: Fr, blockHeadersHash: Fr, contentCommitment: ContentCommitment, slotNumber: SlotNumber, timestamp: bigint, coinbase: EthAddress, feeRecipient: AztecAddress, gasFees: GasFees, totalManaUsed: Fr) ``` **Properties** - `blockHeadersHash: Fr` - `coinbase: EthAddress` - `contentCommitment: ContentCommitment` - `feeRecipient: AztecAddress` - `gasFees: GasFees` - `lastArchiveRoot: Fr` - `static schema: unknown` - `slotNumber: SlotNumber` - `timestamp: bigint` - `totalManaUsed: Fr` **Methods** - `[custom]() => string` - `static empty(fields?: Partial>) => CheckpointHeader` - `equals(other: CheckpointHeader) => boolean` - `static from(fields: FieldsOf) => CheckpointHeader` - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointHeader` - `static fromString(str: string) => CheckpointHeader` - `static fromViem(header: ViemHeader) => CheckpointHeader` - `static getFields(fields: FieldsOf) => readonly []` - `getSlotNumber() => SlotNumber` - Returns the slot number as a SlotNumber branded type. - `hash() => Fr` - `isEmpty() => boolean` - `static random(overrides?: Partial> & Partial>) => CheckpointHeader` - `toBuffer() => any` - `toInspect() => { blockHeadersHash: string; coinbase: string; ... }` - `toString() => string` - Serializes this instance into a string. - `toViem() => ViemHeader` ### CheckpointMergeRollupPrivateInputs Represents inputs of the checkpoint merge rollup circuit. **Constructor** ```typescript new CheckpointMergeRollupPrivateInputs(previousRollups: []) ``` **Properties** - `previousRollups: []` - `static schema: unknown` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointMergeRollupPrivateInputs` - `static fromString(str: string) => CheckpointMergeRollupPrivateInputs` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### CheckpointPaddingRollupPrivateInputs **Constructor** ```typescript new CheckpointPaddingRollupPrivateInputs() ``` **Properties** - `static schema: unknown` **Methods** - `static fromBuffer(_buffer: Buffer | BufferReader) => CheckpointPaddingRollupPrivateInputs` - `static fromString(_str: string) => CheckpointPaddingRollupPrivateInputs` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### CheckpointRollupPublicInputs Output of the checkpoint root and checkpoint merge rollup circuits. **Constructor** ```typescript new CheckpointRollupPublicInputs(constants: EpochConstantData, previousArchive: AppendOnlyTreeSnapshot, newArchive: AppendOnlyTreeSnapshot, checkpointHeaderHashes: [], fees: [], startBlobAccumulator: BlobAccumulator, endBlobAccumulator: BlobAccumulator, finalBlobChallenges: FinalBlobBatchingChallenges) ``` **Properties** - `checkpointHeaderHashes: []` - `constants: EpochConstantData` - `endBlobAccumulator: BlobAccumulator` - `fees: []` - `finalBlobChallenges: FinalBlobBatchingChallenges` - `newArchive: AppendOnlyTreeSnapshot` - `previousArchive: AppendOnlyTreeSnapshot` - `static schema: unknown` - `startBlobAccumulator: BlobAccumulator` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointRollupPublicInputs` - `static fromString(str: string) => CheckpointRollupPublicInputs` - `toBuffer() => any` - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` ### CheckpointRootRollupHints **Constructor** ```typescript new CheckpointRootRollupHints(previousBlockHeader: BlockHeader, previousArchiveSiblingPath: [], startBlobAccumulator: BlobAccumulator, finalBlobChallenges: FinalBlobBatchingChallenges, blobFields: Fr[], blobCommitments: [], blobsHash: Fr) ``` **Properties** - `blobCommitments: []` - `blobFields: Fr[]` - `blobsHash: Fr` - `finalBlobChallenges: FinalBlobBatchingChallenges` - `previousArchiveSiblingPath: []` - `previousBlockHeader: BlockHeader` - `static schema: unknown` - `startBlobAccumulator: BlobAccumulator` **Methods** - `static from(fields: FieldsOf) => CheckpointRootRollupHints` - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointRootRollupHints` - `static fromString(str: string) => CheckpointRootRollupHints` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### CheckpointRootRollupPrivateInputs **Constructor** ```typescript new CheckpointRootRollupPrivateInputs(previousRollups: [], hints: CheckpointRootRollupHints) ``` **Properties** - `hints: CheckpointRootRollupHints` - `previousRollups: []` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => CheckpointRootRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointRootRollupPrivateInputs` - `static fromString(str: string) => CheckpointRootRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### CheckpointRootSingleBlockRollupPrivateInputs **Constructor** ```typescript new CheckpointRootSingleBlockRollupPrivateInputs(previousRollup: RollupHonkProofData, hints: CheckpointRootRollupHints) ``` **Properties** - `hints: CheckpointRootRollupHints` - `previousRollup: RollupHonkProofData` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => CheckpointRootSingleBlockRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => CheckpointRootSingleBlockRollupPrivateInputs` - `static fromString(str: string) => CheckpointRootSingleBlockRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - `toString() => string` ### ChonkProof **Constructor** ```typescript new ChonkProof(fields: Fr[]) ``` **Properties** - `fields: Fr[]` - `static schema: unknown` **Methods** - `attachPublicInputs(publicInputs: Fr[]) => ChonkProofWithPublicInputs` - `static empty() => ChonkProof` - `static fromBuffer(buffer: Buffer | BufferReader) => ChonkProof` - `isEmpty() => boolean` - `static random() => ChonkProof` - `toBuffer() => any` - `toJSON() => any` ### ChonkProofWithPublicInputs **Constructor** ```typescript new ChonkProofWithPublicInputs(fieldsWithPublicInputs: Fr[]) ``` **Properties** - `fieldsWithPublicInputs: Fr[]` - `static schema: unknown` **Methods** - `static empty() => ChonkProofWithPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => ChonkProofWithPublicInputs` - `static fromBufferArray(fields: Uint8Array[]) => ChonkProofWithPublicInputs` - `getPublicInputs() => Fr[]` - `isEmpty() => boolean` - `removePublicInputs() => ChonkProof` - `toBuffer() => any` - `toJSON() => any` ### ClaimedLengthArray **Constructor** ```typescript new ClaimedLengthArray(array: Tuple, claimedLength: number) ``` **Properties** - `array: Tuple` - `claimedLength: number` **Methods** - `[custom]() => string` - `static empty Fr } | string & { toField: () => Fr } | string & { toFields: () => Fr[] } | string & Fieldable[] | number & Buffer | number & Fr | number & { toFr: () => Fr } | number & { toField: () => Fr } | number & { toFields: () => Fr[] } | number & Fieldable[] | never | bigint & Fr | bigint & { toFr: () => Fr } | bigint & { toField: () => Fr } | bigint & { toFields: () => Fr[] } | bigint & Fieldable[] | false & Buffer | false & Fr | false & { toFr: () => Fr } | false & { toField: () => Fr } | false & { toFields: () => Fr[] } | false & Fieldable[] | true & Buffer | true & Fr | true & { toFr: () => Fr } | true & { toField: () => Fr } | true & { toFields: () => Fr[] } | true & Fieldable[] | Buffer & number | never | Buffer & false | Buffer & true | Buffer & Fr | Buffer & { toFr: () => Fr } | Buffer & { toField: () => Fr } | Buffer & { toFields: () => Fr[] } | Buffer & Fieldable[] | Uint8Array & number | never | Uint8Array & false | Uint8Array & true | Uint8Array & Buffer | Uint8Array & Fr | Uint8Array & { toFr: () => Fr } | Uint8Array & { toField: () => Fr } | Uint8Array & { toFields: () => Fr[] } | Uint8Array & Fieldable[] | { toBuffer: () => Buffer } & number | { toBuffer: () => Buffer } & bigint | { toBuffer: () => Buffer } & false | { toBuffer: () => Buffer } & true | { toBuffer: () => Buffer } & Buffer | { toBuffer: () => Buffer } & Fr | { toBuffer: () => Buffer } & { toFr: () => Fr } | { toBuffer: () => Buffer } & { toField: () => Fr } | { toBuffer: () => Buffer } & { toFields: () => Fr[] } | { toBuffer: () => Buffer } & Fieldable[] | Bufferable[] & number | Bufferable[] & bigint | Bufferable[] & false | Bufferable[] & true | Bufferable[] & Buffer | Bufferable[] & Fr | Bufferable[] & { toFr: () => Fr } | Bufferable[] & { toField: () => Fr } | Bufferable[] & { toFields: () => Fr[] } | Bufferable[] & Fieldable[], N extends number>(elem: { empty: () => T }, arraySize: number) => ClaimedLengthArray` - `static fromBuffer Fr } | string & { toField: () => Fr } | string & { toFields: () => Fr[] } | string & Fieldable[] | number & Buffer | number & Fr | number & { toFr: () => Fr } | number & { toField: () => Fr } | number & { toFields: () => Fr[] } | number & Fieldable[] | never | bigint & Fr | bigint & { toFr: () => Fr } | bigint & { toField: () => Fr } | bigint & { toFields: () => Fr[] } | bigint & Fieldable[] | false & Buffer | false & Fr | false & { toFr: () => Fr } | false & { toField: () => Fr } | false & { toFields: () => Fr[] } | false & Fieldable[] | true & Buffer | true & Fr | true & { toFr: () => Fr } | true & { toField: () => Fr } | true & { toFields: () => Fr[] } | true & Fieldable[] | Buffer & number | never | Buffer & false | Buffer & true | Buffer & Fr | Buffer & { toFr: () => Fr } | Buffer & { toField: () => Fr } | Buffer & { toFields: () => Fr[] } | Buffer & Fieldable[] | Uint8Array & number | never | Uint8Array & false | Uint8Array & true | Uint8Array & Buffer | Uint8Array & Fr | Uint8Array & { toFr: () => Fr } | Uint8Array & { toField: () => Fr } | Uint8Array & { toFields: () => Fr[] } | Uint8Array & Fieldable[] | { toBuffer: () => Buffer } & number | { toBuffer: () => Buffer } & bigint | { toBuffer: () => Buffer } & false | { toBuffer: () => Buffer } & true | { toBuffer: () => Buffer } & Buffer | { toBuffer: () => Buffer } & Fr | { toBuffer: () => Buffer } & { toFr: () => Fr } | { toBuffer: () => Buffer } & { toField: () => Fr } | { toBuffer: () => Buffer } & { toFields: () => Fr[] } | { toBuffer: () => Buffer } & Fieldable[] | Bufferable[] & number | Bufferable[] & bigint | Bufferable[] & false | Bufferable[] & true | Bufferable[] & Buffer | Bufferable[] & Fr | Bufferable[] & { toFr: () => Fr } | Bufferable[] & { toField: () => Fr } | Bufferable[] & { toFields: () => Fr[] } | Bufferable[] & Fieldable[], N extends number>(buffer: Buffer | BufferReader, deserializer: { fromBuffer: (reader: BufferReader) => T }, arrayLength: N) => ClaimedLengthArray` - `static fromFields Fr } | string & { toField: () => Fr } | string & { toFields: () => Fr[] } | string & Fieldable[] | number & Buffer | number & Fr | number & { toFr: () => Fr } | number & { toField: () => Fr } | number & { toFields: () => Fr[] } | number & Fieldable[] | never | bigint & Fr | bigint & { toFr: () => Fr } | bigint & { toField: () => Fr } | bigint & { toFields: () => Fr[] } | bigint & Fieldable[] | false & Buffer | false & Fr | false & { toFr: () => Fr } | false & { toField: () => Fr } | false & { toFields: () => Fr[] } | false & Fieldable[] | true & Buffer | true & Fr | true & { toFr: () => Fr } | true & { toField: () => Fr } | true & { toFields: () => Fr[] } | true & Fieldable[] | Buffer & number | never | Buffer & false | Buffer & true | Buffer & Fr | Buffer & { toFr: () => Fr } | Buffer & { toField: () => Fr } | Buffer & { toFields: () => Fr[] } | Buffer & Fieldable[] | Uint8Array & number | never | Uint8Array & false | Uint8Array & true | Uint8Array & Buffer | Uint8Array & Fr | Uint8Array & { toFr: () => Fr } | Uint8Array & { toField: () => Fr } | Uint8Array & { toFields: () => Fr[] } | Uint8Array & Fieldable[] | { toBuffer: () => Buffer } & number | { toBuffer: () => Buffer } & bigint | { toBuffer: () => Buffer } & false | { toBuffer: () => Buffer } & true | { toBuffer: () => Buffer } & Buffer | { toBuffer: () => Buffer } & Fr | { toBuffer: () => Buffer } & { toFr: () => Fr } | { toBuffer: () => Buffer } & { toField: () => Fr } | { toBuffer: () => Buffer } & { toFields: () => Fr[] } | { toBuffer: () => Buffer } & Fieldable[] | Bufferable[] & number | Bufferable[] & bigint | Bufferable[] & false | Bufferable[] & true | Bufferable[] & Buffer | Bufferable[] & Fr | Bufferable[] & { toFr: () => Fr } | Bufferable[] & { toField: () => Fr } | Bufferable[] & { toFields: () => Fr[] } | Bufferable[] & Fieldable[], N extends number>(fields: Fr[] | FieldReader, deserializer: { fromFields: (reader: FieldReader) => T }, arrayLength: N) => ClaimedLengthArray` - `getActiveItems() => T[]` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### CollectionLimitsConfig **Constructor** ```typescript new CollectionLimitsConfig(maxDebugLogMemoryReads: number, maxCalldataSizeInFields: number, maxReturndataSizeInFields: number, maxCallStackDepth: number, maxCallStackItems: number) ``` **Properties** - `readonly maxCalldataSizeInFields: number` - `readonly maxCallStackDepth: number` - `readonly maxCallStackItems: number` - `readonly maxDebugLogMemoryReads: number` - `readonly maxReturndataSizeInFields: number` - `static schema: unknown` **Methods** - `static empty() => CollectionLimitsConfig` - `static from(obj: Partial) => CollectionLimitsConfig` ### CommitmentMap Used store and serialize a key-value map of commitments where key is the name of the commitment and value is the commitment itself. The name can be e.g. Q_1, Q_2, SIGMA_1 etc. **Constructor** ```typescript new CommitmentMap(record: {}) ``` **Properties** - `record: {}` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => CommitmentMap` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `toBuffer() => any` - Serialize as a buffer. ### CommitteeAttestation **Constructor** ```typescript new CommitteeAttestation(address: EthAddress, signature: Signature) ``` **Properties** - `readonly address: EthAddress` - `static schema: unknown` - `readonly signature: Signature` **Methods** - `static empty() => CommitteeAttestation` - `equals(other: CommitteeAttestation) => boolean` - `static fromAddress(address: EthAddress) => CommitteeAttestation` - `static fromAddressAndSignature(address: EthAddress, signature: Signature) => CommitteeAttestation` - `static fromBuffer(buffer: Buffer | BufferReader) => CommitteeAttestation` - `static fromPacked(packed: ViemCommitteeAttestations, committeeSize: number) => CommitteeAttestation[]` - `static fromSignature(signature: Signature) => CommitteeAttestation` - `static fromViem(viem: ViemCommitteeAttestation) => CommitteeAttestation` - `static random() => CommitteeAttestation` - `toBuffer() => Buffer` - `toViem() => ViemCommitteeAttestation` ### CommitteeAttestationsAndSigners Implements: `Signable` **Constructor** ```typescript new CommitteeAttestationsAndSigners(attestations: CommitteeAttestation[]) ``` **Properties** - `attestations: CommitteeAttestation[]` - `static schema: unknown` **Methods** - `static empty() => CommitteeAttestationsAndSigners` - `getPackedAttestations() => ViemCommitteeAttestations` - Packs an array of committee attestations into the format expected by the Solidity contract - `getPayloadToSign(domainSeparator: SignatureDomainSeparator) => Buffer` - `getSignedAttestations() => CommitteeAttestation[]` - `getSigners() => EthAddress[]` - `toString() => void` - Returns a string representation of an object. ### CompleteAddress A complete address is a combination of an Aztec address, a public key and a partial address. **Properties** - `address: AztecAddress` - `partialAddress: Fr` - `publicKeys: PublicKeys` - `static schema: unknown` - `static readonly SIZE_IN_BYTES: number` - Size in bytes of an instance **Methods** - `static create(address: AztecAddress, publicKeys: PublicKeys, partialAddress: Fr) => Promise` - `equals(other: CompleteAddress) => boolean` - Determines if this CompleteAddress instance is equal to the given CompleteAddress instance. Equality is based on the content of their respective buffers. - `static fromBuffer(buffer: Buffer | BufferReader) => Promise` - Creates an CompleteAddress instance from a given buffer or BufferReader. If the input is a Buffer, it wraps it in a BufferReader before processing. Throws an error if the input length is not equal to the expected size. - `static fromSecretKeyAndInstance(secretKey: Fr, instance: Pick | { originalContractClassId: Fr; saltedInitializationHash: Fr }) => Promise` - `static fromSecretKeyAndPartialAddress(secretKey: Fr, partialAddress: Fr) => Promise` - `static fromString(address: string) => Promise` - Create a CompleteAddress instance from a hex-encoded string. The input 'address' should be prefixed with '0x' or not, and have exactly 128 hex characters representing the x and y coordinates. Throws an error if the input length is invalid or coordinate values are out of range. - `getPreaddress() => Promise` - `static random() => Promise` - `toBuffer() => Buffer` - Converts the CompleteAddress instance into a Buffer. This method should be used when encoding the address for storage, transmission or serialization purposes. - `toJSON() => string` - `toReadableString() => string` - Gets a readable string representation of the complete address. - `toString() => string` - Convert the CompleteAddress to a hexadecimal string representation, with a "0x" prefix. The resulting string will have a length of 66 characters (including the prefix). - `validate() => Promise` - Throws if the address is not correctly derived from the public key and partial address. ### ComponentsVersionsError Extends: `Error` **Constructor** ```typescript new ComponentsVersionsError(key: string, expected: string, value: string) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### ConsensusPayload Implements: `Signable` **Constructor** ```typescript new ConsensusPayload(header: CheckpointHeader, archive: Fr) ``` **Properties** - `readonly archive: Fr` - `readonly header: CheckpointHeader` - `static schema: unknown` **Methods** - `static empty() => ConsensusPayload` - `equals(other: ConsensusPayload) => boolean` - `static fromBlock(block: L2Block) => ConsensusPayload` - `static fromBuffer(buf: Buffer | BufferReader) => ConsensusPayload` - `static fromCheckpoint(checkpoint: Checkpoint) => ConsensusPayload` - `static fromFields(fields: FieldsOf) => ConsensusPayload` - `static getFields(fields: FieldsOf) => readonly []` - `getPayloadToSign(domainSeparator: SignatureDomainSeparator) => Buffer` - `getSize() => number` - Get the size of the consensus payload in bytes. - `static random() => ConsensusPayload` - `toBuffer() => Buffer` - `toInspect() => { archive: string; header: { blockHeadersHash: string; coinbase: string; ... } }` - `toString() => string` - Returns a string representation of an object. ### ContentCommitment **Constructor** ```typescript new ContentCommitment(blobsHash: Fr, inHash: Fr, outHash: Fr) ``` **Properties** - `blobsHash: Fr` - `inHash: Fr` - `outHash: Fr` - `static schema: unknown` **Methods** - `static empty() => ContentCommitment` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => ContentCommitment` - `static fromBuffer(buffer: Buffer | BufferReader) => ContentCommitment` - `static fromFields(fields: Fr[] | FieldReader) => ContentCommitment` - `static fromString(str: string) => ContentCommitment` - `static fromViem(contentCommitment: ViemContentCommitment) => ContentCommitment` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `static random(overrides?: Partial>) => ContentCommitment` - `toBuffer() => any` - `toFields() => Fr[]` - `toInspect() => { blobsHash: string; inHash: string; outHash: string }` - `toString() => string` - `toViem() => ViemContentCommitment` ### ContractClassLog **Constructor** ```typescript new ContractClassLog(contractAddress: AztecAddress, fields: ContractClassLogFields, emittedLength: number) ``` **Properties** - `contractAddress: AztecAddress` - `emittedLength: number` - `fields: ContractClassLogFields` - `static schema: unknown` - `static SIZE_IN_BYTES: number` **Methods** - `[custom]() => string` - `static empty() => ContractClassLog` - `equals(other: ContractClassLog) => boolean` - `static from(fields: FieldsOf) => ContractClassLog` - `static fromBlobFields(emittedLength: number, fields: Fr[] | FieldReader) => ContractClassLog` - `static fromBuffer(buffer: Buffer | BufferReader) => ContractClassLog` - `static fromFields(fields: Fr[] | FieldReader) => ContractClassLog` - `static fromPlainObject(obj: any) => ContractClassLog` - Creates a ContractClassLog from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getEmittedFields() => Fr[]` - `hash() => Promise` - `isEmpty() => boolean` - `static random() => Promise` - `toBlobFields() => Fr[]` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### ContractClassLogFields **Constructor** ```typescript new ContractClassLogFields(fields: Fr[]) ``` **Properties** - `fields: Fr[]` - `static schema: unknown` **Methods** - `clone() => ContractClassLogFields` - `static empty() => ContractClassLogFields` - `equals(other: ContractClassLogFields) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => ContractClassLogFields` - `static fromEmittedFields(emittedFields: Fr[]) => ContractClassLogFields` - `static fromFields(fields: Fr[] | FieldReader) => ContractClassLogFields` - `static fromPlainObject(obj: any) => ContractClassLogFields` - Creates a ContractClassLogFields from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getEmittedFields(emittedLength: number) => Fr[]` - `hash() => Promise` - `isEmpty() => boolean` - `static random(emittedLength?: number) => ContractClassLogFields` - `toBuffer() => any` - `toFields() => Fr[]` ### ContractDeploymentData Class containing contract class logs and private logs which are both relevant for contract registrations and deployments. **Constructor** ```typescript new ContractDeploymentData(contractClassLogs: ContractClassLog[], privateLogs: PrivateLog[]) ``` **Properties** - `readonly contractClassLogs: ContractClassLog[]` - `readonly privateLogs: PrivateLog[]` - `static schema: unknown` **Methods** - `static empty() => ContractDeploymentData` - `static from(args: { contractClassLogs: ContractClassLog[]; privateLogs: PrivateLog[] }) => ContractDeploymentData` - `static fromPlainObject(obj: any) => ContractDeploymentData` - Creates a ContractDeploymentData from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getContractClassLogs() => ContractClassLog[]` - `getPrivateLogs() => PrivateLog[]` ### ContractStorageRead Contract storage read operation on a specific contract. Note: Similar to `PublicDataRead` but it's from the POV of contract storage so we are not working with public data tree leaf index but storage slot index. **Constructor** ```typescript new ContractStorageRead(storageSlot: Fr, currentValue: Fr, counter: number, contractAddress?: AztecAddress) ``` **Properties** - `contractAddress?: AztecAddress` - `readonly counter: number` - `readonly currentValue: Fr` - `readonly storageSlot: Fr` **Methods** - `static empty() => ContractStorageRead` - `static from(args: { contractAddress?: AztecAddress; counter: number; ... }) => ContractStorageRead` - `static fromBuffer(buffer: Buffer | BufferReader) => ContractStorageRead` - `static fromFields(fields: Fr[] | FieldReader) => ContractStorageRead` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` - `toFriendlyJSON() => string` ### ContractStorageUpdateRequest Contract storage update request for a slot on a specific contract. Note: Similar to `PublicDataUpdateRequest` but it's from the POV of contract storage so we are not working with public data tree leaf index but storage slot index. **Constructor** ```typescript new ContractStorageUpdateRequest(storageSlot: Fr, newValue: Fr, counter: number, contractAddress?: AztecAddress) ``` **Properties** - `contractAddress?: AztecAddress` - `readonly counter: number` - `readonly newValue: Fr` - `readonly storageSlot: Fr` **Methods** - `static empty() => ContractStorageUpdateRequest` - `static from(fields: FieldsOf) => ContractStorageUpdateRequest` - Create ContractStorageUpdateRequest from a fields dictionary. - `static fromBuffer(buffer: Buffer | BufferReader) => ContractStorageUpdateRequest` - `static fromFields(fields: Fr[] | FieldReader) => ContractStorageUpdateRequest` - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` - `toFriendlyJSON() => string` ### CountedContractClassLog Implements: `IsEmpty` **Constructor** ```typescript new CountedContractClassLog(log: ContractClassLog, counter: number) ``` **Properties** - `counter: number` - `log: ContractClassLog` - `static schema: unknown` **Methods** - `static from(fields: { counter: number; log: ContractClassLog }) => CountedContractClassLog` - `isEmpty() => boolean` ### CountedL2ToL1Message **Constructor** ```typescript new CountedL2ToL1Message(message: L2ToL1Message, counter: number) ``` **Properties** - `counter: number` - `message: L2ToL1Message` - `static schema: unknown` **Methods** - `static empty() => CountedL2ToL1Message` - `static fromBuffer(buffer: Buffer | BufferReader) => CountedL2ToL1Message` - `static fromFields(fields: Fr[] | FieldReader) => CountedL2ToL1Message` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### CountedLogHash **Constructor** ```typescript new CountedLogHash(logHash: LogHash, counter: number) ``` **Properties** - `counter: number` - `logHash: LogHash` **Methods** - `static empty() => CountedLogHash` - `static fromBuffer(buffer: Buffer | BufferReader) => CountedLogHash` - `static fromFields(fields: Fr[] | FieldReader) => CountedLogHash` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### CountedPublicCallRequest **Constructor** ```typescript new CountedPublicCallRequest(inner: PublicCallRequest, counter: number) ``` **Properties** - `counter: number` - `inner: PublicCallRequest` **Methods** - `static empty() => CountedPublicCallRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => CountedPublicCallRequest` - `static fromFields(fields: Fr[] | FieldReader) => CountedPublicCallRequest` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### DatabasePublicStateSource Provides a view into public contract state Implements: `PublicStateSource` **Constructor** ```typescript new DatabasePublicStateSource(db: MerkleTreeReadOperations) ``` **Methods** - `storageRead(contractAddress: AztecAddress, slot: Fr) => Promise` - Returns the value for a given slot at a given contract. ### DatabaseVersion Represents a version record for storing in a version file. **Constructor** ```typescript new DatabaseVersion(schemaVersion: number, rollupAddress: EthAddress) ``` **Properties** - `readonly rollupAddress: EthAddress` - `static schema: unknown` - `readonly schemaVersion: number` **Methods** - `[custom]() => string` - Allows for better introspection. - `cmp(other: DatabaseVersion) => -1 | 0 | 1` - Compares two versions. If the rollups addresses are different then it returns undefined - `static empty() => DatabaseVersion` - Returns an empty instance - `equals(other: DatabaseVersion) => boolean` - Checks if two versions exactly match - `static fromBuffer(buf: Buffer) => DatabaseVersion` - `toBuffer() => Buffer` - `toString() => string` ### DatabaseVersionManager A manager for handling database versioning and migrations. This class will check the version of data in a directory and either reset or upgrade based on version compatibility. **Constructor** ```typescript new DatabaseVersionManager(__namedParameters: DatabaseVersionManagerOptions) ``` **Properties** - `static readonly VERSION_FILE: string` **Methods** - `getDataDirectory() => string` - Get the data directory path - `getSchemaVersion() => number` - Get the current version number - `open() => Promise<[]>` - Checks the stored version against the current version and handles the outcome by either resetting the data directory or calling an upgrade function - `resetDataDirectory() => Promise` - Resets the data directory by deleting it and recreating it - `static writeVersion(version: DatabaseVersion, dataDir: string, fileSystem?: DatabaseVersionManagerFs) => Promise` ### DebugLog **Constructor** ```typescript new DebugLog(contractAddress: AztecAddress, level: "silent" | "fatal" | "error" | "warn" | "info" | "verbose" | "debug" | "trace", message: string, fields: Fr[]) ``` **Properties** - `contractAddress: AztecAddress` - `fields: Fr[]` - `level: "silent" | "fatal" | "error" | "warn" | "info" | "verbose" | "debug" | "trace"` - `message: string` - `static schema: unknown` **Methods** - `static fromPlainObject(obj: any) => DebugLog` - Creates a DebugLog from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### DelayedPublicMutableValues **Constructor** ```typescript new DelayedPublicMutableValues(svc: ScheduledValueChange, sdc: ScheduledDelayChange) ``` **Properties** - `sdc: ScheduledDelayChange` - `svc: ScheduledValueChange` **Methods** - `static empty(valueSize: number) => DelayedPublicMutableValues` - `static fromBuffer(buffer: Buffer | BufferReader, valueSize: number) => DelayedPublicMutableValues` - `static fromFields(fields: Fr[] | FieldReader) => DelayedPublicMutableValues` - `hash() => Promise` - `isEmpty() => boolean` - `static readFromTree(delayedPublicMutableSlot: Fr, readStorage: (storageSlot: Fr) => Promise) => Promise` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `writeToTree(delayedPublicMutableSlot: Fr, storageWrite: (storageSlot: Fr, value: Fr) => Promise) => Promise` ### DelayedPublicMutableValuesWithHash **Constructor** ```typescript new DelayedPublicMutableValuesWithHash(svc: ScheduledValueChange, sdc: ScheduledDelayChange) ``` **Methods** - `static getContractUpdateSlots(contractAddress: AztecAddress) => Promise<{ delayedPublicMutableHashSlot: Fr; delayedPublicMutableSlot: Fr }>` - `toFields() => Promise` - `writeToTree(delayedPublicMutableSlot: Fr, storageWrite: (storageSlot: Fr, value: Fr) => Promise) => Promise` ### DirectionalAppTaggingSecret Directional application tagging secret used for log tagging. "Directional" because the derived secret is bound to the recipient address: A→B differs from B→A even with the same participants and app. Note: It's a bit unfortunate that this type resides in `stdlib` as the rest of the tagging functionality resides in `pxe/src/tagging`. We need to use this type in `PreTag` that in turn is used by other types in stdlib hence there doesn't seem to be a good way around this. **Properties** - `readonly value: Fr` **Methods** - `static compute(localAddress: CompleteAddress, localIvsk: Fq, externalAddress: AztecAddress, app: AztecAddress, recipient: AztecAddress) => Promise` - Derives shared tagging secret and from that, the app address and recipient derives the directional app tagging secret. - `static fromString(str: string) => DirectionalAppTaggingSecret` - `toString() => string` ### EmptyTxValidator Implements: `TxValidator` **Constructor** ```typescript new EmptyTxValidator() ``` **Methods** - `validateTx(_tx: T) => Promise` ### EpochConstantData Constants that are the same for the entire epoch. **Constructor** ```typescript new EpochConstantData(chainId: Fr, version: Fr, vkTreeRoot: Fr, protocolContractsHash: Fr, proverId: Fr) ``` **Properties** - `chainId: Fr` - `protocolContractsHash: Fr` - `proverId: Fr` - `version: Fr` - `vkTreeRoot: Fr` **Methods** - `static empty() => EpochConstantData` - `static from(fields: FieldsOf) => EpochConstantData` - `static fromBuffer(buffer: Buffer | BufferReader) => EpochConstantData` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toFields() => Fr[]` ### EthAddress Represents an Ethereum address as a 20-byte buffer and provides various utility methods for converting between different representations, generating random addresses, validating checksums, and comparing addresses. EthAddress can be instantiated using a buffer or string, and can be serialized/deserialized from a buffer or BufferReader. **Constructor** ```typescript new EthAddress(buffer: Buffer) ``` **Properties** - `static schema: unknown` - `static SIZE_IN_BYTES: number` - The size of an Ethereum address in bytes. - `static ZERO: EthAddress` - Represents a zero Ethereum address with 20 bytes filled with zeros. **Methods** - `[custom]() => string` - `static areEqual(a: string | EthAddress, b: string | EthAddress) => boolean` - `static checkAddressChecksum(address: string) => boolean` - Checks if the given Ethereum address has a valid checksum. The input 'address' should be prefixed with '0x' or not, and have exactly 40 hex characters. Returns true if the address has a valid checksum, false otherwise. - `equals(rhs: EthAddress) => boolean` - Checks whether the given EthAddress instance is equal to the current instance. Equality is determined by comparing the underlying byte buffers of both instances. - `static fromBuffer(buffer: Buffer | BufferReader) => EthAddress` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromField(fr: Fr) => EthAddress` - Converts a field to a eth address. - `static fromFields(fields: Fr[] | FieldReader) => EthAddress` - `static fromNumber(num: number | bigint) => EthAddress` - Converts a number into an address. Useful for testing. - `static fromPlainObject(obj: any) => EthAddress` - Creates an EthAddress from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). Handles buffers (20 or 32 bytes), strings, or existing instances. - `static fromString(address: string) => EthAddress` - Creates an EthAddress instance from a valid Ethereum address string. The input 'address' can be either in checksum format or lowercase, and it can be prefixed with '0x'. Throws an error if the input is not a valid Ethereum address. - `static isAddress(address: string) => boolean` - Determines if the given string represents a valid Ethereum address. A valid address should meet the following criteria: 1. Contains exactly 40 hex characters (excluding an optional '0x' prefix). 2. Is either all lowercase, all uppercase, or has a valid checksum based on EIP-55. - `isZero() => boolean` - Checks if the EthAddress instance represents a zero address. A zero address consists of 20 bytes filled with zeros and is considered an invalid address. - `static random() => EthAddress` - Create a random EthAddress instance with 20 random bytes. This method generates a new Ethereum address with a randomly generated set of 20 bytes. It is useful for generating test addresses or unique identifiers. - `toBuffer() => any` - Returns a 20-byte buffer representation of the Ethereum address. - `toBuffer32() => any` - Returns a 32-byte buffer representation of the Ethereum address, with the original 20-byte address occupying the last 20 bytes and the first 12 bytes being zero-filled. This format is commonly used in smart contracts when handling addresses as 32-byte values. - `static toChecksumAddress(address: string) => string` - Converts an Ethereum address to its checksum format. The input 'address' should be prefixed with '0x' or not, and have exactly 40 hex characters. The checksum format is created by capitalizing certain characters in the hex string based on the hash of the lowercase address. Throws an error if the input address is invalid. - `toChecksumString() => string` - Returns the Ethereum address as a checksummed string. The output string will have characters in the correct upper or lowercase form, according to EIP-55. This provides a way to verify if an address is typed correctly, by checking the character casing. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toJSON() => string` - `toString() => string` - Converts the Ethereum address to a hex-encoded string. The resulting string is prefixed with '0x' and has exactly 40 hex characters. This method can be used to represent the EthAddress instance in the widely used hexadecimal format. ### EventSelector An event selector is the first 4 bytes of the hash of an event signature. Extends: `Selector` **Constructor** ```typescript new EventSelector(value: number) ``` **Properties** - `_branding: "EventSelector"` - Brand. - `static schema: unknown` - `static SIZE: number` - The size of the selector in bytes. - `value: number` **Methods** - `[custom]() => string` - `static empty() => EventSelector` - Creates an empty selector. - `equals(other: Selector) => boolean` - Checks if this selector is equal to another. - `static fromBuffer(buffer: Buffer | BufferReader) => EventSelector` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromField(fr: Fr) => EventSelector` - Converts a field to selector. - `static fromSignature(signature: string) => Promise` - Creates a selector from a signature. - `static fromString(selector: string) => EventSelector` - Create a Selector instance from a hex-encoded string. - `isEmpty() => boolean` - Checks if the selector is empty (all bytes are 0). - `static random() => EventSelector` - Creates a random selector. - `toBuffer(bufferSize?: number) => Buffer` - Serialize as a buffer. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toJSON() => string` - `toString() => string` - Serialize as a hex string. ### ExecutionPayload Represents data necessary to perform an action in the network successfully. This class can be considered Aztec's "minimal execution unit". **Constructor** ```typescript new ExecutionPayload(calls: FunctionCall[], authWitnesses: AuthWitness[], capsules: Capsule[], extraHashedArgs?: HashedValues[], feePayer?: AztecAddress) ``` **Properties** - `authWitnesses: AuthWitness[]` - `calls: FunctionCall[]` - `capsules: Capsule[]` - `extraHashedArgs: HashedValues[]` - `feePayer?: AztecAddress` **Methods** - `static empty() => ExecutionPayload` ### ExtendedContractClassLog Represents an individual contract class log entry extended with info about the block and tx it was emitted in. **Constructor** ```typescript new ExtendedContractClassLog(id: LogId, log: ContractClassLog) ``` **Properties** - `readonly id: LogId` - `readonly log: ContractClassLog` - `static schema: unknown` **Methods** - `equals(other: ExtendedContractClassLog) => boolean` - Checks if two ExtendedContractClassLog objects are equal. - `static from(fields: FieldsOf) => ExtendedContractClassLog` - `static fromBuffer(buffer: Buffer | BufferReader) => ExtendedContractClassLog` - Deserializes log from a buffer. - `static fromString(data: string) => ExtendedContractClassLog` - Deserializes `ExtendedContractClassLog` object from a hex string representation. - `static random() => Promise` - `toBuffer() => Buffer` - Serializes log to a buffer. - `toString() => string` - Serializes log to a string. ### ExtendedPublicLog Represents an individual public log entry extended with info about the block and tx it was emitted in. **Constructor** ```typescript new ExtendedPublicLog(id: LogId, log: PublicLog) ``` **Properties** - `readonly id: LogId` - `readonly log: PublicLog` - `static schema: unknown` **Methods** - `equals(other: ExtendedPublicLog) => boolean` - Checks if two ExtendedPublicLog objects are equal. - `static from(fields: FieldsOf) => ExtendedPublicLog` - `static fromBuffer(buffer: Buffer | BufferReader) => ExtendedPublicLog` - Deserializes log from a buffer. - `static fromString(data: string) => ExtendedPublicLog` - Deserializes `ExtendedPublicLog` object from a hex string representation. - `static random() => Promise` - `toBuffer() => Buffer` - Serializes log to a buffer. - `toHumanReadable() => string` - Serializes log to a human readable string. - `toString() => string` - Serializes log to a string. ### FailedToReExecuteTransactionsError Extends: `ValidatorError` **Constructor** ```typescript new FailedToReExecuteTransactionsError(txHashes: TxHash[]) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### FeeRecipient **Constructor** ```typescript new FeeRecipient(recipient: EthAddress, value: Fr) ``` **Properties** - `recipient: EthAddress` - `value: Fr` **Methods** - `static empty() => FeeRecipient` - `static fromBuffer(buffer: Buffer | BufferReader) => FeeRecipient` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `static random() => FeeRecipient` - `toBuffer() => any` - `toFields() => Fr[]` - `toFriendlyJSON() => { recipient?: undefined; value?: undefined } | { recipient: string; value: string }` ### FlatPublicLogs **Constructor** ```typescript new FlatPublicLogs(length: number, payload: Fr[]) ``` **Properties** - `length: number` - `payload: Fr[]` - `static schema: unknown` **Methods** - `static empty() => FlatPublicLogs` - `static fromBlobFields(length: number, fields: Fr[] | FieldReader) => FlatPublicLogs` - `static fromBuffer(buffer: Buffer | BufferReader) => FlatPublicLogs` - `static fromFields(fields: Fr[] | FieldReader) => FlatPublicLogs` - `static fromLogs(logs: PublicLog[]) => FlatPublicLogs` - `static fromPlainObject(obj: any) => FlatPublicLogs` - Creates a FlatPublicLogs instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `isEmpty() => boolean` - `toBlobFields() => Fr[]` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toLogs() => PublicLog[]` ### FunctionCall A request to call a function on a contract. **Constructor** ```typescript new FunctionCall(name: string, to: AztecAddress, selector: FunctionSelector, type: FunctionType, hideMsgSender: boolean, isStatic: boolean, args: Fr[], returnTypes: AbiType[]) ``` **Properties** - `args: Fr[]` - `hideMsgSender: boolean` - `isStatic: boolean` - `name: string` - `returnTypes: AbiType[]` - `selector: FunctionSelector` - `to: AztecAddress` - `type: FunctionType` **Methods** - `static empty() => { args: never[]; hideMsgSender: boolean; ... }` - Creates an empty function call. - `static from(fields: FieldsOf) => FunctionCall` - `static getFields(fields: FieldsOf) => readonly []` ### FunctionData Function description for circuit. **Constructor** ```typescript new FunctionData(selector: FunctionSelector, isPrivate: boolean) ``` **Properties** - `isPrivate: boolean` - `static schema: unknown` - `selector: FunctionSelector` **Methods** - `static empty(args?: { isPrivate?: boolean; isStatic?: boolean }) => FunctionData` - Returns a new instance of FunctionData with zero function selector. - `equals(other: FunctionData) => boolean` - Returns whether this instance is equal to another. - `static fromAbi(abi: FunctionAbi | ContractFunctionDao) => Promise` - `static fromBuffer(buffer: Buffer | BufferReader) => FunctionData` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromFields(fields: Fr[] | FieldReader) => FunctionData` - `isEmpty() => boolean` - Returns whether this instance is empty. - `toBuffer() => Buffer` - Serialize this as a buffer. - `toFields() => Fr[]` ### FunctionSelector A function selector is the first 4 bytes of the hash of a function signature. Extends: `Selector` **Constructor** ```typescript new FunctionSelector(value: number) ``` **Properties** - `_branding: "FunctionSelector"` - Brand. - `static schema: unknown` - `static SIZE: number` - The size of the selector in bytes. - `value: number` **Methods** - `[custom]() => string` - `static empty() => FunctionSelector` - Creates an empty selector. - `equals(other: Selector) => boolean` - Checks if this selector is equal to another. - `static fromBuffer(buffer: Buffer | BufferReader) => FunctionSelector` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromField(fr: Fr) => FunctionSelector` - Converts a field to selector. - `static fromFields(fields: Fr[] | FieldReader) => FunctionSelector` - `static fromNameAndParameters(args: { name: string; parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[] }) => Promise` - Creates a function selector for a given function name and parameters. - `static fromSignature(signature: string) => Promise` - Creates a selector from a signature. - `static fromString(selector: string) => FunctionSelector` - Create a Selector instance from a hex-encoded string. - `isEmpty() => boolean` - Checks if the selector is empty (all bytes are 0). - `static random() => FunctionSelector` - Creates a random instance. - `toBuffer(bufferSize?: number) => Buffer` - Serialize as a buffer. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toJSON() => string` - `toString() => string` - Serialize as a hex string. ### FunctionSignatureDecoder Decodes the signature of a function from the name and parameters. **Constructor** ```typescript new FunctionSignatureDecoder(name: string, parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[], includeNames?: boolean) ``` **Methods** - `decode() => string` - Decodes all the parameters and build the function signature ### G1AffineElement Curve data. **Constructor** ```typescript new G1AffineElement(x: bigint | Fq, y: bigint | Fq) ``` **Properties** - `x: Fq` - Element's x coordinate. - `y: Fq` - Element's y coordinate. **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => G1AffineElement` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `toBuffer() => any` - Serialize as a buffer. ### Gas Gas amounts in each dimension. **Constructor** ```typescript new Gas(daGas: number, l2Gas: number) ``` **Properties** - `readonly daGas: number` - `readonly l2Gas: number` - `static schema: unknown` **Methods** - `[custom]() => string` - `add(other: Gas) => Gas` - `clone() => Gas` - `computeFee(gasFees: GasFees) => Fr` - `static empty() => Gas` - `equals(other: Gas) => boolean` - `static from(fields: Partial>) => Gas` - `static fromBuffer(buffer: Buffer | BufferReader) => Gas` - `static fromFields(fields: Fr[] | FieldReader) => Gas` - `static fromPlainObject(obj: any) => Gas` - Creates a Gas instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `get(dimension: "da" | "l2") => number` - `getSize() => number` - `gtAny(other: Gas) => boolean` - Returns true if any of this instance's dimensions is greater than the corresponding on the other. - `isEmpty() => boolean` - `mul(scalar: number) => Gas` - `static random() => Gas` - `sub(other: Gas) => Gas` - `toBuffer() => any` - `toFields() => Fr[]` ### GasFees Gas prices for each dimension. **Constructor** ```typescript new GasFees(feePerDaGas: number | bigint, feePerL2Gas: number | bigint) ``` **Properties** - `readonly feePerDaGas: bigint` - `readonly feePerL2Gas: bigint` - `static schema: unknown` **Methods** - `[custom]() => string` - `clone() => GasFees` - `static empty() => GasFees` - `equals(other: GasFees) => boolean` - `static from(fields: FieldsOf) => GasFees` - `static fromBuffer(buffer: Buffer | BufferReader) => GasFees` - `static fromFields(fields: Fr[] | FieldReader) => GasFees` - `static fromPlainObject(obj: any) => GasFees` - Creates a GasFees instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `get(dimension: "da" | "l2") => bigint` - `isEmpty() => boolean` - `mul(scalar: number | bigint) => GasFees` - `static random() => GasFees` - `toBuffer() => any` - `toFields() => Fr[]` - `toInspect() => { feePerDaGas: bigint; feePerL2Gas: bigint }` ### GasSettings Gas usage and fees limits set by the transaction sender for different dimensions and phases. **Constructor** ```typescript new GasSettings(gasLimits: Gas, teardownGasLimits: Gas, maxFeesPerGas: GasFees, maxPriorityFeesPerGas: GasFees) ``` **Properties** - `readonly gasLimits: Gas` - `readonly maxFeesPerGas: GasFees` - `readonly maxPriorityFeesPerGas: GasFees` - `static schema: unknown` - `readonly teardownGasLimits: Gas` **Methods** - `clone() => GasSettings` - `static default(overrides: { gasLimits?: Gas; maxFeesPerGas: GasFees; ... }) => GasSettings` - Default gas settings to use when user has not provided them. Requires explicit max fees per gas. - `static empty() => GasSettings` - Zero-value gas settings. - `equals(other: GasSettings) => boolean` - `static from(args: { gasLimits: FieldsOf; maxFeesPerGas: FieldsOf; ... }) => GasSettings` - `static fromBuffer(buffer: Buffer | BufferReader) => GasSettings` - `static fromFields(fields: Fr[] | FieldReader) => GasSettings` - `static fromPlainObject(obj: any) => GasSettings` - Creates a GasSettings instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getFeeLimit() => Fr` - Returns the maximum fee to be paid according to gas limits and max fees set. - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### GlobalVariables Global variables of the L2 block. **Constructor** ```typescript new GlobalVariables(chainId: Fr, version: Fr, blockNumber: BlockNumber, slotNumber: SlotNumber, timestamp: bigint, coinbase: EthAddress, feeRecipient: AztecAddress, gasFees: GasFees) ``` **Properties** - `blockNumber: BlockNumber` - `chainId: Fr` - `coinbase: EthAddress` - `feeRecipient: AztecAddress` - `gasFees: GasFees` - `static schema: unknown` - `slotNumber: SlotNumber` - `timestamp: bigint` - `version: Fr` **Methods** - `[custom]() => string` - `clone() => GlobalVariables` - `static empty(fields?: Partial>) => GlobalVariables` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => GlobalVariables` - `static fromBuffer(buffer: Buffer | BufferReader) => GlobalVariables` - `static fromFields(fields: Fr[] | FieldReader) => GlobalVariables` - `static fromPlainObject(obj: any) => GlobalVariables` - Creates a GlobalVariables instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `static random(overrides?: Partial>) => GlobalVariables` - `toBuffer() => any` - `toFields() => Fr[]` - `toFriendlyJSON() => { blockNumber: BlockNumber; coinbase: string; ... }` - A trimmed version of the JSON representation of the global variables, tailored for human consumption. - `toInspect() => { blockNumber: BlockNumber; chainId: number; ... }` - `toJSON() => { blockNumber: BlockNumber; chainId: Fr; ... }` - Converts GlobalVariables to a plain object suitable for MessagePack serialization. This method ensures that slotNumber is serialized as a Fr (Field element) to match the C++ struct definition which expects slot_number as FF. ### GoogleCloudFileStore Simple file store. Implements: `FileStore` **Constructor** ```typescript new GoogleCloudFileStore(bucketName: string, basePath: string, log?: Logger) ``` **Methods** - `checkCredentials() => Promise` - `download(pathOrUrlStr: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrlStr: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrlStr: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. - `save(path: string, data: Buffer, opts?: FileStoreSaveOptions) => Promise` - Saves contents to the given path. Returns an URI that can be used later to `read` the file. Default: `compress` is false unless explicitly set. - `upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions) => Promise` - Uploads contents from a local file. Returns an URI that can be used later to `read` the file. Default: `compress` is true unless explicitly set to false. ### Gossipable Gossipable Any class which extends gossipable will be able to be Gossiped over the p2p network **Constructor** ```typescript new Gossipable() ``` **Properties** - `static p2pTopic: TopicType` - The p2p topic identifier, this determines how the message is handled **Methods** - `generateP2PMessageIdentifier() => Promise` - `getSize() => number` - Get the size of the gossipable object. This is used for metrics recording. - `p2pMessageLoggingIdentifier() => Promise` - A digest of the message information **used for logging only**. The identifier used for deduplication is `getMsgIdFn` as defined in `encoding.ts` which is a hash over topic and data. - `toBuffer() => Buffer` - `toMessage() => Buffer` ### HashedValues A container for storing a list of values and their hash. **Constructor** ```typescript new HashedValues(values: Fr[], hash: Fr) ``` **Properties** - `readonly hash: Fr` - `static schema: unknown` - `readonly values: Fr[]` **Methods** - `static from(fields: FieldsOf) => HashedValues` - `static fromArgs(args: Fr[]) => Promise` - `static fromBuffer(buffer: Buffer | BufferReader) => HashedValues` - `static fromCalldata(calldata: Fr[]) => Promise` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `static random() => HashedValues` - `toBuffer() => any` ### HidingKernelToPublicPrivateInputs **Constructor** ```typescript new HidingKernelToPublicPrivateInputs(previousKernelPublicInputs: PrivateToPublicKernelCircuitPublicInputs, previousKernelVkData: VkData) ``` **Properties** - `previousKernelPublicInputs: PrivateToPublicKernelCircuitPublicInputs` - `previousKernelVkData: VkData` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => HidingKernelToPublicPrivateInputs` - `toBuffer() => any` ### HidingKernelToRollupPrivateInputs **Constructor** ```typescript new HidingKernelToRollupPrivateInputs(previousKernelPublicInputs: PrivateToRollupKernelCircuitPublicInputs, previousKernelVkData: VkData) ``` **Properties** - `previousKernelPublicInputs: PrivateToRollupKernelCircuitPublicInputs` - `previousKernelVkData: VkData` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => HidingKernelToRollupPrivateInputs` - `toBuffer() => any` ### HttpFileStore Simple read-only file store. Implements: `ReadOnlyFileStore` **Constructor** ```typescript new HttpFileStore(baseUrl: string, log?: Logger) ``` **Methods** - `download(pathOrUrl: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrl: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrl: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. ### InboxLeaf **Constructor** ```typescript new InboxLeaf(index: bigint, leaf: Fr) ``` **Properties** - `readonly index: bigint` - `readonly leaf: Fr` **Methods** - `static checkpointNumberFromIndex(index: bigint) => CheckpointNumber` - Returns the checkpoint number for a given leaf index - `fromBuffer(buffer: Buffer | BufferReader) => InboxLeaf` - `static indexRangeForCheckpoint(checkpointNumber: CheckpointNumber) => []` - Returns the range of valid indices for a given checkpoint. Start index is inclusive, end index is exclusive. - `static smallestIndexForCheckpoint(checkpointNumber: CheckpointNumber) => bigint` - `toBuffer() => Buffer` ### InvalidValidatorPrivateKeyError Extends: `ValidatorError` **Constructor** ```typescript new InvalidValidatorPrivateKeyError() ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### KeyValidationHint **Constructor** ```typescript new KeyValidationHint(skM: Fq) ``` **Properties** - `skM: Fq` **Methods** - `static empty() => KeyValidationHint` - `static fromBuffer(buffer: Buffer | BufferReader) => KeyValidationHint` - `toBuffer() => any` ### KeyValidationRequest Request for validating keys used in the app. **Constructor** ```typescript new KeyValidationRequest(pkM: Point, skApp: Fr | Fq) ``` **Properties** - `readonly pkM: Point` - `readonly skApp: Fr` - App-siloed secret key corresponding to the same underlying secret as master public key above. - `skAppAsGrumpkinScalar: unknown` **Methods** - `static empty() => KeyValidationRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => KeyValidationRequest` - `static fromFields(fields: Fr[] | FieldReader) => KeyValidationRequest` - `isEmpty() => boolean` - `static random() => Promise` - `toBuffer() => any` - `toFields() => Fr[]` ### KeyValidationRequestAndSeparator Request for validating keys used in the app and a generator. **Constructor** ```typescript new KeyValidationRequestAndSeparator(request: KeyValidationRequest, skAppGenerator: Fr) ``` **Properties** - `readonly request: KeyValidationRequest` - `readonly skAppGenerator: Fr` **Methods** - `static empty() => KeyValidationRequestAndSeparator` - `static fromBuffer(buffer: Buffer | BufferReader) => KeyValidationRequestAndSeparator` - `static fromFields(fields: Fr[] | FieldReader) => KeyValidationRequestAndSeparator` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### L1Actor The sender of an L1 to L2 message or recipient of an L2 to L1 message. **Constructor** ```typescript new L1Actor(sender: EthAddress, chainId: number) ``` **Properties** - `readonly chainId: number` - `readonly sender: EthAddress` **Methods** - `static empty() => L1Actor` - `static fromBuffer(buffer: Buffer | BufferReader) => L1Actor` - `static random() => L1Actor` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### L1PublishedData **Constructor** ```typescript new L1PublishedData(blockNumber: bigint, timestamp: bigint, blockHash: string) ``` **Properties** - `blockHash: string` - `blockNumber: bigint` - `static schema: unknown` - `timestamp: bigint` **Methods** - `static fromFields(fields: FieldsOf) => L1PublishedData` - `static random() => L1PublishedData` ### L1ToL2Message The format of an L1 to L2 Message. **Constructor** ```typescript new L1ToL2Message(sender: L1Actor, recipient: L2Actor, content: Fr, secretHash: Fr, index: Fr) ``` **Properties** - `readonly content: Fr` - `readonly index: Fr` - `readonly recipient: L2Actor` - `readonly secretHash: Fr` - `readonly sender: L1Actor` **Methods** - `static empty() => L1ToL2Message` - `static fromBuffer(buffer: Buffer | BufferReader) => L1ToL2Message` - `static fromString(data: string) => L1ToL2Message` - `hash() => Fr` - `static random() => Promise` - `toBuffer() => Buffer` - `toFields() => Fr[]` - Returns each element within its own field so that it can be consumed by an acvm oracle call. - `toString() => string` ### L2Actor The recipient of an L2 message. **Constructor** ```typescript new L2Actor(recipient: AztecAddress, version: number) ``` **Properties** - `readonly recipient: AztecAddress` - `readonly version: number` **Methods** - `static empty() => L2Actor` - `static fromBuffer(buffer: Buffer | BufferReader) => L2Actor` - `static random() => Promise` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### L2Block The data that makes up the rollup proof, with encoder decoder functions. **Constructor** ```typescript new L2Block(archive: AppendOnlyTreeSnapshot, header: L2BlockHeader, body: Body, blockHash?: Fr) ``` **Properties** - `archive: AppendOnlyTreeSnapshot` - `body: Body` - `header: L2BlockHeader` - `number: unknown` - `static schema: unknown` - `slot: unknown` - `timestamp: unknown` **Methods** - `static empty() => L2Block` - Creates an L2 block containing empty data. - `equals(other: L2Block) => boolean` - `static fromBuffer(buf: Buffer | BufferReader) => L2Block` - Deserializes a block from a buffer - `static fromCheckpoint(checkpoint: Checkpoint) => L2Block` - `static fromString(str: string) => L2Block` - Deserializes L2 block from a buffer. - `getBlockHeader() => BlockHeader` - `getCheckpointBlobFields() => Fr[]` - `getCheckpointHeader() => CheckpointHeader` - `getStats() => { blockNumber: BlockNumber; blockTimestamp: number; ... }` - Returns stats used for logging. - `hash() => Promise` - Returns the block's hash (hash of block header). - `static random(l2BlockNum: BlockNumber, txsPerBlock?: number, numPublicCallsPerTx?: number, numPublicLogsPerCall?: number, inHash?: Fr, slotNumber?: number, maxEffects?: number) => Promise` - Creates an L2 block containing random data. - `toBlobFields() => Fr[]` - `toBlockBlobData() => BlockBlobData` - `toBlockInfo() => L2BlockInfo` - `toBuffer() => any` - Serializes a block - `toCheckpoint() => Checkpoint` - `toL2Block() => L2BlockNew` - `toString() => string` - Serializes a block to a string. ### L2BlockHash Hash of an L2 block. Extends: `Buffer32` **Constructor** ```typescript new L2BlockHash(hash: Buffer) ``` **Properties** - `buffer: Buffer` - `static schema: unknown` - `static SIZE: number` - The size of the hash in bytes. - `static ZERO: Buffer32` - Buffer32 with value zero. **Methods** - `[custom]() => string` - `equals(hash: Buffer32) => boolean` - Checks if this hash and another hash are equal. - `static fromBigInt(hash: bigint) => Buffer32` - Creates a Buffer32 from a bigint. - `static fromBuffer(buffer: Buffer | BufferReader) => L2BlockHash` - Creates a Buffer32 from a buffer. - `static fromBuffer28(buffer: Buffer) => Buffer32` - Converts this hash from a buffer of 28 bytes. Verifies the input is 28 bytes. - `static fromField(hash: Fr) => L2BlockHash` - `static fromNumber(num: number) => L2BlockHash` - Converts a number into a Buffer32 object. - `static fromString(str: string) => Buffer32` - Converts a string into a Buffer32 object. - `isZero() => boolean` - Returns true if this hash is zero. - `static random() => L2BlockHash` - Generates a random Buffer32. - `toBigInt() => bigint` - Convert this hash to a big int. - `toBuffer() => any` - Returns the raw buffer of the hash. - `toJSON() => string` - `toString() => string` - Convert this hash to a hex string. - `static zero() => L2BlockHash` ### L2BlockHeader TO BE DELETED A header of an L2 block combining the block header and the checkpoint header. This is a temporary workaround to avoid changing too many things before building in chunks is properly implemented. This works for now because we only have one block per checkpoint. **Constructor** ```typescript new L2BlockHeader(lastArchive: AppendOnlyTreeSnapshot, contentCommitment: ContentCommitment, state: StateReference, globalVariables: GlobalVariables, totalFees: Fr, totalManaUsed: Fr, spongeBlobHash: Fr, blockHeadersHash: Fr) ``` **Properties** - `blockHeadersHash: Fr` - `contentCommitment: ContentCommitment` - `globalVariables: GlobalVariables` - `lastArchive: AppendOnlyTreeSnapshot` - `static schema: unknown` - `spongeBlobHash: Fr` - `state: StateReference` - `totalFees: Fr` - `totalManaUsed: Fr` **Methods** - `[custom]() => string` - `clone() => L2BlockHeader` - `static empty(fields?: Partial>) => L2BlockHeader` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => L2BlockHeader` - `static fromBuffer(buffer: Buffer | BufferReader) => L2BlockHeader` - `static fromFields(fields: Fr[] | FieldReader) => L2BlockHeader` - `static fromString(str: string) => L2BlockHeader` - `getBlockNumber() => BlockNumber` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `getSlot() => SlotNumber` - `isEmpty() => boolean` - `toBlockHeader() => BlockHeader` - `toBuffer() => any` - `toCheckpointHeader() => CheckpointHeader` - `toFields() => Fr[]` - `toInspect() => { blockHeadersHash: string; contentCommitment: { blobsHash: string; inHash: string; outHash: string }; ... }` - `toString() => string` - Serializes this instance into a string. ### L2BlockNew An L2 block with a header and a body. Delete the existing `L2Block` class and rename this to `L2Block`. **Constructor** ```typescript new L2BlockNew(archive: AppendOnlyTreeSnapshot, header: BlockHeader, body: Body, checkpointNumber: CheckpointNumber, indexWithinCheckpoint: number, blockHash?: Fr) ``` **Properties** - `archive: AppendOnlyTreeSnapshot` - `body: Body` - `checkpointNumber: CheckpointNumber` - `header: BlockHeader` - `indexWithinCheckpoint: number` - `number: unknown` - `static schema: unknown` - `timestamp: unknown` **Methods** - `static empty() => L2BlockNew` - `static fromBuffer(buf: Buffer | BufferReader) => L2BlockNew` - Deserializes a block from a buffer - `getPrivateLogs() => PrivateLog[]` - `getStats() => { blockNumber: BlockNumber; blockTimestamp: number; ... }` - Returns stats used for logging. - `hash() => Promise` - Returns the block's hash (hash of block header). - `static random(blockNumber: BlockNumber, __namedParameters?: { checkpointNumber?: CheckpointNumber; indexWithinCheckpoint?: number; ... } & Partial> & Partial>>) => Promise` - Creates an L2 block containing random data. - `toBlobFields() => Fr[]` - `toBlockBlobData() => BlockBlobData` - `toBlockInfo() => L2BlockInfo` - `toBuffer() => any` - Serializes a block ### L2BlockStream Creates a stream of events for new blocks, chain tips updates, and reorgs, out of polling an archiver or a node. **Constructor** ```typescript new L2BlockStream(l2BlockSource: Pick, localData: L2BlockStreamLocalDataProvider, handler: L2BlockStreamEventHandler, log?: Logger, opts?: { batchSize?: number; pollIntervalMS?: number; ... }) ``` **Methods** - `isRunning() => boolean` - `start() => void` - `stop() => Promise` - `sync() => Promise` - `work() => Promise` ### L2TipsMemoryStore Stores currently synced L2 tips and unfinalized block hashes. Implements: `L2BlockStreamEventHandler`, `L2BlockStreamLocalDataProvider` **Constructor** ```typescript new L2TipsMemoryStore() ``` **Properties** - `readonly l2BlockHashesStore: Map` - `readonly l2TipsStore: Map` **Methods** - `computeBlockHash(block: L2Block) => Promise` - `getL2BlockHash(number: number) => Promise` - `getL2Tips() => Promise` - `handleBlockStreamEvent(event: L2BlockStreamEvent) => Promise` - `saveTag(name: L2BlockTag, block: L2BlockId) => void` ### L2ToL1Message **Constructor** ```typescript new L2ToL1Message(recipient: EthAddress, content: Fr) ``` **Properties** - `content: Fr` - `recipient: EthAddress` - `static schema: unknown` **Methods** - `static empty() => L2ToL1Message` - Creates an empty L2ToL1Message with default values. - `equals(other: L2ToL1Message) => boolean` - Checks if another L2ToL1Message is equal to this instance. - `static fromBuffer(buffer: Buffer | BufferReader) => L2ToL1Message` - Deserializes from a buffer or reader. - `static fromFields(fields: Fr[] | FieldReader) => L2ToL1Message` - Deserializes an array of fields into an L2ToL1Message instance. - `static fromPlainObject(obj: any) => L2ToL1Message` - Creates an L2ToL1Message instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `isEmpty() => boolean` - Convenience method to check if the message is empty. - `scope(contractAddress: AztecAddress) => ScopedL2ToL1Message` - `toBuffer() => Buffer` - Serialize this as a buffer. - `toFields() => Fr[]` - Serializes the L2ToL1Message into an array of fields. ### LocalFileStore Simple file store. Implements: `FileStore` **Constructor** ```typescript new LocalFileStore(basePath: string) ``` **Methods** - `download(pathOrUrlStr: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrlStr: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrlStr: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. - `save(path: string, data: Buffer) => Promise` - Saves contents to the given path. Returns an URI that can be used later to `read` the file. Default: `compress` is false unless explicitly set. - `upload(destPath: string, srcPath: string, _opts: { compress: boolean }) => Promise` - Uploads contents from a local file. Returns an URI that can be used later to `read` the file. Default: `compress` is true unless explicitly set to false. ### LogHash **Constructor** ```typescript new LogHash(value: Fr, length: number) ``` **Properties** - `length: number` - `value: Fr` **Methods** - `[custom]() => string` - `static empty() => LogHash` - `static from(fields: FieldsOf) => LogHash` - `static fromBuffer(buffer: Buffer | BufferReader) => LogHash` - `static fromFields(fields: Fr[] | FieldReader) => LogHash` - `isEmpty() => boolean` - `scope(contractAddress: AztecAddress) => ScopedLogHash` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` ### LogId A globally unique log id. **Constructor** ```typescript new LogId(blockNumber: BlockNumber, txIndex: number, logIndex: number) ``` **Properties** - `readonly blockNumber: BlockNumber` - `readonly logIndex: number` - `static schema: unknown` - `readonly txIndex: number` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => LogId` - Creates a LogId from a buffer. - `static fromString(data: string) => LogId` - Creates a LogId from a string. - `static random() => LogId` - `toBuffer() => Buffer` - Serializes log id to a buffer. - `toHumanReadable() => string` - Serializes log id to a human readable string. - `toString() => string` - Converts the LogId instance to a string. ### MaliciousCommitteeAttestationsAndSigners Malicious extension of CommitteeAttestationsAndSigners that keeps separate attestations and signers. Used for tricking the L1 contract into accepting attestations by reconstructing the correct committee commitment (which relies on the signers, ignoring the signatures) with an invalid set of attestation signatures. Extends: `CommitteeAttestationsAndSigners` **Constructor** ```typescript new MaliciousCommitteeAttestationsAndSigners(attestations: CommitteeAttestation[], signers: EthAddress[]) ``` **Properties** - `attestations: CommitteeAttestation[]` - `static schema: unknown` **Methods** - `static empty() => CommitteeAttestationsAndSigners` - `getPackedAttestations() => ViemCommitteeAttestations` - Packs an array of committee attestations into the format expected by the Solidity contract - `getPayloadToSign(domainSeparator: SignatureDomainSeparator) => Buffer` - `getSignedAttestations() => CommitteeAttestation[]` - `getSigners() => EthAddress[]` - `toString() => void` - Returns a string representation of an object. ### MessageContext Additional information needed to process a message. All messages exist in the context of a transaction, and information about that transaction is typically required in order to perform validation, store results, etc. For example, messages containing notes require knowledge of note hashes and the first nullifier in order to find the note's nonce. A TS version of `message_context.nr`. **Constructor** ```typescript new MessageContext(txHash: TxHash, uniqueNoteHashesInTx: Fr[], firstNullifierInTx: Fr, recipient: AztecAddress) ``` **Properties** - `firstNullifierInTx: Fr` - `recipient: AztecAddress` - `txHash: TxHash` - `uniqueNoteHashesInTx: Fr[]` **Methods** - `static fromTxEffectAndRecipient(txEffect: TxEffect, recipient: AztecAddress) => MessageContext` - `toFields() => Fr[]` - `toNoirStruct() => { first_nullifier_in_tx: Fr; recipient: AztecAddress; ... }` ### NestedProcessReturnValues Return values of simulating complete callstack. **Constructor** ```typescript new NestedProcessReturnValues(values: Fr[], nested?: NestedProcessReturnValues[]) ``` **Properties** - `nested: NestedProcessReturnValues[]` - `static schema: unknown` - `values: Fr[]` **Methods** - `static empty() => NestedProcessReturnValues` - `equals(other: NestedProcessReturnValues) => boolean` - `static fromPlainObject(obj: any) => NestedProcessReturnValues` - `static random(depth?: number) => NestedProcessReturnValues` ### Note The Note class represents a Note emitted from a Noir contract as a vector of Fr (finite field) elements. This data also represents a preimage to a note hash. Extends: `Vector` **Constructor** ```typescript new Note(items: Fr[]) ``` **Properties** - `items: Fr[]` - `length: unknown` - `static schema: unknown` **Methods** - `equals(other: Note) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => Note` - Create a Note instance from a Buffer or BufferReader. The input 'buffer' can be either a Buffer containing the serialized Fr elements or a BufferReader instance. This function reads the Fr elements in the buffer and constructs a Note with them. - `static fromString(str: string) => Note` - Creates a new Note instance from a hex string. - `static random() => Note` - Generates a random Note instance with a variable number of items. The number of items is determined by a random value between 1 and 10 (inclusive). Each item in the Note is generated using the Fr.random() method. - `toBuffer() => any` - `toFriendlyJSON() => Fr[]` - `toJSON() => any` - `toString() => string` - Returns a hex representation of the note. ### NoteAndSlot The contents of a new note. **Constructor** ```typescript new NoteAndSlot(note: Note, storageSlot: Fr, randomness: Fr, noteTypeId: NoteSelector) ``` **Properties** - `note: Note` - `noteTypeId: NoteSelector` - `randomness: Fr` - `static schema: unknown` - `storageSlot: Fr` **Methods** - `static from(fields: FieldsOf) => NoteAndSlot` - `static random() => NoteAndSlot` ### NoteDao A Note Data Access Object, representing a note that was committed to the note hash tree, holding all of the information required to use it during execution and manage its state. **Constructor** ```typescript new NoteDao(note: Note, contractAddress: AztecAddress, owner: AztecAddress, storageSlot: Fr, randomness: Fr, noteNonce: Fr, noteHash: Fr, siloedNullifier: Fr, txHash: TxHash, l2BlockNumber: BlockNumber, l2BlockHash: string, index: bigint) ``` **Properties** - `contractAddress: AztecAddress` - `index: bigint` - `l2BlockHash: string` - `l2BlockNumber: BlockNumber` - `note: Note` - `noteHash: Fr` - `noteNonce: Fr` - `owner: AztecAddress` - `randomness: Fr` - `siloedNullifier: Fr` - `storageSlot: Fr` - `txHash: TxHash` **Methods** - `equals(other: NoteDao) => boolean` - Returns true if this note is equal to the `other` one. - `static fromBuffer(buffer: Buffer | BufferReader) => NoteDao` - `static fromString(str: string) => NoteDao` - `getSize() => number` - Returns the size in bytes of the Note Dao. - `static random(__namedParameters?: Partial) => Promise` - `toBuffer() => Buffer` - `toString() => string` ### NoteHash **Constructor** ```typescript new NoteHash(value: Fr, counter: number) ``` **Properties** - `counter: number` - `value: Fr` **Methods** - `static empty() => NoteHash` - `static fromBuffer(buffer: Buffer | BufferReader) => NoteHash` - `static fromFields(fields: Fr[] | FieldReader) => NoteHash` - `isEmpty() => boolean` - `scope(contractAddress: AztecAddress) => ScopedNoteHash` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` ### NoteHashReadRequestHintsBuilder **Constructor** ```typescript new NoteHashReadRequestHintsBuilder(maxPending: PENDING, maxSettled: SETTLED) ``` **Properties** - `readonly maxPending: PENDING` - `readonly maxSettled: SETTLED` - `numPendingReadHints: number` - `numSettledReadHints: number` **Methods** - `addPendingReadRequest(readRequestIndex: number, noteHashIndex: number) => void` - `addSettledReadRequest(readRequestIndex: number, membershipWitness: MembershipWitness<42>, value: Fr) => void` - `static empty(maxPending: PENDING, maxSettled: SETTLED) => NoteHashReadRequestHints` - `toHints() => NoteHashReadRequestHints` ### NoteSelector A note selector is a 7 bit long value that identifies a note type within a contract. Encoding of note type id can be reduced to 7 bits. Extends: `Selector` **Constructor** ```typescript new NoteSelector(value: number) ``` **Properties** - `_branding: "NoteSelector"` - Brand. - `static schema: unknown` - `static SIZE: number` - The size of the selector in bytes. - `value: number` **Methods** - `[custom]() => string` - `static empty() => NoteSelector` - Creates an empty selector. - `equals(other: Selector) => boolean` - Checks if this selector is equal to another. - `static fromBuffer(buffer: Buffer | BufferReader) => NoteSelector` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromField(fr: Fr) => NoteSelector` - Converts a field to selector. - `static fromString(buf: string) => NoteSelector` - `isEmpty() => boolean` - Checks if the selector is empty (all bytes are 0). - `static random() => NoteSelector` - Creates a random selector. - `toBuffer(bufferSize?: number) => Buffer` - Serialize as a buffer. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toJSON() => string` - `toString() => string` - Serialize as a hex string. ### Nullifier Implements: `Ordered` **Constructor** ```typescript new Nullifier(value: Fr, noteHash: Fr, counter: number) ``` **Properties** - `counter: number` - `noteHash: Fr` - `value: Fr` **Methods** - `static empty() => Nullifier` - `static fromBuffer(buffer: Buffer | BufferReader) => Nullifier` - `static fromFields(fields: Fr[] | FieldReader) => Nullifier` - `isEmpty() => boolean` - `scope(contractAddress: AztecAddress) => ScopedNullifier` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` - Returns a string representation of an object. ### NullifierLeaf A nullifier to be inserted in the nullifier tree. Implements: `IndexedTreeLeaf` **Constructor** ```typescript new NullifierLeaf(nullifier: Fr) ``` **Properties** - `nullifier: Fr` - `static schema: unknown` **Methods** - `static buildDummy(key: bigint) => NullifierLeaf` - `clone() => NullifierLeaf` - `static empty() => NullifierLeaf` - `static fromBuffer(buf: Buffer | BufferReader) => NullifierLeaf` - `static fromPlainObject(obj: any) => NullifierLeaf` - Creates a NullifierLeaf from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getKey() => bigint` - Returns key of the leaf. It's used for indexing. - `isEmpty() => boolean` - Returns true if the leaf is empty. - `static random() => NullifierLeaf` - `toBuffer() => Buffer` - Serializes the leaf into a buffer. - `toHashInputs() => Buffer[]` - `updateTo(_another: NullifierLeaf) => NullifierLeaf` - Updates the leaf with the data of another leaf. ### NullifierLeafPreimage Class containing the data of a preimage of a single leaf in the nullifier tree. Note: It's called preimage because this data gets hashed before being inserted as a node into the `IndexedTree`. Implements: `IndexedTreeLeafPreimage` **Constructor** ```typescript new NullifierLeafPreimage(leaf: NullifierLeaf, nextKey: Fr, nextIndex: bigint) ``` **Properties** - `leaf: NullifierLeaf` - `static leafSchema: unknown` - `nextIndex: bigint` - `nextKey: Fr` - `static schema: unknown` **Methods** - `asLeaf() => NullifierLeaf` - Returns the preimage as a leaf. - `static clone(preimage: NullifierLeafPreimage) => NullifierLeafPreimage` - `static empty() => NullifierLeafPreimage` - `static fromBuffer(buffer: Buffer | BufferReader) => NullifierLeafPreimage` - `static fromLeaf(leaf: NullifierLeaf, nextKey: bigint, nextIndex: bigint) => NullifierLeafPreimage` - `static fromPlainObject(obj: any) => NullifierLeafPreimage` - Creates a NullifierLeafPreimage from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getKey() => bigint` - Returns key of the leaf corresponding to this preimage. - `getNextIndex() => bigint` - Returns the index of the next leaf. - `getNextKey() => bigint` - `static random() => NullifierLeafPreimage` - `toBuffer() => Buffer` - Serializes the preimage into a buffer. - `toFields() => Fr[]` - `toHashInputs() => Buffer[]` - Serializes the preimage to an array of buffers for hashing. ### NullifierMembershipWitness Nullifier membership witness. **Constructor** ```typescript new NullifierMembershipWitness(index: bigint, leafPreimage: NullifierLeafPreimage, siblingPath: SiblingPath<42>) ``` **Properties** - `readonly index: bigint` - `readonly leafPreimage: NullifierLeafPreimage` - `static schema: unknown` - `readonly siblingPath: SiblingPath<42>` **Methods** - `static random() => NullifierMembershipWitness` - `toFields() => Fr[]` - Returns a field array representation of a nullifier witness. - `toNoirRepresentation() => string | string[][]` - Returns a representation of the nullifier membership witness as expected by intrinsic Noir deserialization. - `withoutPreimage() => MembershipWitness<42>` ### NullifierReadRequestHintsBuilder **Constructor** ```typescript new NullifierReadRequestHintsBuilder(maxPending: PENDING, maxSettled: SETTLED) ``` **Properties** - `readonly maxPending: PENDING` - `readonly maxSettled: SETTLED` **Methods** - `addPendingReadRequest(readRequestIndex: number, nullifierIndex: number) => void` - `addSettledReadRequest(readRequestIndex: number, membershipWitness: MembershipWitness<42>, leafPreimage: NullifierLeafPreimage) => void` - `static empty(maxPending: PENDING, maxSettled: SETTLED) => NullifierReadRequestHints` - `toHints() => NullifierReadRequestHints` ### OptionalNumber **Constructor** ```typescript new OptionalNumber(isSome: boolean, value: number) ``` **Properties** - `isSome: boolean` - `value: number` **Methods** - `static empty() => OptionalNumber` - `static fromBuffer(buffer: Buffer | BufferReader) => OptionalNumber` - `static fromFields(fields: Fr[] | FieldReader) => OptionalNumber` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### P2PMessage **Constructor** ```typescript new P2PMessage(payload: Buffer, timestamp?: Date) ``` **Properties** - `readonly payload: Buffer` - `readonly timestamp?: Date` **Methods** - `static fromGossipable(message: Gossipable, instrumentMessages?: boolean) => P2PMessage` - `static fromMessageData(messageData: Buffer, instrumentMessages?: boolean) => P2PMessage` - `toMessageData() => Buffer` ### PaddedSideEffectAmounts **Constructor** ```typescript new PaddedSideEffectAmounts(nonRevertibleNoteHashes: number, revertibleNoteHashes: number, nonRevertibleNullifiers: number, revertibleNullifiers: number, nonRevertiblePrivateLogs: number, revertiblePrivateLogs: number) ``` **Properties** - `nonRevertibleNoteHashes: number` - `nonRevertibleNullifiers: number` - `nonRevertiblePrivateLogs: number` - `revertibleNoteHashes: number` - `revertibleNullifiers: number` - `revertiblePrivateLogs: number` **Methods** - `static empty() => PaddedSideEffectAmounts` - `static fromBuffer(buffer: Buffer | BufferReader) => PaddedSideEffectAmounts` - `toBuffer() => any` ### PaddedSideEffects **Constructor** ```typescript new PaddedSideEffects(noteHashes: [], nullifiers: [], privateLogs: []) ``` **Properties** - `noteHashes: []` - `nullifiers: []` - `privateLogs: []` **Methods** - `static empty() => PaddedSideEffects` - `static fromBuffer(buffer: Buffer | BufferReader) => PaddedSideEffects` - `toBuffer() => any` ### ParityBasePrivateInputs **Constructor** ```typescript new ParityBasePrivateInputs(msgs: [], vkTreeRoot: Fr) ``` **Properties** - `readonly msgs: []` - `static schema: unknown` - `readonly vkTreeRoot: Fr` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => ParityBasePrivateInputs` - Deserializes the inputs from a buffer. - `static fromSlice(array: Fr[], index: number, vkTreeRoot: Fr) => ParityBasePrivateInputs` - `static fromString(str: string) => ParityBasePrivateInputs` - Deserializes the inputs from a hex string. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### ParityPublicInputs **Constructor** ```typescript new ParityPublicInputs(shaRoot: Fr, convertedRoot: Fr, vkTreeRoot: Fr) ``` **Properties** - `convertedRoot: Fr` - `static schema: unknown` - `shaRoot: Fr` - `vkTreeRoot: Fr` **Methods** - `static from(fields: FieldsOf) => ParityPublicInputs` - Creates a new ParityPublicInputs instance from the given fields. - `static fromBuffer(buffer: Buffer | BufferReader) => ParityPublicInputs` - Deserializes the inputs from a buffer. - `static fromString(str: string) => ParityPublicInputs` - Deserializes the inputs from a hex string. - `static getFields(fields: FieldsOf) => readonly []` - Extracts the fields from the given instance. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### ParityRootPrivateInputs **Constructor** ```typescript new ParityRootPrivateInputs(children: []) ``` **Properties** - `readonly children: []` - `static schema: unknown` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => ParityRootPrivateInputs` - Deserializes the inputs from a buffer. - `static fromString(str: string) => ParityRootPrivateInputs` - Deserializes the inputs from a hex string. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### PartialPrivateTailPublicInputsForPublic **Constructor** ```typescript new PartialPrivateTailPublicInputsForPublic(nonRevertibleAccumulatedData: PrivateToPublicAccumulatedData, revertibleAccumulatedData: PrivateToPublicAccumulatedData, publicTeardownCallRequest: PublicCallRequest) ``` **Properties** - `needsAppLogic: unknown` - `needsSetup: unknown` - `needsTeardown: unknown` - `nonRevertibleAccumulatedData: PrivateToPublicAccumulatedData` - `publicTeardownCallRequest: PublicCallRequest` - `revertibleAccumulatedData: PrivateToPublicAccumulatedData` **Methods** - `static empty() => PartialPrivateTailPublicInputsForPublic` - `static fromBuffer(buffer: Buffer | BufferReader) => PartialPrivateTailPublicInputsForPublic` - `getSize() => number` - `toBuffer() => any` ### PartialPrivateTailPublicInputsForRollup **Constructor** ```typescript new PartialPrivateTailPublicInputsForRollup(end: PrivateToRollupAccumulatedData) ``` **Properties** - `end: PrivateToRollupAccumulatedData` **Methods** - `static empty() => PartialPrivateTailPublicInputsForRollup` - `static fromBuffer(buffer: Buffer | BufferReader) => PartialPrivateTailPublicInputsForRollup` - `getSize() => number` - `toBuffer() => any` ### PartialStateReference Stores snapshots of trees which are commonly needed by base or merge rollup circuits. **Constructor** ```typescript new PartialStateReference(noteHashTree: AppendOnlyTreeSnapshot, nullifierTree: AppendOnlyTreeSnapshot, publicDataTree: AppendOnlyTreeSnapshot) ``` **Properties** - `readonly noteHashTree: AppendOnlyTreeSnapshot` - `readonly nullifierTree: AppendOnlyTreeSnapshot` - `readonly publicDataTree: AppendOnlyTreeSnapshot` - `static schema: unknown` **Methods** - `static empty() => PartialStateReference` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => PartialStateReference` - `static fromBuffer(buffer: Buffer | BufferReader) => PartialStateReference` - `static fromFields(fields: Fr[] | FieldReader) => PartialStateReference` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `static random() => PartialStateReference` - `toAbi() => []` - `toBuffer() => any` - `toFields() => Fr[]` ### PendingReadHint **Constructor** ```typescript new PendingReadHint(readRequestIndex: number, pendingValueIndex: number) ``` **Properties** - `pendingValueIndex: number` - `readRequestIndex: number` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => PendingReadHint` - `static nada(readRequestLen: number) => PendingReadHint` - `toBuffer() => any` ### PendingTaggedLog Represents a pending tagged log as it is stored in the pending tagged log array to which the fetchTaggedLogs oracle inserts found private logs. A TS version of `pending_tagged_log.nr`. **Constructor** ```typescript new PendingTaggedLog(log: Fr[], txHash: TxHash, uniqueNoteHashesInTx: Fr[], firstNullifierInTx: Fr, recipient: AztecAddress) ``` **Properties** - `log: Fr[]` **Methods** - `toFields() => Fr[]` ### PrivateAccumulatedData Specific accumulated data structure for the final ordering private kernel circuit. It is included in the final public inputs of private kernel circuit. **Constructor** ```typescript new PrivateAccumulatedData(noteHashes: ClaimedLengthArray, nullifiers: ClaimedLengthArray, l2ToL1Msgs: ClaimedLengthArray, privateLogs: ClaimedLengthArray, contractClassLogsHashes: ClaimedLengthArray, publicCallRequests: ClaimedLengthArray, privateCallStack: ClaimedLengthArray) ``` **Properties** - `contractClassLogsHashes: ClaimedLengthArray` - `l2ToL1Msgs: ClaimedLengthArray` - `noteHashes: ClaimedLengthArray` - `nullifiers: ClaimedLengthArray` - `privateCallStack: ClaimedLengthArray` - `privateLogs: ClaimedLengthArray` - `publicCallRequests: ClaimedLengthArray` **Methods** - `static empty() => PrivateAccumulatedData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateAccumulatedData` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromString(str: string) => PrivateAccumulatedData` - Deserializes from a string, corresponding to a write in cpp. - `toBuffer() => any` - `toString() => string` ### PrivateBaseRollupHints **Constructor** ```typescript new PrivateBaseRollupHints(start: PartialStateReference, startSpongeBlob: SpongeBlob, treeSnapshotDiffHints: TreeSnapshotDiffHints, feePayerBalanceLeafPreimage: PublicDataTreeLeafPreimage, anchorBlockArchiveSiblingPath: [], contractClassLogsFields: [], constants: BlockConstantData) ``` **Properties** - `anchorBlockArchiveSiblingPath: []` - `constants: BlockConstantData` - `contractClassLogsFields: []` - `feePayerBalanceLeafPreimage: PublicDataTreeLeafPreimage` - `start: PartialStateReference` - `startSpongeBlob: SpongeBlob` - `treeSnapshotDiffHints: TreeSnapshotDiffHints` **Methods** - `static empty() => PrivateBaseRollupHints` - `static from(fields: FieldsOf) => PrivateBaseRollupHints` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateBaseRollupHints` - `static fromString(str: string) => PrivateBaseRollupHints` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - Serializes the inputs to a buffer. - `toString() => string` - Serializes the inputs to a hex string. ### PrivateCallData Private call data. **Constructor** ```typescript new PrivateCallData(publicInputs: PrivateCircuitPublicInputs, vk: VerificationKeyAsFields, verificationKeyHints: PrivateVerificationKeyHints) ``` **Properties** - `publicInputs: PrivateCircuitPublicInputs` - `verificationKeyHints: PrivateVerificationKeyHints` - `vk: VerificationKeyAsFields` **Methods** - `static from(fields: FieldsOf) => PrivateCallData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateCallData` - Deserializes from a buffer or reader. - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `toBuffer() => Buffer` - Serialize this as a buffer. ### PrivateCallExecutionResult The result of executing a call to a private function. **Constructor** ```typescript new PrivateCallExecutionResult(acir: Buffer, vk: Buffer, partialWitness: Map, publicInputs: PrivateCircuitPublicInputs, noteHashLeafIndexMap: Map, newNotes: NoteAndSlot[], noteHashNullifierCounterMap: Map, returnValues: Fr[], offchainEffects: { data: Fr[] }[], preTags: PreTag[], nestedExecutionResults: PrivateCallExecutionResult[], contractClassLogs: CountedContractClassLog[], profileResult?: PrivateExecutionProfileResult) ``` **Properties** - `acir: Buffer` - `contractClassLogs: CountedContractClassLog[]` - `nestedExecutionResults: PrivateCallExecutionResult[]` - `newNotes: NoteAndSlot[]` - `noteHashLeafIndexMap: Map` - `noteHashNullifierCounterMap: Map` - `offchainEffects: { data: Fr[] }[]` - `partialWitness: Map` - `preTags: PreTag[]` - `profileResult?: PrivateExecutionProfileResult` - `publicInputs: PrivateCircuitPublicInputs` - `returnValues: Fr[]` - `static schema: unknown` - `vk: Buffer` **Methods** - `static from(fields: FieldsOf) => PrivateCallExecutionResult` - `static random(nested?: number) => Promise` ### PrivateCallRequest **Constructor** ```typescript new PrivateCallRequest(callContext: CallContext, argsHash: Fr, returnsHash: Fr, startSideEffectCounter: number, endSideEffectCounter: number) ``` **Properties** - `argsHash: Fr` - `callContext: CallContext` - `endSideEffectCounter: number` - `returnsHash: Fr` - `startSideEffectCounter: number` **Methods** - `static empty() => PrivateCallRequest` - `equals(callRequest: PrivateCallRequest) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateCallRequest` - `static fromFields(fields: Fr[] | FieldReader) => PrivateCallRequest` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` - `toString() => string` ### PrivateCircuitPublicInputs Public inputs to a private circuit. **Constructor** ```typescript new PrivateCircuitPublicInputs(callContext: CallContext, argsHash: Fr, returnsHash: Fr, minRevertibleSideEffectCounter: Fr, isFeePayer: boolean, includeByTimestamp: bigint, noteHashReadRequests: ClaimedLengthArray, nullifierReadRequests: ClaimedLengthArray, keyValidationRequestsAndGenerators: ClaimedLengthArray, noteHashes: ClaimedLengthArray, nullifiers: ClaimedLengthArray, privateCallRequests: ClaimedLengthArray, publicCallRequests: ClaimedLengthArray, publicTeardownCallRequest: PublicCallRequest, l2ToL1Msgs: ClaimedLengthArray, privateLogs: ClaimedLengthArray, contractClassLogsHashes: ClaimedLengthArray, startSideEffectCounter: Fr, endSideEffectCounter: Fr, expectedNonRevertibleSideEffectCounter: Fr, expectedRevertibleSideEffectCounter: Fr, anchorBlockHeader: BlockHeader, txContext: TxContext) ``` **Properties** - `anchorBlockHeader: BlockHeader` - `argsHash: Fr` - `callContext: CallContext` - `contractClassLogsHashes: ClaimedLengthArray` - `endSideEffectCounter: Fr` - `expectedNonRevertibleSideEffectCounter: Fr` - `expectedRevertibleSideEffectCounter: Fr` - `includeByTimestamp: bigint` - `isFeePayer: boolean` - `keyValidationRequestsAndGenerators: ClaimedLengthArray` - `l2ToL1Msgs: ClaimedLengthArray` - `minRevertibleSideEffectCounter: Fr` - `noteHashes: ClaimedLengthArray` - `noteHashReadRequests: ClaimedLengthArray` - `nullifierReadRequests: ClaimedLengthArray` - `nullifiers: ClaimedLengthArray` - `privateCallRequests: ClaimedLengthArray` - `privateLogs: ClaimedLengthArray` - `publicCallRequests: ClaimedLengthArray` - `publicTeardownCallRequest: PublicCallRequest` - `returnsHash: Fr` - `static schema: unknown` - `startSideEffectCounter: Fr` - `txContext: TxContext` **Methods** - `static empty() => PrivateCircuitPublicInputs` - Create an empty PrivateCircuitPublicInputs. - `static from(fields: FieldsOf) => PrivateCircuitPublicInputs` - Create PrivateCircuitPublicInputs from a fields dictionary. - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateCircuitPublicInputs` - Deserializes from a buffer or reader. - `static fromFields(fields: Fr[] | FieldReader) => PrivateCircuitPublicInputs` - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `isEmpty() => boolean` - `toBuffer() => Buffer` - Serialize this as a buffer. - `toFields() => Fr[]` - Serialize this as a field array. - `toJSON() => any` ### PrivateContextInputs **Constructor** ```typescript new PrivateContextInputs(callContext: CallContext, anchorBlockHeader: BlockHeader, txContext: TxContext, startSideEffectCounter: number) ``` **Properties** - `anchorBlockHeader: BlockHeader` - `callContext: CallContext` - `startSideEffectCounter: number` - `txContext: TxContext` **Methods** - `static empty() => PrivateContextInputs` - `toFields() => Fr[]` ### PrivateExecutionProfileResult **Constructor** ```typescript new PrivateExecutionProfileResult(timings: { oracles?: Record; witgen: number }) ``` **Properties** - `timings: { oracles?: Record; witgen: number }` ### PrivateExecutionResult **Constructor** ```typescript new PrivateExecutionResult(entrypoint: PrivateCallExecutionResult, firstNullifier: Fr, publicFunctionCalldata: HashedValues[]) ``` **Properties** - `entrypoint: PrivateCallExecutionResult` - `firstNullifier: Fr` - `publicFunctionCalldata: HashedValues[]` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PrivateExecutionResult` - `getSimulationAnchorBlockNumber() => BlockNumber` - The anchor block number that this execution was simulated with. - `static random(nested?: number) => Promise` ### PrivateKernelCircuitPublicInputs Public inputs to the inner private kernel circuit **Constructor** ```typescript new PrivateKernelCircuitPublicInputs(constants: PrivateTxConstantData, minRevertibleSideEffectCounter: Fr, validationRequests: PrivateValidationRequests, end: PrivateAccumulatedData, publicTeardownCallRequest: PublicCallRequest, feePayer: AztecAddress, includeByTimestamp: bigint, isPrivateOnly: boolean, claimedFirstNullifier: Fr, claimedRevertibleCounter: number) ``` **Properties** - `claimedFirstNullifier: Fr` - `claimedRevertibleCounter: number` - `constants: PrivateTxConstantData` - `end: PrivateAccumulatedData` - `feePayer: AztecAddress` - `includeByTimestamp: bigint` - `isPrivateOnly: boolean` - `minRevertibleSideEffectCounter: Fr` - `publicTeardownCallRequest: PublicCallRequest` - `static schema: unknown` - `validationRequests: PrivateValidationRequests` **Methods** - `static empty() => PrivateKernelCircuitPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelCircuitPublicInputs` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `toBuffer() => any` - `toJSON() => any` ### PrivateKernelData Data of the previous kernel iteration in the chain of kernels. **Constructor** ```typescript new PrivateKernelData(publicInputs: PrivateKernelCircuitPublicInputs, vkData: VkData) ``` **Properties** - `publicInputs: PrivateKernelCircuitPublicInputs` - `vkData: VkData` **Methods** - `static empty() => PrivateKernelData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelData` - `toBuffer() => any` - Serialize this as a buffer. ### PrivateKernelInitCircuitPrivateInputs Input to the private kernel circuit - initial call. **Constructor** ```typescript new PrivateKernelInitCircuitPrivateInputs(txRequest: TxRequest, vkTreeRoot: Fr, protocolContracts: ProtocolContracts, privateCall: PrivateCallData, isPrivateOnly: boolean, firstNullifierHint: Fr, revertibleCounterHint: number) ``` **Properties** - `firstNullifierHint: Fr` - `isPrivateOnly: boolean` - `privateCall: PrivateCallData` - `protocolContracts: ProtocolContracts` - `revertibleCounterHint: number` - `txRequest: TxRequest` - `vkTreeRoot: Fr` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelInitCircuitPrivateInputs` - Deserializes from a buffer or reader. - `toBuffer() => any` - Serialize this as a buffer. ### PrivateKernelInnerCircuitPrivateInputs Input to the private kernel circuit - Inner call. **Constructor** ```typescript new PrivateKernelInnerCircuitPrivateInputs(previousKernel: PrivateKernelData, privateCall: PrivateCallData) ``` **Properties** - `previousKernel: PrivateKernelData` - `privateCall: PrivateCallData` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelInnerCircuitPrivateInputs` - Deserializes from a buffer or reader. - `toBuffer() => any` - Serialize this as a buffer. ### PrivateKernelResetCircuitPrivateInputs Input to the private kernel circuit - reset call. **Constructor** ```typescript new PrivateKernelResetCircuitPrivateInputs(previousKernel: PrivateKernelData, paddedSideEffects: PaddedSideEffects, hints: PrivateKernelResetHints<64, 64, 64, 64, 64, 64>, dimensions: PrivateKernelResetDimensions) ``` **Properties** - `dimensions: PrivateKernelResetDimensions` - `hints: PrivateKernelResetHints<64, 64, 64, 64, 64, 64>` - `paddedSideEffects: PaddedSideEffects` - `previousKernel: PrivateKernelData` **Methods** - `toBuffer() => any` - Serialize this as a buffer. - `trimToSizes() => PrivateKernelResetCircuitPrivateInputsVariants` ### PrivateKernelResetCircuitPrivateInputsVariants **Constructor** ```typescript new PrivateKernelResetCircuitPrivateInputsVariants(previousKernel: PrivateKernelData, paddedSideEffects: PaddedSideEffects, hints: PrivateKernelResetHints) ``` **Properties** - `hints: PrivateKernelResetHints` - `paddedSideEffects: PaddedSideEffects` - `previousKernel: PrivateKernelData` **Methods** - `toBuffer() => any` ### PrivateKernelResetDimensions **Constructor** ```typescript new PrivateKernelResetDimensions(NOTE_HASH_PENDING_READ: number, NOTE_HASH_SETTLED_READ: number, NULLIFIER_PENDING_READ: number, NULLIFIER_SETTLED_READ: number, KEY_VALIDATION: number, TRANSIENT_DATA_SQUASHING: number, NOTE_HASH_SILOING: number, NULLIFIER_SILOING: number, PRIVATE_LOG_SILOING: number) ``` **Properties** - `KEY_VALIDATION: number` - `NOTE_HASH_PENDING_READ: number` - `NOTE_HASH_SETTLED_READ: number` - `NOTE_HASH_SILOING: number` - `NULLIFIER_PENDING_READ: number` - `NULLIFIER_SETTLED_READ: number` - `NULLIFIER_SILOING: number` - `PRIVATE_LOG_SILOING: number` - `TRANSIENT_DATA_SQUASHING: number` **Methods** - `static empty() => PrivateKernelResetDimensions` - `static from(fields: Partial>) => PrivateKernelResetDimensions` - `static fromValues(values: number[]) => PrivateKernelResetDimensions` - `toBuffer() => any` - `toValues() => number[]` ### PrivateKernelResetHints **Constructor** ```typescript new PrivateKernelResetHints(noteHashReadRequestHints: NoteHashReadRequestHints, nullifierReadRequestHints: NullifierReadRequestHints, keyValidationHints: Tuple, transientDataSquashingHints: Tuple) ``` **Properties** - `keyValidationHints: Tuple` - `noteHashReadRequestHints: NoteHashReadRequestHints` - `nullifierReadRequestHints: NullifierReadRequestHints` - `transientDataSquashingHints: Tuple` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader, numNoteHashReadRequestPending: NH_RR_PENDING, numNoteHashReadRequestSettled: NH_RR_SETTLED, numNullifierReadRequestPending: NLL_RR_PENDING, numNullifierReadRequestSettled: NLL_RR_SETTLED, numKeyValidationHints: KEY_VALIDATION_HINTS_LEN, numTransientDataSquashingHints: TRANSIENT_DATA_HINTS_LEN) => PrivateKernelResetHints` - Deserializes from a buffer or reader. - `toBuffer() => any` - `trimToSizes(numNoteHashReadRequestPending: number, numNoteHashReadRequestSettled: number, numNullifierReadRequestPending: number, numNullifierReadRequestSettled: number, numKeyValidationHints: number, numTransientDataSquashingHints: number) => PrivateKernelResetHints` ### PrivateKernelTailCircuitPrivateInputs Input to the private kernel circuit - tail call. **Constructor** ```typescript new PrivateKernelTailCircuitPrivateInputs(previousKernel: PrivateKernelData, paddedSideEffectAmounts: PaddedSideEffectAmounts, includeByTimestampUpperBound: bigint) ``` **Properties** - `includeByTimestampUpperBound: bigint` - `paddedSideEffectAmounts: PaddedSideEffectAmounts` - `previousKernel: PrivateKernelData` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelTailCircuitPrivateInputs` - Deserializes from a buffer or reader. - `isForPublic() => boolean` - `toBuffer() => any` - Serialize this as a buffer. ### PrivateKernelTailCircuitPublicInputs **Constructor** ```typescript new PrivateKernelTailCircuitPublicInputs(constants: TxConstantData, gasUsed: Gas, feePayer: AztecAddress, includeByTimestamp: bigint, forPublic?: PartialPrivateTailPublicInputsForPublic, forRollup?: PartialPrivateTailPublicInputsForRollup) ``` **Properties** - `constants: TxConstantData` - `feePayer: AztecAddress` - `forPublic?: PartialPrivateTailPublicInputsForPublic` - `forRollup?: PartialPrivateTailPublicInputsForRollup` - `gasUsed: Gas` - `includeByTimestamp: bigint` - `static schema: unknown` **Methods** - `static empty() => PrivateKernelTailCircuitPublicInputs` - `static emptyWithNullifier() => PrivateKernelTailCircuitPublicInputs` - Creates an empty instance except for a nullifier in the combined accumulated data. Useful for populating a tx, which relies on that nullifier for extracting its tx hash. Remove this method as we move away from 1st nullifier as hash. - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateKernelTailCircuitPublicInputs` - `getEmittedContractClassLogsLength() => number` - `getEmittedPrivateLogsLength() => number` - `getNonEmptyContractClassLogsHashes() => ScopedLogHash[]` - `getNonEmptyNoteHashes() => Fr[]` - `getNonEmptyNullifiers() => Fr[]` - `getNonEmptyPrivateLogs() => PrivateLog[]` - `getNonRevertiblePublicCallRequests() => PublicCallRequest[]` - `getRevertiblePublicCallRequests() => PublicCallRequest[]` - `getSize() => number` - `getTeardownPublicCallRequest() => PublicCallRequest` - `hasTeardownPublicCallRequest() => boolean` - `numberOfNonRevertiblePublicCallRequests() => number` - `numberOfPublicCallRequests() => number` - `numberOfRevertiblePublicCallRequests() => number` - `publicInputs() => PrivateToRollupKernelCircuitPublicInputs | PrivateToPublicKernelCircuitPublicInputs` - `toBuffer() => any` - `toJSON() => any` - `toPrivateToPublicKernelCircuitPublicInputs() => PrivateToPublicKernelCircuitPublicInputs` - `toPrivateToRollupKernelCircuitPublicInputs() => PrivateToRollupKernelCircuitPublicInputs` ### PrivateLog **Constructor** ```typescript new PrivateLog(fields: [], emittedLength: number) ``` **Properties** - `emittedLength: number` - `fields: []` - `static schema: unknown` - `static SIZE_IN_BYTES: number` **Methods** - `[custom]() => string` - `static empty() => PrivateLog` - `equals(other: PrivateLog) => boolean` - `static from(fields: FieldsOf) => PrivateLog` - `static fromBlobFields(emittedLength: number, fields: Fr[] | FieldReader) => PrivateLog` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateLog` - `static fromFields(fields: Fr[] | FieldReader) => PrivateLog` - `static fromPlainObject(obj: any) => PrivateLog` - Creates a PrivateLog from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getEmittedFields() => Fr[]` - `getEmittedFieldsWithoutTag() => Fr[]` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `static random(tag?: Fr) => PrivateLog` - `toBlobFields() => Fr[]` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### PrivateLogData **Constructor** ```typescript new PrivateLogData(log: PrivateLog, noteHashCounter: number, counter: number) ``` **Properties** - `counter: number` - `log: PrivateLog` - `noteHashCounter: number` **Methods** - `[custom]() => string` - `static empty() => PrivateLogData` - `static from(fields: FieldsOf) => PrivateLogData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateLogData` - `static fromFields(fields: Fr[] | FieldReader) => PrivateLogData` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### PrivateLogWithTxData **Constructor** ```typescript new PrivateLogWithTxData(logPayload: Fr[], txHash: TxHash, uniqueNoteHashesInTx: Fr[], firstNullifierInTx: Fr) ``` **Properties** - `firstNullifierInTx: Fr` - `logPayload: Fr[]` - `txHash: TxHash` - `uniqueNoteHashesInTx: Fr[]` **Methods** - `static noirSerializationOfEmpty() => Fr | Fr[][]` - `toNoirSerialization() => Fr | Fr[][]` ### PrivateSimulationResult **Constructor** ```typescript new PrivateSimulationResult(privateExecutionResult: PrivateExecutionResult, publicInputs: PrivateKernelTailCircuitPublicInputs) ``` **Properties** - `privateExecutionResult: PrivateExecutionResult` - `publicInputs: PrivateKernelTailCircuitPublicInputs` **Methods** - `getPrivateReturnValues() => NestedProcessReturnValues` - `toSimulatedTx() => Promise` ### PrivateToAvmAccumulatedData **Constructor** ```typescript new PrivateToAvmAccumulatedData(noteHashes: [], nullifiers: [], l2ToL1Msgs: []) ``` **Properties** - `l2ToL1Msgs: []` - `noteHashes: []` - `nullifiers: []` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PrivateToAvmAccumulatedData` - `static from(fields: FieldsOf) => PrivateToAvmAccumulatedData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToAvmAccumulatedData` - `static fromFields(fields: Fr[] | FieldReader) => PrivateToAvmAccumulatedData` - `static fromPlainObject(obj: any) => PrivateToAvmAccumulatedData` - Creates a PrivateToAvmAccumulatedData instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getArrayLengths() => PrivateToAvmAccumulatedDataArrayLengths` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => Fr[]` ### PrivateToAvmAccumulatedDataArrayLengths **Constructor** ```typescript new PrivateToAvmAccumulatedDataArrayLengths(noteHashes: number, nullifiers: number, l2ToL1Msgs: number) ``` **Properties** - `l2ToL1Msgs: number` - `noteHashes: number` - `nullifiers: number` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PrivateToAvmAccumulatedDataArrayLengths` - `static from(fields: FieldsOf) => PrivateToAvmAccumulatedDataArrayLengths` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToAvmAccumulatedDataArrayLengths` - `static fromFields(fields: Fr[] | FieldReader) => PrivateToAvmAccumulatedDataArrayLengths` - `static fromPlainObject(obj: any) => PrivateToAvmAccumulatedDataArrayLengths` - Creates a PrivateToAvmAccumulatedDataArrayLengths instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => number[]` ### PrivateToPublicAccumulatedData **Constructor** ```typescript new PrivateToPublicAccumulatedData(noteHashes: [], nullifiers: [], l2ToL1Msgs: [], privateLogs: [], contractClassLogsHashes: [], publicCallRequests: []) ``` **Properties** - `readonly contractClassLogsHashes: []` - `readonly l2ToL1Msgs: []` - `readonly noteHashes: []` - `readonly nullifiers: []` - `readonly privateLogs: []` - `readonly publicCallRequests: []` **Methods** - `[custom]() => string` - `static empty() => PrivateToPublicAccumulatedData` - `static from(fields: FieldsOf) => PrivateToPublicAccumulatedData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToPublicAccumulatedData` - `static fromFields(fields: Fr[] | FieldReader) => PrivateToPublicAccumulatedData` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => Fr[]` ### PrivateToPublicAccumulatedDataBuilder TESTS-ONLY CLASS Builder for PrivateToPublicAccumulatedData, used to conveniently construct instances for testing, as PrivateToPublicAccumulatedData is (or will shortly be) immutable. **Constructor** ```typescript new PrivateToPublicAccumulatedDataBuilder() ``` **Methods** - `build() => PrivateToPublicAccumulatedData` - `pushContractClassLogsHash(contractClassLogsHash: ScopedLogHash) => this` - `pushL2ToL1Msg(newL2ToL1Msg: ScopedL2ToL1Message) => this` - `pushNoteHash(newNoteHash: Fr) => this` - `pushNullifier(newNullifier: Fr) => this` - `pushPrivateLog(privateLog: PrivateLog) => this` - `pushPublicCall(publicCall: PublicCallRequest) => this` - `withContractClassLogsHashes(contractClassLogsHashes: ScopedLogHash[]) => this` - `withL2ToL1Msgs(l2ToL1Msgs: ScopedL2ToL1Message[]) => this` - `withNoteHashes(noteHashes: Fr[]) => this` - `withNullifiers(nullifiers: Fr[]) => this` - `withPrivateLogs(privateLogs: PrivateLog[]) => this` - `withPublicCallRequests(publicCallRequests: PublicCallRequest[]) => this` ### PrivateToPublicKernelCircuitPublicInputs **Constructor** ```typescript new PrivateToPublicKernelCircuitPublicInputs(constants: TxConstantData, nonRevertibleAccumulatedData: PrivateToPublicAccumulatedData, revertibleAccumulatedData: PrivateToPublicAccumulatedData, publicTeardownCallRequest: PublicCallRequest, gasUsed: Gas, feePayer: AztecAddress, includeByTimestamp: bigint) ``` **Properties** - `constants: TxConstantData` - `feePayer: AztecAddress` - `gasUsed: Gas` - `includeByTimestamp: bigint` - `nonRevertibleAccumulatedData: PrivateToPublicAccumulatedData` - `publicTeardownCallRequest: PublicCallRequest` - `revertibleAccumulatedData: PrivateToPublicAccumulatedData` - `static schema: unknown` **Methods** - `static empty() => PrivateToPublicKernelCircuitPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToPublicKernelCircuitPublicInputs` - `static fromString(str: string) => PrivateToPublicKernelCircuitPublicInputs` - `static getFields(fields: FieldsOf) => readonly []` - `hash() => Promise` - `toBuffer() => any` - `toFields() => Fr[]` - `toJSON() => any` - `toString() => string` ### PrivateToRollupAccumulatedData Data that is accumulated during the execution of the transaction. **Constructor** ```typescript new PrivateToRollupAccumulatedData(noteHashes: [], nullifiers: [], l2ToL1Msgs: [], privateLogs: [], contractClassLogsHashes: []) ``` **Properties** - `contractClassLogsHashes: []` - `l2ToL1Msgs: []` - `noteHashes: []` - `nullifiers: []` - `privateLogs: []` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PrivateToRollupAccumulatedData` - `static from(fields: FieldsOf) => PrivateToRollupAccumulatedData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToRollupAccumulatedData` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromString(str: string) => PrivateToRollupAccumulatedData` - Deserializes from a string, corresponding to a write in cpp. - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => Fr[]` - `toJSON() => any` - `toString() => string` ### PrivateToRollupKernelCircuitPublicInputs Outputs from the public kernel circuits. All Public kernels use this shape for outputs. **Constructor** ```typescript new PrivateToRollupKernelCircuitPublicInputs(constants: TxConstantData, end: PrivateToRollupAccumulatedData, gasUsed: Gas, feePayer: AztecAddress, includeByTimestamp: bigint) ``` **Properties** - `constants: TxConstantData` - `end: PrivateToRollupAccumulatedData` - `feePayer: AztecAddress` - `gasUsed: Gas` - `includeByTimestamp: bigint` - `static schema: unknown` **Methods** - `static empty() => PrivateToRollupKernelCircuitPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateToRollupKernelCircuitPublicInputs` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromString(str: string) => PrivateToRollupKernelCircuitPublicInputs` - `static getFields(fields: FieldsOf) => readonly []` - `getNonEmptyNullifiers() => Fr[]` - `hash() => Promise` - `toBuffer() => any` - `toFields() => Fr[]` - `toJSON() => any` - Returns a hex representation for JSON serialization. - `toString() => string` ### PrivateTxBaseRollupPrivateInputs **Constructor** ```typescript new PrivateTxBaseRollupPrivateInputs(hidingKernelProofData: ChonkProofData, hints: PrivateBaseRollupHints) ``` **Properties** - `hidingKernelProofData: ChonkProofData` - `hints: PrivateBaseRollupHints` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PrivateTxBaseRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateTxBaseRollupPrivateInputs` - `static fromString(str: string) => PrivateTxBaseRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` ### PrivateTxConstantData Data that is constant/not modified by neither of the kernels. **Constructor** ```typescript new PrivateTxConstantData(anchorBlockHeader: BlockHeader, txContext: TxContext, vkTreeRoot: Fr, protocolContracts: ProtocolContracts) ``` **Properties** - `anchorBlockHeader: BlockHeader` - `protocolContracts: ProtocolContracts` - `txContext: TxContext` - `vkTreeRoot: Fr` **Methods** - `clone() => PrivateTxConstantData` - `static empty() => PrivateTxConstantData` - `static from(fields: FieldsOf) => PrivateTxConstantData` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateTxConstantData` - `static fromFields(fields: Fr[] | FieldReader) => PrivateTxConstantData` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => Fr[]` ### PrivateValidationRequests Validation requests accumulated during the execution of the transaction. **Constructor** ```typescript new PrivateValidationRequests(noteHashReadRequests: ClaimedLengthArray, nullifierReadRequests: ClaimedLengthArray, scopedKeyValidationRequestsAndGenerators: ClaimedLengthArray) ``` **Properties** - `noteHashReadRequests: ClaimedLengthArray` - `nullifierReadRequests: ClaimedLengthArray` - `scopedKeyValidationRequestsAndGenerators: ClaimedLengthArray` **Methods** - `[custom]() => string` - `static empty() => PrivateValidationRequests` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateValidationRequests` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromString(str: string) => PrivateValidationRequests` - Deserializes from a string, corresponding to a write in cpp. - `getSize() => number` - `toBuffer() => any` - `toString() => string` ### PrivateVerificationKeyHints **Constructor** ```typescript new PrivateVerificationKeyHints(contractClassArtifactHash: Fr, contractClassPublicBytecodeCommitment: Fr, publicKeys: PublicKeys, saltedInitializationHash: Fr, functionLeafMembershipWitness: MembershipWitness<7>, updatedClassIdHints: UpdatedClassIdHints) ``` **Properties** - `contractClassArtifactHash: Fr` - `contractClassPublicBytecodeCommitment: Fr` - `functionLeafMembershipWitness: MembershipWitness<7>` - `publicKeys: PublicKeys` - `saltedInitializationHash: Fr` - `updatedClassIdHints: UpdatedClassIdHints` **Methods** - `static from(fields: FieldsOf) => PrivateVerificationKeyHints` - `static fromBuffer(buffer: Buffer | BufferReader) => PrivateVerificationKeyHints` - Deserializes from a buffer or reader. - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `toBuffer() => Buffer` - Serialize this as a buffer. ### Proof The Proof class is a wrapper around the circuits proof. Underlying it is a buffer of proof data in a form a barretenberg prover understands. It provides methods to easily create, serialize, and deserialize the proof data for efficient communication and storage. **Constructor** ```typescript new Proof(buffer: Buffer, numPublicInputs: number) ``` **Properties** - `readonly __proofBrand: any` - `buffer: Buffer` - `numPublicInputs: number` **Methods** - `static empty() => Proof` - Returns an empty proof. - `extractPublicInputs() => Fr[]` - `static fromBuffer(buffer: Buffer | BufferReader) => Proof` - Create a Proof from a Buffer or BufferReader. Expects a length-encoding. - `static fromString(str: string) => Proof` - Deserialize a Proof instance from a hex string. - `isEmpty() => boolean` - Returns whether this proof is actually empty. - `toBuffer() => any` - Convert the Proof instance to a custom Buffer format. This function serializes the Proof's buffer length and data sequentially into a new Buffer. - `toString() => string` - Serialize the Proof instance to a hex string. - `withoutPublicInputs() => Buffer` - Returns the proof without the public inputs, but includes the pairing point object as part of the proof. ### ProofData Represents the data of a recursive proof. **Constructor** ```typescript new ProofData(publicInputs: T, proof: RecursiveProof, vkData: VkData) ``` **Properties** - `proof: RecursiveProof` - `publicInputs: T` - `vkData: VkData` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader, publicInputs: { fromBuffer: (reader: BufferReader) => T }) => ProofData` - `toBuffer() => Buffer` ### ProtocolContracts **Constructor** ```typescript new ProtocolContracts(derivedAddresses: []) ``` **Properties** - `derivedAddresses: []` - `static schema: unknown` **Methods** - `static empty() => ProtocolContracts` - `static from(fields: FieldsOf) => ProtocolContracts` - `static fromBuffer(buffer: Buffer | BufferReader) => ProtocolContracts` - `static fromFields(fields: Fr[] | FieldReader) => ProtocolContracts` - `static fromPlainObject(obj: any) => ProtocolContracts` - Creates a ProtocolContracts instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `hash() => Promise` - `toBuffer() => any` - `toFields() => Fr[]` ### ProvingError An error thrown when generating a proof fails. Extends: `Error` **Constructor** ```typescript new ProvingError(message: string, cause?: unknown, retry?: boolean) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `static readonly NAME: string` - `readonly retry: boolean` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### PublicBaseRollupHints **Constructor** ```typescript new PublicBaseRollupHints(startSpongeBlob: SpongeBlob, lastArchive: AppendOnlyTreeSnapshot, anchorBlockArchiveSiblingPath: [], contractClassLogsFields: []) ``` **Properties** - `anchorBlockArchiveSiblingPath: []` - `contractClassLogsFields: []` - `lastArchive: AppendOnlyTreeSnapshot` - `startSpongeBlob: SpongeBlob` **Methods** - `static empty() => PublicBaseRollupHints` - `static from(fields: FieldsOf) => PublicBaseRollupHints` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicBaseRollupHints` - `static fromString(str: string) => PublicBaseRollupHints` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - Serializes the inputs to a buffer. - `toString() => string` - Serializes the inputs to a hex string. ### PublicCallRequest Represents a request to call a public function. **Constructor** ```typescript new PublicCallRequest(msgSender: AztecAddress, contractAddress: AztecAddress, isStaticCall: boolean, calldataHash: Fr) ``` **Properties** - `calldataHash: Fr` - `contractAddress: AztecAddress` - `isStaticCall: boolean` - `msgSender: AztecAddress` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PublicCallRequest` - `static from(fields: FieldsOf) => PublicCallRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicCallRequest` - `static fromCalldata(msgSender: AztecAddress, contractAddress: AztecAddress, isStaticCall: boolean, calldata: Fr[]) => Promise` - `static fromFields(fields: Fr[] | FieldReader) => PublicCallRequest` - `static fromPlainObject(obj: any) => PublicCallRequest` - Creates a PublicCallRequest instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### PublicCallRequestArrayLengths Represents lengths of arrays of public call requests. **Constructor** ```typescript new PublicCallRequestArrayLengths(setupCalls: number, appLogicCalls: number, teardownCall: boolean) ``` **Properties** - `appLogicCalls: number` - `static schema: unknown` - `setupCalls: number` - `teardownCall: boolean` **Methods** - `[custom]() => string` - `static empty() => PublicCallRequestArrayLengths` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicCallRequestArrayLengths` - `static fromFields(fields: Fr[] | FieldReader) => PublicCallRequestArrayLengths` - `static fromPlainObject(obj: any) => PublicCallRequestArrayLengths` - Creates a PublicCallRequestArrayLengths instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toFields() => Fr[]` ### PublicCallRequestWithCalldata The call request of a public function, including the calldata. **Constructor** ```typescript new PublicCallRequestWithCalldata(request: PublicCallRequest, calldata: Fr[]) ``` **Properties** - `args: unknown` - `calldata: Fr[]` - `functionSelector: unknown` - `request: PublicCallRequest` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PublicCallRequestWithCalldata` - `static from(fields: Pick) => PublicCallRequestWithCalldata` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicCallRequestWithCalldata` - `static fromPlainObject(obj: any) => PublicCallRequestWithCalldata` - Creates a PublicCallRequestWithCalldata from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `isEmpty() => boolean` - `toBuffer() => any` ### PublicCallStackItemCompressed Compressed call stack item on a public call. **Constructor** ```typescript new PublicCallStackItemCompressed(contractAddress: AztecAddress, callContext: CallContext, argsHash: Fr, returnsHash: Fr, revertCode: RevertCode, startGasLeft: Gas, endGasLeft: Gas) ``` **Properties** - `argsHash: Fr` - `callContext: CallContext` - `contractAddress: AztecAddress` - `endGasLeft: Gas` - `returnsHash: Fr` - `revertCode: RevertCode` - `startGasLeft: Gas` **Methods** - `static empty() => PublicCallStackItemCompressed` - Returns a new instance of PublicCallStackItem with zero contract address, function data and public inputs. - `static fromBuffer(buffer: Buffer | BufferReader) => PublicCallStackItemCompressed` - Deserializes from a buffer or reader. - `static fromFields(fields: Fr[] | FieldReader) => PublicCallStackItemCompressed` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### PublicChonkVerifierPrivateInputs **Constructor** ```typescript new PublicChonkVerifierPrivateInputs(hidingKernelProofData: ChonkProofData, proverId: Fr) ``` **Properties** - `hidingKernelProofData: ChonkProofData` - `proverId: Fr` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PublicChonkVerifierPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicChonkVerifierPrivateInputs` - `static fromString(str: string) => PublicChonkVerifierPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` ### PublicChonkVerifierPublicInputs **Constructor** ```typescript new PublicChonkVerifierPublicInputs(privateTail: PrivateToPublicKernelCircuitPublicInputs, proverId: Fr) ``` **Properties** - `privateTail: PrivateToPublicKernelCircuitPublicInputs` - `proverId: Fr` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PublicChonkVerifierPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicChonkVerifierPublicInputs` - `static fromString(str: string) => PublicChonkVerifierPublicInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` ### PublicDataRead Read operations from the public state tree. **Constructor** ```typescript new PublicDataRead(leafSlot: Fr, value: Fr, counter: number) ``` **Properties** - `readonly counter: number` - `readonly leafSlot: Fr` - `readonly value: Fr` **Methods** - `static empty() => PublicDataRead` - `equals(other: PublicDataRead) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataRead` - `static fromFields(fields: Fr[] | FieldReader) => PublicDataRead` - `isEmpty() => boolean` - `toBuffer() => any` ### PublicDataTreeLeaf A leaf in the public data indexed tree. Implements: `IndexedTreeLeaf` **Constructor** ```typescript new PublicDataTreeLeaf(slot: Fr, value: Fr) ``` **Properties** - `static schema: unknown` - `slot: Fr` - `value: Fr` **Methods** - `static buildDummy(key: bigint) => PublicDataTreeLeaf` - `clone() => PublicDataTreeLeaf` - `static empty() => PublicDataTreeLeaf` - `equals(another: PublicDataTreeLeaf) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataTreeLeaf` - `static fromPlainObject(obj: any) => PublicDataTreeLeaf` - Creates a PublicDataTreeLeaf from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getKey() => bigint` - Returns key of the leaf. It's used for indexing. - `isEmpty() => boolean` - Returns true if the leaf is empty. - `toBuffer() => any` - Serializes the leaf into a buffer. - `toHashInputs() => Buffer[]` - `toString() => string` - Returns a string representation of an object. - `updateTo(another: PublicDataTreeLeaf) => PublicDataTreeLeaf` - Updates the leaf with the data of another leaf. ### PublicDataTreeLeafPreimage Class containing the data of a preimage of a single leaf in the public data tree. Note: It's called preimage because this data gets hashed before being inserted as a node into the `IndexedTree`. Implements: `IndexedTreeLeafPreimage` **Constructor** ```typescript new PublicDataTreeLeafPreimage(leaf: PublicDataTreeLeaf, nextKey: Fr, nextIndex: bigint) ``` **Properties** - `leaf: PublicDataTreeLeaf` - `static leafSchema: unknown` - `nextIndex: bigint` - `nextKey: Fr` - `static schema: unknown` **Methods** - `asLeaf() => PublicDataTreeLeaf` - Returns the preimage as a leaf. - `static clone(preimage: PublicDataTreeLeafPreimage) => PublicDataTreeLeafPreimage` - `static empty() => PublicDataTreeLeafPreimage` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataTreeLeafPreimage` - `static fromLeaf(leaf: PublicDataTreeLeaf, nextKey: bigint, nextIndex: bigint) => PublicDataTreeLeafPreimage` - `static fromPlainObject(obj: any) => PublicDataTreeLeafPreimage` - Creates a PublicDataTreeLeafPreimage from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getKey() => bigint` - Returns key of the leaf corresponding to this preimage. - `getNextIndex() => bigint` - Returns the index of the next leaf. - `getNextKey() => bigint` - `static random() => PublicDataTreeLeafPreimage` - `toBuffer() => Buffer` - Serializes the preimage into a buffer. - `toHashInputs() => Buffer[]` - Serializes the preimage to an array of buffers for hashing. ### PublicDataUpdateRequest Write operations on the public data tree including the previous value. **Constructor** ```typescript new PublicDataUpdateRequest(leafSlot: Fr, newValue: Fr, sideEffectCounter: number) ``` **Properties** - `counter: unknown` - `readonly leafSlot: Fr` - `readonly newValue: Fr` - `position: unknown` - `readonly sideEffectCounter: number` **Methods** - `[custom]() => string` - `static empty() => PublicDataUpdateRequest` - `equals(other: PublicDataUpdateRequest) => boolean` - `static from(args: { leafIndex: Fr; newValue: Fr; sideEffectCounter: number }) => PublicDataUpdateRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataUpdateRequest` - `static fromContractStorageUpdateRequest(contractAddress: AztecAddress, updateRequest: ContractStorageUpdateRequest) => Promise` - `static fromFields(fields: Fr[] | FieldReader) => PublicDataUpdateRequest` - `static isEmpty(x: PublicDataUpdateRequest) => boolean` - `toBuffer() => any` - `toFriendlyJSON() => string` ### PublicDataWitness Public data witness. **Constructor** ```typescript new PublicDataWitness(index: bigint, leafPreimage: PublicDataTreeLeafPreimage, siblingPath: SiblingPath<40>) ``` **Properties** - `readonly index: bigint` - `readonly leafPreimage: PublicDataTreeLeafPreimage` - `static schema: unknown` - `readonly siblingPath: SiblingPath<40>` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataWitness` - Deserializes an PublicDataWitness object from a buffer. - `static fromString(str: string) => PublicDataWitness` - Deserializes an PublicDataWitness object from a string. - `static random() => PublicDataWitness` - `toBuffer() => Buffer` - `toFields() => Fr[]` - Returns a field array representation of a public data witness. - `toNoirRepresentation() => string | string[][]` - Returns a representation of the public data witness as expected by intrinsic Noir deserialization. - `toString() => string` - Returns a string representation of the TxEffect object. - `withoutPreimage() => MembershipWitness<40>` ### PublicDataWrite Write operations on the public state tree. **Constructor** ```typescript new PublicDataWrite(leafSlot: Fr, value: Fr) ``` **Properties** - `readonly leafSlot: Fr` - `static schema: unknown` - `static SIZE_IN_BYTES: number` - `readonly value: Fr` **Methods** - `static empty() => PublicDataWrite` - `equals(other: PublicDataWrite) => boolean` - `static from(fields: FieldsOf) => PublicDataWrite` - `static fromBlobFields(fields: Fr[] | FieldReader) => PublicDataWrite` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicDataWrite` - `static fromFields(fields: Fr[] | FieldReader) => PublicDataWrite` - `static fromPlainObject(obj: any) => PublicDataWrite` - Creates a PublicDataWrite instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromString(str: string) => PublicDataWrite` - `static getFields(fields: FieldsOf) => readonly []` - `static isEmpty(data: PublicDataWrite) => boolean` - `static random() => PublicDataWrite` - `toBlobFields() => []` - `toBuffer() => any` - `toFields() => Fr[]` - `toString() => string` ### PublicInnerCallRequest Represents a request to call a public function. **Constructor** ```typescript new PublicInnerCallRequest(item: PublicCallStackItemCompressed, counter: number) ``` **Properties** - `counter: number` - `item: PublicCallStackItemCompressed` **Methods** - `[custom]() => string` - `static empty() => PublicInnerCallRequest` - `static from(fields: FieldsOf) => PublicInnerCallRequest` - Create PublicInnerCallRequest from a fields dictionary. - `static fromBuffer(buffer: Buffer | BufferReader) => PublicInnerCallRequest` - Deserialize this from a buffer. - `static fromFields(fields: Fr[] | FieldReader) => PublicInnerCallRequest` - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - Serialize this as a buffer. - `toFields() => Fr[]` ### PublicKeys **Constructor** ```typescript new PublicKeys(masterNullifierPublicKey: Point, masterIncomingViewingPublicKey: Point, masterOutgoingViewingPublicKey: Point, masterTaggingPublicKey: Point) ``` **Properties** - `masterIncomingViewingPublicKey: Point` - `masterNullifierPublicKey: Point` - `masterOutgoingViewingPublicKey: Point` - `masterTaggingPublicKey: Point` - `static schema: unknown` **Methods** - `static default() => PublicKeys` - `encodeToNoir() => Fr[]` - `equals(other: PublicKeys) => boolean` - Determines if this PublicKeys instance is equal to the given PublicKeys instance. Equality is based on the content of their respective buffers. - `static from(fields: FieldsOf) => PublicKeys` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicKeys` - Creates an PublicKeys instance from a given buffer or BufferReader. If the input is a Buffer, it wraps it in a BufferReader before processing. Throws an error if the input length is not equal to the expected size. - `static fromFields(fields: Fr[] | FieldReader) => PublicKeys` - `static fromPlainObject(obj: any) => PublicKeys` - Creates a PublicKeys from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `static fromString(keys: string) => PublicKeys` - `hash() => Fr | Promise` - `isEmpty() => boolean` - `static random() => Promise` - `toBuffer() => Buffer` - Converts the PublicKeys instance into a Buffer. This method should be used when encoding the address for storage, transmission or serialization purposes. - `toFields() => Fr[]` - Serializes the payload to an array of fields - `toNoirStruct() => { ivpk_m: { inner: { is_infinite: boolean; x: Fr; y: Fr } }; npk_m: { inner: { is_infinite: boolean; x: Fr; y: Fr } }; ... }` - `toString() => string` ### PublicLog **Constructor** ```typescript new PublicLog(contractAddress: AztecAddress, fields: Fr[]) ``` **Properties** - `contractAddress: AztecAddress` - `fields: Fr[]` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => PublicLog` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => PublicLog` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicLog` - `static fromFields(fields: Fr[] | FieldReader) => PublicLog` - `static fromPlainObject(obj: any) => PublicLog` - `getEmittedFields() => Fr[]` - `getEmittedFieldsWithoutTag() => Fr[]` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `static random() => Promise` - `sizeInFields() => number` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toHumanReadable() => string` ### PublicLogWithTxData **Constructor** ```typescript new PublicLogWithTxData(logPayload: Fr[], txHash: TxHash, uniqueNoteHashesInTx: Fr[], firstNullifierInTx: Fr) ``` **Properties** - `firstNullifierInTx: Fr` - `logPayload: Fr[]` - `txHash: TxHash` - `uniqueNoteHashesInTx: Fr[]` ### PublicSimulationOutput Outputs of processing the public component of a transaction. **Constructor** ```typescript new PublicSimulationOutput(revertReason: SimulationError, globalVariables: GlobalVariables, txEffect: TxEffect, publicReturnValues: NestedProcessReturnValues[], gasUsed: GasUsed) ``` **Properties** - `gasUsed: GasUsed` - `globalVariables: GlobalVariables` - `publicReturnValues: NestedProcessReturnValues[]` - `revertReason: SimulationError` - `static schema: unknown` - `txEffect: TxEffect` **Methods** - `static random() => Promise` ### PublicSimulatorConfig **Constructor** ```typescript new PublicSimulatorConfig(proverId: Fr, skipFeeEnforcement: boolean, collectCallMetadata: boolean, collectHints: boolean, collectPublicInputs: boolean, collectDebugLogs: boolean, collectStatistics: boolean, collectionLimits: CollectionLimitsConfig) ``` **Properties** - `readonly collectCallMetadata: boolean` - `readonly collectDebugLogs: boolean` - `readonly collectHints: boolean` - `readonly collectionLimits: CollectionLimitsConfig` - `readonly collectPublicInputs: boolean` - `readonly collectStatistics: boolean` - `readonly proverId: Fr` - `static schema: unknown` - `readonly skipFeeEnforcement: boolean` **Methods** - `static empty() => PublicSimulatorConfig` - `static from(obj: Partial) => PublicSimulatorConfig` ### PublicTxBaseRollupPrivateInputs **Constructor** ```typescript new PublicTxBaseRollupPrivateInputs(publicChonkVerifierProofData: RollupHonkProofData, avmProofData: AvmProofData, hints: PublicBaseRollupHints) ``` **Properties** - `avmProofData: AvmProofData` - `hints: PublicBaseRollupHints` - `publicChonkVerifierProofData: RollupHonkProofData` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PublicTxBaseRollupPrivateInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => PublicTxBaseRollupPrivateInputs` - `static fromString(str: string) => PublicTxBaseRollupPrivateInputs` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => any` - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` ### PublicTxEffect **Constructor** ```typescript new PublicTxEffect(transactionFee: Fr, noteHashes: Fr[], nullifiers: Fr[], l2ToL1Msgs: ScopedL2ToL1Message[], publicLogs: PublicLog[], publicDataWrites: PublicDataWrite[]) ``` **Properties** - `l2ToL1Msgs: ScopedL2ToL1Message[]` - `noteHashes: Fr[]` - `nullifiers: Fr[]` - `publicDataWrites: PublicDataWrite[]` - `publicLogs: PublicLog[]` - `static schema: unknown` - `transactionFee: Fr` **Methods** - `static empty() => PublicTxEffect` - `equals(other: PublicTxEffect) => boolean` - `static from(obj: any) => PublicTxEffect` - `static fromPlainObject(obj: any) => PublicTxEffect` ### PublicTxResult **Constructor** ```typescript new PublicTxResult(gasUsed: GasUsed, revertCode: RevertCode, publicTxEffect: PublicTxEffect, callStackMetadata: CallStackMetadata[] | NestedProcessReturnValues[], logs: DebugLog[], hints: AvmExecutionHints, publicInputs: AvmCircuitPublicInputs) ``` **Properties** - `callStackMetadata: CallStackMetadata[] | NestedProcessReturnValues[]` - `gasUsed: GasUsed` - `hints: AvmExecutionHints` - `logs: DebugLog[]` - `publicInputs: AvmCircuitPublicInputs` - `publicTxEffect: PublicTxEffect` - `revertCode: RevertCode` - `static schema: unknown` **Methods** - `static empty() => PublicTxResult` - `findRevertReason() => SimulationError` - `static fromPlainObject(obj: any) => PublicTxResult` - Creates a PublicTxResult from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getAppLogicReturnValues() => NestedProcessReturnValues[]` - Returns one level of return values for the app logic phase, one per enqueued call. ### PublishedCheckpoint **Constructor** ```typescript new PublishedCheckpoint(checkpoint: Checkpoint, l1: L1PublishedData, attestations: CommitteeAttestation[]) ``` **Properties** - `attestations: CommitteeAttestation[]` - `checkpoint: Checkpoint` - `l1: L1PublishedData` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => PublishedCheckpoint` - `static fromBuffer(bufferOrReader: Buffer | BufferReader) => PublishedCheckpoint` - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => Buffer` ### PublishedL2Block **Constructor** ```typescript new PublishedL2Block(block: L2Block, l1: L1PublishedData, attestations: CommitteeAttestation[]) ``` **Properties** - `attestations: CommitteeAttestation[]` - `block: L2Block` - `l1: L1PublishedData` - `static schema: unknown` **Methods** - `static fromBuffer(bufferOrReader: Buffer | BufferReader) => PublishedL2Block` - `static fromFields(fields: FieldsOf) => PublishedL2Block` - `static fromPublishedCheckpoint(checkpoint: PublishedCheckpoint) => PublishedL2Block` - `toBuffer() => Buffer` - `toPublishedCheckpoint() => PublishedCheckpoint` ### ReExFailedTxsError Extends: `ValidatorError` **Constructor** ```typescript new ReExFailedTxsError(numFailedTxs: number) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### ReExStateMismatchError Extends: `ValidatorError` **Constructor** ```typescript new ReExStateMismatchError(expectedArchiveRoot: Fr, actualArchiveRoot: Fr) ``` **Properties** - `readonly actualArchiveRoot: Fr` - `cause?: unknown` - `readonly expectedArchiveRoot: Fr` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### ReExTimeoutError Extends: `ValidatorError` **Constructor** ```typescript new ReExTimeoutError() ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### ReadRequest **Constructor** ```typescript new ReadRequest(value: Fr, counter: number) ``` **Properties** - `counter: number` - `value: Fr` **Methods** - `static empty() => ReadRequest` - Returns an empty instance of side-effect. - `static fromBuffer(buffer: Buffer | BufferReader) => ReadRequest` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromFields(fields: Fr[] | FieldReader) => ReadRequest` - `isEmpty() => boolean` - Returns whether this instance of side-effect is empty. - `scope(contractAddress: AztecAddress) => ScopedReadRequest` - `toBuffer() => Buffer` - Serialize this as a buffer. - `toFields() => Fr[]` - Convert to an array of fields. ### ReadRequestAction **Constructor** ```typescript new ReadRequestAction(action: ReadRequestActionEnum, hintIndex: number) ``` **Properties** - `action: ReadRequestActionEnum` - `hintIndex: number` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => ReadRequestAction` - `static readAsPending(hintIndex: number) => ReadRequestAction` - `static readAsSettled(hintIndex: number) => ReadRequestAction` - `static skip() => ReadRequestAction` - `toBuffer() => any` ### ReadRequestResetActions **Constructor** ```typescript new ReadRequestResetActions(actions: Tuple, pendingReadHints: PendingReadHint[]) ``` **Properties** - `actions: Tuple` - `pendingReadHints: PendingReadHint[]` **Methods** - `static empty(numReads: NUM_READS) => ReadRequestResetActions` ### ReadRequestResetHints Hints for read request reset circuit. **Constructor** ```typescript new ReadRequestResetHints(readRequestActions: Tuple, pendingReadHints: Tuple, settledReadHints: Tuple, SETTLED_READ_HINTS_LEN>) ``` **Properties** - `pendingReadHints: Tuple` - `readRequestActions: Tuple` - `settledReadHints: Tuple, SETTLED_READ_HINTS_LEN>` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader, readRequestLen: READ_REQUEST_LEN, numPendingReads: PENDING_READ_HINTS_LEN, numSettledReads: SETTLED_READ_HINTS_LEN, treeHeight: TREE_HEIGHT, leafPreimageFromBuffer: { fromBuffer: (buffer: BufferReader) => LEAF_PREIMAGE }) => ReadRequestResetHints` - Deserializes from a buffer or reader. - `toBuffer() => any` - `trimToSizes(numPendingReads: NEW_PENDING_READ_HINTS_LEN, numSettledReads: NEW_SETTLED_READ_HINTS_LEN) => ReadRequestResetHints` ### RecursiveProof The Recursive proof class is a wrapper around the circuit's proof. We store the proof in 2 forms for convenience. The first is in the 'fields' format. This is a list of fields, for which there are distinct lengths based on the level of recursion. This 'fields' version does not contain the circuits public inputs We also store the raw binary proof which van be directly verified. The 'fieldsValid' member is set to false in the case where this object is constructed solely from the 'binary' proof This is usually when the proof has been received from clients and signals to provers that the 'fields' version needs to be generated **Constructor** ```typescript new RecursiveProof(proof: Fr[], binaryProof: Proof, fieldsValid: boolean, proofLength: N) ``` **Properties** - `binaryProof: Proof` - `fieldsValid: boolean` - `proof: Fr[]` - `proofLength: N` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader, expectedSize?: N) => RecursiveProof` - Create a Proof from a Buffer or BufferReader. Expects a length-encoding. - `static fromString(str: string, expectedSize?: N) => RecursiveProof` - Deserialize a Proof instance from a hex string. - `static schemaFor(expectedSize?: N) => ZodEffects, RecursiveProof, any>` - Creates an instance from a hex string with expected size. - `toBuffer() => any` - Convert the Proof instance to a custom Buffer format. This function serializes the Proof's buffer length and data sequentially into a new Buffer. - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` - Serialize the Proof instance to a hex string. ### RevertCode Wrapper class over a field to safely represent a revert code. **Properties** - `static readonly APP_LOGIC_REVERTED: RevertCode` - `static readonly BOTH_REVERTED: RevertCode` - `static readonly OK: RevertCode` - `static schema: unknown` - `static readonly TEARDOWN_REVERTED: RevertCode` **Methods** - `[custom]() => string` - `equals(other: RevertCode) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => RevertCode` - `static fromField(field: Fr) => RevertCode` - `static fromFields(fields: Fr[] | FieldReader) => RevertCode` - `static fromNumber(code: number) => RevertCode` - `static fromPlainObject(obj: any) => RevertCode` - Creates a RevertCode from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getCode() => RevertCodeEnum` - `getDescription() => string` - `getSerializedLength() => number` - `isOK() => boolean` - `static random() => RevertCode` - `toBuffer() => Buffer` - `toField() => Fr` - `toHashPreimage() => Buffer` - `toJSON() => number` ### RootRollupPrivateInputs Represents inputs of the root rollup circuit. **Constructor** ```typescript new RootRollupPrivateInputs(previousRollups: []) ``` **Properties** - `previousRollups: []` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => RootRollupPrivateInputs` - Creates a new instance from fields. - `static fromBuffer(buffer: Buffer | BufferReader) => RootRollupPrivateInputs` - Deserializes the inputs from a buffer. - `static fromString(str: string) => RootRollupPrivateInputs` - Deserializes the inputs from a hex string. - `static getFields(fields: FieldsOf) => readonly []` - Extracts fields from an instance. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### RootRollupPublicInputs Represents public inputs of the root rollup circuit. NOTE: in practice, we'll hash all of this up into a single public input, for cheap onchain verification. **Constructor** ```typescript new RootRollupPublicInputs(previousArchiveRoot: Fr, endArchiveRoot: Fr, checkpointHeaderHashes: [], fees: [], constants: EpochConstantData, blobPublicInputs: FinalBlobAccumulator) ``` **Properties** - `blobPublicInputs: FinalBlobAccumulator` - `checkpointHeaderHashes: []` - `constants: EpochConstantData` - `endArchiveRoot: Fr` - `fees: []` - `previousArchiveRoot: Fr` - `static schema: unknown` **Methods** - `static from(fields: FieldsOf) => RootRollupPublicInputs` - `static fromBuffer(buffer: Buffer | BufferReader) => RootRollupPublicInputs` - Deserializes a buffer into a `RootRollupPublicInputs` object. - `static fromString(str: string) => RootRollupPublicInputs` - `static getFields(fields: FieldsOf) => readonly []` - `static random() => RootRollupPublicInputs` - Creates a random instance. Used for testing only - will not prove/verify. - `toBuffer() => any` - `toFields() => Fr[]` - `toJSON() => any` - Returns a representation for JSON serialization. - `toString() => string` ### S3FileStore Simple file store. Implements: `FileStore` **Constructor** ```typescript new S3FileStore(bucketName: string, basePath: string, opts: { endpoint?: string; publicBaseUrl?: string }, log?: Logger) ``` **Methods** - `download(pathOrUrlStr: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrlStr: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrlStr: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. - `save(path: string, data: Buffer, opts?: FileStoreSaveOptions) => Promise` - Saves contents to the given path. Returns an URI that can be used later to `read` the file. Default: `compress` is false unless explicitly set. - `upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions) => Promise` - Uploads contents from a local file. Returns an URI that can be used later to `read` the file. Default: `compress` is true unless explicitly set to false. ### ScheduledDelayChange **Constructor** ```typescript new ScheduledDelayChange(pre: bigint, post: bigint, timestampOfChange: bigint) ``` **Properties** - `post: bigint` - `pre: bigint` - `timestampOfChange: bigint` **Methods** - `static empty() => ScheduledDelayChange` - `isEmpty() => boolean` ### ScheduledValueChange **Constructor** ```typescript new ScheduledValueChange(previous: Fr[], post: Fr[], timestampOfChange: bigint) ``` **Properties** - `post: Fr[]` - `previous: Fr[]` - `timestampOfChange: bigint` **Methods** - `static empty(valueSize: number) => ScheduledValueChange` - `getCurrentAt(timestamp: bigint) => Fr[]` - `isEmpty() => boolean` ### ScopedCountedL2ToL1Message **Constructor** ```typescript new ScopedCountedL2ToL1Message(inner: CountedL2ToL1Message, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `inner: CountedL2ToL1Message` - `static schema: unknown` **Methods** - `static empty() => ScopedCountedL2ToL1Message` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedCountedL2ToL1Message` - `static fromFields(fields: Fr[] | FieldReader) => ScopedCountedL2ToL1Message` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### ScopedCountedLogHash **Constructor** ```typescript new ScopedCountedLogHash(inner: CountedLogHash, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `inner: CountedLogHash` **Methods** - `static empty() => ScopedCountedLogHash` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedCountedLogHash` - `static fromFields(fields: Fr[] | FieldReader) => ScopedCountedLogHash` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### ScopedKeyValidationRequestAndGenerator Request for validating keys used in the app. **Constructor** ```typescript new ScopedKeyValidationRequestAndGenerator(request: KeyValidationRequestAndSeparator, contractAddress: AztecAddress) ``` **Properties** - `readonly contractAddress: AztecAddress` - `readonly request: KeyValidationRequestAndSeparator` **Methods** - `static empty() => ScopedKeyValidationRequestAndGenerator` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedKeyValidationRequestAndGenerator` - `static fromFields(fields: Fr[] | FieldReader) => ScopedKeyValidationRequestAndGenerator` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### ScopedL2ToL1Message **Constructor** ```typescript new ScopedL2ToL1Message(message: L2ToL1Message, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `message: L2ToL1Message` - `static schema: unknown` **Methods** - `static empty() => ScopedL2ToL1Message` - `equals(other: ScopedL2ToL1Message) => boolean` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedL2ToL1Message` - `static fromFields(fields: Fr[] | FieldReader) => ScopedL2ToL1Message` - `static fromPlainObject(obj: any) => ScopedL2ToL1Message` - Creates a ScopedL2ToL1Message instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### ScopedLogHash **Constructor** ```typescript new ScopedLogHash(logHash: LogHash, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `logHash: LogHash` - `value: unknown` **Methods** - `static empty() => ScopedLogHash` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedLogHash` - `static fromFields(fields: Fr[] | FieldReader) => ScopedLogHash` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` ### ScopedNoteHash Implements: `Ordered` **Constructor** ```typescript new ScopedNoteHash(noteHash: NoteHash, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `counter: unknown` - `noteHash: NoteHash` - `value: unknown` **Methods** - `static empty() => ScopedNoteHash` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedNoteHash` - `static fromFields(fields: Fr[] | FieldReader) => ScopedNoteHash` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` - Returns a string representation of an object. ### ScopedNullifier Implements: `Ordered` **Constructor** ```typescript new ScopedNullifier(nullifier: Nullifier, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `counter: unknown` - `nullifiedNoteHash: unknown` - `nullifier: Nullifier` - `value: unknown` **Methods** - `static empty() => ScopedNullifier` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedNullifier` - `static fromFields(fields: Fr[] | FieldReader) => ScopedNullifier` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` - Returns a string representation of an object. ### ScopedPrivateLogData **Constructor** ```typescript new ScopedPrivateLogData(inner: PrivateLogData, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `inner: PrivateLogData` **Methods** - `[custom]() => string` - `static empty() => ScopedPrivateLogData` - `static from(fields: FieldsOf) => ScopedPrivateLogData` - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedPrivateLogData` - `static fromFields(fields: Fr[] | FieldReader) => ScopedPrivateLogData` - `static getFields(fields: FieldsOf) => readonly []` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### ScopedReadRequest ReadRequest with context of the contract emitting the request. **Constructor** ```typescript new ScopedReadRequest(readRequest: ReadRequest, contractAddress: AztecAddress) ``` **Properties** - `contractAddress: AztecAddress` - `counter: unknown` - `readRequest: ReadRequest` - `value: unknown` **Methods** - `static empty() => ScopedReadRequest` - Returns an empty instance of side-effect. - `static fromBuffer(buffer: Buffer | BufferReader) => ScopedReadRequest` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromFields(fields: Fr[] | FieldReader) => ScopedReadRequest` - `isEmpty() => boolean` - Returns whether this instance of side-effect is empty. - `toBuffer() => Buffer` - Serialize this as a buffer. - `toFields() => Fr[]` - Convert to an array of fields. ### ScopedValueCache **Constructor** ```typescript new ScopedValueCache(items: T[]) ``` **Methods** - `get(matcher: { contractAddress: AztecAddress; value: Fr }) => T[]` ### Selector A selector is the first 4 bytes of the hash of a signature. **Constructor** ```typescript new Selector(value: number) ``` **Properties** - `static SIZE: number` - The size of the selector in bytes. - `value: number` **Methods** - `[custom]() => string` - `equals(other: Selector) => boolean` - Checks if this selector is equal to another. - `isEmpty() => boolean` - Checks if the selector is empty (all bytes are 0). - `toBuffer(bufferSize?: number) => Buffer` - Serialize as a buffer. - `toField() => Fr` - Returns a new field with the same contents as this EthAddress. - `toString() => string` - Serialize as a hex string. ### SerializableContractInstance **Constructor** ```typescript new SerializableContractInstance(instance: ContractInstance) ``` **Properties** - `readonly currentContractClassId: Fr` - `readonly deployer: AztecAddress` - `readonly initializationHash: Fr` - `readonly originalContractClassId: Fr` - `readonly publicKeys: PublicKeys` - `readonly salt: Fr` - `readonly version: 1` **Methods** - `static default() => SerializableContractInstance` - `static fromBuffer(bufferOrReader: Buffer | BufferReader) => SerializableContractInstance` - `static random(opts?: Partial>) => Promise` - `toBuffer() => any` - `withAddress(address: AztecAddress) => ContractInstanceWithAddress` - Returns a copy of this object with its address included. ### SerializableContractInstanceUpdate **Constructor** ```typescript new SerializableContractInstanceUpdate(instance: ContractInstanceUpdate) ``` **Properties** - `newContractClassId: Fr` - `prevContractClassId: Fr` - `timestampOfChange: bigint` **Methods** - `static default() => SerializableContractInstanceUpdate` - `static fromBuffer(bufferOrReader: Buffer | BufferReader) => SerializableContractInstanceUpdate` - `static random(opts?: Partial>) => SerializableContractInstanceUpdate` - `toBuffer() => any` ### SettledReadHint **Constructor** ```typescript new SettledReadHint(readRequestIndex: number, membershipWitness: MembershipWitness, leafPreimage: LEAF_PREIMAGE) ``` **Properties** - `leafPreimage: LEAF_PREIMAGE` - `membershipWitness: MembershipWitness` - `readRequestIndex: number` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader, treeHeight: TREE_HEIGHT, leafPreimage: {}) => SettledReadHint` - `static nada(readRequestLen: number, treeHeight: TREE_HEIGHT, emptyLeafPreimage: () => LEAF_PREIMAGE) => SettledReadHint` - `toBuffer() => any` ### Signature Contains a signature split into it's primary components (r,s,v) **Constructor** ```typescript new Signature(r: Buffer32, s: Buffer32, v: number) ``` **Properties** - `readonly empty: boolean` - `readonly r: Buffer32` - `readonly s: Buffer32` - `static schema: unknown` - `readonly v: number` **Methods** - `static empty() => Signature` - `equals(other: Signature) => boolean` - `static fromBuffer(buf: Buffer | BufferReader) => Signature` - `static fromString(sig: string) => Signature` - A seperate method exists for this as when signing locally with viem, as when parsing from viem, we can expect the v value to be a u8, rather than our default serialization of u32 - `static fromViemSignature(sig: ViemSignature) => Signature` - `static fromViemTransactionSignature(sig: ViemTransactionSignature) => Signature` - `getSize() => number` - `isEmpty() => boolean` - `static isValidString(sig: string) => boolean` - `static random() => Signature` - `toBuffer() => Buffer` - `toJSON() => string` - `toString() => string` - `toViemSignature() => ViemSignature` - Return the signature with `0x${string}` encodings for r and s - `toViemTransactionSignature() => ViemTransactionSignature` - Return the signature with `0x${string}` encodings for r and s. Verifies v is valid ### SimulationError An error during the simulation of a function call. Extends: `Error` **Constructor** ```typescript new SimulationError(originalMessage: string, functionErrorStack: FailingFunction[], revertData?: Fr[], noirErrorStack?: NoirCallStack, options?: ErrorOptions) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `revertData: Fr[]` - `static schema: unknown` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `enrichWithContractName(contractAddress: AztecAddress, contractName: string) => void` - Enriches the error with the name of a contract that failed. - `enrichWithFunctionName(contractAddress: AztecAddress, functionSelector: FunctionSelector, functionName: string) => void` - Enriches the error with the name of a function that failed. - `getCallStack() => FailingFunction[]` - The aztec function stack that failed during simulation. - `getMessage() => string` - `getNoirCallStack() => NoirCallStack` - Returns the noir call stack inside the first function that failed during simulation. - `getOriginalMessage() => string` - `getStack() => string` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` - `static random() => Promise` - `setAztecContext(context: string) => void` - `setNoirCallStack(callStack: NoirCallStack) => void` - Sets the noir call stack. - `setOriginalMessage(message: string) => void` - `toJSON() => { functionErrorStack: FailingFunction[]; noirErrorStack: NoirCallStack; ... }` ### SimulationOverrides **Constructor** ```typescript new SimulationOverrides(contracts?: ContractOverrides) ``` **Properties** - `contracts?: ContractOverrides` - `static schema: unknown` ### SlashFactoryContract **Constructor** ```typescript new SlashFactoryContract(client: ViemClient, address: string | EthAddress) ``` **Properties** - `address: unknown` - `readonly client: ViemClient` **Methods** - `buildCreatePayloadRequest(slashes: ValidatorSlash[]) => L1TxRequest` - `getAddressAndIsDeployed(slashes: ValidatorSlash[]) => Promise<{ address: EthAddress; isDeployed: boolean; salt: string }>` - `getSlashPayloadCreatedEvents() => Promise` - `getSlashPayloadFromEvents(payloadAddress: EthAddress, settings: { logsBatchSize?: number; slashingPayloadLifetimeInRounds: number; slashingRoundSize: number } & Pick) => Promise>` - Searches for a slash payload in the events emitted by the contract. This method cannot query for historical payload events, it queries for payloads that have not yet expired. - `tryExtractSlashPayloadCreatedEvent(logs: { address: string; blockHash: string; ... }[]) => { args: { amounts: readonly bigint[]; offenses: readonly readonly bigint[][]; ... }; eventName: "SlashPayloadCreated" }` - Tries to extract a SlashPayloadCreated event from the given logs. ### StateReference Stores snapshots of all the trees but archive. **Constructor** ```typescript new StateReference(l1ToL2MessageTree: AppendOnlyTreeSnapshot, partial: PartialStateReference) ``` **Properties** - `l1ToL2MessageTree: AppendOnlyTreeSnapshot` - `partial: PartialStateReference` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => StateReference` - `equals(other: this) => boolean` - `static from(fields: FieldsOf) => StateReference` - `static fromBuffer(buffer: Buffer | BufferReader) => StateReference` - `static fromFields(fields: Fr[] | FieldReader) => StateReference` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `isEmpty() => boolean` - `static random() => StateReference` - `toAbi() => []` - `toBuffer() => any` - `toFields() => Fr[]` - `toInspect() => { l1ToL2MessageTree: string; noteHashTree: string; ... }` - `validate() => void` - Validates the trees in world state have the expected number of leaves (multiple of number of insertions per tx) ### TransactionsNotAvailableError Extends: `ValidatorError` **Constructor** ```typescript new TransactionsNotAvailableError(txHashes: TxHash[]) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### TransientDataSquashingHint **Constructor** ```typescript new TransientDataSquashingHint(nullifierIndex: number, noteHashIndex: number) ``` **Properties** - `noteHashIndex: number` - `nullifierIndex: number` **Methods** - `[custom]() => string` - `static empty() => TransientDataSquashingHint` - `static fromBuffer(buffer: Buffer | BufferReader) => TransientDataSquashingHint` - `static fromFields(fields: Fr[] | FieldReader) => TransientDataSquashingHint` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` - `toString() => string` ### TreeLeafReadRequest **Constructor** ```typescript new TreeLeafReadRequest(value: Fr, leafIndex: Fr) ``` **Properties** - `leafIndex: Fr` - `value: Fr` **Methods** - `static empty() => TreeLeafReadRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => TreeLeafReadRequest` - `static fromFields(fields: Fr[] | FieldReader) => TreeLeafReadRequest` - `isEmpty() => boolean` - `toBuffer() => Buffer` - `toFields() => Fr[]` ### TreeSnapshotDiffHints Hints used while proving state diff validity for the private base rollup. **Constructor** ```typescript new TreeSnapshotDiffHints(noteHashSubtreeRootSiblingPath: [], nullifierPredecessorPreimages: [], nullifierPredecessorMembershipWitnesses: [], sortedNullifiers: [], sortedNullifierIndexes: [], nullifierSubtreeRootSiblingPath: [], feePayerBalanceMembershipWitness: MembershipWitness<40>) ``` **Properties** - `feePayerBalanceMembershipWitness: MembershipWitness<40>` - `noteHashSubtreeRootSiblingPath: []` - `nullifierPredecessorMembershipWitnesses: []` - `nullifierPredecessorPreimages: []` - `nullifierSubtreeRootSiblingPath: []` - `sortedNullifierIndexes: []` - `sortedNullifiers: []` **Methods** - `static empty() => TreeSnapshotDiffHints` - `static from(fields: FieldsOf) => TreeSnapshotDiffHints` - `static fromBuffer(buffer: Buffer | BufferReader) => TreeSnapshotDiffHints` - Deserializes the state diff hints from a buffer. - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => Buffer` - Serializes the state diff hints to a buffer. ### TreeSnapshots Stores snapshots of all the trees but archive. **Constructor** ```typescript new TreeSnapshots(l1ToL2MessageTree: AppendOnlyTreeSnapshot, noteHashTree: AppendOnlyTreeSnapshot, nullifierTree: AppendOnlyTreeSnapshot, publicDataTree: AppendOnlyTreeSnapshot) ``` **Properties** - `l1ToL2MessageTree: AppendOnlyTreeSnapshot` - `noteHashTree: AppendOnlyTreeSnapshot` - `nullifierTree: AppendOnlyTreeSnapshot` - `publicDataTree: AppendOnlyTreeSnapshot` - `static schema: unknown` **Methods** - `[custom]() => string` - `static empty() => TreeSnapshots` - `static fromBuffer(buffer: Buffer | BufferReader) => TreeSnapshots` - `static fromFields(fields: Fr[] | FieldReader) => TreeSnapshots` - `static fromPlainObject(obj: any) => TreeSnapshots` - Creates a TreeSnapshots instance from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - `toFields() => Fr[]` ### Tx The interface of an L2 transaction. Extends: `Gossipable` **Constructor** ```typescript new Tx(txHash: TxHash, data: PrivateKernelTailCircuitPublicInputs, chonkProof: ChonkProof, contractClassLogFields: ContractClassLogFields[], publicFunctionCalldata: HashedValues[]) ``` **Properties** - `readonly chonkProof: ChonkProof` - `readonly contractClassLogFields: ContractClassLogFields[]` - `readonly data: PrivateKernelTailCircuitPublicInputs` - `static p2pTopic: TopicType` - The p2p topic identifier, this determines how the message is handled - `readonly publicFunctionCalldata: HashedValues[]` - `static schema: unknown` - `readonly txHash: TxHash` **Methods** - `static clone(tx: Tx, cloneProof?: boolean) => Tx` - Clones a tx, making a deep copy of all fields. - `static computeTxHash(fields: Pick, "data">) => Promise` - `static create(fields: Omit, "txHash">) => Promise` - `static from(fields: FieldsOf) => Tx` - `static fromBuffer(buffer: Buffer | BufferReader) => Tx` - Deserializes the Tx object from a Buffer. - `generateP2PMessageIdentifier() => Promise` - `getCalldataMap() => Map` - `getContractClassLogs() => ContractClassLog[]` - `getEstimatedPrivateTxEffectsSize() => number` - Estimates the tx size based on its private effects. Note that the actual size of the tx after processing will probably be larger, as public execution would generate more data. - `getGasSettings() => GasSettings` - `getNonRevertiblePublicCallRequestsWithCalldata() => PublicCallRequestWithCalldata[]` - `getPublicCallRequestsWithCalldata() => PublicCallRequestWithCalldata[]` - `getPublicLogs(logsSource: L2LogsSource) => Promise` - Gets public logs emitted by this tx. - `getRevertiblePublicCallRequestsWithCalldata() => PublicCallRequestWithCalldata[]` - `getSize() => number` - Get the size of the gossipable object. This is used for metrics recording. - `getSplitContractClassLogs(revertible: boolean) => ContractClassLog[]` - Gets either revertible or non revertible contract class logs emitted by this tx. - `getStats() => TxStats` - Returns stats about this tx. - `getTeardownPublicCallRequestWithCalldata() => PublicCallRequestWithCalldata` - `getTotalPublicCalldataCount() => number` - `getTxHash() => TxHash` - Return transaction hash. - `hasPublicCalls() => boolean` - `numberOfPublicCalls() => number` - `p2pMessageLoggingIdentifier() => Promise` - A digest of the message information **used for logging only**. The identifier used for deduplication is `getMsgIdFn` as defined in `encoding.ts` which is a hash over topic and data. - `static random(args?: { randomProof?: boolean; txHash?: string | TxHash }) => Tx` - Creates a random tx. - `recomputeHash() => Promise` - Recomputes the tx hash. Used for testing purposes only when a property of the tx was mutated. - `toBuffer() => any` - Serializes the Tx object into a Buffer. - `toMessage() => Buffer` - `validateTxHash() => Promise` - Validates that the tx hash matches the computed hash from the tx data. This should be called when deserializing a tx from an untrusted source. ### TxArray Helper class to handle Serialization and Deserialization of Txs array. Extends: `Array` **Constructor** ```typescript new TxArray(arrayLength: number) ``` **Properties** - `static readonly [species]: ArrayConstructor` - `readonly [unscopables]: { [unscopables]?: boolean; length?: boolean }` - Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - `length: number` - Gets or sets the length of the array. This is a number one higher than the highest index in the array. **Methods** - `[iterator]() => IterableIterator` - Iterator - `at(index: number) => Tx` - Returns the item located at the specified index. - `concat(...items: ConcatArray[]) => Tx[]` - Combines two or more arrays. This method returns a new array without modifying any existing arrays. - `copyWithin(target: number, start: number, end?: number) => this` - Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - `entries() => IterableIterator<[]>` - Returns an iterable of key, value pairs for every entry in the array - `every(predicate: (value: Tx, index: number, array: Tx[]) => boolean, thisArg?: any) => boolean` - Determines whether all the members of an array satisfy the specified test. - `fill(value: Tx, start?: number, end?: number) => this` - Changes all array elements from `start` to `end` index to a static `value` and returns the modified array - `filter(predicate: (value: Tx, index: number, array: Tx[]) => boolean, thisArg?: any) => S[]` - Returns the elements of an array that meet the condition specified in a callback function. - `find(predicate: (value: Tx, index: number, obj: Tx[]) => boolean, thisArg?: any) => S` - Returns the value of the first element in the array where predicate is true, and undefined otherwise. - `findIndex(predicate: (value: Tx, index: number, obj: Tx[]) => unknown, thisArg?: any) => number` - Returns the index of the first element in the array where predicate is true, and -1 otherwise. - `flat(this: A, depth?: D) => FlatArray[]` - Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - `flatMap(callback: (this: This, value: Tx, index: number, array: Tx[]) => U | readonly U[], thisArg?: This) => U[]` - Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - `forEach(callbackfn: (value: Tx, index: number, array: Tx[]) => void, thisArg?: any) => void` - Performs the specified action for each element in an array. - `static from(arrayLike: ArrayLike) => T[]` - Creates an array from an array-like object. - `static fromBuffer(buffer: Buffer | BufferReader) => TxArray` - `includes(searchElement: Tx, fromIndex?: number) => boolean` - Determines whether an array includes a certain element, returning true or false as appropriate. - `indexOf(searchElement: Tx, fromIndex?: number) => number` - Returns the index of the first occurrence of a value in an array, or -1 if it is not present. - `static isArray(arg: any) => boolean` - `join(separator?: string) => string` - Adds all the elements of an array into a string, separated by the specified separator string. - `keys() => IterableIterator` - Returns an iterable of keys in the array - `lastIndexOf(searchElement: Tx, fromIndex?: number) => number` - Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. - `map(callbackfn: (value: Tx, index: number, array: Tx[]) => U, thisArg?: any) => U[]` - Calls a defined callback function on each element of an array, and returns an array that contains the results. - `static of(...items: T[]) => T[]` - Returns a new array from a set of elements. - `pop() => Tx` - Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. - `push(...items: Tx[]) => number` - Appends new elements to the end of an array, and returns the new length of the array. - `reduce(callbackfn: (previousValue: Tx, currentValue: Tx, currentIndex: number, array: Tx[]) => Tx) => Tx` - Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - `reduceRight(callbackfn: (previousValue: Tx, currentValue: Tx, currentIndex: number, array: Tx[]) => Tx) => Tx` - Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - `reverse() => Tx[]` - Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. - `shift() => Tx` - Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. - `slice(start?: number, end?: number) => Tx[]` - Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. - `some(predicate: (value: Tx, index: number, array: Tx[]) => unknown, thisArg?: any) => boolean` - Determines whether the specified callback function returns true for any element of an array. - `sort(compareFn?: (a: Tx, b: Tx) => number) => this` - Sorts an array in place. This method mutates the array and returns a reference to the same array. - `splice(start: number, deleteCount?: number) => Tx[]` - Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - `toBuffer() => Buffer` - `toLocaleString() => string` - Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - `toString() => string` - Returns a string representation of an array. - `unshift(...items: Tx[]) => number` - Inserts new elements at the start of an array, and returns the new length of the array. - `values() => IterableIterator` - Returns an iterable of values in the array ### TxConstantData Version of `PrivateTxConstantData` exposed by the tail circuits It compresses the protocol contracts list to a hash to minimize the number of public inputs. Refer to `PrivateTxConstantData` for more details. **Constructor** ```typescript new TxConstantData(anchorBlockHeader: BlockHeader, txContext: TxContext, vkTreeRoot: Fr, protocolContractsHash: Fr) ``` **Properties** - `anchorBlockHeader: BlockHeader` - `protocolContractsHash: Fr` - `txContext: TxContext` - `vkTreeRoot: Fr` **Methods** - `clone() => TxConstantData` - `static empty() => TxConstantData` - `static from(fields: FieldsOf) => TxConstantData` - `static fromBuffer(buffer: Buffer | BufferReader) => TxConstantData` - `static fromFields(fields: Fr[] | FieldReader) => TxConstantData` - `static getFields(fields: FieldsOf) => readonly []` - `getSize() => number` - `toBuffer() => any` - `toFields() => Fr[]` ### TxContext Transaction context. **Constructor** ```typescript new TxContext(chainId: number | bigint | Fr, version: number | bigint | Fr, gasSettings: GasSettings) ``` **Properties** - `chainId: Fr` - `gasSettings: GasSettings` - `static schema: unknown` - `version: Fr` **Methods** - `clone() => TxContext` - `static empty(chainId?: number | Fr, version?: number | Fr) => TxContext` - `static from(fields: FieldsOf) => TxContext` - Create a new instance from a fields dictionary. - `static fromBuffer(buffer: Buffer | BufferReader) => TxContext` - Deserializes TxContext from a buffer or reader. - `static fromFields(fields: Fr[] | FieldReader) => TxContext` - `static getFields(fields: FieldsOf) => readonly []` - Serialize into a field array. Low-level utility. - `getSize() => number` - `isEmpty() => boolean` - `toBuffer() => any` - Serialize as a buffer. - `toFields() => Fr[]` ### TxEffect **Constructor** ```typescript new TxEffect(revertCode: RevertCode, txHash: TxHash, transactionFee: Fr, noteHashes: Fr[], nullifiers: Fr[], l2ToL1Msgs: Fr[], publicDataWrites: PublicDataWrite[], privateLogs: PrivateLog[], publicLogs: PublicLog[], contractClassLogs: ContractClassLog[]) ``` **Properties** - `contractClassLogs: ContractClassLog[]` - `l2ToL1Msgs: Fr[]` - `noteHashes: Fr[]` - `nullifiers: Fr[]` - `privateLogs: PrivateLog[]` - `publicDataWrites: PublicDataWrite[]` - `publicLogs: PublicLog[]` - `revertCode: RevertCode` - `static schema: unknown` - `transactionFee: Fr` - `txHash: TxHash` **Methods** - `[custom]() => string` - `static empty() => TxEffect` - `equals(other: TxEffect) => boolean` - `static from(fields: FieldsOf) => TxEffect` - `static fromBlobFields(fields: Fr[]) => TxEffect` - `static fromBuffer(buffer: Buffer | BufferReader) => TxEffect` - Deserializes the TxEffect object from a Buffer. - `static fromString(str: string) => TxEffect` - Deserializes an TxEffect object from a string. - `static fromTxBlobData(txBlobData: TxBlobData) => TxEffect` - Decodes a flat packed array of fields to TxEffect. - `getNumBlobFields() => number` - `getTxStartMarker() => TxStartMarker` - `static random(__namedParameters?: { maxEffects?: number; numContractClassLogs?: number; ... }) => Promise` - `toBlobFields() => Fr[]` - `toBuffer() => Buffer` - `toString() => string` - Returns a hex representation of the TxEffect object. - `toTxBlobData() => TxBlobData` - `txOutHash() => Fr` - Computes txOutHash of this tx effect. ### TxExecutionRequest Request to execute a transaction. Similar to TxRequest, but has the full args. **Constructor** ```typescript new TxExecutionRequest(origin: AztecAddress, functionSelector: FunctionSelector, firstCallArgsHash: Fr, txContext: TxContext, argsOfCalls: HashedValues[], authWitnesses: AuthWitness[], capsules: Capsule[], salt?: Fr) ``` **Properties** - `argsOfCalls: HashedValues[]` - `authWitnesses: AuthWitness[]` - `capsules: Capsule[]` - `firstCallArgsHash: Fr` - `functionSelector: FunctionSelector` - `origin: AztecAddress` - `salt: Fr` - `static schema: unknown` - `txContext: TxContext` **Methods** - `[custom]() => string` - `static from(fields: FieldsOf) => TxExecutionRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => TxExecutionRequest` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromString(str: string) => TxExecutionRequest` - Deserializes from a string, corresponding to a write in cpp. - `static getFields(fields: FieldsOf) => readonly []` - `static random() => Promise` - `toBuffer() => any` - Serialize as a buffer. - `toString() => string` - Serialize as a string. - `toTxRequest() => TxRequest` ### TxHash A class representing hash of Aztec transaction. **Constructor** ```typescript new TxHash(hash: Fr) ``` **Properties** - `readonly hash: Fr` - `static schema: unknown` - `static SIZE: unknown` **Methods** - `equals(other: TxHash) => boolean` - `static fromBigInt(value: bigint) => TxHash` - `static fromBuffer(buffer: Uint8Array | BufferReader) => TxHash` - `static fromField(value: Fr) => TxHash` - `static fromString(str: string) => TxHash` - `static random() => TxHash` - `toBigInt() => bigint` - `toBuffer() => any` - `toJSON() => string` - `toString() => string` - `static zero() => TxHash` ### TxHashArray Helper class to handle Serialization and Deserialization of TxHashes array. Extends: `Array` **Constructor** ```typescript new TxHashArray(arrayLength: number) ``` **Properties** - `static readonly [species]: ArrayConstructor` - `readonly [unscopables]: { [unscopables]?: boolean; length?: boolean }` - Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. - `length: number` - Gets or sets the length of the array. This is a number one higher than the highest index in the array. **Methods** - `[iterator]() => IterableIterator` - Iterator - `at(index: number) => TxHash` - Returns the item located at the specified index. - `concat(...items: ConcatArray[]) => TxHash[]` - Combines two or more arrays. This method returns a new array without modifying any existing arrays. - `copyWithin(target: number, start: number, end?: number) => this` - Returns the this object after copying a section of the array identified by start and end to the same array starting at position target - `entries() => IterableIterator<[]>` - Returns an iterable of key, value pairs for every entry in the array - `every(predicate: (value: TxHash, index: number, array: TxHash[]) => boolean, thisArg?: any) => boolean` - Determines whether all the members of an array satisfy the specified test. - `fill(value: TxHash, start?: number, end?: number) => this` - Changes all array elements from `start` to `end` index to a static `value` and returns the modified array - `filter(predicate: (value: TxHash, index: number, array: TxHash[]) => boolean, thisArg?: any) => S[]` - Returns the elements of an array that meet the condition specified in a callback function. - `find(predicate: (value: TxHash, index: number, obj: TxHash[]) => boolean, thisArg?: any) => S` - Returns the value of the first element in the array where predicate is true, and undefined otherwise. - `findIndex(predicate: (value: TxHash, index: number, obj: TxHash[]) => unknown, thisArg?: any) => number` - Returns the index of the first element in the array where predicate is true, and -1 otherwise. - `flat(this: A, depth?: D) => FlatArray[]` - Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. - `flatMap(callback: (this: This, value: TxHash, index: number, array: TxHash[]) => U | readonly U[], thisArg?: This) => U[]` - Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. - `forEach(callbackfn: (value: TxHash, index: number, array: TxHash[]) => void, thisArg?: any) => void` - Performs the specified action for each element in an array. - `static from(arrayLike: ArrayLike) => T[]` - Creates an array from an array-like object. - `static fromBuffer(buffer: Buffer | BufferReader) => TxHashArray` - `includes(searchElement: TxHash, fromIndex?: number) => boolean` - Determines whether an array includes a certain element, returning true or false as appropriate. - `indexOf(searchElement: TxHash, fromIndex?: number) => number` - Returns the index of the first occurrence of a value in an array, or -1 if it is not present. - `static isArray(arg: any) => boolean` - `join(separator?: string) => string` - Adds all the elements of an array into a string, separated by the specified separator string. - `keys() => IterableIterator` - Returns an iterable of keys in the array - `lastIndexOf(searchElement: TxHash, fromIndex?: number) => number` - Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. - `map(callbackfn: (value: TxHash, index: number, array: TxHash[]) => U, thisArg?: any) => U[]` - Calls a defined callback function on each element of an array, and returns an array that contains the results. - `static of(...items: T[]) => T[]` - Returns a new array from a set of elements. - `pop() => TxHash` - Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. - `push(...items: TxHash[]) => number` - Appends new elements to the end of an array, and returns the new length of the array. - `reduce(callbackfn: (previousValue: TxHash, currentValue: TxHash, currentIndex: number, array: TxHash[]) => TxHash) => TxHash` - Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - `reduceRight(callbackfn: (previousValue: TxHash, currentValue: TxHash, currentIndex: number, array: TxHash[]) => TxHash) => TxHash` - Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. - `reverse() => TxHash[]` - Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. - `shift() => TxHash` - Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. - `slice(start?: number, end?: number) => TxHash[]` - Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. - `some(predicate: (value: TxHash, index: number, array: TxHash[]) => unknown, thisArg?: any) => boolean` - Determines whether the specified callback function returns true for any element of an array. - `sort(compareFn?: (a: TxHash, b: TxHash) => number) => this` - Sorts an array in place. This method mutates the array and returns a reference to the same array. - `splice(start: number, deleteCount?: number) => TxHash[]` - Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. - `toBuffer() => Buffer` - `toLocaleString() => string` - Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. - `toString() => string` - Returns a string representation of an array. - `unshift(...items: TxHash[]) => number` - Inserts new elements at the start of an array, and returns the new length of the array. - `values() => IterableIterator` - Returns an iterable of values in the array ### TxMergeRollupPrivateInputs Represents inputs of the merge rollup circuit. **Constructor** ```typescript new TxMergeRollupPrivateInputs(previousRollups: []) ``` **Properties** - `previousRollups: []` - `static schema: unknown` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => TxMergeRollupPrivateInputs` - Deserializes the inputs from a buffer. - `static fromString(str: string) => TxMergeRollupPrivateInputs` - Deserializes the inputs from a hex string. - `toBuffer() => any` - Serializes the inputs to a buffer. - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` - Serializes the inputs to a hex string. ### TxProfileResult **Constructor** ```typescript new TxProfileResult(executionSteps: PrivateExecutionStep[], stats: ProvingStats) ``` **Properties** - `executionSteps: PrivateExecutionStep[]` - `static schema: unknown` - `stats: ProvingStats` **Methods** - `static random() => TxProfileResult` ### TxProvingResult **Constructor** ```typescript new TxProvingResult(privateExecutionResult: PrivateExecutionResult, publicInputs: PrivateKernelTailCircuitPublicInputs, chonkProof: ChonkProof, stats?: ProvingStats) ``` **Properties** - `chonkProof: ChonkProof` - `privateExecutionResult: PrivateExecutionResult` - `publicInputs: PrivateKernelTailCircuitPublicInputs` - `static schema: unknown` - `stats?: ProvingStats` **Methods** - `static from(fields: FieldsOf) => TxProvingResult` - `getOffchainEffects() => OffchainEffect[]` - `static random() => Promise` - `toTx() => Promise` ### TxReceipt Represents a transaction receipt in the Aztec network. Contains essential information about the transaction including its status, origin, and associated addresses. REFACTOR: TxReceipt should be returned only once the tx is mined, and all its fields should be required. We should not be using a TxReceipt to answer a query for a pending or dropped tx. **Constructor** ```typescript new TxReceipt(txHash: TxHash, status: TxStatus, error: string, transactionFee?: bigint, blockHash?: L2BlockHash, blockNumber?: BlockNumber) ``` **Properties** - `blockHash?: L2BlockHash` - `blockNumber?: BlockNumber` - `error: string` - `static schema: unknown` - `status: TxStatus` - `transactionFee?: bigint` - `txHash: TxHash` **Methods** - `static empty() => TxReceipt` - `static from(fields: FieldsOf) => TxReceipt` - `static statusFromRevertCode(revertCode: RevertCode) => SUCCESS | APP_LOGIC_REVERTED | TEARDOWN_REVERTED | BOTH_REVERTED` ### TxRequest Transaction request. **Constructor** ```typescript new TxRequest(origin: AztecAddress, argsHash: Fr, txContext: TxContext, functionData: FunctionData, salt: Fr) ``` **Properties** - `argsHash: Fr` - `functionData: FunctionData` - `origin: AztecAddress` - `salt: Fr` - `txContext: TxContext` **Methods** - `static empty() => TxRequest` - `static from(fields: FieldsOf) => TxRequest` - `static fromBuffer(buffer: Buffer | BufferReader) => TxRequest` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static getFields(fields: FieldsOf) => readonly []` - `hash() => Promise` - `isEmpty() => boolean` - `toBuffer() => any` - Serialize as a buffer. - `toFields() => Fr[]` ### TxRollupPublicInputs Output of the base and merge rollup circuits. **Constructor** ```typescript new TxRollupPublicInputs(numTxs: number, constants: BlockConstantData, startTreeSnapshots: PartialStateReference, endTreeSnapshots: PartialStateReference, startSpongeBlob: SpongeBlob, endSpongeBlob: SpongeBlob, outHash: Fr, accumulatedFees: Fr, accumulatedManaUsed: Fr) ``` **Properties** - `accumulatedFees: Fr` - `accumulatedManaUsed: Fr` - `constants: BlockConstantData` - `endSpongeBlob: SpongeBlob` - `endTreeSnapshots: PartialStateReference` - `numTxs: number` - `outHash: Fr` - `static schema: unknown` - `startSpongeBlob: SpongeBlob` - `startTreeSnapshots: PartialStateReference` **Methods** - `static empty() => TxRollupPublicInputs` - Returns an empty instance. - `static fromBuffer(buffer: Buffer | BufferReader) => TxRollupPublicInputs` - Deserializes from a buffer or reader. Note: Corresponds to a write in cpp. - `static fromString(str: string) => TxRollupPublicInputs` - Deserializes from a hex string. - `toBuffer() => any` - Serialize this as a buffer. - `toJSON() => any` - Returns a buffer representation for JSON serialization. - `toString() => string` - Serialize this as a hex string. ### TxScopedL2Log **Constructor** ```typescript new TxScopedL2Log(txHash: TxHash, dataStartIndexForTx: number, logIndexInTx: number, blockNumber: BlockNumber, log: PrivateLog | PublicLog) ``` **Properties** - `blockNumber: BlockNumber` - `dataStartIndexForTx: number` - `isFromPublic: unknown` - `log: PrivateLog | PublicLog` - `logIndexInTx: number` - `static schema: unknown` - `txHash: TxHash` **Methods** - `equals(other: TxScopedL2Log) => boolean` - `static fromBuffer(buffer: Buffer) => TxScopedL2Log` - `static random(isFromPublic?: boolean) => Promise` - `toBuffer() => any` ### TxSimulationResult **Constructor** ```typescript new TxSimulationResult(privateExecutionResult: PrivateExecutionResult, publicInputs: PrivateKernelTailCircuitPublicInputs, publicOutput?: PublicSimulationOutput, stats?: SimulationStats) ``` **Properties** - `gasUsed: unknown` - `privateExecutionResult: PrivateExecutionResult` - `publicInputs: PrivateKernelTailCircuitPublicInputs` - `publicOutput?: PublicSimulationOutput` - `static schema: unknown` - `stats?: SimulationStats` **Methods** - `static from(fields: Omit, "gasUsed">) => TxSimulationResult` - `static fromPrivateSimulationResultAndPublicOutput(privateSimulationResult: PrivateSimulationResult, publicOutput?: PublicSimulationOutput, stats?: SimulationStats) => TxSimulationResult` - `getPrivateReturnValues() => NestedProcessReturnValues` - `getPublicReturnValues() => NestedProcessReturnValues[]` - `static random() => Promise` - `toSimulatedTx() => Promise` ### UpdateChecker Extends: `EventEmitter` **Constructor** ```typescript new UpdateChecker(updatesUrl: URL, nodeVersion: string, rollupVersion: bigint, fetch: (input: URL | RequestInfo, init?: RequestInit) => Promise, getLatestRollupVersion: () => Promise, checkIntervalMs?: number, log?: Logger) ``` **Methods** - `[captureRejectionSymbol](error: Error, event: string | symbol, ...args: any[]) => void` - The `Symbol.for('nodejs.rejection')` method is called in case a promise rejection happens when emitting an event and `captureRejections` is enabled on the emitter. It is possible to use `events.captureRejectionSymbol` in place of `Symbol.for('nodejs.rejection')`. ```js import { EventEmitter, captureRejectionSymbol } from 'node:events'; class MyClass extends EventEmitter { constructor() { super({ captureRejections: true }); } [captureRejectionSymbol](err, event, ...args) { console.log('rejection happened for', event, 'with', err, ...args); this.destroy(err); } destroy(err) { // Tear the resource down here. } } ``` - `addListener(eventName: E | keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig", listener: (...args: unknown) => void) => this` - Alias for `emitter.on(eventName, listener)`. - `emit(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, ...args: unknown) => boolean` - Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments to each. Returns `true` if the event had listeners, `false` otherwise. ```js import { EventEmitter } from 'node:events'; const myEmitter = new EventEmitter(); // First listener myEmitter.on('event', function firstListener() { console.log('Helloooo! first listener'); }); // Second listener myEmitter.on('event', function secondListener(arg1, arg2) { console.log(`event with parameters ${arg1}, ${arg2} in second listener`); }); // Third listener myEmitter.on('event', function thirdListener(...args) { const parameters = args.join(', '); console.log(`event with parameters ${parameters} in third listener`); }); console.log(myEmitter.listeners('event')); myEmitter.emit('event', 1, 2, 3, 4, 5); // Prints: // [ // [Function: firstListener], // [Function: secondListener], // [Function: thirdListener] // ] // Helloooo! first listener // event with parameters 1, 2 in second listener // event with parameters 1, 2, 3, 4, 5 in third listener ``` - `eventNames() => string | symbol[]` - Returns an array listing the events for which the emitter has registered listeners. ```js import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => {}); myEE.on('bar', () => {}); const sym = Symbol('symbol'); myEE.on(sym, () => {}); console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ] ``` - `getMaxListeners() => number` - Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to `events.defaultMaxListeners`. - `listenerCount(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener?: (...args: unknown) => void) => number` - Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event. - `listeners(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E) => (...args: unknown) => void[]` - Returns a copy of the array of listeners for the event named `eventName`. ```js server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ] ``` - `static new(config: Config) => Promise` - `off(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Alias for `emitter.removeListener()`. - `on(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName` and `listener` will result in the `listener` being added, and called, multiple times. ```js server.on('connection', (stream) => { console.log('someone connected!'); }); ``` Returns a reference to the `EventEmitter`, so that calls can be chained. By default, event listeners are invoked in the order they are added. The `emitter.prependListener()` method can be used as an alternative to add the event listener to the beginning of the listeners array. ```js import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => console.log('a')); myEE.prependListener('foo', () => console.log('b')); myEE.emit('foo'); // Prints: // b // a ``` - `once(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. ```js server.once('connection', (stream) => { console.log('Ah, we have our first user!'); }); ``` Returns a reference to the `EventEmitter`, so that calls can be chained. By default, event listeners are invoked in the order they are added. The `emitter.prependOnceListener()` method can be used as an alternative to add the event listener to the beginning of the listeners array. ```js import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.once('foo', () => console.log('a')); myEE.prependOnceListener('foo', () => console.log('b')); myEE.emit('foo'); // Prints: // b // a ``` - `prependListener(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has already been added. Multiple calls passing the same combination of `eventName` and `listener` will result in the `listener` being added, and called, multiple times. ```js server.prependListener('connection', (stream) => { console.log('someone connected!'); }); ``` Returns a reference to the `EventEmitter`, so that calls can be chained. - `prependOnceListener(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Adds a **one-time** `listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this listener is removed, and then invoked. ```js server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); }); ``` Returns a reference to the `EventEmitter`, so that calls can be chained. - `rawListeners(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E) => (...args: unknown) => void[]` - Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). ```js import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.once('log', () => console.log('log once')); // Returns a new Array with a function `onceWrapper` which has a property // `listener` which contains the original listener bound above const listeners = emitter.rawListeners('log'); const logFnWrapper = listeners[0]; // Logs "log once" to the console and does not unbind the `once` event logFnWrapper.listener(); // Logs "log once" to the console and removes the listener logFnWrapper(); emitter.on('log', () => console.log('log persistently')); // Will return a new Array with a single function bound by `.on()` above const newListeners = emitter.rawListeners('log'); // Logs "log persistently" twice newListeners[0](); emitter.emit('log'); ``` - `removeAllListeners(eventName?: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E) => this` - Removes all listeners, or those of the specified `eventName`. It is bad practice to remove listeners added elsewhere in the code, particularly when the `EventEmitter` instance was created by some other component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter`, so that calls can be chained. - `removeListener(eventName: keyof EventEmitterEventMap | "newRollupVersion" | "newNodeVersion" | "updateNodeConfig" | "updatePublicTelemetryConfig" | E, listener: (...args: unknown) => void) => this` - Removes the specified `listener` from the listener array for the event named `eventName`. ```js const callback = (stream) => { console.log('someone connected!'); }; server.on('connection', callback); // ... server.removeListener('connection', callback); ``` `removeListener()` will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified `eventName`, then `removeListener()` must be called multiple times to remove each instance. Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any `removeListener()` or `removeAllListeners()` calls _after_ emitting and _before_ the last listener finishes execution will not remove them from `emit()` in progress. Subsequent events behave as expected. ```js import { EventEmitter } from 'node:events'; class MyEmitter extends EventEmitter {} const myEmitter = new MyEmitter(); const callbackA = () => { console.log('A'); myEmitter.removeListener('event', callbackB); }; const callbackB = () => { console.log('B'); }; myEmitter.on('event', callbackA); myEmitter.on('event', callbackB); // callbackA removes listener callbackB but it will still be called. // Internal listener array at time of emit [callbackA, callbackB] myEmitter.emit('event'); // Prints: // A // B // callbackB is now removed. // Internal listener array [callbackA] myEmitter.emit('event'); // Prints: // A ``` Because listeners are managed using an internal array, calling this will change the position indexes of any listener registered _after_ the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the `emitter.listeners()` method will need to be recreated. When a single function has been added as a handler multiple times for a single event (as in the example below), `removeListener()` will remove the most recently added instance. In the example the `once('ping')` listener is removed: ```js import { EventEmitter } from 'node:events'; const ee = new EventEmitter(); function pong() { console.log('pong'); } ee.on('ping', pong); ee.once('ping', pong); ee.removeListener('ping', pong); ee.emit('ping'); ee.emit('ping'); ``` Returns a reference to the `EventEmitter`, so that calls can be chained. - `setMaxListeners(n: number) => this` - By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding memory leaks. The `emitter.setMaxListeners()` method allows the limit to be modified for this specific `EventEmitter` instance. The value can be set to `Infinity` (or `0`) to indicate an unlimited number of listeners. Returns a reference to the `EventEmitter`, so that calls can be chained. - `start() => void` - `stop() => Promise` - `trigger() => Promise` ### UpdatedClassIdHints **Constructor** ```typescript new UpdatedClassIdHints(updatedClassIdWitness: MembershipWitness<40>, updatedClassIdLeaf: PublicDataTreeLeafPreimage, updatedClassIdValues: DelayedPublicMutableValues) ``` **Properties** - `updatedClassIdLeaf: PublicDataTreeLeafPreimage` - `updatedClassIdValues: DelayedPublicMutableValues` - `updatedClassIdWitness: MembershipWitness<40>` **Methods** - `static from(fields: FieldsOf) => UpdatedClassIdHints` - `static fromBuffer(buffer: Buffer | BufferReader) => UpdatedClassIdHints` - Deserializes from a buffer or reader. - `static getFields(fields: FieldsOf) => readonly []` - `toBuffer() => Buffer` - Serialize this as a buffer. ### UtilitySimulationResult **Constructor** ```typescript new UtilitySimulationResult(result: Fr[], stats?: SimulationStats) ``` **Properties** - `result: Fr[]` - `static schema: unknown` - `stats?: SimulationStats` **Methods** - `static random() => UtilitySimulationResult` ### ValidatorError Extends: `Error` **Constructor** ```typescript new ValidatorError(message: string) ``` **Properties** - `cause?: unknown` - `message: string` - `name: string` - `stack?: string` - `static stackTraceLimit: number` - The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. **Methods** - `static captureStackTrace(targetObject: object, constructorOpt?: Function) => void` - Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. ```js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` ``` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: ```js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a(); ``` - `static prepareStackTrace(err: Error, stackTraces: CallSite[]) => any` ### Vector Implementation of a vector. Matches how we are serializing and deserializing vectors in cpp (length in the first position, followed by the items). **Constructor** ```typescript new Vector(items: T[]) ``` **Properties** - `items: T[]` **Methods** - `toBuffer() => any` - `toFriendlyJSON() => T[]` ### VerificationKey **Constructor** ```typescript new VerificationKey(circuitType: CircuitType, circuitSize: number, numPublicInputs: number, commitments: Record, containsRecursiveProof: boolean, recursiveProofPublicInputIndices: number[]) ``` **Properties** - `circuitSize: number` - `circuitType: CircuitType` - `commitments: Record` - `containsRecursiveProof: boolean` - `numPublicInputs: number` - `recursiveProofPublicInputIndices: number[]` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => VerificationKey` - Deserializes class from a buffer. - `static makeFake() => VerificationKey` - Builds a fake verification key that should be accepted by circuits. - `static makeFakeMegaHonk() => Buffer` - Builds a fake MegaHonk verification key buffer for testing. Uses a real VK from a compiled contract to ensure proper format. - `static makeRollupFake() => VerificationKey` - Builds a fake Rollup Honk verification key that should be accepted by circuits. - `toBuffer() => any` - Serialize as a buffer. ### VerificationKeyAsFields Provides a 'fields' representation of a circuit's verification key **Constructor** ```typescript new VerificationKeyAsFields(key: Fr[], hash: Fr) ``` **Properties** - `circuitSize: unknown` - `hash: Fr` - `key: Fr[]` - `numPublicInputs: unknown` - `static schema: unknown` **Methods** - `static fromBuffer(buffer: Buffer | BufferReader) => VerificationKeyAsFields` - Deserializes from a buffer or reader, corresponding to a write in cpp. - `static fromFrBuffer(vkBytes: Buffer) => Promise` - `static fromKey(key: Fr[]) => Promise` - `static makeEmpty(size: number) => VerificationKeyAsFields` - Builds an 'empty' verification key - `static makeFake(size: number, seed?: number) => VerificationKeyAsFields` - Builds a fake verification key that should be accepted by circuits. - `static makeFakeHonk(seed?: number) => VerificationKeyAsFields` - `static makeFakeRollupHonk(seed?: number) => VerificationKeyAsFields` - `toBuffer() => any` - Serialize as a buffer. - `toFields() => number | Fr[]` - `toJSON() => any` ### VerificationKeyData **Constructor** ```typescript new VerificationKeyData(keyAsFields: VerificationKeyAsFields, keyAsBytes: Buffer) ``` **Properties** - `circuitSize: unknown` - `readonly keyAsBytes: Buffer` - `readonly keyAsFields: VerificationKeyAsFields` - `numPublicInputs: unknown` - `static schema: unknown` **Methods** - `clone() => VerificationKeyData` - `static empty() => VerificationKeyData` - `static fromBuffer(buffer: Buffer | BufferReader) => VerificationKeyData` - `static fromFrBuffer(vkBytes: Buffer) => Promise` - `static fromString(str: string) => VerificationKeyData` - `static makeFake(len?: number) => VerificationKeyData` - `static makeFakeHonk() => VerificationKeyData` - `static makeFakeRollupHonk() => VerificationKeyData` - `toBuffer() => any` - Serialize as a buffer. - `toJSON() => any` - Returns a hex representation for JSON serialization. - `toString() => string` ### VkData **Constructor** ```typescript new VkData(vk: VerificationKeyData, leafIndex: number, siblingPath: []) ``` **Properties** - `leafIndex: number` - `siblingPath: []` - `vk: VerificationKeyData` **Methods** - `static empty() => VkData` - `static fromBuffer(buffer: Buffer | BufferReader) => VkData` - `toBuffer() => any` - `toString() => string` ### WorldStateRevision **Constructor** ```typescript new WorldStateRevision(forkId: number, blockNumber: number, includeUncommitted: boolean) ``` **Properties** - `readonly blockNumber: number` - `readonly forkId: number` - `readonly includeUncommitted: boolean` - `static schema: unknown` **Methods** - `static empty() => WorldStateRevision` - `toString() => string` ### WorldStateRevisionWithHandle Extends: `WorldStateRevision` **Constructor** ```typescript new WorldStateRevisionWithHandle(forkId: number, blockNumber: number, includeUncommitted: boolean, handle: any) ``` **Properties** - `readonly blockNumber: number` - `readonly forkId: number` - `readonly handle: any` - `readonly includeUncommitted: boolean` - `static schema: unknown` **Methods** - `static empty() => WorldStateRevision` - `static fromWorldStateRevision(revision: WorldStateRevision, handle: any) => WorldStateRevisionWithHandle` - `toString() => string` - `toWorldStateRevision() => WorldStateRevision` ### ZkPassportProofParams **Constructor** ```typescript new ZkPassportProofParams(devMode: boolean, vkeyHash: Buffer32, proof: Buffer, publicInputs: Fr[], committedInputs: Buffer, validityPeriodInSeconds: bigint, domain: string, scope: string) ``` **Properties** - `committedInputs: Buffer` - `devMode: boolean` - `domain: string` - `proof: Buffer` - `publicInputs: Fr[]` - `scope: string` - `validityPeriodInSeconds: bigint` - `vkeyHash: Buffer32` **Methods** - `static fromBuffer(buffer: Buffer) => ZkPassportProofParams` - `static fromViem(params: ViemZkPassportProofParams) => ZkPassportProofParams` - `static random() => ZkPassportProofParams` - `toBuffer() => any` - `toViem() => ViemZkPassportProofParams` ## Interfaces ### ArrayType An array type. Extends: `BasicType<"array">` **Properties** - `kind: "array"` - The kind of the type. - `length: number` - The length of the array. - `type: AbiType` - The type of the array elements. ### AztecNode The aztec node. We will probably implement the additional interfaces by means other than Aztec Node as it's currently a privacy leak Extends: `Pick` **Methods** - `findLeavesIndexes(blockNumber: BlockNumber | "latest", treeId: MerkleTreeId, leafValues: Fr[]) => Promise[]>` - Find the indexes of the given leaves in the given tree along with a block metadata pointing to the block in which the leaves were inserted. - `getAllowedPublicSetup() => Promise` - Returns the list of allowed public setup elements configured for this node. - `getArchiveMembershipWitness(blockNumber: BlockNumber | "latest", archive: Fr) => Promise>` - Returns a membership witness for a given archive leaf at a given block. - `getArchiveSiblingPath(blockNumber: BlockNumber | "latest", leafIndex: bigint) => Promise>` - Returns a sibling path for a leaf in the committed historic blocks tree. - `getBlock(number: BlockNumber | "latest") => Promise` - Get a block specified by its number. - `getBlockByArchive(archive: Fr) => Promise` - Get a block specified by its archive root. - `getBlockByHash(blockHash: Fr) => Promise` - Get a block specified by its hash. - `getBlockHeader(blockNumber?: BlockNumber | "latest") => Promise` - Returns the currently committed block header. - `getBlockHeaderByArchive(archive: Fr) => Promise` - Get a block header specified by its archive root. - `getBlockHeaderByHash(blockHash: Fr) => Promise` - Get a block header specified by its hash. - `getBlockNumber() => Promise` - Method to fetch the latest block number synchronized by the node. - `getBlocks(from: BlockNumber, limit: number) => Promise` - Method to request blocks. Will attempt to return all requested blocks but will return only those available. - `getChainId() => Promise` - Method to fetch the chain id of the base-layer for the rollup. - `getContract(address: AztecAddress) => Promise` - Returns a publicly deployed contract instance given its address. - `getContractClass(id: Fr) => Promise` - Returns a registered contract class given its id. - `getContractClassLogs(filter: LogFilter) => Promise` - Gets contract class logs based on the provided filter. - `getCurrentBaseFees() => Promise` - Method to fetch the current base fees. - `getEncodedEnr() => Promise` - Returns the ENR of this node for peer discovery, if available. - `getL1ContractAddresses() => Promise` - Method to fetch the currently deployed l1 contract addresses. - `getL1ToL2MessageBlock(l1ToL2Message: Fr) => Promise` - Returns the L2 block number in which this L1 to L2 message becomes available, or undefined if not found. - `getL1ToL2MessageMembershipWitness(blockNumber: BlockNumber | "latest", l1ToL2Message: Fr) => Promise<[]>` - Returns the index and a sibling path for a leaf in the committed l1 to l2 data tree. - `getL2Tips() => Promise` - Returns the tips of the L2 chain. - `getL2ToL1Messages(blockNumber: BlockNumber | "latest") => Promise` - Returns all the L2 to L1 messages in a block. - `getLogsByTags(tags: Fr[], logsPerTag?: number) => Promise` - Gets all logs that match any of the received tags (i.e. logs with their first field equal to a tag). - `getLowNullifierMembershipWitness(blockNumber: BlockNumber | "latest", nullifier: Fr) => Promise` - Returns a low nullifier membership witness for a given nullifier at a given block. - `getMaxPriorityFees() => Promise` - Method to fetch the current max priority fee of txs in the mempool. - `getNodeInfo() => Promise` - Returns the information about the server's node. Includes current Node version, compatible Noir version, L1 chain identifier, protocol version, and L1 address of the rollup contract. - `getNodeVersion() => Promise` - Method to fetch the version of the package. - `getNoteHashMembershipWitness(blockNumber: BlockNumber | "latest", noteHash: Fr) => Promise>` - Returns a membership witness for a given note hash at a given block. - `getNoteHashSiblingPath(blockNumber: BlockNumber | "latest", leafIndex: bigint) => Promise>` - Returns a sibling path for the given index in the note hash tree. - `getNullifierMembershipWitness(blockNumber: BlockNumber | "latest", nullifier: Fr) => Promise` - Returns a nullifier membership witness for a given nullifier at a given block. - `getNullifierSiblingPath(blockNumber: BlockNumber | "latest", leafIndex: bigint) => Promise>` - Returns a sibling path for the given index in the nullifier tree. - `getPendingTxCount() => Promise` - Retrieves the number of pending txs - `getPendingTxs(limit?: number, after?: TxHash) => Promise` - Method to retrieve pending txs. - `getProtocolContractAddresses() => Promise` - Method to fetch the protocol contract addresses. - `getProvenBlockNumber() => Promise` - Fetches the latest proven block number. - `getPublicDataSiblingPath(blockNumber: BlockNumber | "latest", leafIndex: bigint) => Promise>` - Returns a sibling path for a leaf in the committed public data tree. - `getPublicDataWitness(blockNumber: BlockNumber | "latest", leafSlot: Fr) => Promise` - Returns a public data tree witness for a given leaf slot at a given block. - `getPublicLogs(filter: LogFilter) => Promise` - Gets public logs based on the provided filter. - `getPublicStorageAt(blockNumber: BlockNumber | "latest", contract: AztecAddress, slot: Fr) => Promise` - Gets the storage value at the given contract storage slot. - `getPublishedBlocks(from: BlockNumber, limit: number, proven?: boolean) => Promise` - Equivalent to getBlocks but includes publish data. - `getTxByHash(txHash: TxHash) => Promise` - Method to retrieve a single pending tx. - `getTxEffect(txHash: TxHash) => Promise` - Gets a tx effect. - `getTxReceipt(txHash: TxHash) => Promise` - Fetches a transaction receipt for a given transaction hash. Returns a mined receipt if it was added to the chain, a pending receipt if it's still in the mempool of the connected Aztec node, or a dropped receipt if not found in the connected Aztec node. - `getTxsByHash(txHashes: TxHash[]) => Promise` - Method to retrieve multiple pending txs. - `getValidatorsStats() => Promise` - Returns stats for validators if enabled. - `getValidatorStats(validatorAddress: EthAddress, fromSlot?: SlotNumber, toSlot?: SlotNumber) => Promise` - Returns stats for a single validator if enabled. - `getVersion() => Promise` - Method to fetch the version of the rollup the node is connected to. - `getWorldStateSyncStatus() => Promise` - Returns the sync status of the node's world state - `isL1ToL2MessageSynced(l1ToL2Message: Fr) => Promise` - Returns whether an L1 to L2 message is synced by archiver. - `isReady() => Promise` - Method to determine if the node is ready to accept transactions. - `isValidTx(tx: Tx, options?: { isSimulation?: boolean; skipFeeEnforcement?: boolean }) => Promise` - Returns true if the transaction is valid for inclusion at the current state. Valid transactions can be made invalid by *other* transactions if e.g. they emit the same nullifiers, or come become invalid due to e.g. the include_by_timestamp property. - `registerContractFunctionSignatures(functionSignatures: string[]) => Promise` - Registers contract function signatures for debugging purposes. - `sendTx(tx: Tx) => Promise` - Method to submit a transaction to the p2p pool. - `simulatePublicCalls(tx: Tx, skipFeeEnforcement?: boolean) => Promise` - Simulates the public part of a transaction with the current state. This currently just checks that the transaction execution succeeds. ### AztecNodeAdmin Aztec node admin API. **Methods** - `getConfig() => Promise` - Retrieves the configuration of this node. - `getSlashOffenses(round: bigint | "all" | "current") => Promise` - Returns all offenses applicable for the given round. - `getSlashPayloads() => Promise` - Returns all monitored payloads by the slasher for the current round. - `pauseSync() => Promise` - Pauses archiver and world state syncing. - `resumeSync() => Promise` - Resumes archiver and world state syncing. - `rollbackTo(targetBlockNumber: number, force?: boolean) => Promise` - Pauses syncing and rolls back the database to the target L2 block number. - `setConfig(config: Partial) => Promise` - Updates the configuration of this node. - `startSnapshotUpload(location: string) => Promise` - Pauses syncing, creates a backup of archiver and world-state databases, and uploads them. Returns immediately. ### BasicType A basic type. **Properties** - `kind: T` - The kind of the type. ### BasicValue A basic value. **Properties** - `kind: T` - The kind of the value. - `value: V` ### BatchInsertionResult The result of a batch insertion in an indexed merkle tree. **Properties** - `lowLeavesWitnessData?: LeafUpdateWitnessData[]` - Data for the leaves to be updated when inserting the new ones. - `newSubtreeSiblingPath: SiblingPath` - Sibling path "pointing to" where the new subtree should be inserted into the tree. - `sortedNewLeaves: Buffer[]` - The new leaves being inserted in high to low order. This order corresponds with the order of the low leaves witness. - `sortedNewLeavesIndexes: number[]` - The indexes of the sorted new leaves to the original ones. ### BuildBlockResult **Properties** - `block: L2Block` - `blockBuildingTimer: Timer` - `failedTxs: FailedTx[]` - `numMsgs: number` - `numTxs: number` - `publicGas: Gas` - `publicProcessorDuration: number` - `usedTxs: Tx[]` ### ClientProtocolCircuitVerifier A verifier used by nodes to check tx proofs are valid. **Methods** - `stop() => Promise` - Stop the verifier. - `verifyProof(tx: Tx) => Promise` - Verifies the private protocol circuit's proof. ### ContractArtifact Defines artifact of a contract. **Properties** - `fileMap: DebugFileMap` - The map of file ID to the source code and path of the file. - `functions: FunctionArtifact[]` - The functions of the contract. Includes private and utility functions, plus the public dispatch function. - `name: string` - The name of the contract. - `nonDispatchPublicFunctions: FunctionAbi[]` - The public functions of the contract, excluding dispatch. - `outputs: { globals: Record; structs: Record }` - The outputs of the contract. - `storageLayout: Record` - Storage layout ### ContractClass A Contract Class in the protocol. Aztec differentiates contracts classes and instances, where a contract class represents the code of the contract, but holds no state. Classes are identified by an id that is a commitment to all its data. **Properties** - `artifactHash: Fr` - Hash of the contract artifact. The specification of this hash is not enforced by the protocol. Should include commitments to code of utility functions and compilation metadata. Intended to be used by clients to verify that an offchain fetched artifact matches a registered class. - `packedBytecode: Buffer` - Bytecode for the public_dispatch function, or empty. - `privateFunctions: PrivateFunction[]` - List of individual private functions, constructors included. - `version: 1` - Version of the contract class. ### ContractClassMetadata **Properties** - `artifact?: ContractArtifact` - `contractClass?: ContractClassWithId` - `isContractClassPubliclyRegistered: boolean` ### ContractDataSource **Methods** - `getBlockNumber() => Promise` - Gets the number of the latest L2 block processed by the implementation. - `getBytecodeCommitment(id: Fr) => Promise` - `getContract(address: AztecAddress, timestamp?: bigint) => Promise` - Returns a publicly deployed contract instance given its address. - `getContractClass(id: Fr) => Promise` - Returns the contract class for a given contract class id, or undefined if not found. - `getContractClassIds() => Promise` - Returns the list of all class ids known. - `getDebugFunctionName(address: AztecAddress, selector: FunctionSelector) => Promise` - Returns a function's name. It's only available if provided by calling `registerContractFunctionSignatures`. - `registerContractFunctionSignatures(signatures: string[]) => Promise` - Registers a function names. Useful for debugging. ### ContractFunctionDao A contract function Data Access Object (DAO). Extends the FunctionArtifact interface, adding a 'selector' property. The 'selector' is a unique identifier for the function within the contract. Extends: `FunctionArtifact` **Properties** - `bytecode: Buffer` - The ACIR bytecode of the function. - `debug?: FunctionDebugMetadata` - Debug metadata for the function. - `debugSymbols: string` - Maps opcodes to source code pointers - `errorTypes: Partial>` - The types of the errors that the function can throw. - `functionType: FunctionType` - Whether the function is secret. - `isInitializer: boolean` - Whether the function is flagged as an initializer. - `isOnlySelf: boolean` - Whether the function is marked as `#[only_self]` and hence callable only from within the contract. - `isStatic: boolean` - Whether the function can alter state or not - `name: string` - The name of the function. - `parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]` - Function parameters. - `returnTypes: AbiType[]` - The types of the return values. - `selector: FunctionSelector` - Unique identifier for a contract function. - `verificationKey?: string` - The verification key of the function, base64 encoded, if it's a private fn. ### ContractInstance A contract instance is a concrete deployment of a contract class. It always references a contract class, which dictates what code it executes when called. It has state (both private and public), as well as an address that acts as its identifier. It can be called into. It may have encryption and nullifying public keys. **Properties** - `currentContractClassId: Fr` - Identifier of the contract class for this instance. - `deployer: AztecAddress` - Optional deployer address or zero if this was a universal deploy. - `initializationHash: Fr` - Hash of the selector and arguments to the constructor. - `originalContractClassId: Fr` - Identifier of the original (at deployment) contract class for this instance - `publicKeys: PublicKeys` - Public keys associated with this instance. - `salt: Fr` - User-generated pseudorandom value for uniqueness. - `version: 1` - Version identifier. Initially one, bumped for any changes to the contract instance struct. ### ContractInstanceUpdate An update to a contract instance, changing its contract class. **Properties** - `newContractClassId: Fr` - Identifier of the new contract class for this instance. - `prevContractClassId: Fr` - Identifier of the previous contract class for this instance - `timestampOfChange: bigint` - The timestamp at which the contract class in use will be the new one ### ContractMetadata **Properties** - `contractInstance?: ContractInstanceWithAddress` - `isContractInitialized: boolean` - `isContractPublished: boolean` ### DebugInfo The debug information for a given function. **Properties** - `acir_locations: OpcodeToLocationsMap` - `brillig_locations: Record` - For each Brillig function, we have a map of the opcode location to the source code location. - `location_tree: LocationTree` - A map of the opcode location to the source code location. ### DimensionConfig **Properties** - `cost: number` - `standalone: number[]` - `variants: number[]` ### EpochProver Coordinates the proving of an entire epoch. Extends: `Omit` **Methods** - `addTxs(txs: ProcessedTx[]) => Promise` - Adds all processed txs to the block. Updates world state with the effects from this tx. - `cancel() => void` - Cancels all proving jobs. - `finalizeEpoch() => Promise<{ batchedBlobInputs: BatchedBlob; proof: Proof; publicInputs: RootRollupPublicInputs }>` - Pads the epoch with empty block roots if needed and blocks until proven. Throws if proving has failed. - `getProverId() => EthAddress` - Returns an identifier for the prover or zero if not set. - `setBlockCompleted(blockNumber: BlockNumber, expectedBlockHeader?: BlockHeader) => Promise` - Returns the block. - `startChonkVerifierCircuits(txs: Tx[]) => Promise` - Kickstarts chonk verifier circuits for the specified txs. These will be used during epoch proving. Note that if the chonk verifier circuits are not started this way, they will be started nonetheless after processing. - `startNewBlock(blockNumber: BlockNumber, timestamp: bigint, totalNumTxs: number) => Promise` - Starts a new block. - `startNewCheckpoint(checkpointIndex: number, constants: CheckpointConstantData, l1ToL2Messages: Fr[], totalNumBlocks: number, headerOfLastBlockInPreviousCheckpoint: BlockHeader) => Promise` - Starts a new checkpoint. - `startNewEpoch(epochNumber: EpochNumber, totalNumCheckpoints: number, finalBlobBatchingChallenges: FinalBlobBatchingChallenges) => void` - Starts a new epoch. Must be the first method to be called. - `stop() => Promise` - Called when no longer required, cleans up internal resources ### EpochProverManager The interface to the prover client. Provides the ability to generate proofs and build rollups. **Methods** - `createEpochProver() => EpochProver` - `getProverId() => EthAddress` - `getProvingJobSource() => ProvingJobConsumer` - `start() => Promise` - `stop() => Promise` - `updateProverConfig(config: Partial) => Promise` ### ExecutablePrivateFunction Private function definition with executable bytecode. Extends: `PrivateFunction` **Properties** - `bytecode: Buffer` - ACIR and Brillig bytecode - `selector: FunctionSelector` - Selector of the function. Calculated as the hash of the method name and parameters. The specification of this is not enforced by the protocol. - `vkHash: Fr` - Hash of the verification key associated to this private function. ### FailingFunction Address and selector of a function that failed during simulation. **Properties** - `contractAddress: AztecAddress` - The address of the contract that failed. - `contractName?: string` - The name of the contract that failed. - `functionName?: string` - The name of the function that failed. - `functionSelector?: FunctionSelector` - The selector of the function that failed. ### FileStore Simple file store. Extends: `ReadOnlyFileStore` **Methods** - `download(pathOrUrlStr: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrl: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrl: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. - `save(path: string, data: Buffer, opts?: FileStoreSaveOptions) => Promise` - Saves contents to the given path. Returns an URI that can be used later to `read` the file. Default: `compress` is false unless explicitly set. - `upload(destPath: string, srcPath: string, opts?: FileStoreSaveOptions) => Promise` - Uploads contents from a local file. Returns an URI that can be used later to `read` the file. Default: `compress` is true unless explicitly set to false. ### ForkMerkleTreeOperations Provides writeable forks of the world state at a given block number. **Methods** - `backupTo(dstPath: string, compact?: boolean) => Promise>` - Backups the db to the target path. - `fork(block?: BlockNumber) => Promise` - Forks the world state at the given block number, defaulting to the latest one. - `getSnapshot(blockNumber: BlockNumber) => MerkleTreeReadOperations` - Gets a handle that allows reading the state as it was at the given block number. ### FunctionAbi The abi entry of a function. **Properties** - `errorTypes: Partial>` - The types of the errors that the function can throw. - `functionType: FunctionType` - Whether the function is secret. - `isInitializer: boolean` - Whether the function is flagged as an initializer. - `isOnlySelf: boolean` - Whether the function is marked as `#[only_self]` and hence callable only from within the contract. - `isStatic: boolean` - Whether the function can alter state or not - `name: string` - The name of the function. - `parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]` - Function parameters. - `returnTypes: AbiType[]` - The types of the return values. ### FunctionArtifact The artifact entry of a function. Extends: `FunctionAbi` **Properties** - `bytecode: Buffer` - The ACIR bytecode of the function. - `debug?: FunctionDebugMetadata` - Debug metadata for the function. - `debugSymbols: string` - Maps opcodes to source code pointers - `errorTypes: Partial>` - The types of the errors that the function can throw. - `functionType: FunctionType` - Whether the function is secret. - `isInitializer: boolean` - Whether the function is flagged as an initializer. - `isOnlySelf: boolean` - Whether the function is marked as `#[only_self]` and hence callable only from within the contract. - `isStatic: boolean` - Whether the function can alter state or not - `name: string` - The name of the function. - `parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]` - Function parameters. - `returnTypes: AbiType[]` - The types of the return values. - `verificationKey?: string` - The verification key of the function, base64 encoded, if it's a private fn. ### FunctionArtifactWithContractName The artifact entry of a function. Extends: `FunctionArtifact` **Properties** - `bytecode: Buffer` - The ACIR bytecode of the function. - `contractName: string` - The name of the contract. - `debug?: FunctionDebugMetadata` - Debug metadata for the function. - `debugSymbols: string` - Maps opcodes to source code pointers - `errorTypes: Partial>` - The types of the errors that the function can throw. - `functionType: FunctionType` - Whether the function is secret. - `isInitializer: boolean` - Whether the function is flagged as an initializer. - `isOnlySelf: boolean` - Whether the function is marked as `#[only_self]` and hence callable only from within the contract. - `isStatic: boolean` - Whether the function can alter state or not - `name: string` - The name of the function. - `parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]` - Function parameters. - `returnTypes: AbiType[]` - The types of the return values. - `verificationKey?: string` - The verification key of the function, base64 encoded, if it's a private fn. ### FunctionDebugMetadata Debug metadata for a function. **Properties** - `debugSymbols: DebugInfo` - Maps opcodes to source code pointers - `files: DebugFileMap` - Maps the file IDs to the file contents to resolve pointers ### GasUsed **Properties** - `billedGas: Gas` - The gas billed for the transaction. This uses teardown gas limit instead of actual teardown gas. - `publicGas: Gas` - Total gas used during public execution, including actual teardown gas - `teardownGas: Gas` - The actual gas used in the teardown phase. - `totalGas: Gas` - Total gas used across both private and public executions. Note that this does not determine the transaction fee. The fee is calculated with billedGas, which uses `teardownGasLimits` from `GasSettings`, rather than actual teardown gas. ### GlobalVariableBuilder Interface for building global variables for Aztec blocks. **Methods** - `buildGlobalVariables(blockNumber: number, coinbase: EthAddress, feeRecipient: AztecAddress, slotNumber?: SlotNumber) => Promise` - Builds global variables for a given block. - `getCurrentBaseFees() => Promise` ### IBlockFactory The interface to a block builder. Generates an L2 block out of a set of processed txs. Extends: `ProcessedTxHandler` **Methods** - `addTxs(txs: ProcessedTx[]) => Promise` - Adds all processed txs to the block. Updates world state with the effects from this tx. - `setBlockCompleted(expectedBlockHeader?: BlockHeader) => Promise` - Assembles the block and updates the archive tree. - `startNewBlock(globalVariables: GlobalVariables, l1ToL2Messages: Fr[]) => Promise` - Prepares to build a new block. Updates the L1 to L2 message tree. ### IFullNodeBlockBuilder **Methods** - `buildBlock(txs: Iterable | AsyncIterable, l1ToL2Messages: Fr[], globalVariables: GlobalVariables, options: PublicProcessorLimits, fork?: MerkleTreeWriteOperations) => Promise` - `getConfig() => FullNodeBlockBuilderConfig` - `getFork(blockNumber: BlockNumber) => Promise` - `updateConfig(config: Partial) => void` ### ITxProvider **Methods** - `getAvailableTxs(txHashes: TxHash[]) => Promise<{ missingTxs: TxHash[]; txs: Tx[] }>` - `getTxsForBlock(block: L2BlockNew, opts: { deadline: Date }) => Promise<{ missingTxs: TxHash[]; txs: Tx[] }>` - `getTxsForBlockProposal(blockProposal: BlockProposal, blockNumber: number, opts: { deadline: Date; pinnedPeer: any }) => Promise<{ missingTxs: TxHash[]; txs: Tx[] }>` ### IntegerType An integer type. Extends: `BasicType<"integer">` **Properties** - `kind: "integer"` - The kind of the type. - `sign: "unsigned" | "signed"` - The sign of the integer. - `width: number` - The width of the integer in bits. ### IntegerValue A basic value. Extends: `BasicValue<"integer", string>` **Properties** - `kind: "integer"` - The kind of the value. - `sign: boolean` - `value: string` ### IsEmpty **Properties** - `isEmpty: () => boolean` ### L1ToL2MessageSource Interface of classes allowing for the retrieval of L1 to L2 messages. **Methods** - `getL1ToL2MessageIndex(l1ToL2Message: Fr) => Promise` - Gets the L1 to L2 message index in the L1 to L2 message tree. - `getL1ToL2Messages(checkpointNumber: CheckpointNumber) => Promise` - Gets new L1 to L2 message (to be) included in a given checkpoint. - `getL2Tips() => Promise` - Returns the tips of the L2 chain. ### L2BlockSource Interface of classes allowing for the retrieval of L2 blocks. **Methods** - `getBlock(number: BlockNumber) => Promise` - Gets an l2 block. If a negative number is passed, the block returned is the most recent. - `getBlockHeader(number: BlockNumber | "latest") => Promise` - Gets an l2 block header. - `getBlockHeaderByArchive(archive: Fr) => Promise` - Gets a block header by its archive root. - `getBlockHeaderByHash(blockHash: Fr) => Promise` - Gets a block header by its hash. - `getBlockHeadersForEpoch(epochNumber: EpochNumber) => Promise` - Returns all block headers for a given epoch. - `getBlockNumber() => Promise` - Gets the number of the latest L2 block processed by the block source implementation. - `getBlocks(from: BlockNumber, limit: number, proven?: boolean) => Promise` - Gets up to `limit` amount of L2 blocks starting from `from`. - `getBlocksForEpoch(epochNumber: EpochNumber) => Promise` - Returns all blocks for a given epoch. - `getCheckpointByArchive(archive: Fr) => Promise` - Gets a checkpoint by the archive root, which should be the root of the archive tree after the requested checkpoint is applied. - `getCheckpointsForEpoch(epochNumber: EpochNumber) => Promise` - Returns all checkpoints for a given epoch. - `getGenesisValues() => Promise<{ genesisArchiveRoot: Fr }>` - Returns values for the genesis block - `getL1Constants() => Promise` - Returns the rollup constants for the current chain. - `getL1Timestamp() => Promise` - Latest synced L1 timestamp. - `getL2EpochNumber() => Promise` - Returns the current L2 epoch number based on the currently synced L1 timestamp. - `getL2SlotNumber() => Promise` - Returns the current L2 slot number based on the currently synced L1 timestamp. - `getL2Tips() => Promise` - Returns the tips of the L2 chain. - `getPendingChainValidationStatus() => Promise` - Returns the status of the pending chain validation. If the chain is invalid, reports the earliest consecutive block that is invalid, along with the reason for being invalid, which can be used to trigger an invalidation. - `getProvenBlockNumber() => Promise` - Gets the number of the latest L2 block proven seen by the block source implementation. - `getPublishedBlockByArchive(archive: Fr) => Promise` - Gets a published block by its archive root. - `getPublishedBlockByHash(blockHash: Fr) => Promise` - Gets a published block by its hash. - `getPublishedBlocks(from: BlockNumber, limit: number, proven?: boolean) => Promise` - Equivalent to getBlocks but includes publish data. - `getPublishedCheckpoints(from: CheckpointNumber, limit: number) => Promise` - `getRegistryAddress() => Promise` - Method to fetch the registry contract address at the base-layer. - `getRollupAddress() => Promise` - Method to fetch the rollup contract address at the base-layer. - `getSettledTxReceipt(txHash: TxHash) => Promise` - Gets a receipt of a settled tx. - `getTxEffect(txHash: TxHash) => Promise` - Gets a tx effect. - `isEpochComplete(epochNumber: EpochNumber) => Promise` - Returns whether the given epoch is completed on L1, based on the current L1 and L2 block numbers. - `isPendingChainInvalid() => Promise` - Returns whether the latest block in the pending chain on L1 is invalid (ie its attestations are incorrect). Note that invalid blocks do not get synced, so the latest block returned by the block source is always a valid one. - `syncImmediate() => Promise` - Force a sync. ### L2BlockSourceEventEmitter Interface of classes allowing for the retrieval of L2 blocks. Extends: `L2BlockSource`, `ArchiverEmitter` **Methods** - `emit(event: K, ...args: Parameters<{ invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }[K]>) => boolean` - `getBlock(number: BlockNumber) => Promise` - Gets an l2 block. If a negative number is passed, the block returned is the most recent. - `getBlockHeader(number: BlockNumber | "latest") => Promise` - Gets an l2 block header. - `getBlockHeaderByArchive(archive: Fr) => Promise` - Gets a block header by its archive root. - `getBlockHeaderByHash(blockHash: Fr) => Promise` - Gets a block header by its hash. - `getBlockHeadersForEpoch(epochNumber: EpochNumber) => Promise` - Returns all block headers for a given epoch. - `getBlockNumber() => Promise` - Gets the number of the latest L2 block processed by the block source implementation. - `getBlocks(from: BlockNumber, limit: number, proven?: boolean) => Promise` - Gets up to `limit` amount of L2 blocks starting from `from`. - `getBlocksForEpoch(epochNumber: EpochNumber) => Promise` - Returns all blocks for a given epoch. - `getCheckpointByArchive(archive: Fr) => Promise` - Gets a checkpoint by the archive root, which should be the root of the archive tree after the requested checkpoint is applied. - `getCheckpointsForEpoch(epochNumber: EpochNumber) => Promise` - Returns all checkpoints for a given epoch. - `getGenesisValues() => Promise<{ genesisArchiveRoot: Fr }>` - Returns values for the genesis block - `getL1Constants() => Promise` - Returns the rollup constants for the current chain. - `getL1Timestamp() => Promise` - Latest synced L1 timestamp. - `getL2EpochNumber() => Promise` - Returns the current L2 epoch number based on the currently synced L1 timestamp. - `getL2SlotNumber() => Promise` - Returns the current L2 slot number based on the currently synced L1 timestamp. - `getL2Tips() => Promise` - Returns the tips of the L2 chain. - `getPendingChainValidationStatus() => Promise` - Returns the status of the pending chain validation. If the chain is invalid, reports the earliest consecutive block that is invalid, along with the reason for being invalid, which can be used to trigger an invalidation. - `getProvenBlockNumber() => Promise` - Gets the number of the latest L2 block proven seen by the block source implementation. - `getPublishedBlockByArchive(archive: Fr) => Promise` - Gets a published block by its archive root. - `getPublishedBlockByHash(blockHash: Fr) => Promise` - Gets a published block by its hash. - `getPublishedBlocks(from: BlockNumber, limit: number, proven?: boolean) => Promise` - Equivalent to getBlocks but includes publish data. - `getPublishedCheckpoints(from: CheckpointNumber, limit: number) => Promise` - `getRegistryAddress() => Promise` - Method to fetch the registry contract address at the base-layer. - `getRollupAddress() => Promise` - Method to fetch the rollup contract address at the base-layer. - `getSettledTxReceipt(txHash: TxHash) => Promise` - Gets a receipt of a settled tx. - `getTxEffect(txHash: TxHash) => Promise` - Gets a tx effect. - `isEpochComplete(epochNumber: EpochNumber) => Promise` - Returns whether the given epoch is completed on L1, based on the current L1 and L2 block numbers. - `isPendingChainInvalid() => Promise` - Returns whether the latest block in the pending chain on L1 is invalid (ie its attestations are incorrect). Note that invalid blocks do not get synced, so the latest block returned by the block source is always a valid one. - `off(event: K, listener: { invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }[K]) => this` - `on(event: K, listener: { invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }[K]) => this` - `once(event: K, listener: { invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }[K]) => this` - `removeAllListeners(event: K) => this` - `removeListener(event: K, listener: { invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }[K]) => this` - `syncImmediate() => Promise` - Force a sync. ### L2BlockStreamEventHandler Interface to a handler of events emitted. **Methods** - `handleBlockStreamEvent(event: L2BlockStreamEvent) => Promise` ### L2BlockStreamLocalDataProvider Interface to the local view of the chain. Implemented by world-state and l2-tips-store. **Methods** - `getL2BlockHash(number: number) => Promise` - `getL2Tips() => Promise` ### L2LogsSource Interface of classes allowing for the retrieval of logs. **Methods** - `getBlockNumber() => Promise` - Gets the number of the latest L2 block processed by the implementation. - `getContractClassLogs(filter: LogFilter) => Promise` - Gets contract class logs based on the provided filter. - `getLogsByTags(tags: Fr[], logsPerTag?: number) => Promise` - Gets all logs that match any of the received tags (i.e. logs with their first field equal to a tag). - `getPublicLogs(filter: LogFilter) => Promise` - Gets public logs based on the provided filter. ### LeafUpdateWitnessData Witness data for a leaf update. **Properties** - `index: bigint` - The index of the leaf. - `leafPreimage: IndexedTreeLeafPreimage` - Preimage of the leaf before updating. - `siblingPath: SiblingPath` - Sibling path to prove membership of the leaf. ### MakeConsensusPayloadOptions **Properties** - `archive?: Fr` - `attesterSigner?: Secp256k1Signer` - `header?: L2BlockHeader` - `proposerSigner?: Secp256k1Signer` - `signer?: Secp256k1Signer` - `txHashes?: TxHash[]` - `txs?: Tx[]` ### MerkleTreeCheckpointOperations **Methods** - `commitAllCheckpoints() => Promise` - Commits all checkpoints - `commitCheckpoint() => Promise` - Commits the current checkpoint - `createCheckpoint() => Promise` - Checkpoints the current fork state - `revertAllCheckpoints() => Promise` - Reverts all checkpoints - `revertCheckpoint() => Promise` - Reverts the current checkpoint ### MerkleTreeReadOperations Defines the interface for operations on a set of Merkle Trees. **Methods** - `findLeafIndices(treeId: ID, values: MerkleTreeLeafType[]) => Promise` - Returns the index containing a leaf value. - `findLeafIndicesAfter(treeId: ID, values: MerkleTreeLeafType[], startIndex: bigint) => Promise` - Returns the first index containing a leaf value after `startIndex`. - `findSiblingPaths(treeId: ID, values: MerkleTreeLeafType[]) => Promise<{ index: bigint; path: SiblingPath<{ 0: 42; 1: 42; ... }[ID]> }[]>` - Returns the sibling paths for the given leaf values - `getBlockNumbersForLeafIndices(treeId: ID, leafIndices: bigint[]) => Promise` - Get the block numbers for a set of leaf indices - `getInitialHeader() => BlockHeader` - Gets the initial header. - `getLeafPreimage(treeId: ID, index: bigint) => Promise` - Returns the data at a specific leaf. - `getLeafValue(treeId: ID, index: bigint) => Promise>` - Gets the value for a leaf in the tree. - `getPreviousValueIndex(treeId: ID, value: bigint) => Promise<{ alreadyPresent: boolean; index: bigint }>` - Returns the previous index for a given value in an indexed tree. - `getRevision() => WorldStateRevision | WorldStateRevisionWithHandle` - Gets the current revision. - `getSiblingPath(treeId: ID, index: bigint) => Promise>` - Gets sibling path for a leaf. - `getStateReference() => Promise` - Gets the current state reference. - `getTreeInfo(treeId: MerkleTreeId) => Promise` - Returns information about the given tree. ### MerkleTreeWriteOperations Defines the interface for operations on a set of Merkle Trees. Extends: `MerkleTreeReadOperations`, `MerkleTreeCheckpointOperations` **Methods** - `appendLeaves(treeId: ID, leaves: MerkleTreeLeafType[]) => Promise` - Appends leaves to a given tree. - `batchInsert(treeId: ID, leaves: Buffer[], subtreeHeight: number) => Promise>` - Batch insert multiple leaves into the tree. - `close() => Promise` - Closes the database, discarding any uncommitted changes. - `commitAllCheckpoints() => Promise` - Commits all checkpoints - `commitCheckpoint() => Promise` - Commits the current checkpoint - `createCheckpoint() => Promise` - Checkpoints the current fork state - `findLeafIndices(treeId: ID, values: MerkleTreeLeafType[]) => Promise` - Returns the index containing a leaf value. - `findLeafIndicesAfter(treeId: ID, values: MerkleTreeLeafType[], startIndex: bigint) => Promise` - Returns the first index containing a leaf value after `startIndex`. - `findSiblingPaths(treeId: ID, values: MerkleTreeLeafType[]) => Promise<{ index: bigint; path: SiblingPath<{ 0: 42; 1: 42; ... }[ID]> }[]>` - Returns the sibling paths for the given leaf values - `getBlockNumbersForLeafIndices(treeId: ID, leafIndices: bigint[]) => Promise` - Get the block numbers for a set of leaf indices - `getInitialHeader() => BlockHeader` - Gets the initial header. - `getLeafPreimage(treeId: ID, index: bigint) => Promise` - Returns the data at a specific leaf. - `getLeafValue(treeId: ID, index: bigint) => Promise>` - Gets the value for a leaf in the tree. - `getPreviousValueIndex(treeId: ID, value: bigint) => Promise<{ alreadyPresent: boolean; index: bigint }>` - Returns the previous index for a given value in an indexed tree. - `getRevision() => WorldStateRevision | WorldStateRevisionWithHandle` - Gets the current revision. - `getSiblingPath(treeId: ID, index: bigint) => Promise>` - Gets sibling path for a leaf. - `getStateReference() => Promise` - Gets the current state reference. - `getTreeInfo(treeId: MerkleTreeId) => Promise` - Returns information about the given tree. - `revertAllCheckpoints() => Promise` - Reverts all checkpoints - `revertCheckpoint() => Promise` - Reverts the current checkpoint - `sequentialInsert(treeId: ID, leaves: Buffer[]) => Promise>` - Inserts multiple leaves into the tree, getting witnesses at every step. Note: This method doesn't support inserting empty leaves. - `updateArchive(header: BlockHeader) => Promise` - Inserts the block hash into the archive. This includes all of the current roots of all of the data trees and the current blocks global vars. ### MessageRetrieval **Methods** - `getL2ToL1Messages(l2BlockNumber: BlockNumber) => Promise` ### NodeInfo Provides basic information about the running node. **Properties** - `enr: string` - The node's ENR. - `l1ChainId: number` - L1 chain id. - `l1ContractAddresses: L1ContractAddresses` - The deployed l1 contract addresses - `nodeVersion: string` - Version as tracked in the aztec-packages repository. - `protocolContractAddresses: ProtocolContractAddresses` - Protocol contract addresses - `rollupVersion: number` - Rollup version. ### NoirCompiledCircuit The compilation result of a protocol (non-contract) circuit. **Properties** - `abi: NoirFunctionAbi` - The ABI of the function. - `bytecode: string` - The bytecode of the circuit in base64. - `debug_symbols: string` - The debug information, compressed and base64 encoded. - `file_map: DebugFileMap` - The map of file ID to the source code and path of the file. - `hash?: number` - The hash of the circuit. - `verificationKey: { bytes: string; fields: string[]; hash: string }` - The verification key of the circuit. ### NoirCompiledCircuitWithName The compilation result of a protocol (non-contract) circuit. Extends: `NoirCompiledCircuit` **Properties** - `abi: NoirFunctionAbi` - The ABI of the function. - `bytecode: string` - The bytecode of the circuit in base64. - `debug_symbols: string` - The debug information, compressed and base64 encoded. - `file_map: DebugFileMap` - The map of file ID to the source code and path of the file. - `hash?: number` - The hash of the circuit. - `name: string` - The name of the circuit. - `verificationKey: { bytes: string; fields: string[]; hash: string }` - The verification key of the circuit. ### NoirCompiledContract The compilation result of an Aztec.nr contract. **Properties** - `file_map: DebugFileMap` - The map of file ID to the source code and path of the file. - `functions: NoirFunctionEntry[]` - The functions of the contract. - `name: string` - The name of the contract. - `outputs: { globals: Record; structs: Record }` - The events of the contract - `transpiled?: boolean` - Is the contract's public bytecode transpiled? ### NoirContractCompilationArtifacts The compilation artifacts of a given contract. **Properties** - `contract: NoirCompiledContract` - The compiled contract. ### NoirDebugMetadata The debug metadata of an Aztec.nr contract. **Properties** - `debug_symbols: DebugInfo[]` - The debug information for each function. - `file_map: DebugFileMap` - The map of file ID to the source code and path of the file. ### NoirFunctionAbi The ABI of an Aztec.nr function. **Properties** - `error_types: Partial>` - Mapping of error selector => error type - `parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]` - The parameters of the function. - `return_type: { abi_type: AbiType; visibility: "public" | "private" | "databus" }` - The return type of the function. ### NoirProgramCompilationArtifacts The compilation artifacts of a given program. **Properties** - `name: string` - not part of the compilation output, injected later - `program: NoirCompiledCircuit` - The compiled contract. ### Ordered **Properties** - `counter: number` ### P2PApiWithAttestations Exposed API to the P2P module. Extends: `P2PApiWithoutAttestations` **Methods** - `deleteAttestation(attestation: BlockAttestation) => Promise` - Deletes a given attestation manually from the p2p client attestation pool. - `getAttestationsForSlot(slot: SlotNumber, proposalId?: string) => Promise` - Queries the Attestation pool for attestations for the given slot - `getEncodedEnr() => Promise` - Returns the ENR for this node, if any. - `getPeers(includePending?: boolean) => Promise` - Returns info for all connected, dialing, and cached peers. - `getPendingTxCount() => Promise` - Returns the number of pending txs in the p2p tx pool. - `getPendingTxs(limit?: number, after?: TxHash) => Promise` - Returns all pending transactions in the transaction pool. ### P2PApiWithoutAttestations Exposed API to the P2P module. **Methods** - `getEncodedEnr() => Promise` - Returns the ENR for this node, if any. - `getPeers(includePending?: boolean) => Promise` - Returns info for all connected, dialing, and cached peers. - `getPendingTxCount() => Promise` - Returns the number of pending txs in the p2p tx pool. - `getPendingTxs(limit?: number, after?: TxHash) => Promise` - Returns all pending transactions in the transaction pool. ### P2PBootstrapApi Exposed API to the P2P bootstrap node. **Methods** - `getEncodedEnr() => Promise` - Returns the ENR for this node. - `getRoutingTable() => Promise` - Returns ENRs for all nodes in the routing table. ### P2PClient Exposed API to the P2P module. Extends: `P2PApiWithAttestations` **Methods** - `addAttestations(attestations: BlockAttestation[]) => Promise` - Manually adds an attestation to the p2p client attestation pool. - `deleteAttestation(attestation: BlockAttestation) => Promise` - Deletes a given attestation manually from the p2p client attestation pool. - `getAttestationsForSlot(slot: SlotNumber, proposalId?: string) => Promise` - Queries the Attestation pool for attestations for the given slot - `getEncodedEnr() => Promise` - Returns the ENR for this node, if any. - `getPeers(includePending?: boolean) => Promise` - Returns info for all connected, dialing, and cached peers. - `getPendingTxCount() => Promise` - Returns the number of pending txs in the p2p tx pool. - `getPendingTxs(limit?: number, after?: TxHash) => Promise` - Returns all pending transactions in the transaction pool. ### P2PValidator P2PValidator A validator for P2P messages, which returns a severity of error to be applied to the peer **Methods** - `validate(message: T) => Promise` ### PrivateExecutionStep Represents either a simulated private kernel circuit or one of our application function circuits. **Properties** - `bytecode: Buffer` - `functionName: string` - `gateCount?: number` - `timings: { gateCount?: number; oracles?: Record; witgen: number }` - `vk: Buffer` - `witness: WitnessMap` ### PrivateFunction Private function definition within a contract class. **Properties** - `selector: FunctionSelector` - Selector of the function. Calculated as the hash of the method name and parameters. The specification of this is not enforced by the protocol. - `vkHash: Fr` - Hash of the verification key associated to this private function. ### PrivateKernelExecutionProofOutput Represents the output of proven PrivateKernelSimulateOutput. **Properties** - `chonkProof: ChonkProof` - The private IVC proof optimized for user devices. It will be consumed by an Aztec prover, which recursively verifies it through the "private tx base" or the "public chonk verifier" circuit. - `executionSteps: PrivateExecutionStep[]` - The trace the chonkProof corresponds to. A trace of app circuits interleaved with private kernel circuits. If simulate is ran with profiling mode, also includes gate counts. - `publicInputs: PublicInputsType` - The public inputs used by the proof generation process. - `timings?: { proving: number }` - Performance metrics ### PrivateKernelProver PrivateKernelProver provides functionality to simulate and validate circuits, and retrieve siloed commitments necessary for maintaining transaction privacy and security on the network. **Methods** - `computeGateCountForCircuit(bytecode: Buffer, circuitName: string) => Promise` - Compute the gate count for a given circuit. - `createChonkProof(executionSteps: PrivateExecutionStep[]) => Promise` - Based of a program stack, create a folding proof. - `generateHidingToPublicOutput(inputs: HidingKernelToPublicPrivateInputs) => Promise>` - `generateHidingToRollupOutput(inputs: HidingKernelToRollupPrivateInputs) => Promise>` - `generateInitOutput(privateKernelInputsInit: PrivateKernelInitCircuitPrivateInputs) => Promise>` - Creates a proof output for a given signed transaction request and private call data for the first iteration. - `generateInnerOutput(privateKernelInputsInner: PrivateKernelInnerCircuitPrivateInputs) => Promise>` - Creates a proof output for a given previous kernel data and private call data for an inner iteration. - `generateResetOutput(privateKernelInputsReset: PrivateKernelResetCircuitPrivateInputs) => Promise>` - Creates a proof output by resetting the arrays using the reset circuit. - `generateTailOutput(privateKernelInputsTail: PrivateKernelTailCircuitPrivateInputs) => Promise>` - Creates a proof output based on the last inner kernel iteration kernel data for the final ordering iteration. - `simulateInit(privateKernelInputsInit: PrivateKernelInitCircuitPrivateInputs) => Promise>` - Executes the first kernel iteration without generating a proof. - `simulateInner(privateKernelInputsInner: PrivateKernelInnerCircuitPrivateInputs) => Promise>` - Executes an inner kernel iteration without generating a proof. - `simulateReset(privateKernelInputsReset: PrivateKernelResetCircuitPrivateInputs) => Promise>` - Executes the reset circuit without generating a proof - `simulateTail(privateKernelInputsTail: PrivateKernelTailCircuitPrivateInputs) => Promise>` - Executes the final ordering iteration circuit. ### PrivateKernelResetDimensionsConfig **Properties** - `dimensions: { KEY_VALIDATION: DimensionConfig; NOTE_HASH_PENDING_READ: DimensionConfig; ... }` - `specialCases: number[][]` ### PrivateKernelSimulateOutput Represents the output of the proof creation process for init and inner private kernel circuit. Contains the public inputs required for the init and inner private kernel circuit and the generated proof. **Properties** - `bytecode: Buffer` - `outputWitness: WitnessMap` - `publicInputs: PublicInputsType` - The public inputs required for the proof generation process. - `verificationKey: VerificationKeyData` ### ProcessedTxHandler Receives processed txs as part of block simulation or proving. **Methods** - `addTxs(txs: ProcessedTx[]) => Promise` - Handles processed txs. ### ProgramDebugInfo The debug information for a given program (a collection of functions) **Properties** - `debug_infos: DebugInfo[]` - A list of debug information that matches with each function in a program ### ProposerSlashActionProvider **Methods** - `getProposerActions(slotNumber: SlotNumber) => Promise` - Returns the actions to take for the proposer in the current slot. This can include creating a slash payload or other actions. ### ProverAgentApi **Methods** - `getStatus() => Promise` ### ProverCoordination Provides basic operations for ProverNodes to interact with other nodes in the network. **Methods** - `gatherTxs(txHashes: TxHash[]) => Promise` - `getP2PClient() => P2PClient` - `getTxsByHash(txHashes: TxHash[]) => Promise` - Returns a set of transactions given their hashes if available. ### ProverNodeApi JSON RPC public interface to a prover node. **Methods** - `getJobs() => Promise<{ epochNumber: number; status: "initialized" | "processing" | "awaiting-prover" | "publishing-proof" | "completed" | "failed" | "stopped" | "timed-out" | "reorg"; uuid: string }[]>` - `getL2Tips() => Promise` - `getWorldStateSyncStatus() => Promise` - `startProof(epochNumber: number) => Promise` ### ProvingJobBroker An interface for the proving orchestrator. The producer uses this to enqueue jobs for agents Extends: `ProvingJobProducer`, `ProvingJobConsumer` **Methods** - `cancelProvingJob(id: string) => Promise` - Cancels a proving job. - `enqueueProvingJob(job: ProvingJobShape) => Promise<{ status: "in-queue" } | { status: "in-progress" } | { status: "not-found" } | { status: "fulfilled"; value: string & BRAND<"ProvingJobUri"> } | { reason: string; status: "rejected" }>` - Enqueues a proving job - `getCompletedJobs(ids: string[]) => Promise` - Returns the ids of jobs that have been completed since the last call Also returns the set of provided job ids that are completed - `getProvingJob(filter?: ProvingJobFilter) => Promise` - Gets a proving job to work on - `getProvingJobStatus(id: string) => Promise<{ status: "in-queue" } | { status: "in-progress" } | { status: "not-found" } | { status: "fulfilled"; value: string & BRAND<"ProvingJobUri"> } | { reason: string; status: "rejected" }>` - Returns the current status fof the proving job - `reportProvingJobError(id: string, err: string, retry?: boolean, filter?: ProvingJobFilter) => Promise` - Marks a proving job as errored - `reportProvingJobProgress(id: string, startedAt: number, filter?: ProvingJobFilter) => Promise` - Sends a heartbeat to the broker to indicate that the agent is still working on the given proving job - `reportProvingJobSuccess(id: string, result: string & BRAND<"ProvingJobUri">, filter?: ProvingJobFilter) => Promise` - Marks a proving job as successful ### ProvingJobConsumer An interface for proving agents to request jobs and report results **Methods** - `getProvingJob(filter?: ProvingJobFilter) => Promise` - Gets a proving job to work on - `reportProvingJobError(id: string, err: string, retry?: boolean, filter?: ProvingJobFilter) => Promise` - Marks a proving job as errored - `reportProvingJobProgress(id: string, startedAt: number, filter?: ProvingJobFilter) => Promise` - Sends a heartbeat to the broker to indicate that the agent is still working on the given proving job - `reportProvingJobSuccess(id: string, result: string & BRAND<"ProvingJobUri">, filter?: ProvingJobFilter) => Promise` - Marks a proving job as successful ### ProvingJobProducer An interface for the proving orchestrator. The producer uses this to enqueue jobs for agents **Methods** - `cancelProvingJob(id: string) => Promise` - Cancels a proving job. - `enqueueProvingJob(job: ProvingJobShape) => Promise<{ status: "in-queue" } | { status: "in-progress" } | { status: "not-found" } | { status: "fulfilled"; value: string & BRAND<"ProvingJobUri"> } | { reason: string; status: "rejected" }>` - Enqueues a proving job - `getCompletedJobs(ids: string[]) => Promise` - Returns the ids of jobs that have been completed since the last call Also returns the set of provided job ids that are completed - `getProvingJobStatus(id: string) => Promise<{ status: "in-queue" } | { status: "in-progress" } | { status: "not-found" } | { status: "fulfilled"; value: string & BRAND<"ProvingJobUri"> } | { reason: string; status: "rejected" }>` - Returns the current status fof the proving job ### ProvingJobSource **Methods** - `getProvingJob() => Promise` - Gets the next proving job. `heartbeat` must be called periodically to keep the job alive. - `heartbeat(jobId: string) => Promise` - Keeps the job alive. If this isn't called regularly then the job will be considered abandoned and re-queued for another consumer to pick up - `rejectProvingJob(jobId: string, reason: string) => Promise` - Rejects a proving job. - `resolveProvingJob(jobId: string, result: { result: ProofAndVerificationKey<20000>; type: PUBLIC_VM } | { result: PublicInputsAndRecursiveProof; type: PUBLIC_CHONK_VERIFIER } | { result: PublicInputsAndRecursiveProof; type: PRIVATE_TX_BASE_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: PUBLIC_TX_BASE_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: TX_MERGE_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_ROOT_FIRST_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_ROOT_SINGLE_TX_FIRST_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_ROOT_EMPTY_TX_FIRST_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_ROOT_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_ROOT_SINGLE_TX_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: BLOCK_MERGE_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: CHECKPOINT_ROOT_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: CHECKPOINT_ROOT_SINGLE_BLOCK_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: CHECKPOINT_PADDING_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: CHECKPOINT_MERGE_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: ROOT_ROLLUP } | { result: PublicInputsAndRecursiveProof; type: PARITY_BASE } | { result: PublicInputsAndRecursiveProof; type: PARITY_ROOT }) => Promise` - Resolves a proving job. ### ProvingStats **Properties** - `nodeRPCCalls?: Partial>` - `timings: ProvingTimings` ### PublicProcessorLimits **Properties** - `deadline?: Date` - `maxBlobFields?: number` - `maxBlockGas?: Gas` - `maxBlockSize?: number` - `maxTransactions?: number` ### PublicProcessorValidator **Properties** - `nullifierCache?: { addNullifiers: (nullifiers: Buffer[]) => void }` - `preprocessValidator?: TxValidator` ### PublicStateSource Provides a view into public contract state **Properties** - `storageRead: (contractAddress: AztecAddress, slot: Fr) => Promise` - Returns the value for a given slot at a given contract. ### RawGossipMessage **Properties** - `data: Uint8Array` - `topic: string` ### ReadOnlyFileStore Simple read-only file store. **Methods** - `download(pathOrUrlStr: string, destPath: string) => Promise` - Downloads a file given a path, or an URI as returned by calling `save`. Saves file to local path. - `exists(pathOrUrl: string) => Promise` - Returns whether a file at the given path or URI exists. - `read(pathOrUrl: string) => Promise` - Reads a file given a path, or an URI as returned by calling `save`. Returns file contents. ### SequencerConfig The sequencer configuration. **Properties** - `acvmBinaryPath?: string` - The path to the ACVM binary - `acvmWorkingDirectory?: string` - The working directory to use for simulation/proving - `attestationPropagationTime?: number` - How many seconds it takes for proposals and attestations to travel across the p2p layer (one-way) - `broadcastInvalidBlockProposal?: boolean` - Broadcast invalid block proposals with corrupted state (for testing only) - `coinbase?: EthAddress` - Recipient of block reward. - `enforceTimeTable?: boolean` - Whether to enforce the time table when building blocks - `fakeProcessingDelayPerTxMs?: number` - Used for testing to introduce a fake delay after processing each tx - `feeRecipient?: AztecAddress` - Address to receive fees. - `fishermanMode?: boolean` - Whether to run in fisherman mode: builds blocks on every slot for validation without publishing - `governanceProposerPayload?: EthAddress` - Payload address to vote for - `injectFakeAttestation?: boolean` - Inject a fake attestation (for testing only) - `maxBlockSizeInBytes?: number` - Max block size - `maxDABlockGas?: number` - The maximum DA block gas. - `maxL1TxInclusionTimeIntoSlot?: number` - How many seconds into an L1 slot we can still send a tx and get it mined. - `maxL2BlockGas?: number` - The maximum L2 block gas. - `maxTxsPerBlock?: number` - The maximum number of txs to include in a block. - `minTxsPerBlock?: number` - The minimum number of txs to include in a block. - `publishTxsWithProposals?: boolean` - Whether to publish txs with the block proposals - `secondsBeforeInvalidatingBlockAsCommitteeMember?: number` - How many seconds before invalidating a block as a committee member (zero to never invalidate) - `secondsBeforeInvalidatingBlockAsNonCommitteeMember?: number` - How many seconds before invalidating a block as a non-committee member (zero to never invalidate) - `shuffleAttestationOrdering?: boolean` - Shuffle attestation ordering to create invalid ordering (for testing only) - `skipCollectingAttestations?: boolean` - Skip collecting attestations (for testing only) - `skipInvalidateBlockAsProposer?: boolean` - Do not invalidate the previous block if invalid when we are the proposer (for testing only) - `transactionPollingIntervalMS?: number` - The number of ms to wait between polling for pending txs. - `txPublicSetupAllowList?: AllowedElement[]` - The list of functions calls allowed to run in setup ### SequentialInsertionResult The result of a sequential insertion in an indexed merkle tree. **Properties** - `insertionWitnessData: LeafUpdateWitnessData[]` - Data for the inserted leaves - `lowLeavesWitnessData: LeafUpdateWitnessData[]` - Data for the leaves to be updated when inserting the new ones. ### ServerCircuitProver Generates proofs for parity and rollup circuits. **Methods** - `getAvmProof(inputs: AvmCircuitInputs, skipPublicInputsValidation?: boolean, signal?: AbortSignal, epochNumber?: number) => Promise>` - Create a proof for the AVM circuit. - `getBaseParityProof(inputs: ParityBasePrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getBlockMergeRollupProof(input: BlockMergeRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getBlockRootEmptyTxFirstRollupProof(input: BlockRootEmptyTxFirstRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getBlockRootFirstRollupProof(input: BlockRootFirstRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getBlockRootRollupProof(input: BlockRootRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getBlockRootSingleTxFirstRollupProof(input: BlockRootSingleTxFirstRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getBlockRootSingleTxRollupProof(input: BlockRootSingleTxRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getCheckpointMergeRollupProof(input: CheckpointMergeRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getCheckpointPaddingRollupProof(input: CheckpointPaddingRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getCheckpointRootRollupProof(input: CheckpointRootRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getCheckpointRootSingleBlockRollupProof(input: CheckpointRootSingleBlockRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getPrivateTxBaseRollupProof(baseRollupInput: PrivateTxBaseRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getPublicChonkVerifierProof(inputs: PublicChonkVerifierPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getPublicTxBaseRollupProof(inputs: PublicTxBaseRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - `getRootParityProof(inputs: ParityRootPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getRootRollupProof(input: RootRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. - `getTxMergeRollupProof(input: TxMergeRollupPrivateInputs, signal?: AbortSignal, epochNumber?: number) => Promise>` - Creates a proof for the given input. ### Service Represents a local service that can be started and stopped. **Methods** - `resume() => void` - Resumes the service after it was stopped - `start(waitUntilSynced?: boolean) => Promise` - Starts the service. - `stop() => Promise` - Stops the service. ### Signable **Methods** - `getPayloadToSign(domainSeparator: SignatureDomainSeparator) => Buffer` ### SimulationStats **Properties** - `nodeRPCCalls: Partial>` - `timings: SimulationTimings` ### SimulationTimings **Properties** - `perFunction: FunctionTiming[]` - `publicSimulation?: number` - `sync: number` - `total: number` - `unaccounted: number` - `validation?: number` ### SlasherConfig **Properties** - `slashAttestDescendantOfInvalidPenalty: bigint` - `slashBroadcastedInvalidBlockPenalty: bigint` - `slashDataWithholdingPenalty: bigint` - `slashExecuteRoundsLookBack: number` - `slashGracePeriodL2Slots: number` - `slashInactivityConsecutiveEpochThreshold: number` - `slashInactivityPenalty: bigint` - `slashInactivityTargetPercentage: number` - `slashMaxPayloadSize: number` - `slashMaxPenaltyPercentage: number` - `slashMinPenaltyPercentage: number` - `slashOffenseExpirationRounds: number` - `slashOverridePayload?: EthAddress` - `slashProposeInvalidAttestationsPenalty: bigint` - `slashPrunePenalty: bigint` - `slashSelfAllowed?: boolean` - `slashUnknownPenalty: bigint` - `slashValidatorsAlways: EthAddress[]` - `slashValidatorsNever: EthAddress[]` ### SourceCodeLocation A pointer to a failing section of the noir source code. **Properties** - `column: number` - The column number of the call. - `filePath: string` - The path to the source file. - `fileSource: string` - The source code of the file. - `line: number` - The line number of the call. - `locationText: string` - The source code text of the failed constraint. ### StringType A string type. Extends: `BasicType<"string">` **Properties** - `kind: "string"` - The kind of the type. - `length: number` - The length of the string. ### StructType A struct type. Extends: `BasicType<"struct">` **Properties** - `fields: { name: string; type: AbiType }[]` - The fields of the struct. - `kind: "struct"` - The kind of the type. - `path: string` - Fully qualified name of the struct. ### StructValue **Properties** - `fields: TypedStructFieldValue[]` - `kind: "struct"` ### TreeInfo Defines tree information. **Properties** - `depth: number` - The depth of the tree. - `root: Buffer` - The tree root. - `size: bigint` - The number of leaves in the tree. - `treeId: MerkleTreeId` - The tree ID. ### TupleType A tuple type. Extends: `BasicType<"tuple">` **Properties** - `fields: AbiType[]` - The types of the tuple elements. - `kind: "tuple"` - The kind of the type. ### TupleValue **Properties** - `fields: AbiValue[]` - `kind: "tuple"` ### TxValidator **Methods** - `validateTx(tx: T) => Promise` ### UtilityFunction Utility function definition. **Properties** - `bytecode: Buffer` - Brillig. - `selector: FunctionSelector` - Selector of the function. Calculated as the hash of the method name and parameters. The specification of this is not enforced by the protocol. ### Validator **Methods** - `attestToProposal(proposal: BlockProposal, sender: PeerId) => Promise` - `broadcastBlockProposal(proposal: BlockProposal) => Promise` - `collectAttestations(proposal: BlockProposal, required: number, deadline: Date) => Promise` - `createBlockProposal(blockNumber: number, header: CheckpointHeader, archive: Fr, txs: Tx[], proposerAddress: EthAddress, options: BlockProposalOptions) => Promise` - `signAttestationsAndSigners(attestationsAndSigners: CommitteeAttestationsAndSigners, proposer: EthAddress) => Promise` - `start() => Promise` - `updateConfig(config: Partial) => void` ### ValidatorClientConfig Validator client configuration **Properties** - `alwaysReexecuteBlockProposals?: boolean` - Whether to always reexecute block proposals, even for non-validator nodes or when out of the currnet committee - `attestationPollingIntervalMs: number` - Interval between polling for new attestations from peers - `disabledValidators: EthAddress[]` - Temporarily disable these specific validator addresses - `disableValidator: boolean` - Do not run the validator - `fishermanMode?: boolean` - Whether to run in fisherman mode: validates all proposals and attestations but does not broadcast attestations or participate in consensus - `validatorAddresses?: EthAddress[]` - The addresses of the validators to use with remote signers - `validatorPrivateKeys?: SecretValue` - The private keys of the validators participating in attestation duties - `validatorReexecute: boolean` - Whether to re-execute transactions in a block proposal before attesting - `validatorReexecuteDeadlineMs: number` - Will re-execute until this many milliseconds are left in the slot ### WorldStateSyncStatus **Properties** - `finalizedBlockNumber: BlockNumber` - `latestBlockHash: string` - `latestBlockNumber: BlockNumber` - `oldestHistoricBlockNumber: BlockNumber` - `treesAreSynched: boolean` ### WorldStateSynchronizer Defines the interface for a world state synchronizer. Extends: `ForkMerkleTreeOperations` **Methods** - `backupTo(dstPath: string, compact?: boolean) => Promise>` - Backups the db to the target path. - `clear() => Promise` - Deletes the db - `fork(block?: BlockNumber) => Promise` - Forks the world state at the given block number, defaulting to the latest one. - `getCommitted() => MerkleTreeReadOperations` - Returns an instance of MerkleTreeAdminOperations that will not include uncommitted data. - `getSnapshot(blockNumber: BlockNumber) => MerkleTreeReadOperations` - Gets a handle that allows reading the state as it was at the given block number. - `resumeSync() => void` - Resumes synching after a stopSync call. - `start() => Promise>` - Starts the synchronizer. - `status() => Promise` - Returns the current status of the synchronizer. - `stop() => Promise` - Stops the synchronizer and its database. - `stopSync() => Promise` - Stops the synchronizer from syncing, but keeps the database online. - `syncImmediate(minBlockNumber?: BlockNumber, skipThrowIfTargetNotReached?: boolean) => Promise` - Forces an immediate sync to an optionally provided minimum block number ### WorldStateSynchronizerStatus Defines the status of the world state synchronizer. **Properties** - `state: WorldStateRunningState` - The current state of the world state synchronizer. - `syncSummary: WorldStateSyncStatus` - The block numbers that the world state synchronizer is synced to. ## Functions ### ClaimedLengthArrayFromBuffer ```typescript function ClaimedLengthArrayFromBuffer Fr } | string & { toField: () => Fr } | string & { toFields: () => Fr[] } | string & Fieldable[] | number & Buffer | number & Fr | number & { toFr: () => Fr } | number & { toField: () => Fr } | number & { toFields: () => Fr[] } | number & Fieldable[] | never | bigint & Fr | bigint & { toFr: () => Fr } | bigint & { toField: () => Fr } | bigint & { toFields: () => Fr[] } | bigint & Fieldable[] | false & Buffer | false & Fr | false & { toFr: () => Fr } | false & { toField: () => Fr } | false & { toFields: () => Fr[] } | false & Fieldable[] | true & Buffer | true & Fr | true & { toFr: () => Fr } | true & { toField: () => Fr } | true & { toFields: () => Fr[] } | true & Fieldable[] | Buffer & number | never | Buffer & false | Buffer & true | Buffer & Fr | Buffer & { toFr: () => Fr } | Buffer & { toField: () => Fr } | Buffer & { toFields: () => Fr[] } | Buffer & Fieldable[] | Uint8Array & number | never | Uint8Array & false | Uint8Array & true | Uint8Array & Buffer | Uint8Array & Fr | Uint8Array & { toFr: () => Fr } | Uint8Array & { toField: () => Fr } | Uint8Array & { toFields: () => Fr[] } | Uint8Array & Fieldable[] | { toBuffer: () => Buffer } & number | { toBuffer: () => Buffer } & bigint | { toBuffer: () => Buffer } & false | { toBuffer: () => Buffer } & true | { toBuffer: () => Buffer } & Buffer | { toBuffer: () => Buffer } & Fr | { toBuffer: () => Buffer } & { toFr: () => Fr } | { toBuffer: () => Buffer } & { toField: () => Fr } | { toBuffer: () => Buffer } & { toFields: () => Fr[] } | { toBuffer: () => Buffer } & Fieldable[] | Bufferable[] & number | Bufferable[] & bigint | Bufferable[] & false | Bufferable[] & true | Bufferable[] & Buffer | Bufferable[] & Fr | Bufferable[] & { toFr: () => Fr } | Bufferable[] & { toField: () => Fr } | Bufferable[] & { toFields: () => Fr[] } | Bufferable[] & Fieldable[], N extends number>(deserializer: { fromBuffer: (reader: BufferReader) => T }, arrayLength: N) => { fromBuffer: (reader: BufferReader) => ClaimedLengthArray } ``` ### ClaimedLengthArrayFromFields ```typescript function ClaimedLengthArrayFromFields Fr } | string & { toField: () => Fr } | string & { toFields: () => Fr[] } | string & Fieldable[] | number & Buffer | number & Fr | number & { toFr: () => Fr } | number & { toField: () => Fr } | number & { toFields: () => Fr[] } | number & Fieldable[] | never | bigint & Fr | bigint & { toFr: () => Fr } | bigint & { toField: () => Fr } | bigint & { toFields: () => Fr[] } | bigint & Fieldable[] | false & Buffer | false & Fr | false & { toFr: () => Fr } | false & { toField: () => Fr } | false & { toFields: () => Fr[] } | false & Fieldable[] | true & Buffer | true & Fr | true & { toFr: () => Fr } | true & { toField: () => Fr } | true & { toFields: () => Fr[] } | true & Fieldable[] | Buffer & number | never | Buffer & false | Buffer & true | Buffer & Fr | Buffer & { toFr: () => Fr } | Buffer & { toField: () => Fr } | Buffer & { toFields: () => Fr[] } | Buffer & Fieldable[] | Uint8Array & number | never | Uint8Array & false | Uint8Array & true | Uint8Array & Buffer | Uint8Array & Fr | Uint8Array & { toFr: () => Fr } | Uint8Array & { toField: () => Fr } | Uint8Array & { toFields: () => Fr[] } | Uint8Array & Fieldable[] | { toBuffer: () => Buffer } & number | { toBuffer: () => Buffer } & bigint | { toBuffer: () => Buffer } & false | { toBuffer: () => Buffer } & true | { toBuffer: () => Buffer } & Buffer | { toBuffer: () => Buffer } & Fr | { toBuffer: () => Buffer } & { toFr: () => Fr } | { toBuffer: () => Buffer } & { toField: () => Fr } | { toBuffer: () => Buffer } & { toFields: () => Fr[] } | { toBuffer: () => Buffer } & Fieldable[] | Bufferable[] & number | Bufferable[] & bigint | Bufferable[] & false | Bufferable[] & true | Bufferable[] & Buffer | Bufferable[] & Fr | Bufferable[] & { toFr: () => Fr } | Bufferable[] & { toField: () => Fr } | Bufferable[] & { toFields: () => Fr[] } | Bufferable[] & Fieldable[], N extends number>(deserializer: { fromFields: (reader: FieldReader) => T }, arrayLength: N) => { fromFields: (reader: FieldReader) => ClaimedLengthArray } ``` ### NullishToUndefined ```typescript function NullishToUndefined(schema: ZodFor) => ZodEffects>>, any, any> ``` ### accumulatePrivateReturnValues ```typescript function accumulatePrivateReturnValues(executionResult: PrivateExecutionResult) => NestedProcessReturnValues ``` Recursively accummulate the return values of a call result and its nested executions, so they can be retrieved in order. ### bigIntToOffense ```typescript function bigIntToOffense(offense: bigint) => OffenseType ``` ### bufferAsFields ```typescript function bufferAsFields(input: Buffer, targetLength: number) => Fr[] ``` Formats a buffer as an array of fields. Splits the input into 31-byte chunks, and stores each of them into a field, omitting the field's first byte, then adds zero-fields at the end until the max length. ### bufferFromFields ```typescript function bufferFromFields(fields: Fr[]) => Buffer ``` Recovers a buffer from an array of fields. ### bufferSchemaFor ```typescript function bufferSchemaFor(klazz: TClass, refinement?: (buf: Buffer) => boolean) => ZodType ``` Creates a schema that accepts a base64 string and uses it to hydrate an instance. ### buildNoteHashReadRequestHints ```typescript function buildNoteHashReadRequestHints(oracle: {}, noteHashReadRequests: ClaimedLengthArray, noteHashes: ClaimedLengthArray, noteHashLeafIndexMap: Map, futureNoteHashes: ScopedNoteHash[], maxPending?: PENDING, maxSettled?: SETTLED) => Promise ``` ### buildNoteHashReadRequestHintsFromResetActions ```typescript function buildNoteHashReadRequestHintsFromResetActions(oracle: {}, noteHashReadRequests: ClaimedLengthArray, noteHashes: ClaimedLengthArray, resetActions: ReadRequestResetActions<64>, noteHashLeafIndexMap: Map, maxPending?: PENDING, maxSettled?: SETTLED) => Promise ``` ### buildNullifierReadRequestHints ```typescript function buildNullifierReadRequestHints(oracle: {}, nullifierReadRequests: ClaimedLengthArray, nullifiers: ClaimedLengthArray, futureNullifiers: ScopedNullifier[], maxPending?: PENDING, maxSettled?: SETTLED, siloed?: boolean) => Promise ``` ### buildNullifierReadRequestHintsFromResetActions ```typescript function buildNullifierReadRequestHintsFromResetActions(oracle: {}, nullifierReadRequests: ClaimedLengthArray, resetActions: ReadRequestResetActions<64>, maxPending?: PENDING, maxSettled?: SETTLED, siloed?: boolean) => Promise ``` ### buildTransientDataHints ```typescript function buildTransientDataHints(noteHashes: ClaimedLengthArray, nullifiers: ClaimedLengthArray, futureNoteHashReads: ScopedReadRequest[], futureNullifierReads: ScopedReadRequest[], noteHashNullifierCounterMap: Map, splitCounter: number) => { hints: Tuple; numTransientData: number } ``` ### checkCompressedComponentVersion ```typescript function checkCompressedComponentVersion(compressed: string, expected: ComponentsVersions) => void ``` Checks if the compressed string matches against the expected versions. Throws on mismatch. ### collectNested ```typescript function collectNested(executionStack: PrivateCallExecutionResult[], extractExecutionItems: (execution: PrivateCallExecutionResult) => T[]) => T[] ``` ### collectNoteHashLeafIndexMap ```typescript function collectNoteHashLeafIndexMap(execResult: PrivateExecutionResult) => Map ``` ### collectNoteHashNullifierCounterMap ```typescript function collectNoteHashNullifierCounterMap(execResult: PrivateExecutionResult) => Map ``` ### collectOffchainEffects ```typescript function collectOffchainEffects(execResult: PrivateExecutionResult) => OffchainEffect[] ``` Collect all offchain effects emitted across all nested executions. ### collectSortedContractClassLogs ```typescript function collectSortedContractClassLogs(execResult: PrivateExecutionResult) => ContractClassLogFields[] ``` Collect all contract class logs across all nested executions and sorts by counter. ### compressComponentVersions ```typescript function compressComponentVersions(versions: ComponentsVersions) => string ``` Returns a compressed string representation of the version (around 32 chars). Used in p2p ENRs. ### computeAddress ```typescript function computeAddress(publicKeys: PublicKeys, partialAddress: Fr) => Promise ``` ### computeAddressSecret ```typescript function computeAddressSecret(preaddress: Fr, ivsk: Fq) => Promise ``` ### computeAppNullifierSecretKey ```typescript function computeAppNullifierSecretKey(masterNullifierSecretKey: Fq, app: AztecAddress) => Promise ``` ### computeAppSecretKey ```typescript function computeAppSecretKey(skM: Fq, app: AztecAddress, keyPrefix: KeyPrefix) => Promise ``` ### computeArtifactFunctionTree ```typescript function computeArtifactFunctionTree(artifact: ContractArtifact, fnType: FunctionType) => Promise ``` ### computeArtifactFunctionTreeRoot ```typescript function computeArtifactFunctionTreeRoot(artifact: ContractArtifact, fnType: FunctionType) => Promise ``` ### computeArtifactHash ```typescript function computeArtifactHash(artifact: ContractArtifact | { metadataHash: Fr; privateFunctionRoot: Fr; utilityFunctionRoot: Fr }) => Promise ``` Returns the artifact hash of a given compiled contract artifact. ``` private_functions_artifact_leaves = artifact.private_functions.map fn => sha256(fn.selector, fn.metadata_hash, sha256(fn.bytecode)) private_functions_artifact_tree_root = merkleize(private_functions_artifact_leaves) utility_functions_artifact_leaves = artifact.utility_functions.map fn => sha256(fn.selector, fn.metadata_hash, sha256(fn.bytecode)) utility_functions_artifact_tree_root = merkleize(utility_functions_artifact_leaves) version = 1 artifact_hash = sha256( version, private_functions_artifact_tree_root, utility_functions_artifact_tree_root, artifact_metadata, ) ``` ### computeArtifactHashPreimage ```typescript function computeArtifactHashPreimage(artifact: ContractArtifact) => Promise<{ metadataHash: Fr; privateFunctionRoot: Fr; utilityFunctionRoot: Fr }> ``` ### computeArtifactMetadataHash ```typescript function computeArtifactMetadataHash(artifact: ContractArtifact) => Fr ``` ### computeBlockHeadersHash ```typescript function computeBlockHeadersHash(blockHeaders: BlockHeader[]) => Promise ``` ### computeBlockOutHash ```typescript function computeBlockOutHash(messagesPerBlock: Fr[][]) => Fr ``` ### computeCalldataHash ```typescript function computeCalldataHash(calldata: Fr[]) => Promise ``` Computes the hash of a public function's calldata. ### computeCheckpointOutHash ```typescript function computeCheckpointOutHash(messagesForAllTxs: Fr[][][]) => Fr ``` ### computeContractAddressFromInstance ```typescript function computeContractAddressFromInstance(instance: ContractInstance | { originalContractClassId: Fr; saltedInitializationHash: Fr } & Pick) => Promise ``` Returns the deployment address for a given contract instance. ``` salted_initialization_hash = pedersen([salt, initialization_hash, deployer], GENERATOR__SALTED_INITIALIZATION_HASH) partial_address = pedersen([contract_class_id, salted_initialization_hash], GENERATOR__CONTRACT_PARTIAL_ADDRESS_V1) address = ((poseidon2Hash([public_keys_hash, partial_address, GENERATOR__CONTRACT_ADDRESS_V1]) * G) + ivpk_m).x <- the x-coordinate of the address point ``` ### computeContractClassId ```typescript function computeContractClassId(contractClass: ContractClass | ContractClassIdPreimage) => Promise ``` Returns the id of a contract class computed as its hash. ``` version = 1 private_function_leaves = private_functions.map(fn => pedersen([fn.function_selector as Field, fn.vk_hash], GENERATOR__FUNCTION_LEAF)) private_functions_root = merkleize(private_function_leaves) bytecode_commitment = calculate_commitment(packed_bytecode) contract_class_id = pedersen([version, artifact_hash, private_functions_root, bytecode_commitment], GENERATOR__CLASS_IDENTIFIER) ``` ### computeContractClassIdPreimage ```typescript function computeContractClassIdPreimage(contractClass: ContractClass) => Promise ``` Returns the preimage of a contract class id given a contract class. ### computeContractClassIdWithPreimage ```typescript function computeContractClassIdWithPreimage(contractClass: ContractClass | ContractClassIdPreimage) => Promise ``` Computes a contract class id and returns it along with its preimage. ### computeEffectiveGasFees ```typescript function computeEffectiveGasFees(gasFees: GasFees, gasSettings: GasSettings) => GasFees ``` Compute the effective gas fees that should be used to compute the transaction fee. This is the sum of the gas fees and the priority fees, but capped at the max fees per gas. ### computeFunctionArtifactHash ```typescript function computeFunctionArtifactHash(fn: FunctionArtifact | Pick & { functionMetadataHash: Fr; selector: FunctionSelector }) => Promise ``` ### computeFunctionMetadataHash ```typescript function computeFunctionMetadataHash(fn: FunctionArtifact) => Fr ``` ### computeInHashFromL1ToL2Messages ```typescript function computeInHashFromL1ToL2Messages(unpaddedL1ToL2Messages: Fr[]) => Fr ``` Computes the inHash for a block's ContentCommitment given its l1 to l2 messages. ### computeInitializationHash ```typescript function computeInitializationHash(initFn: FunctionAbi, args: any[]) => Promise ``` Computes the initialization hash for an instance given its constructor function and arguments. ### computeInitializationHashFromEncodedArgs ```typescript function computeInitializationHashFromEncodedArgs(initFn: FunctionSelector, encodedArgs: Fr[]) => Promise ``` Computes the initialization hash for an instance given its constructor function selector and encoded arguments. ### computeInnerAuthWitHash ```typescript function computeInnerAuthWitHash(args: Fr[]) => Promise ``` ### computeL1ToL2MessageNullifier ```typescript function computeL1ToL2MessageNullifier(contract: AztecAddress, messageHash: Fr, secret: Fr) => Promise ``` ### computeL2ToL1MembershipWitness ```typescript function computeL2ToL1MembershipWitness(messageRetriever: MessageRetrieval, l2BlockNumber: BlockNumber, message: Fr) => Promise ``` ### computeL2ToL1MembershipWitnessFromMessagesForAllTxs ```typescript function computeL2ToL1MembershipWitnessFromMessagesForAllTxs(messagesForAllTxs: Fr[][], message: Fr) => L2ToL1MembershipWitness ``` ### computeL2ToL1MessageHash ```typescript function computeL2ToL1MessageHash(__namedParameters: { chainId: Fr; content: Fr; ... }) => Fr ``` Calculates a siloed hash of a scoped l2 to l1 message. ### computeNoteHashNonce ```typescript function computeNoteHashNonce(nullifierZero: Fr, noteHashIndex: number) => Promise ``` Computes a note hash nonce, which will be used to create a unique note hash. ### computeOuterAuthWitHash ```typescript function computeOuterAuthWitHash(consumer: AztecAddress, chainId: Fr, version: Fr, innerHash: Fr) => Promise ``` ### computeOvskApp ```typescript function computeOvskApp(ovsk: Fq, app: AztecAddress) => Promise ``` ### computePartialAddress ```typescript function computePartialAddress(instance: Pick | { originalContractClassId: Fr; saltedInitializationHash: Fr }) => Promise ``` Computes the partial address defined as the hash of the contract class id and salted initialization hash. ### computePreaddress ```typescript function computePreaddress(publicKeysHash: Fr, partialAddress: Fr) => Promise ``` ### computePrivateFunctionLeaf ```typescript function computePrivateFunctionLeaf(fn: PrivateFunction) => Promise ``` Returns the leaf for a given private function. ### computePrivateFunctionsRoot ```typescript function computePrivateFunctionsRoot(fns: PrivateFunction[]) => Promise ``` Returns the Merkle tree root for the set of private functions in a contract. ### computePrivateFunctionsTree ```typescript function computePrivateFunctionsTree(fns: PrivateFunction[]) => Promise ``` Returns a Merkle tree for the set of private functions in a contract. ### computeProtocolNullifier ```typescript function computeProtocolNullifier(txRequestHash: Fr) => Promise ``` Computes the protocol nullifier, which is the hash of the initial tx request siloed with the null msg sender address. ### computePublicBytecodeCommitment ```typescript function computePublicBytecodeCommitment(packedBytecode: Buffer) => Promise ``` ### computePublicDataTreeLeafSlot ```typescript function computePublicDataTreeLeafSlot(contractAddress: AztecAddress, storageSlot: Fr) => Promise ``` Computes a public data tree index from contract address and storage slot. ### computePublicDataTreeValue ```typescript function computePublicDataTreeValue(value: Fr) => Fr ``` Computes a public data tree value ready for insertion. ### computeSaltedInitializationHash ```typescript function computeSaltedInitializationHash(instance: Pick) => Promise ``` Computes the salted initialization hash for an address, defined as the hash of the salt and initialization hash. ### computeSecretHash ```typescript function computeSecretHash(secret: Fr) => Promise ``` Computes a hash of a secret. ### computeTransactionFee ```typescript function computeTransactionFee(gasFees: GasFees, gasSettings: GasSettings, gasUsed: Gas) => Fr ``` ### computeTxOutHash ```typescript function computeTxOutHash(messages: Fr[]) => Fr ``` ### computeUniqueNoteHash ```typescript function computeUniqueNoteHash(noteNonce: Fr, siloedNoteHash: Fr) => Promise ``` Computes a unique note hash. ### computeVarArgsHash ```typescript function computeVarArgsHash(args: Fr[]) => Promise ``` Computes the hash of a list of arguments. Used for input arguments or return values for private functions, or for authwit creation. ### computeVerificationKeyHash ```typescript function computeVerificationKeyHash(f: FunctionArtifact) => Promise ``` For a given private function, computes the hash of its vk. ### contractArtifactFromBuffer ```typescript function contractArtifactFromBuffer(buffer: Buffer) => ContractArtifact ``` Deserializes a contract artifact from storage. ### contractArtifactToBuffer ```typescript function contractArtifactToBuffer(artifact: ContractArtifact) => Buffer ``` Serializes a contract artifact to a buffer for storage. ### contractClassPublicFromPlainObject ```typescript function contractClassPublicFromPlainObject(obj: any) => ContractClassPublic ``` Creates a ContractClassPublic from a plain object without Zod validation. Suitable for deserializing trusted data (e.g., from C++ via MessagePack). Note: privateFunctions and utilityFunctions are set to empty arrays since C++ does not provide them. ### contractInstanceFromPlainObject ```typescript function contractInstanceFromPlainObject(obj: any) => ContractInstance ``` Creates a ContractInstance from a plain object without Zod validation. Suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### contractInstanceWithAddressFromPlainObject ```typescript function contractInstanceWithAddressFromPlainObject(address: AztecAddress, obj: any) => ContractInstanceWithAddress ``` Creates a ContractInstanceWithAddress from a plain object without Zod validation. Suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### countAccumulatedItems ```typescript function countAccumulatedItems(arr: T[]) => number ``` ### countArgumentsSize ```typescript function countArgumentsSize(abi: FunctionAbi) => number ``` Returns the size of the arguments for a function ABI. ### createAztecNodeAdminClient ```typescript function createAztecNodeAdminClient(url: string, versions?: Partial, fetch?: (host: string, body: unknown, extraHeaders?: Record, noRetry?: boolean) => Promise<{ headers: { get: (header: string) => string | null | undefined }; response: any }>) => AztecNodeAdmin ``` ### createAztecNodeClient ```typescript function createAztecNodeClient(url: string, versions?: Partial, fetch?: (host: string, body: unknown, extraHeaders?: Record, noRetry?: boolean) => Promise<{ headers: { get: (header: string) => string | null | undefined }; response: any }>, batchWindowMS?: number) => AztecNode ``` ### createFileStore ```typescript function createFileStore(config: string, logger?: Logger) => Promise ``` ### createPrivateFunctionMembershipProof ```typescript function createPrivateFunctionMembershipProof(selector: FunctionSelector, artifact: ContractArtifact) => Promise ``` Creates a membership proof for a private function in a contract class, to be verified via `isValidPrivateFunctionMembershipProof`. ### createReadOnlyFileStore ```typescript function createReadOnlyFileStore(config: string, logger?: Logger) => Promise ``` ### createTopicString ```typescript function createTopicString(topicType: TopicType, protocolVersion: string) => string ``` Creates the topic channel identifier string from a given topic type ### createUtilityFunctionMembershipProof ```typescript function createUtilityFunctionMembershipProof(selector: FunctionSelector, artifact: ContractArtifact) => Promise ``` Creates a membership proof for a utility function in a contract class, to be verified via `isValidUtilityFunctionMembershipProof`. ### dataInBlockSchemaFor ```typescript function dataInBlockSchemaFor(schema: T) => z.ZodObject<{ l2BlockHash: z.ZodEffects, string, string>, Buffer, string>, L2BlockHash, string>; l2BlockNumber: z.ZodEffects, z.ZodNumber>, BlockNumber, string | number | bigint> } & { data: T }, "strip", ZodTypeAny, unknown, unknown> ``` ### decodeFromAbi ```typescript function decodeFromAbi(typ: AbiType[], buffer: Fr[]) => AbiDecoded ``` Decodes values in a flattened Field array using a provided ABI. ### decodeFunctionSignature ```typescript function decodeFunctionSignature(name: string, parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]) => string ``` Decodes a function signature from the name and parameters. ### decodeFunctionSignatureWithParameterNames ```typescript function decodeFunctionSignatureWithParameterNames(name: string, parameters: { name: string; type: AbiType } & { visibility: "public" | "private" | "databus" }[]) => string ``` Decodes a function signature from the name and parameters including parameter names. ### deriveEcdhSharedSecret ```typescript function deriveEcdhSharedSecret(secretKey: Fq, publicKey: Point) => Promise ``` Derive an Elliptic Curve Diffie-Hellman (ECDH) Shared Secret. The function takes in an ECDH public key, a private key, and a Grumpkin instance to compute the shared secret. ### deriveKeys ```typescript function deriveKeys(secretKey: Fr) => Promise<{ masterIncomingViewingSecretKey: Fq; masterNullifierSecretKey: Fq; ... }> ``` Computes secret and public keys and public keys hash from a secret key. ### deriveMasterIncomingViewingSecretKey ```typescript function deriveMasterIncomingViewingSecretKey(secretKey: Fr) => GrumpkinScalar ``` ### deriveMasterNullifierSecretKey ```typescript function deriveMasterNullifierSecretKey(secretKey: Fr) => GrumpkinScalar ``` ### deriveMasterOutgoingViewingSecretKey ```typescript function deriveMasterOutgoingViewingSecretKey(secretKey: Fr) => GrumpkinScalar ``` ### derivePublicKeyFromSecretKey ```typescript function derivePublicKeyFromSecretKey(secretKey: Fq) => Promise ``` ### deriveSigningKey ```typescript function deriveSigningKey(secretKey: Fr) => GrumpkinScalar ``` ### deriveStorageSlotInMap ```typescript function deriveStorageSlotInMap(mapSlot: bigint | Fr, key: { toField: () => Fr }) => Promise ``` Computes the resulting storage slot for an entry in a map. ### deserializeBlockInfo ```typescript function deserializeBlockInfo(buffer: Buffer | BufferReader) => L2BlockInfo ``` ### deserializeFromMessagePack ```typescript function deserializeFromMessagePack(buffer: Buffer) => any ``` ### deserializeIndexedTxEffect ```typescript function deserializeIndexedTxEffect(buffer: Buffer) => IndexedTxEffect ``` ### deserializeOffense ```typescript function deserializeOffense(buffer: Buffer) => Offense ``` ### deserializeSlashPayload ```typescript function deserializeSlashPayload(buffer: Buffer) => SlashPayload ``` ### deserializeSlashPayloadRound ```typescript function deserializeSlashPayloadRound(buffer: Buffer) => SlashPayloadRound ``` ### deserializeValidateBlockResult ```typescript function deserializeValidateBlockResult(bufferOrReader: Buffer | BufferReader) => ValidateBlockResult ``` ### downloadSnapshot ```typescript function downloadSnapshot(snapshot: Pick, localPaths: Record<"archiver" | "nullifier-tree" | "public-data-tree" | "note-hash-tree" | "archive-tree" | "l1-to-l2-message-tree", string>, store: ReadOnlyFileStore) => Promise ``` ### emptyContractArtifact ```typescript function emptyContractArtifact() => ContractArtifact ``` ### emptyFunctionAbi ```typescript function emptyFunctionAbi() => FunctionAbi ``` ### emptyFunctionArtifact ```typescript function emptyFunctionArtifact() => FunctionArtifact ``` ### encodeArguments ```typescript function encodeArguments(abi: FunctionAbi, args: any[]) => Fr[] ``` Encodes all the arguments for a function call. ### encodeSlashConsensusVotes ```typescript function encodeSlashConsensusVotes(votes: number[]) => Buffer ``` Encodes a set of slash votes into a Buffer for use in a consensus slashing vote transaction. Each vote is represented as a 2-bit value, which represents how many slashing units the validator should be slashed. ### enhanceProofWithPiValidationFlag ```typescript function enhanceProofWithPiValidationFlag(proof: Fr[], skipPublicInputsValidation: boolean) => Fr[] ``` ### equalL2Blocks ```typescript function equalL2Blocks(a: any, b: any) => boolean | undefined ``` Checks if two objects are the same L2Block. Sometimes we might be comparing two L2Block instances that represent the same block but one of them might not have calculated and filled its `blockHash` property (which is computed on demand). This function ensures both objects are really the same L2Block. ### findPrivateKernelResetDimensions ```typescript function findPrivateKernelResetDimensions(requestedDimensions: PrivateKernelResetDimensions, config: PrivateKernelResetDimensionsConfig, isInner?: boolean, allowRemainder?: boolean) => PrivateKernelResetDimensions ``` ### fr ```typescript function fr(n: number) => Fr ``` Since the max value check is currently disabled this function is pointless. Should it be removed? Test only. Easy to identify big endian field serialize. ### gasUsedFromPlainObject ```typescript function gasUsedFromPlainObject(obj: any) => GasUsed ``` Creates a GasUsed from a plain object without Zod validation. This method is optimized for performance and skips validation, making it suitable for deserializing trusted data (e.g., from C++ via MessagePack). ### getAllFunctionAbis ```typescript function getAllFunctionAbis(artifact: ContractArtifact) => FunctionAbi[] ``` Gets all function abis ### getArtifactMerkleTreeHasher ```typescript function getArtifactMerkleTreeHasher() => (l: Buffer, r: Buffer) => Promise> ``` ### getAttestationInfoFromPayload ```typescript function getAttestationInfoFromPayload(payload: ConsensusPayload, attestations: CommitteeAttestation[]) => AttestationInfo[] ``` ### getAttestationInfoFromPublishedL2Block ```typescript function getAttestationInfoFromPublishedL2Block(block: { attestations: CommitteeAttestation[]; block: L2Block }) => AttestationInfo[] ``` Extracts attestation information from a published L2 block. Returns info for each attestation, preserving array indices. ### getBasePath ```typescript function getBasePath(metadata: SnapshotsIndexMetadata) => string ``` ### getBenchmarkContractArtifact ```typescript function getBenchmarkContractArtifact() => ContractArtifact ``` ### getComponentsVersionsFromConfig ```typescript function getComponentsVersionsFromConfig(config: ChainConfig, l2ProtocolContractsHash: string | Fr, l2CircuitsVkTreeRoot: string | Fr) => ComponentsVersions ``` Returns components versions from chain config. ### getContractClassFromArtifact ```typescript function getContractClassFromArtifact(artifact: ContractArtifact | ContractArtifactWithHash) => Promise ``` Creates a ContractClass from a contract compilation artifact. ### getContractClassPrivateFunctionFromArtifact ```typescript function getContractClassPrivateFunctionFromArtifact(f: FunctionArtifact) => Promise ``` ### getContractInstanceFromInstantiationParams ```typescript function getContractInstanceFromInstantiationParams(artifact: ContractArtifact, opts: ContractInstantiationData) => Promise ``` Generates a Contract Instance from some instantiation params. ### getDefaultInitializer ```typescript function getDefaultInitializer(contractArtifact: ContractArtifact) => FunctionAbi | undefined ``` Returns an initializer from the contract, assuming there is at least one. If there are multiple initializers, it returns the one named "constructor" or "initializer"; if there is none with that name, it returns the first initializer it finds, prioritizing initializers with no arguments and then private ones. ### getEpochAtSlot ```typescript function getEpochAtSlot(slot: SlotNumber, constants: Pick) => EpochNumber ``` Returns the epoch number for a given slot. ### getEpochForOffense ```typescript function getEpochForOffense(offense: Pick, constants: Pick) => bigint ``` Returns the epoch for a given offense. If the offense type or epoch is not defined, returns undefined. ### getEpochFromProvingJobId ```typescript function getEpochFromProvingJobId(id: string) => EpochNumber ``` ### getEpochNumberAtTimestamp ```typescript function getEpochNumberAtTimestamp(ts: bigint, constants: Pick) => EpochNumber ``` Returns the epoch number for a given timestamp. ### getEpochsForRound ```typescript function getEpochsForRound(round: bigint, constants: { epochDuration: number; slashingRoundSize: number }) => EpochNumber[] ``` Returns the epochs spanned during a given slashing round ### getFinalMinRevertibleSideEffectCounter ```typescript function getFinalMinRevertibleSideEffectCounter(execResult: PrivateExecutionResult) => number ``` ### getFirstEligibleRoundForOffense ```typescript function getFirstEligibleRoundForOffense(offense: OffenseIdentifier, constants: { epochDuration: number; proofSubmissionEpochs: number; slashingRoundSize: number }) => bigint ``` Returns the first round in which the offense is eligible for being included in an Empire-based slash payload. Should be equal to to the first round that starts strictly after the offense becomes detectable. ### getFunctionArtifact ```typescript function getFunctionArtifact(artifact: ContractArtifact, functionNameOrSelector: string | FunctionSelector) => Promise ``` Gets a function artifact including debug metadata given its name or selector. ### getFunctionArtifactByName ```typescript function getFunctionArtifactByName(artifact: ContractArtifact, functionName: string) => FunctionArtifact ``` ### getFunctionDebugMetadata ```typescript function getFunctionDebugMetadata(contractArtifact: ContractArtifact, functionArtifact: FunctionArtifact) => FunctionDebugMetadata | undefined ``` Gets the debug metadata of a given function from the contract artifact ### getHashedSignaturePayload ```typescript function getHashedSignaturePayload(s: Signable, domainSeparator: SignatureDomainSeparator) => Buffer32 ``` Get the hashed payload for the signature of the `Signable` ### getHashedSignaturePayloadEthSignedMessage ```typescript function getHashedSignaturePayloadEthSignedMessage(s: Signable, domainSeparator: SignatureDomainSeparator) => Buffer32 ``` Get the hashed payload for the signature of the `Signable` as an Ethereum signed message EIP-712 ### getInitializer ```typescript function getInitializer(contract: ContractArtifact, initializerNameOrArtifact: string | FunctionArtifact) => FunctionAbi | undefined ``` Returns an initializer from the contract. ### getKeyGenerator ```typescript function getKeyGenerator(prefix: KeyPrefix) => KeyGenerator ``` ### getL2ToL1MessageLeafId ```typescript function getL2ToL1MessageLeafId(membershipWitness: Pick) => bigint ``` ### getLatestSnapshotMetadata ```typescript function getLatestSnapshotMetadata(metadata: SnapshotsIndexMetadata, store: ReadOnlyFileStore) => Promise ``` ### getNonNullifiedL1ToL2MessageWitness ```typescript function getNonNullifiedL1ToL2MessageWitness(node: AztecNode, contractAddress: AztecAddress, messageHash: Fr, secret: Fr) => Promise<[]> ``` ### getNoteHashReadRequestResetActions ```typescript function getNoteHashReadRequestResetActions(noteHashReadRequests: ClaimedLengthArray, noteHashes: ClaimedLengthArray, futureNoteHashes: ScopedNoteHash[]) => ReadRequestResetActions ``` ### getNullifierReadRequestResetActions ```typescript function getNullifierReadRequestResetActions(nullifierReadRequests: ClaimedLengthArray, nullifiers: ClaimedLengthArray, futureNullifiers: ScopedNullifier[]) => ReadRequestResetActions ``` ### getOffenseIdentifiersFromPayload ```typescript function getOffenseIdentifiersFromPayload(payload: SlashPayload | SlashPayloadRound) => OffenseIdentifier[] ``` Extracts offense identifiers (validator, epoch, offense type) from an Empire-based SlashPayload ### getOffenseTypeName ```typescript function getOffenseTypeName(offense: OffenseType) => "attested_descendant_of_invalid" | "broadcasted_invalid_block_proposal" | "data_withholding" | "inactivity" | "proposed_incorrect_attestations" | "proposed_insufficient_attestations" | "unknown" | "valid_epoch_pruned" ``` ### getPackageVersion ```typescript function getPackageVersion() => string | undefined ``` Returns package version. ### getPathToFixture ```typescript function getPathToFixture(name: string) => string ``` ### getPenaltyForOffense ```typescript function getPenaltyForOffense(offense: OffenseType, config: Pick) => bigint ``` Reads the configured penalty for a given offense type from a slasher config struct ### getProofSubmissionDeadlineEpoch ```typescript function getProofSubmissionDeadlineEpoch(epochNumber: EpochNumber, constants: Pick) => EpochNumber ``` Returns the epoch number at which proofs are no longer accepted for a given epoch. See l1-contracts/src/core/libraries/TimeLib.sol ### getProofSubmissionDeadlineTimestamp ```typescript function getProofSubmissionDeadlineTimestamp(epochNumber: EpochNumber, constants: Pick) => bigint ``` Returns the deadline timestamp (in seconds) for submitting a proof for a given epoch. Computed as the start of the given epoch plus the proof submission window. ### getProvingJobInputClassFor ```typescript function getProvingJobInputClassFor(type: ProvingRequestType) => typeof AvmCircuitInputs | typeof ParityBasePrivateInputs | typeof ParityRootPrivateInputs | typeof BlockMergeRollupPrivateInputs | typeof BlockRootFirstRollupPrivateInputs | typeof BlockRootSingleTxFirstRollupPrivateInputs | typeof BlockRootEmptyTxFirstRollupPrivateInputs | typeof BlockRootRollupPrivateInputs | typeof BlockRootSingleTxRollupPrivateInputs | typeof PrivateTxBaseRollupPrivateInputs | typeof PublicTxBaseRollupPrivateInputs | typeof TxMergeRollupPrivateInputs | typeof CheckpointMergeRollupPrivateInputs | typeof CheckpointRootRollupPrivateInputs | typeof CheckpointRootSingleBlockRollupPrivateInputs | typeof CheckpointPaddingRollupPrivateInputs | typeof PublicChonkVerifierPrivateInputs ``` ### getRoundForOffense ```typescript function getRoundForOffense(offense: Pick, constants: { epochDuration: number; slashingRoundSize: number }) => bigint ``` Returns the slashing round in which a given offense occurred. ### getRoundForSlot ```typescript function getRoundForSlot(slot: SlotNumber, constants: { slashingRoundSize: number }) => { round: bigint; votingSlot: SlotNumber } ``` Returns the voting round number and voting slot within the round for a given L2 slot. ### getRoundsForEpoch ```typescript function getRoundsForEpoch(epoch: EpochNumber, constants: { epochDuration: number; slashingRoundSize: number }) => [] ``` Returns the voting round(s) lower and upper bounds (inclusive) covered by the given epoch ### getSlashConsensusVotesFromOffenses ```typescript function getSlashConsensusVotesFromOffenses(offenses: PartialBy[], committees: EthAddress[][], epochsForCommittees: bigint[], settings: { epochDuration: number; slashingAmounts: [] }) => ValidatorSlashVote[] ``` Creates a consensus-slash vote for a given set of committees based on a set of Offenses ### getSlotAtTimestamp ```typescript function getSlotAtTimestamp(ts: bigint, constants: Pick) => SlotNumber ``` Returns the slot number for a given timestamp. ### getSlotForOffense ```typescript function getSlotForOffense(offense: Pick, constants: Pick) => SlotNumber ``` Returns the slot for a given offense. If the offense references an epoch, returns the first slot of the epoch. ### getSlotRangeForEpoch ```typescript function getSlotRangeForEpoch(epochNumber: EpochNumber, constants: Pick) => [] ``` Returns the range of L2 slots (inclusive) for a given epoch number. ### getSlotStartBuildTimestamp ```typescript function getSlotStartBuildTimestamp(slotNumber: SlotNumber, constants: Pick) => number ``` Returns the timestamp to start building a block for a given L2 slot. Computed as the start timestamp of the slot minus one L1 slot duration. ### getSnapshotIndex ```typescript function getSnapshotIndex(metadata: SnapshotsIndexMetadata, store: ReadOnlyFileStore) => Promise ``` ### getSnapshotIndexPath ```typescript function getSnapshotIndexPath(metadata: SnapshotsIndexMetadata) => string ``` ### getStartTimestampForEpoch ```typescript function getStartTimestampForEpoch(epochNumber: EpochNumber, constants: Pick) => bigint ``` Returns the start timestamp for a given epoch number. ### getTestContractArtifact ```typescript function getTestContractArtifact() => ContractArtifact ``` ### getTimeUnitForOffense ```typescript function getTimeUnitForOffense(offense: OffenseType) => "epoch" | "slot" ``` Returns whether the `epochOrSlot` field for an offense references an epoch or a slot ### getTimestampForSlot ```typescript function getTimestampForSlot(slot: SlotNumber, constants: Pick) => bigint ``` Returns the timestamp for a given L2 slot. ### getTimestampRangeForEpoch ```typescript function getTimestampRangeForEpoch(epochNumber: EpochNumber, constants: Pick) => [] ``` Returns the range of L1 timestamps (inclusive) for a given epoch number. Note that the endTimestamp is the start timestamp of the last L1 slot for the epoch. ### getTokenContractArtifact ```typescript function getTokenContractArtifact() => ContractArtifact ``` ### getTopicFromString ```typescript function getTopicFromString(topicStr: string) => TopicType | undefined ``` Extracts the topic type from a topic string ### getTopicTypeForClientType ```typescript function getTopicTypeForClientType(clientType: P2PClientType) => TopicType[] ``` ### getTopicsForClientAndConfig ```typescript function getTopicsForClientAndConfig(clientType: P2PClientType, disableTransactions: boolean) => TopicType[] ``` ### getTreeHeight ```typescript function getTreeHeight(treeId: TID) => TreeHeights[TID] ``` ### getTreeName ```typescript function getTreeName(treeId: TID) => typeof TREE_NAMES[TID] ``` ### getTxHash ```typescript function getTxHash(tx: AnyTx) => TxHash ``` ### getVersioningMiddleware ```typescript function getVersioningMiddleware(versions: Partial) => (ctx: Koa.Context, next: () => Promise) => Promise ``` Returns a Koa middleware that injects the versioning info as headers. ### getVersioningResponseHandler ```typescript function getVersioningResponseHandler(versions: Partial) => ({ headers }: { headers: { get: (header: string) => string | null | undefined } }) => Promise ``` Returns a json rpc client handler that rejects responses with mismatching versions. ### hasPublicCalls ```typescript function hasPublicCalls(tx: AnyTx) => boolean ``` ### hashVK ```typescript function hashVK(keyAsFields: Fr[]) => Promise ``` Computes a hash of a given verification key. ### hexSchemaFor ```typescript function hexSchemaFor(klazz: TClass, refinement?: (input: string) => boolean) => ZodType ``` Creates a schema that accepts a hex string and uses it to hydrate an instance. ### inBlockSchema ```typescript function inBlockSchema() => z.ZodObject<{ l2BlockHash: z.ZodEffects, string, string>, Buffer, string>, L2BlockHash, string>; l2BlockNumber: z.ZodEffects, z.ZodNumber>, BlockNumber, string | number | bigint> }, "strip", ZodTypeAny, { l2BlockHash: L2BlockHash; l2BlockNumber: number & { _branding: "BlockNumber" } }, { l2BlockHash: string; l2BlockNumber: string | number | bigint }> ``` ### inTxSchema ```typescript function inTxSchema() => z.ZodIntersection, string, string>, Buffer, string>, L2BlockHash, string>; l2BlockNumber: z.ZodEffects, z.ZodNumber>, BlockNumber, string | number | bigint> }, "strip", z.ZodTypeAny, { l2BlockHash: L2BlockHash; l2BlockNumber: number & { _branding: "BlockNumber" } }, { l2BlockHash: string; l2BlockNumber: string | number | bigint }>, z.ZodObject<{ txHash: z.ZodEffects, string, string>, Buffer, string>, TxHash, string> }, "strip", z.ZodTypeAny, { txHash: TxHash }, { txHash: string }>> ``` ### indexedTxSchema ```typescript function indexedTxSchema() => ZodObject ``` ### inspectTree ```typescript function inspectTree(db: MerkleTreeReadOperations, treeId: MerkleTreeId, log?: Logger) => Promise ``` Outputs a tree leaves using for debugging purposes. ### isAddressStruct ```typescript function isAddressStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is an Aztec or Ethereum Address defined in Aztec.nr. ### isAztecAddressStruct ```typescript function isAztecAddressStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is an Aztec Address defined in Aztec.nr. ### isBoundedVecStruct ```typescript function isBoundedVecStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is a BoundedVec struct from Noir's std::collections::bounded_vec. ### isEthAddressStruct ```typescript function isEthAddressStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is an Ethereum Address defined in Aztec.nr. ### isFunctionSelectorStruct ```typescript function isFunctionSelectorStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is an Function Selector defined in Aztec.nr. ### isNoirCallStackUnresolved ```typescript function isNoirCallStackUnresolved(callStack: NoirCallStack) => boolean ``` Checks if a call stack is unresolved. ### isNoirContractCompilationArtifacts ```typescript function isNoirContractCompilationArtifacts(artifact: NoirCompilationResult) => boolean ``` Check if it has Contract unique property ### isNoirProgramCompilationArtifacts ```typescript function isNoirProgramCompilationArtifacts(artifact: NoirCompilationResult) => boolean ``` Check if it has Contract unique property ### isOffenseUncontroversial ```typescript function isOffenseUncontroversial(offense: OffenseType) => boolean ``` Returns true if the offense is uncontroversial as in it can be verified via L1 data alone, and does not depend on the local view of the node of the L2 p2p network. ### isValidNoteHashReadRequest ```typescript function isValidNoteHashReadRequest(readRequest: ScopedReadRequest, noteHash: ScopedNoteHash) => boolean ``` ### isValidNullifierReadRequest ```typescript function isValidNullifierReadRequest(readRequest: ScopedReadRequest, nullifier: ScopedNullifier) => boolean ``` ### isValidPrivateFunctionMembershipProof ```typescript function isValidPrivateFunctionMembershipProof(fn: ExecutablePrivateFunctionWithMembershipProof, contractClass: Pick) => Promise ``` Verifies that a private function with a membership proof as emitted by the ClassRegistry contract is valid, as defined in the protocol specs at contract-deployment/classes: ``` // Load contract class from local db contract_class = db.get_contract_class(contract_class_id) // Compute function leaf and assert it belongs to the private functions tree function_leaf = pedersen([selector as Field, vk_hash], GENERATOR__FUNCTION_LEAF) computed_private_function_tree_root = compute_root(function_leaf, private_function_tree_sibling_path) assert computed_private_function_tree_root == contract_class.private_functions_root // Compute artifact leaf and assert it belongs to the artifact artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode)) computed_artifact_private_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path) computed_artifact_hash = sha256(computed_artifact_private_function_tree_root, utility_functions_artifact_tree_root, artifact_metadata_hash) assert computed_artifact_hash == contract_class.artifact_hash ``` ### isValidUtilityFunctionMembershipProof ```typescript function isValidUtilityFunctionMembershipProof(fn: UtilityFunctionWithMembershipProof, contractClass: Pick) => Promise ``` Verifies that a utility function with a membership proof as emitted by the ClassRegistry contract is valid, as defined in the protocol specs at contract-deployment/classes: ``` // Load contract class from local db contract_class = db.get_contract_class(contract_class_id) // Compute artifact leaf and assert it belongs to the artifact artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode)) computed_artifact_utility_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path, artifact_function_tree_leaf_index) computed_artifact_hash = sha256(private_functions_artifact_tree_root, computed_artifact_utility_function_tree_root, artifact_metadata_hash) assert computed_artifact_hash == contract_class.artifact_hash ``` ### isWrappedFieldStruct ```typescript function isWrappedFieldStruct(abiType: AbiType) => boolean ``` Returns whether the ABI type is a struct with a single `inner` field. ### loadContractArtifact ```typescript function loadContractArtifact(input: NoirCompiledContract) => ContractArtifact ``` Gets nargo build output and returns a valid contract artifact instance. Does not include public bytecode, apart from the public_dispatch function. ### loadContractArtifactForPublic ```typescript function loadContractArtifactForPublic(input: NoirCompiledContract) => ContractArtifact ``` Gets nargo build output and returns a valid contract artifact instance. Differs from loadContractArtifact() by retaining all bytecode. ### makeAndSignCommitteeAttestationsAndSigners ```typescript function makeAndSignCommitteeAttestationsAndSigners(attestationsAndSigners: CommitteeAttestationsAndSigners, signer?: Secp256k1Signer) => Signature ``` ### makeAppendOnlyTreeSnapshot ```typescript function makeAppendOnlyTreeSnapshot(seed?: number) => AppendOnlyTreeSnapshot ``` Makes arbitrary append only tree snapshot. ### makeArray ```typescript function makeArray(length: number, fn: (i: number) => T, offset?: number) => T[] ``` ### makeArrayAsync ```typescript function makeArrayAsync(length: number, fn: (i: number) => Promise, offset?: number) => Promise[]> ``` ### makeAttestationFromCheckpoint ```typescript function makeAttestationFromCheckpoint(checkpoint: Checkpoint, attesterSigner?: Secp256k1Signer, proposerSigner?: Secp256k1Signer) => BlockAttestation ``` ### makeAvmAppendLeavesHint ```typescript function makeAvmAppendLeavesHint(seed?: number) => AvmAppendLeavesHint ``` ### makeAvmBytecodeCommitmentHint ```typescript function makeAvmBytecodeCommitmentHint(seed?: number) => Promise ``` ### makeAvmCheckpointActionCommitCheckpointHint ```typescript function makeAvmCheckpointActionCommitCheckpointHint(seed?: number) => AvmCommitCheckpointHint ``` ### makeAvmCheckpointActionCreateCheckpointHint ```typescript function makeAvmCheckpointActionCreateCheckpointHint(seed?: number) => AvmCreateCheckpointHint ``` ### makeAvmCheckpointActionRevertCheckpointHint ```typescript function makeAvmCheckpointActionRevertCheckpointHint(seed?: number) => AvmRevertCheckpointHint ``` ### makeAvmCircuitInputs ```typescript function makeAvmCircuitInputs(seed?: number, overrides?: Partial>) => Promise ``` Creates arbitrary AvmCircuitInputs. ### makeAvmContractClassHint ```typescript function makeAvmContractClassHint(seed?: number) => AvmContractClassHint ``` ### makeAvmContractDbCheckpointActionCommitCheckpointHint ```typescript function makeAvmContractDbCheckpointActionCommitCheckpointHint(seed?: number) => AvmContractDbCommitCheckpointHint ``` ### makeAvmContractDbCheckpointActionCreateCheckpointHint ```typescript function makeAvmContractDbCheckpointActionCreateCheckpointHint(seed?: number) => AvmContractDbCreateCheckpointHint ``` ### makeAvmContractDbCheckpointActionRevertCheckpointHint ```typescript function makeAvmContractDbCheckpointActionRevertCheckpointHint(seed?: number) => AvmContractDbRevertCheckpointHint ``` ### makeAvmContractInstanceHint ```typescript function makeAvmContractInstanceHint(seed?: number) => AvmContractInstanceHint ``` Makes arbitrary AvmContractInstanceHint. ### makeAvmDebugFunctionNameHint ```typescript function makeAvmDebugFunctionNameHint(seed?: number) => AvmDebugFunctionNameHint ``` Makes arbitrary AvmDebugFunctionNameHint. ### makeAvmExecutionHints ```typescript function makeAvmExecutionHints(seed?: number, overrides?: Partial>) => Promise ``` Creates arbitrary AvmExecutionHints. ### makeAvmGetLeafPreimageHintNullifierTree ```typescript function makeAvmGetLeafPreimageHintNullifierTree(seed?: number) => AvmGetLeafPreimageHintNullifierTree ``` ### makeAvmGetLeafPreimageHintPublicDataTree ```typescript function makeAvmGetLeafPreimageHintPublicDataTree(seed?: number) => AvmGetLeafPreimageHintPublicDataTree ``` ### makeAvmGetLeafValueHint ```typescript function makeAvmGetLeafValueHint(seed?: number) => AvmGetLeafValueHint ``` ### makeAvmGetPreviousValueIndexHint ```typescript function makeAvmGetPreviousValueIndexHint(seed?: number) => AvmGetPreviousValueIndexHint ``` ### makeAvmGetSiblingPathHint ```typescript function makeAvmGetSiblingPathHint(seed?: number) => AvmGetSiblingPathHint ``` ### makeAvmSequentialInsertHintNullifierTree ```typescript function makeAvmSequentialInsertHintNullifierTree(seed?: number) => AvmSequentialInsertHintNullifierTree ``` ### makeAvmSequentialInsertHintPublicDataTree ```typescript function makeAvmSequentialInsertHintPublicDataTree(seed?: number) => AvmSequentialInsertHintPublicDataTree ``` ### makeAvmTxHint ```typescript function makeAvmTxHint(seed?: number) => Promise ``` ### makeAztecAddress ```typescript function makeAztecAddress(seed?: number) => AztecAddress ``` Makes arbitrary aztec address. ### makeBlockAttestation ```typescript function makeBlockAttestation(options?: MakeConsensusPayloadOptions) => BlockAttestation ``` ### makeBlockAttestationFromBlock ```typescript function makeBlockAttestationFromBlock(block: L2Block, attesterSigner?: Secp256k1Signer, proposerSigner?: Secp256k1Signer) => BlockAttestation ``` ### makeBlockAttestationFromPayload ```typescript function makeBlockAttestationFromPayload(payload: ConsensusPayload, attesterSigner?: Secp256k1Signer, proposerSigner?: Secp256k1Signer) => BlockAttestation ``` ### makeBlockHeader ```typescript function makeBlockHeader(seed?: number, overrides?: Partial>> & Partial>) => BlockHeader ``` ### makeBlockMergeRollupPrivateInputs ```typescript function makeBlockMergeRollupPrivateInputs(seed?: number) => BlockMergeRollupPrivateInputs ``` Makes arbitrary block merge rollup inputs. ### makeBlockProposal ```typescript function makeBlockProposal(options?: MakeConsensusPayloadOptions) => BlockProposal ``` ### makeBlockRollupPublicInputs ```typescript function makeBlockRollupPublicInputs(seed?: number) => BlockRollupPublicInputs ``` Makes arbitrary block merge or block root rollup circuit public inputs. ### makeBlockRootFirstRollupPrivateInputs ```typescript function makeBlockRootFirstRollupPrivateInputs(seed?: number) => BlockRootFirstRollupPrivateInputs ``` ### makeBlockRootSingleTxRollupPrivateInputs ```typescript function makeBlockRootSingleTxRollupPrivateInputs(seed?: number) => BlockRootSingleTxRollupPrivateInputs ``` ### makeBytes ```typescript function makeBytes(size?: number, fill?: number) => Buffer ``` Creates a buffer of a given size filled with a given value. ### makeCallContext ```typescript function makeCallContext(seed?: number, overrides?: Partial>) => CallContext ``` Creates arbitrary call context. ### makeCheckpointHeader ```typescript function makeCheckpointHeader(seed?: number) => CheckpointHeader ``` ### makeCheckpointRollupPublicInputs ```typescript function makeCheckpointRollupPublicInputs(seed?: number) => CheckpointRollupPublicInputs ``` ### makeContentCommitment ```typescript function makeContentCommitment(seed?: number) => ContentCommitment ``` Makes content commitment ### makeContractClassLog ```typescript function makeContractClassLog(seed?: number) => ContractClassLog ``` ### makeContractClassPublic ```typescript function makeContractClassPublic(seed?: number, publicBytecode?: Buffer) => Promise ``` ### makeContractDeploymentData ```typescript function makeContractDeploymentData(seed?: number) => ContractDeploymentData ``` ### makeContractInstanceFromClassId ```typescript function makeContractInstanceFromClassId(classId: Fr, seed?: number, overrides?: { currentClassId?: Fr; deployer?: AztecAddress; ... }) => Promise ``` ### makeContractStorageRead ```typescript function makeContractStorageRead(seed?: number) => ContractStorageRead ``` Creates arbitrary contract storage read. ### makeContractStorageUpdateRequest ```typescript function makeContractStorageUpdateRequest(seed?: number) => ContractStorageUpdateRequest ``` Creates arbitrary contract storage update request. ### makeEmptyProof ```typescript function makeEmptyProof() => Proof ``` Makes an empty proof. Note: Used for local devnet milestone where we are not proving anything yet. ### makeEmptyPublicDataRead ```typescript function makeEmptyPublicDataRead() => PublicDataRead ``` Creates empty public data read. ### makeEmptyRecursiveProof ```typescript function makeEmptyRecursiveProof(size: N) => RecursiveProof ``` Makes an empty proof. Note: Used for local devnet milestone where we are not proving anything yet. ### makeEthAddress ```typescript function makeEthAddress(seed?: number) => EthAddress ``` Makes arbitrary eth address. ### makeExecutablePrivateFunctionWithMembershipProof ```typescript function makeExecutablePrivateFunctionWithMembershipProof(seed?: number) => ExecutablePrivateFunctionWithMembershipProof ``` ### makeGas ```typescript function makeGas(seed?: number) => Gas ``` ### makeGasSettings ```typescript function makeGasSettings() => GasSettings ``` Creates a default instance of gas settings. No seed value is used to ensure we allocate a sensible amount of gas for testing. ### makeGlobalVariables ```typescript function makeGlobalVariables(seed?: number, overrides?: Partial>) => GlobalVariables ``` ### makeGrumpkinScalar ```typescript function makeGrumpkinScalar(seed?: number) => GrumpkinScalar ``` Creates an arbitrary grumpkin scalar. ### makeL2BlockHeader ```typescript function makeL2BlockHeader(seed?: number, blockNumber?: number, slotNumber?: number, overrides?: Partial>) => L2BlockHeader ``` ### makeL2BlockId ```typescript function makeL2BlockId(number: BlockNumber, hash?: string) => L2BlockId ``` Creates an L2 block id ### makeL2ToL1Message ```typescript function makeL2ToL1Message(seed?: number) => L2ToL1Message ``` Makes arbitrary L2 to L1 message. ### makeMap ```typescript function makeMap(size: number, fn: (i: number) => [], offset?: number) => Map ``` ### makeMapAsync ```typescript function makeMapAsync(size: number, fn: (i: number) => Promise<[]>, offset?: number) => Promise> ``` ### makeMembershipWitness ```typescript function makeMembershipWitness(size: N, start: number) => MembershipWitness ``` Creates arbitrary/mocked membership witness where the sibling paths is an array of fields in an ascending order starting from `start`. ### makeNullifierLeaf ```typescript function makeNullifierLeaf(seed?: number) => NullifierLeaf ``` Makes arbitrary nullifier leaf. ### makeNullifierLeafPreimage ```typescript function makeNullifierLeafPreimage(seed?: number) => NullifierLeafPreimage ``` Makes arbitrary nullifier leaf preimages. ### makeParityBasePrivateInputs ```typescript function makeParityBasePrivateInputs(seed?: number) => ParityBasePrivateInputs ``` ### makeParityPublicInputs ```typescript function makeParityPublicInputs(seed?: number) => ParityPublicInputs ``` ### makeParityRootPrivateInputs ```typescript function makeParityRootPrivateInputs(seed?: number) => ParityRootPrivateInputs ``` ### makePartialStateReference ```typescript function makePartialStateReference(seed?: number) => PartialStateReference ``` Makes arbitrary partial state reference. ### makePoint ```typescript function makePoint(seed?: number) => Point ``` Creates an arbitrary point in a curve. ### makePrivateCircuitPublicInputs ```typescript function makePrivateCircuitPublicInputs(seed?: number) => PrivateCircuitPublicInputs ``` Makes arbitrary private circuit public inputs. ### makePrivateKernelTailCircuitPublicInputs ```typescript function makePrivateKernelTailCircuitPublicInputs(seed?: number, isForPublic?: boolean) => PrivateKernelTailCircuitPublicInputs ``` Creates arbitrary private kernel tail circuit public inputs. ### makePrivateToPublicAccumulatedData ```typescript function makePrivateToPublicAccumulatedData(seed?: number, __namedParameters?: { numContractClassLogs?: number; numEnqueuedCalls?: number; ... }) => PrivateToPublicAccumulatedData ``` ### makePrivateToPublicKernelCircuitPublicInputs ```typescript function makePrivateToPublicKernelCircuitPublicInputs(seed?: number) => PrivateToPublicKernelCircuitPublicInputs ``` ### makePrivateToRollupAccumulatedData ```typescript function makePrivateToRollupAccumulatedData(seed?: number, __namedParameters?: { numContractClassLogs?: number; numL2ToL1Messages?: number; ... }) => PrivateToRollupAccumulatedData ``` Creates arbitrary accumulated data. ### makePrivateToRollupKernelCircuitPublicInputs ```typescript function makePrivateToRollupKernelCircuitPublicInputs(seed?: number) => PrivateToRollupKernelCircuitPublicInputs ``` Creates arbitrary public kernel circuit public inputs. ### makePrivateTxBaseRollupPrivateInputs ```typescript function makePrivateTxBaseRollupPrivateInputs(seed?: number) => PrivateTxBaseRollupPrivateInputs ``` ### makeProcessedTxFromPrivateOnlyTx ```typescript function makeProcessedTxFromPrivateOnlyTx(tx: Tx, transactionFee: Fr, feePaymentPublicDataWrite: PublicDataWrite, globalVariables: GlobalVariables) => ProcessedTx ``` ### makeProcessedTxFromTxWithPublicCalls ```typescript function makeProcessedTxFromTxWithPublicCalls(tx: Tx, globalVariables: GlobalVariables, avmProvingRequest: { inputs: AvmCircuitInputs; type: PUBLIC_VM }, publicTxEffect: PublicTxEffect, gasUsed: GasUsed, revertCode: RevertCode, revertReason: SimulationError) => ProcessedTx ``` ### makeProof ```typescript function makeProof(seed?: number) => Proof ``` Makes arbitrary proof. ### makeProofAndVerificationKey ```typescript function makeProofAndVerificationKey(proof: RecursiveProof, verificationKey: VerificationKeyData) => ProofAndVerificationKey ``` ### makeProofData ```typescript function makeProofData(seed: number, makePublicInputs: (seed: number) => T, proofSize?: PROOF_LENGTH) => ProofData ``` ### makeProtocolContracts ```typescript function makeProtocolContracts(seed?: number) => ProtocolContracts ``` ### makeProvingJobId ```typescript function makeProvingJobId(epochNumber: EpochNumber, type: ProvingRequestType, inputsHash: string) => string ``` ### makeProvingRequestResult ```typescript function makeProvingRequestResult(type: ProvingRequestType, result: ProofAndVerificationKey<20000> | PublicInputsAndRecursiveProof | PublicInputsAndRecursiveProof | PublicInputsAndRecursiveProof | PublicInputsAndRecursiveProof | PublicInputsAndRecursiveProof | PublicInputsAndRecursiveProof) => ProvingJobResult ``` ### makePublicCallRequest ```typescript function makePublicCallRequest(seed?: number) => PublicCallRequest ``` ### makePublicCallRequestArrayLengths ```typescript function makePublicCallRequestArrayLengths(seed?: number) => PublicCallRequestArrayLengths ``` ### makePublicCallRequestWithCalldata ```typescript function makePublicCallRequestWithCalldata(seed?: number) => Promise ``` ### makePublicChonkVerifierPublicInputs ```typescript function makePublicChonkVerifierPublicInputs(seed?: number) => PublicChonkVerifierPublicInputs ``` ### makePublicDataRead ```typescript function makePublicDataRead(seed?: number) => PublicDataRead ``` Creates arbitrary public data read. ### makePublicDataTreeLeaf ```typescript function makePublicDataTreeLeaf(seed?: number) => PublicDataTreeLeaf ``` Makes arbitrary public data tree leaves. ### makePublicDataTreeLeafPreimage ```typescript function makePublicDataTreeLeafPreimage(seed?: number) => PublicDataTreeLeafPreimage ``` Makes arbitrary public data tree leaf preimages. ### makePublicDataWrite ```typescript function makePublicDataWrite(seed?: number) => PublicDataWrite ``` ### makePublicInputsAndRecursiveProof ```typescript function makePublicInputsAndRecursiveProof(inputs: T, proof: RecursiveProof, verificationKey: VerificationKeyData) => PublicInputsAndRecursiveProof ``` ### makePublicKeys ```typescript function makePublicKeys(seed?: number) => Promise ``` ### makePublicTxBaseRollupPrivateInputs ```typescript function makePublicTxBaseRollupPrivateInputs(seed?: number) => PublicTxBaseRollupPrivateInputs ``` ### makeRecursiveProof ```typescript function makeRecursiveProof(size: PROOF_LENGTH, seed?: number) => RecursiveProof ``` ### makeRecursiveProofFromBinary ```typescript function makeRecursiveProofFromBinary(proof: Proof, size: PROOF_LENGTH) => RecursiveProof ``` Makes an instance of the recursive proof from a binary only proof ### makeRootRollupPublicInputs ```typescript function makeRootRollupPublicInputs(seed?: number) => RootRollupPublicInputs ``` Makes root rollup public inputs. ### makeSchnorrSignature ```typescript function makeSchnorrSignature(seed?: number) => SchnorrSignature ``` Makes arbitrary Schnorr signature. ### makeSelector ```typescript function makeSelector(seed: number) => FunctionSelector ``` Creates arbitrary selector from the given seed. ### makeSnapshotPaths ```typescript function makeSnapshotPaths(baseDir: string) => SnapshotDataUrls ``` ### makeStateReference ```typescript function makeStateReference(seed?: number) => StateReference ``` Makes arbitrary state reference. ### makeTreeSnapshotDiffHints ```typescript function makeTreeSnapshotDiffHints(seed?: number) => TreeSnapshotDiffHints ``` Creates an instance of TreeSnapshotDiffHints with arbitrary values based on the provided seed. ### makeTxContext ```typescript function makeTxContext(seed?: number) => TxContext ``` Creates an arbitrary tx context with the given seed. ### makeTxMergeRollupPrivateInputs ```typescript function makeTxMergeRollupPrivateInputs(seed?: number) => TxMergeRollupPrivateInputs ``` ### makeTxRequest ```typescript function makeTxRequest(seed?: number) => TxRequest ``` Makes arbitrary tx request. ### makeTxRollupPublicInputs ```typescript function makeTxRollupPublicInputs(seed?: number, globalVariables?: GlobalVariables) => TxRollupPublicInputs ``` Makes arbitrary base or merge rollup circuit public inputs. ### makeUtilityFunctionWithMembershipProof ```typescript function makeUtilityFunctionWithMembershipProof(seed?: number) => UtilityFunctionWithMembershipProof ``` ### makeVector ```typescript function makeVector(length: number, fn: (i: number) => T, offset?: number) => Vector ``` ### makeVectorAsync ```typescript function makeVectorAsync(length: number, fn: (i: number) => Promise, offset?: number) => Promise>> ``` ### makeVerificationKey ```typescript function makeVerificationKey() => VerificationKey ``` Creates arbitrary/mocked verification key. ### makeVerificationKeyAsFields ```typescript function makeVerificationKeyAsFields(size: number) => VerificationKeyAsFields ``` Creates arbitrary/mocked verification key in fields format. ### mapSchema ```typescript function mapSchema(key: ZodFor, value: ZodFor) => ZodFor> ``` Creates a schema for a js Map type that matches the serialization used in jsonStringify. ### mergeExecutionPayloads ```typescript function mergeExecutionPayloads(requests: ExecutionPayload[]) => ExecutionPayload ``` Merges an array ExecutionPayloads combining their calls, authWitnesses, capsules and extraArgHashes. ### merkleTreeIds ```typescript function merkleTreeIds() => MerkleTreeId[] ``` ### metricsTopicStrToLabels ```typescript function metricsTopicStrToLabels(protocolVersion: string) => Map ``` Convert the topic string into a set of labels In the form: { "/aztec/tx/0.1.0": "tx", ... } ### mockCheckpointAndMessages ```typescript function mockCheckpointAndMessages(checkpointNumber: CheckpointNumber, __namedParameters?: { makeBlockOptions?: (blockNumber: BlockNumber) => Partial<{ checkpointNumber?: CheckpointNumber; indexWithinCheckpoint?: number; ... } & Partial> & Partial>>>; numBlocks?: number; ... } & Partial<{ numBlocks?: number; startBlockNumber?: number } & Partial> & Partial>> & Partial<{ checkpointNumber?: CheckpointNumber; indexWithinCheckpoint?: number; ... } & Partial> & Partial>>>> & Partial<{ checkpointNumber?: CheckpointNumber; indexWithinCheckpoint?: number; ... } & Partial> & Partial>>>) => Promise<{ checkpoint: Checkpoint; messages: Fr[] }> ``` ### mockL1ToL2Messages ```typescript function mockL1ToL2Messages(numL1ToL2Messages: number) => Fr[] ``` ### mockProcessedTx ```typescript function mockProcessedTx(__namedParameters?: { anchorBlockHeader?: BlockHeader; db?: MerkleTreeReadOperations; ... } & { chainId?: Fr; chonkProof?: ChonkProof; ... }) => Promise ``` Mock a processed tx for testing purposes. ### mockSimulatedTx ```typescript function mockSimulatedTx(seed?: number) => Promise ``` ### mockTx ```typescript function mockTx(seed?: number, __namedParameters?: { chainId?: Fr; chonkProof?: ChonkProof; ... }) => Promise ``` ### mockTxForRollup ```typescript function mockTxForRollup(seed?: number, opts?: { chainId?: Fr; chonkProof?: ChonkProof; ... }) => Promise ``` ### noteHashReadRequestHintsFromBuffer ```typescript function noteHashReadRequestHintsFromBuffer(buffer: Buffer | BufferReader, numPending: PENDING, numSettled: SETTLED) => NoteHashReadRequestHints ``` ### nullifierReadRequestHintsFromBuffer ```typescript function nullifierReadRequestHintsFromBuffer(buffer: Buffer | BufferReader, numPendingReads: PENDING, numSettledReads: SETTLED) => NullifierReadRequestHints ``` ### offenseDataComparator ```typescript function offenseDataComparator(a: Offense, b: Offense) => number ``` Sorts offense data by: - Uncontroversial offenses first - Slash amount (descending) - Epoch or slot (ascending, ie oldest first) - Validator address (ascending) - Offense type (descending) ### offensesToValidatorSlash ```typescript function offensesToValidatorSlash(offenses: Offense[]) => ValidatorSlash[] ``` Creates ValidatorSlashes used to create an Empire-based SlashPayload from a set of Offenses ### optional ```typescript function optional(schema: T) => ZodNullableOptional ``` Declares a parameter as optional. Use this over z.optional in order to accept nulls as undefineds. This is required as JSON does not have an undefined type, and null is used to represent it, so we need to convert nulls to undefineds as we parse. ### orderAttestations ```typescript function orderAttestations(attestations: BlockAttestation[], orderAddresses: EthAddress[]) => CommitteeAttestation[] ``` Returns attestation signatures in the order of a series of provided ethereum addresses The rollup smart contract expects attestations to appear in the order of the committee @perform this logic within the memory attestation store instead? ### packValidatorSlashOffense ```typescript function packValidatorSlashOffense(offense: ValidatorSlashOffense) => bigint ``` ### parseDebugSymbols ```typescript function parseDebugSymbols(debugSymbols: string) => DebugInfo[] ``` ### parseSignedInt ```typescript function parseSignedInt(b: Buffer, width?: number) => bigint ``` Returns a bigint by parsing a serialized 2's complement signed int. ### pickFromSchema ```typescript function pickFromSchema>(obj: T, schema: S) => Partial ``` Given an already parsed and validated object, extracts the keys defined in the given schema. Does not validate again. ### randomBlockInfo ```typescript function randomBlockInfo(blockNumber?: number | BlockNumber) => L2BlockInfo ``` ### randomContractArtifact ```typescript function randomContractArtifact() => ContractArtifact ``` ### randomContractInstanceWithAddress ```typescript function randomContractInstanceWithAddress(opts?: { contractClassId?: Fr }, address?: AztecAddress) => Promise ``` ### randomDataInBlock ```typescript function randomDataInBlock(data: T) => DataInBlock ``` ### randomDeployedContract ```typescript function randomDeployedContract() => Promise<{ artifact: ContractArtifact; instance: ContractInstanceWithAddress }> ``` ### randomInBlock ```typescript function randomInBlock() => InBlock ``` ### randomInTx ```typescript function randomInTx() => InTx ``` ### randomIndexedTxEffect ```typescript function randomIndexedTxEffect() => Promise ``` ### randomPublishedL2Block ```typescript function randomPublishedL2Block(l2BlockNumber: number, opts?: { signers?: Secp256k1Signer[] }) => Promise ``` ### randomTxHash ```typescript function randomTxHash() => TxHash ``` ### retainBytecode ```typescript function retainBytecode(input: FunctionArtifact | NoirFunctionEntry) => boolean ``` Returns true if we should retain bytecode ### serializeBlockInfo ```typescript function serializeBlockInfo(blockInfo: L2BlockInfo) => Buffer ``` ### serializeIndexedTxEffect ```typescript function serializeIndexedTxEffect(effect: IndexedTxEffect) => Buffer ``` ### serializeOffense ```typescript function serializeOffense(offense: Offense) => Buffer ``` ### serializePrivateExecutionSteps ```typescript function serializePrivateExecutionSteps(steps: PrivateExecutionStep[]) => Buffer ``` ### serializeSlashPayload ```typescript function serializeSlashPayload(payload: SlashPayload) => Buffer ``` ### serializeSlashPayloadRound ```typescript function serializeSlashPayloadRound(payload: SlashPayloadRound) => Buffer ``` ### serializeValidateBlockResult ```typescript function serializeValidateBlockResult(result: ValidateBlockResult) => Buffer ``` ### serializeWithMessagePack ```typescript function serializeWithMessagePack(obj: any) => Buffer ``` ### siloNoteHash ```typescript function siloNoteHash(contract: AztecAddress, noteHash: Fr) => Promise ``` Computes a siloed note hash, given the contract address and the note hash itself. A siloed note hash effectively namespaces a note hash to a specific contract. ### siloNullifier ```typescript function siloNullifier(contract: AztecAddress, innerNullifier: Fr) => Promise ``` Computes a siloed nullifier, given the contract address and the inner nullifier. A siloed nullifier effectively namespaces a nullifier to a specific contract. ### siloPrivateLog ```typescript function siloPrivateLog(contract: AztecAddress, unsiloedTag: Fr) => Promise ``` Computes a siloed private log tag, given the contract address and the unsiloed tag. A siloed private log tag effectively namespaces a log to a specific contract. ### sortByCounter ```typescript function sortByCounter(arr: Tuple, ascending?: boolean) => Tuple ``` ### testL2TipsStore ```typescript function testL2TipsStore(makeTipsStore: () => Promise) => void ``` ### tryStop ```typescript function tryStop(service?: any, logger?: Logger) => Promise ``` Tries to call stop on a given object and awaits it. Logs any errors and does not rethrow. ### unpackValidatorSlashOffense ```typescript function unpackValidatorSlashOffense(packed: bigint) => ValidatorSlashOffense ``` ### uploadSnapshotData ```typescript function uploadSnapshotData(localPaths: Record<"archiver" | "nullifier-tree" | "public-data-tree" | "note-hash-tree" | "archive-tree" | "l1-to-l2-message-tree", string>, schemaVersions: { archiver: number; worldState: number }, metadata: UploadSnapshotMetadata, store: FileStore, opts?: { pathFor?: (key: "archiver" | "nullifier-tree" | "public-data-tree" | "note-hash-tree" | "archive-tree" | "l1-to-l2-message-tree") => string; private?: boolean }) => Promise ``` ### uploadSnapshotToIndex ```typescript function uploadSnapshotToIndex(localPaths: Record<"archiver" | "nullifier-tree" | "public-data-tree" | "note-hash-tree" | "archive-tree" | "l1-to-l2-message-tree", string>, schemaVersions: { archiver: number; worldState: number }, metadata: UploadSnapshotMetadata, store: FileStore) => Promise ``` ### validatePartialComponentVersionsMatch ```typescript function validatePartialComponentVersionsMatch(expected: Partial, actual: Partial) => void ``` Checks that two component versions match. Undefined fields are ignored. ### wrapDataInBlock ```typescript function wrapDataInBlock(data: T, block: L2Block) => Promise> ``` ## Types ### ABIParameter ```typescript type ABIParameter = z.infer ``` A function parameter. ### ABIParameterVisibility ```typescript type ABIParameterVisibility = readonly [] ``` Indicates whether a parameter is public or secret/private. ### ABIVariable ```typescript type ABIVariable = z.infer ``` A named type. ### AZTEC_INITIALIZER_ATTRIBUTE ```typescript type AZTEC_INITIALIZER_ATTRIBUTE = "abi_initializer" ``` ### AZTEC_ONLY_SELF_ATTRIBUTE ```typescript type AZTEC_ONLY_SELF_ATTRIBUTE = "abi_only_self" ``` ### AZTEC_PRIVATE_ATTRIBUTE ```typescript type AZTEC_PRIVATE_ATTRIBUTE = "abi_private" ``` ### AZTEC_PUBLIC_ATTRIBUTE ```typescript type AZTEC_PUBLIC_ATTRIBUTE = "abi_public" ``` ### AZTEC_UTILITY_ATTRIBUTE ```typescript type AZTEC_UTILITY_ATTRIBUTE = "abi_utility" ``` ### AZTEC_VIEW_ATTRIBUTE ```typescript type AZTEC_VIEW_ATTRIBUTE = "abi_view" ``` ### AbiDecoded ```typescript type AbiDecoded = bigint | boolean | string | AztecAddress | AbiDecoded[] | {} ``` The type of our decoded ABI. ### AbiErrorType ```typescript type AbiErrorType = { error_kind: "string"; string: string } | { error_kind: "fmtstring"; item_types: AbiType[]; length: number } | { error_kind: "custom" } & AbiType ``` An error could be a custom error of any regular type or a string error. ### AbiType ```typescript type AbiType = BasicType<"field"> | BasicType<"boolean"> | IntegerType | ArrayType | StringType | StructType | TupleType ``` A variable type. ### AbiValue ```typescript type AbiValue = BasicValue<"boolean", boolean> | BasicValue<"string", string> | BasicValue<"array", AbiValue[]> | TupleValue | IntegerValue | StructValue ``` An exported value. ### ActualProverConfig ```typescript type ActualProverConfig = { proverTestDelayFactor: number; proverTestDelayMs: number; ... } ``` ### AllowedElement ```typescript type AllowedElement = AllowedInstance | AllowedInstanceFunction | AllowedClass | AllowedClassFunction ``` ### AnyTx ```typescript type AnyTx = Tx | ProcessedTx ``` ### ApiSchemaFor ```typescript type ApiSchemaFor = { [key: string]: unknown } ``` Maps all functions in an interface to their schema representation. ### AppCircuitSimulateOutput ```typescript type AppCircuitSimulateOutput = { verificationKey: VerificationKeyData } ``` Represents the output of the circuit simulation process for init and inner private kernel circuit. ### ArchiverApi ```typescript type ArchiverApi = Omit ``` ### ArchiverEmitter ```typescript type ArchiverEmitter = TypedEventEmitter<{ invalidBlockDetected: (args: InvalidBlockDetectedEvent) => void; l2BlockProven: (args: L2BlockProvenEvent) => void; l2PruneDetected: (args: L2BlockPruneEvent) => void }> ``` L2BlockSource that emits events upon pending / proven chain changes. see L2BlockSourceEvents for the events emitted. ### ArchiverSpecificConfig ```typescript type ArchiverSpecificConfig = { archiverBatchSize?: number; archiverPollingIntervalMS?: number; ... } ``` The archiver configuration. ### AttestationInfo ```typescript type AttestationInfo = { address?: undefined; status: Extract } | { address: EthAddress; status: Extract } ``` Information about an attestation extracted from a published block ### AttestationStatus ```typescript type AttestationStatus = "recovered-from-signature" | "provided-as-address" | "invalid-signature" | "empty" ``` Status indicating how the attestation address was determined ### AvmProofData ```typescript type AvmProofData = ProofData ``` ### AvmProvingRequest ```typescript type AvmProvingRequest = z.infer ``` ### AvmSimulationStats ```typescript type AvmSimulationStats = { appCircuitName: string; duration: number; eventName: "avm-simulation" } ``` ### AztecNodeAdminConfig ```typescript type AztecNodeAdminConfig = ValidatorClientFullConfig & SequencerConfig & ProverConfig & SlasherConfig & Pick & { maxTxPoolSize: number } ``` ### BaseRollupHints ```typescript type BaseRollupHints = PrivateBaseRollupHints | PublicBaseRollupHints ``` ### BlockParameter ```typescript type BlockParameter = z.infer ``` Block parameter - either a specific BlockNumber or 'latest' ### BlockProposalOptions ```typescript type BlockProposalOptions = { broadcastInvalidBlockProposal?: boolean; publishFullTxs: boolean } ``` ### BrilligFunctionId ```typescript type BrilligFunctionId = number ``` ### CIRCUIT_PUBLIC_INPUTS_INDEX ```typescript type CIRCUIT_PUBLIC_INPUTS_INDEX = 1 ``` ### CIRCUIT_SIZE_INDEX ```typescript type CIRCUIT_SIZE_INDEX = 0 ``` ### ChainConfig ```typescript type ChainConfig = { l1ChainId: number; l1Contracts: { rollupAddress: EthAddress }; rollupVersion: number } ``` Chain configuration. ### ChonkProofData ```typescript type ChonkProofData = ProofData ``` ### CircuitName ```typescript type CircuitName = ClientCircuitName | ServerCircuitName ``` ### CircuitProvingStats ```typescript type CircuitProvingStats = { appCircuitName?: string; circuitName: CircuitName; ... } ``` Stats for proving a circuit ### CircuitSimulationStats ```typescript type CircuitSimulationStats = { appCircuitName?: string; circuitName: CircuitName; ... } ``` Stats for circuit simulation. ### CircuitVerificationStats ```typescript type CircuitVerificationStats = { circuitName: CircuitName; duration: number; ... } ``` Stats for verifying a circuit ### CircuitWitnessGenerationStats ```typescript type CircuitWitnessGenerationStats = { appCircuitName?: string; circuitName: CircuitName; ... } ``` Stats for witness generation. ### ClientCircuitName ```typescript type ClientCircuitName = "private-kernel-init" | "private-kernel-inner" | "private-kernel-reset" | "private-kernel-tail" | "private-kernel-tail-to-public" | "hiding-kernel-to-rollup" | "hiding-kernel-to-public" | "app-circuit" ``` ### ComponentsVersions ```typescript type ComponentsVersions = { l1ChainId: number; l1RollupAddress: EthAddress; ... } ``` Fields that identify a version of the Aztec protocol. Any mismatch between these fields should signal an incompatibility between nodes. ### ContractClassIdPreimage ```typescript type ContractClassIdPreimage = { artifactHash: Fr; privateFunctionsRoot: Fr; publicBytecodeCommitment: Fr } ``` Preimage of a contract class id. ### ContractClassPublic ```typescript type ContractClassPublic = { privateFunctions: ExecutablePrivateFunctionWithMembershipProof[]; utilityFunctions: UtilityFunctionWithMembershipProof[] } & Pick & Omit ``` A contract class with public bytecode information, and optional private and utility functions. ### ContractClassPublicWithBlockNumber ```typescript type ContractClassPublicWithBlockNumber = { l2BlockNumber: number } & ContractClassPublic ``` The contract class with the block it was initially deployed at ### ContractClassPublicWithCommitment ```typescript type ContractClassPublicWithCommitment = ContractClassPublic & Pick ``` ### ContractClassWithId ```typescript type ContractClassWithId = ContractClass & Pick ``` A contract class with its precomputed id. ### ContractInstanceUpdateWithAddress ```typescript type ContractInstanceUpdateWithAddress = ContractInstanceUpdate & { address: AztecAddress } ``` ### ContractInstanceWithAddress ```typescript type ContractInstanceWithAddress = ContractInstance & { address: AztecAddress } ``` ### ContractInstantiationData ```typescript type ContractInstantiationData = { constructorArgs?: any[]; constructorArtifact?: FunctionAbi | string; ... } ``` ### ContractOverrides ```typescript type ContractOverrides = Record ``` ### DATABASE_VERSION_FILE_NAME ```typescript type DATABASE_VERSION_FILE_NAME = "db_version" ``` ### DELAYED_PUBLIC_MUTABLE_VALUES_LEN ```typescript type DELAYED_PUBLIC_MUTABLE_VALUES_LEN = number ``` ### DataInBlock ```typescript type DataInBlock = { data: T } & InBlock ``` ### DatabaseVersionManagerFs ```typescript type DatabaseVersionManagerFs = Pick ``` ### DatabaseVersionManagerOptions ```typescript type DatabaseVersionManagerOptions = { dataDirectory: string; fileSystem?: DatabaseVersionManagerFs; ... } ``` ### DebugFileMap ```typescript type DebugFileMap = Record ``` Maps a file ID to its metadata for debugging purposes. ### DeploymentInfo ```typescript type DeploymentInfo = { completeAddress: CompleteAddress; constructorHash: Fr; ... } ``` Represents the data generated as part of contract deployment. ### DimensionName ```typescript type DimensionName = keyof FieldsOf ``` ### EmptyL1RollupConstants ```typescript type EmptyL1RollupConstants = L1RollupConstants ``` ### EpochProvingJobState ```typescript type EpochProvingJobState = typeof EpochProvingJobState[number] ``` ### EpochProvingJobTerminalState ```typescript type EpochProvingJobTerminalState = EpochProvingJobState[] ``` ### EventMap ```typescript type EventMap = { newNodeVersion: []; newRollupVersion: []; ... } ``` ### EventMetadataDefinition ```typescript type EventMetadataDefinition = { abiType: AbiType; eventSelector: EventSelector; fieldNames: string[] } ``` ### ExecutablePrivateFunctionWithMembershipProof ```typescript type ExecutablePrivateFunctionWithMembershipProof = ExecutablePrivateFunction & PrivateFunctionMembershipProof ``` A private function with a membership proof. ### FailedTx ```typescript type FailedTx = { error: Error; tx: Tx } ``` Represents a tx that failed to be processed by the sequencer public processor. ### FieldLayout ```typescript type FieldLayout = { slot: Fr } ``` Type representing a field layout in the storage of a contract. ### FileStoreSaveOptions ```typescript type FileStoreSaveOptions = { compress?: boolean; metadata?: Record; public?: boolean } ``` ### FrTreeId ```typescript type FrTreeId = Exclude ``` ### FullNodeBlockBuilderConfig ```typescript type FullNodeBlockBuilderConfig = Pick & Pick & Pick ``` ### GasDimensions ```typescript type GasDimensions = readonly [] ``` ### GasUsed ```typescript type GasUsed = { fromPlainObject: (obj: any) => GasUsed } ``` ### GetContractClassLogsResponse ```typescript type GetContractClassLogsResponse = { logs: ExtendedContractClassLog[]; maxLogsHit: boolean } ``` Response for the getContractClassLogs archiver call. ### GetProvingJobResponse ```typescript type GetProvingJobResponse = { job: ProvingJob; time: number } ``` ### GetPublicLogsResponse ```typescript type GetPublicLogsResponse = { logs: ExtendedPublicLog[]; maxLogsHit: boolean } ``` Response for the getPublicLogs archiver call. ### IVCProofVerificationResult ```typescript type IVCProofVerificationResult = { durationMs: number; totalDurationMs: number; valid: boolean } ``` ### InBlock ```typescript type InBlock = { l2BlockHash: L2BlockHash; l2BlockNumber: BlockNumber } ``` ### InTx ```typescript type InTx = InBlock & { txHash: TxHash } ``` ### IndexedTreeId ```typescript type IndexedTreeId = MerkleTreeId.NULLIFIER_TREE | MerkleTreeId.PUBLIC_DATA_TREE ``` Type alias for the nullifier tree ID. ### IndexedTxEffect ```typescript type IndexedTxEffect = DataInBlock & { txIndexInBlock: number } ``` ### InvalidBlockDetectedEvent ```typescript type InvalidBlockDetectedEvent = { type: "invalidBlockDetected"; validationResult: ValidateBlockNegativeResult } ``` ### KEY_PREFIXES ```typescript type KEY_PREFIXES = KeyPrefix[] ``` ### KeyGenerator ```typescript type KeyGenerator = GeneratorIndex.NSK_M | GeneratorIndex.IVSK_M | GeneratorIndex.OVSK_M | GeneratorIndex.TSK_M ``` ### KeyPrefix ```typescript type KeyPrefix = "n" | "iv" | "ov" | "t" ``` ### L1PublishBlockStats ```typescript type L1PublishBlockStats = { eventName: "rollup-published-to-l1" } & L1PublishStats & L2BlockStats ``` Stats logged for each L1 rollup publish tx. ### L1PublishProofStats ```typescript type L1PublishProofStats = { eventName: "proof-published-to-l1" } & L1PublishStats ``` Stats logged for each L1 rollup publish tx. ### L1PublishStats ```typescript type L1PublishStats = { blobCount?: number; blobDataGas: bigint; ... } ``` Stats logged for each L1 publish tx. ### L1RollupConstants ```typescript type L1RollupConstants = { epochDuration: number; ethereumSlotDuration: number; ... } ``` ### L2BlockBuiltStats ```typescript type L2BlockBuiltStats = { creator: string; duration: number; ... } & L2BlockStats ``` Stats for an L2 block built by a sequencer. ### L2BlockHandledStats ```typescript type L2BlockHandledStats = { duration: number; eventName: "l2-block-handled"; ... } & L2BlockStats ``` Stats for an L2 block processed by the world state synchronizer. ### L2BlockId ```typescript type L2BlockId = { hash: string; number: BlockNumber } ``` Identifies a block by number and hash. ### L2BlockInfo ```typescript type L2BlockInfo = { archive: Fr; blockHash?: Fr; ... } ``` ### L2BlockProvenEvent ```typescript type L2BlockProvenEvent = { blockNumber: BlockNumber; epochNumber: EpochNumber; ... } ``` ### L2BlockPruneEvent ```typescript type L2BlockPruneEvent = { blocks: L2Block[]; epochNumber: EpochNumber; type: "l2PruneDetected" } ``` ### L2BlockStats ```typescript type L2BlockStats = { blockNumber: number; publicLogCount?: number; txCount: number } ``` Stats associated with an L2 block. ### L2BlockStreamEvent ```typescript type L2BlockStreamEvent = { blocks: PublishedL2Block[]; type: "blocks-added" } | { block: L2BlockId; type: "chain-pruned" } | { block: L2BlockId; type: "chain-proven" } | { block: L2BlockId; type: "chain-finalized" } ``` ### L2BlockTag ```typescript type L2BlockTag = "latest" | "proven" | "finalized" ``` Identifier for L2 block tags. - latest: Latest block pushed to L1. - proven: Proven block on L1. - finalized: Proven block on a finalized L1 block (not implemented, set to proven for now). ### L2Tips ```typescript type L2Tips = Record ``` Tips of the L2 chain. ### L2TipsStore ```typescript type L2TipsStore = L2BlockStreamEventHandler & L2BlockStreamLocalDataProvider ``` ### L2ToL1MembershipWitness ```typescript type L2ToL1MembershipWitness = { leafIndex: bigint; root: Fr; siblingPath: SiblingPath } ``` ### LocationNodeDebugInfo ```typescript type LocationNodeDebugInfo = { parent: number | null; value: SourceCodeLocation } ``` ### LocationTree ```typescript type LocationTree = { locations: LocationNodeDebugInfo[] } ``` ### LogFilter ```typescript type LogFilter = { afterLog?: LogId; contractAddress?: AztecAddress; ... } ``` Log filter used to fetch L2 logs. ### MAX_LOGS_PER_TAG ```typescript type MAX_LOGS_PER_TAG = 10 ``` ### MAX_RPC_BLOCKS_LEN ```typescript type MAX_RPC_BLOCKS_LEN = 50 ``` ### MAX_RPC_LEN ```typescript type MAX_RPC_LEN = 100 ``` ### MAX_RPC_TXS_LEN ```typescript type MAX_RPC_TXS_LEN = 50 ``` ### MerkleTreeLeafType ```typescript type MerkleTreeLeafType = LeafTypes[ID] ``` ### MerkleTreeLeafValue ```typescript type MerkleTreeLeafValue = LeafValueTypes[ID] ``` ### NodeRPCConfig ```typescript type NodeRPCConfig = { rpcMaxBatchSize: number; rpcMaxBodySize: string; ... } ``` ### NodeStats ```typescript type NodeStats = Partial> ``` ### NodeSyncedChainHistoryStats ```typescript type NodeSyncedChainHistoryStats = { blockCount: number; blockNumber: number; ... } ``` Stats logged for synching node chain history. ### NoirCallStack ```typescript type NoirCallStack = SourceCodeLocation[] | OpcodeLocation[] ``` A stack of noir source code locations. ### NoirCompilationResult ```typescript type NoirCompilationResult = NoirContractCompilationArtifacts | NoirProgramCompilationArtifacts ``` output of Noir Wasm compilation, can be for a contract or lib/binary ### NoteHashReadRequestHints ```typescript type NoteHashReadRequestHints = ReadRequestResetHints ``` ### NotesFilter ```typescript type NotesFilter = { contractAddress: AztecAddress; owner?: AztecAddress; ... } ``` A filter used to fetch notes. ### NullifierReadRequestHints ```typescript type NullifierReadRequestHints = ReadRequestResetHints ``` ### OFFCHAIN_MESSAGE_IDENTIFIER ```typescript type OFFCHAIN_MESSAGE_IDENTIFIER = Fr ``` ### OffchainEffect ```typescript type OffchainEffect = { contractAddress: AztecAddress; data: Fr[] } ``` Represents an offchain effect emitted via the `emit_offchain_effect` oracle (see the oracle documentation for more details). ### Offense ```typescript type Offense = { amount: bigint; epochOrSlot: bigint; ... } ``` ### OffenseIdentifier ```typescript type OffenseIdentifier = Pick ``` ### OffenseToBigInt ```typescript type OffenseToBigInt = Record ``` ### OpcodeLocation ```typescript type OpcodeLocation = string ``` The location of an opcode in the bytecode. It's a string of the form `{acirIndex}` or `{acirIndex}:{brilligIndex}`. ### OpcodeToLocationsMap ```typescript type OpcodeToLocationsMap = Record ``` ### P2PApi ```typescript type P2PApi = unknown ``` ### P2PApiFull ```typescript type P2PApiFull = unknown ``` ### ParityBaseProofData ```typescript type ParityBaseProofData = UltraHonkProofData ``` ### PartialAddress ```typescript type PartialAddress = Fr ``` A type which along with public key forms a preimage of a contract address. See the link below for more details https://github.com/AztecProtocol/aztec-packages/blob/master/docs/docs/concepts/foundation/accounts/keys.md#addresses-partial-addresses-and-public-keys ### PeerInfo ```typescript type PeerInfo = { id: string; score: number; status: "connected" } | { addresses: string[]; dialStatus: string; ... } | { addresses: string[]; dialAttempts: number; ... } ``` ### PreTag ```typescript type PreTag = { index: number; secret: DirectionalAppTaggingSecret } ``` Represents a preimage of a private log tag (see `Tag` in `pxe/src/tagging`). Note: It's a bit unfortunate that this type resides in `stdlib` as the rest of the tagging functionality resides in `pxe/src/tagging`. But this type is used by other types in stdlib hence there doesn't seem to be a good way around this. ### PrivateFunctionMembershipProof ```typescript type PrivateFunctionMembershipProof = { artifactMetadataHash: Fr; artifactTreeLeafIndex: number; ... } ``` Sibling paths and sibling commitments for proving membership of a private function within a contract class. ### ProcessReturnValues ```typescript type ProcessReturnValues = Fr[] | undefined ``` Return values of simulating a circuit. ### ProcessedTx ```typescript type ProcessedTx = { avmProvingRequest: AvmProvingRequest | undefined; chonkProof: ChonkProof; ... } ``` Represents a tx that has been processed by the sequencer public processor, so its kernel circuit public inputs are filled in. ### ProofAndVerificationKey ```typescript type ProofAndVerificationKey = { proof: RecursiveProof; verificationKey: VerificationKeyData } ``` ### ProofConstructed ```typescript type ProofConstructed = { acir_test: string; eventName: "proof_construction_time"; ... } ``` Stats associated with an ACIR proof generation. ### ProofUri ```typescript type ProofUri = z.ZodBranded ``` ### ProposerSlashAction ```typescript type ProposerSlashAction = { data: ValidatorSlash[]; type: "create-empire-payload" } | { payload: EthAddress; type: "vote-empire-payload" } | { round: bigint; type: "execute-empire-payload" } | { committees: EthAddress[][]; round: bigint; ... } | { committees: EthAddress[][]; round: bigint; type: "execute-slash" } ``` ### ProposerSlashActionType ```typescript type ProposerSlashActionType = ProposerSlashAction["type"] ``` ### ProtocolContractAddresses ```typescript type ProtocolContractAddresses = { classRegistry: AztecAddress; feeJuice: AztecAddress; ... } ``` ### ProtocolContractsNames ```typescript type ProtocolContractsNames = readonly [] ``` ### ProverAgentStatus ```typescript type ProverAgentStatus = z.infer ``` ### ProverConfig ```typescript type ProverConfig = ActualProverConfig & { failedProofStore?: string; nodeUrl?: string; ... } ``` The prover configuration. ### ProvingJob ```typescript type ProvingJob = z.ZodType ``` ### ProvingJobFilter ```typescript type ProvingJobFilter = { allowList: ProvingRequestType[] } ``` ### ProvingJobFulfilledResult ```typescript type ProvingJobFulfilledResult = z.ZodObject<{ status: z.ZodLiteral<"fulfilled">; value: z.ZodBranded }, "strip", z.ZodTypeAny, { status: "fulfilled"; value: string & z.BRAND<"ProvingJobUri"> }, { status: "fulfilled"; value: string }> ``` ### ProvingJobId ```typescript type ProvingJobId = z.ZodString ``` ### ProvingJobInputs ```typescript type ProvingJobInputs = z.ZodDiscriminatedUnion<"type", []> ``` ### ProvingJobInputsMap ```typescript type ProvingJobInputsMap = { 0: AvmCircuitInputs; 1: PublicChonkVerifierPrivateInputs; ... } ``` ### ProvingJobRejectedResult ```typescript type ProvingJobRejectedResult = z.ZodObject<{ reason: z.ZodString; status: z.ZodLiteral<"rejected"> }, "strip", z.ZodTypeAny, { reason: string; status: "rejected" }, { reason: string; status: "rejected" }> ``` ### ProvingJobResult ```typescript type ProvingJobResult = z.ZodDiscriminatedUnion<"type", []> ``` ### ProvingJobResultsMap ```typescript type ProvingJobResultsMap = { 0: ProofAndVerificationKey; 1: PublicInputsAndRecursiveProof; ... } ``` ### ProvingJobSettledResult ```typescript type ProvingJobSettledResult = z.ZodDiscriminatedUnion<"status", []> ``` ### ProvingJobStatus ```typescript type ProvingJobStatus = z.ZodDiscriminatedUnion<"status", []> ``` ### ProvingRequestResultFor ```typescript type ProvingRequestResultFor = { result: ProvingJobResultsMap[T]; type: T } ``` ### ProvingTimings ```typescript type ProvingTimings = { perFunction: FunctionTiming[]; proving?: number; ... } ``` ### PublicDBAccessStats ```typescript type PublicDBAccessStats = { duration: number; eventName: "public-db-access"; operation: string } ``` ### PublicInputsAndRecursiveProof ```typescript type PublicInputsAndRecursiveProof = { inputs: T; proof: RecursiveProof; verificationKey: VerificationKeyData } ``` ### PublicKey ```typescript type PublicKey = Point ``` Represents a user public key. ### RollupHonkProofData ```typescript type RollupHonkProofData = ProofData ``` ### ServerCircuitName ```typescript type ServerCircuitName = "parity-base" | "parity-root" | "chonk-verifier-public" | "rollup-tx-base-private" | "rollup-tx-base-public" | "rollup-tx-merge" | "rollup-block-root-first" | "rollup-block-root-first-single-tx" | "rollup-block-root-first-empty-tx" | "rollup-block-root" | "rollup-block-root-single-tx" | "rollup-block-merge" | "rollup-checkpoint-root" | "rollup-checkpoint-root-single-block" | "rollup-checkpoint-padding" | "rollup-checkpoint-merge" | "rollup-root" | "avm-circuit" ``` ### SingleValidatorStats ```typescript type SingleValidatorStats = { allTimeProvenPerformance: { epoch: EpochNumber; missed: number; total: number }[]; initialSlot?: SlotNumber; ... } ``` ### SlashPayload ```typescript type SlashPayload = { address: EthAddress; slashes: ValidatorSlash[]; timestamp: bigint } ``` Slash payload as published by the empire slash proposer ### SlashPayloadRound ```typescript type SlashPayloadRound = SlashPayload & { round: bigint; votes: bigint } ``` Slash payload with round information from empire slash proposer ### SlasherClientType ```typescript type SlasherClientType = "empire" | "tally" ``` ### SnapshotDataKeys ```typescript type SnapshotDataKeys = readonly [] ``` ### SnapshotDataUrls ```typescript type SnapshotDataUrls = Record ``` ### SnapshotMetadata ```typescript type SnapshotMetadata = { dataUrls: SnapshotDataUrls; l1BlockNumber: number; ... } ``` ### SnapshotsIndex ```typescript type SnapshotsIndex = SnapshotsIndexMetadata & { snapshots: SnapshotMetadata[] } ``` ### SnapshotsIndexMetadata ```typescript type SnapshotsIndexMetadata = { l1ChainId: number; rollupAddress: EthAddress; rollupVersion: number } ``` ### Stats ```typescript type Stats = AvmSimulationStats | CircuitProvingStats | CircuitSimulationStats | CircuitWitnessGenerationStats | PublicDBAccessStats | L1PublishBlockStats | L1PublishProofStats | L2BlockBuiltStats | L2BlockHandledStats | NodeSyncedChainHistoryStats | ProofConstructed | TreeInsertionStats | TxAddedToPoolStats ``` Stats emitted in structured logs with an `eventName` for tracking. ### StatsEventName ```typescript type StatsEventName = Stats["eventName"] ``` Set of event names across emitted stats. ### TX_ERROR_BLOCK_HEADER ```typescript type TX_ERROR_BLOCK_HEADER = "Block header not found" ``` ### TX_ERROR_CALLDATA_COUNT_MISMATCH ```typescript type TX_ERROR_CALLDATA_COUNT_MISMATCH = "Wrong number of calldata for public calls" ``` ### TX_ERROR_CALLDATA_COUNT_TOO_LARGE ```typescript type TX_ERROR_CALLDATA_COUNT_TOO_LARGE = "Total calldata too large for enqueued public calls" ``` ### TX_ERROR_CONTRACT_CLASS_LOGS ```typescript type TX_ERROR_CONTRACT_CLASS_LOGS = "Mismatched contract class logs" ``` ### TX_ERROR_CONTRACT_CLASS_LOG_COUNT ```typescript type TX_ERROR_CONTRACT_CLASS_LOG_COUNT = "Mismatched number of contract class logs" ``` ### TX_ERROR_CONTRACT_CLASS_LOG_LENGTH ```typescript type TX_ERROR_CONTRACT_CLASS_LOG_LENGTH = "Incorrect contract class logs length" ``` ### TX_ERROR_CONTRACT_CLASS_LOG_SORTING ```typescript type TX_ERROR_CONTRACT_CLASS_LOG_SORTING = "Incorrectly sorted contract class logs" ``` ### TX_ERROR_DUPLICATE_NULLIFIER_IN_TX ```typescript type TX_ERROR_DUPLICATE_NULLIFIER_IN_TX = "Duplicate nullifier in tx" ``` ### TX_ERROR_DURING_VALIDATION ```typescript type TX_ERROR_DURING_VALIDATION = "Unexpected error during validation" ``` ### TX_ERROR_EXISTING_NULLIFIER ```typescript type TX_ERROR_EXISTING_NULLIFIER = "Existing nullifier" ``` ### TX_ERROR_GAS_LIMIT_TOO_HIGH ```typescript type TX_ERROR_GAS_LIMIT_TOO_HIGH = "Gas limit is higher than the amount of gas that the AVM can process" ``` ### TX_ERROR_INCORRECT_CALLDATA ```typescript type TX_ERROR_INCORRECT_CALLDATA = "Incorrect calldata for public call" ``` ### TX_ERROR_INCORRECT_HASH ```typescript type TX_ERROR_INCORRECT_HASH = "Incorrect tx hash" ``` ### TX_ERROR_INCORRECT_L1_CHAIN_ID ```typescript type TX_ERROR_INCORRECT_L1_CHAIN_ID = "Incorrect L1 chain id" ``` ### TX_ERROR_INCORRECT_PROTOCOL_CONTRACTS_HASH ```typescript type TX_ERROR_INCORRECT_PROTOCOL_CONTRACTS_HASH = "Incorrect protocol contracts hash" ``` ### TX_ERROR_INCORRECT_ROLLUP_VERSION ```typescript type TX_ERROR_INCORRECT_ROLLUP_VERSION = "Incorrect rollup version" ``` ### TX_ERROR_INCORRECT_VK_TREE_ROOT ```typescript type TX_ERROR_INCORRECT_VK_TREE_ROOT = "Incorrect verification keys tree root" ``` ### TX_ERROR_INSUFFICIENT_FEE_PAYER_BALANCE ```typescript type TX_ERROR_INSUFFICIENT_FEE_PAYER_BALANCE = "Insufficient fee payer balance" ``` ### TX_ERROR_INSUFFICIENT_FEE_PER_GAS ```typescript type TX_ERROR_INSUFFICIENT_FEE_PER_GAS = "Insufficient fee per gas" ``` ### TX_ERROR_INSUFFICIENT_GAS_LIMIT ```typescript type TX_ERROR_INSUFFICIENT_GAS_LIMIT = "Gas limit is below the minimum fixed cost" ``` ### TX_ERROR_INVALID_INCLUDE_BY_TIMESTAMP ```typescript type TX_ERROR_INVALID_INCLUDE_BY_TIMESTAMP = "Invalid expiration timestamp" ``` ### TX_ERROR_INVALID_PROOF ```typescript type TX_ERROR_INVALID_PROOF = "Invalid proof" ``` ### TX_ERROR_SETUP_FUNCTION_NOT_ALLOWED ```typescript type TX_ERROR_SETUP_FUNCTION_NOT_ALLOWED = "Setup function not on allow list" ``` ### TreeHeights ```typescript type TreeHeights = typeof TREE_HEIGHTS ``` ### TreeInsertionStats ```typescript type TreeInsertionStats = { batchSize: number; duration: number; ... } ``` Stats for tree insertions ### TxAddedToPoolStats ```typescript type TxAddedToPoolStats = { eventName: "tx-added-to-pool" } & TxStats ``` A new tx was added to the tx pool. ### TxStats ```typescript type TxStats = { classPublishedCount: number; contractClassLogSize: number; ... } ``` Stats for a tx. ### TxValidationResult ```typescript type TxValidationResult = { result: "valid" } | { reason: string[]; result: "invalid" } | { reason: string[]; result: "skipped" } ``` ### TypedStructFieldValue ```typescript type TypedStructFieldValue = { name: string; value: T } ``` ### UInt128 ```typescript type UInt128 = bigint ``` A type alias for a 128-bit unsigned integer. ### UInt32 ```typescript type UInt32 = number ``` A type alias for a 32-bit unsigned integer. ### UInt64 ```typescript type UInt64 = bigint ``` A type alias for a 64-bit unsigned integer. ### UltraHonkProofData ```typescript type UltraHonkProofData = ProofData ``` ### UploadSnapshotMetadata ```typescript type UploadSnapshotMetadata = Pick & Pick ``` ### UtilityFunctionMembershipProof ```typescript type UtilityFunctionMembershipProof = { artifactMetadataHash: Fr; artifactTreeLeafIndex: number; ... } ``` Sibling paths and commitments for proving membership of a utility function within a contract class. ### UtilityFunctionWithMembershipProof ```typescript type UtilityFunctionWithMembershipProof = UtilityFunction & UtilityFunctionMembershipProof ``` A utility function with a membership proof. ### ValidateBlockNegativeResult ```typescript type ValidateBlockNegativeResult = { attestations: CommitteeAttestation[]; attestors: EthAddress[]; ... } | { attestations: CommitteeAttestation[]; attestors: EthAddress[]; ... } ``` Subtype for invalid block validation results ### ValidateBlockResult ```typescript type ValidateBlockResult = { valid: true } | ValidateBlockNegativeResult ``` Result type for validating a block attestations ### ValidatorClientFullConfig ```typescript type ValidatorClientFullConfig = ValidatorClientConfig & Pick & Pick & { disableTransactions?: boolean } ``` ### ValidatorMissedStats ```typescript type ValidatorMissedStats = { count: number; currentStreak: number; ... } ``` ### ValidatorSlash ```typescript type ValidatorSlash = { amount: bigint; offenses: ValidatorSlashOffense[]; validator: EthAddress } ``` Slashed amount and total offenses by a validator in the context of a slash payload ### ValidatorSlashOffense ```typescript type ValidatorSlashOffense = { epochOrSlot: bigint; offenseType: OffenseType } ``` Offense by a validator in the context of a slash payload ### ValidatorSlashVote ```typescript type ValidatorSlashVote = number ``` Votes for a validator slash in the consensus slash proposer ### ValidatorStats ```typescript type ValidatorStats = { address: EthAddress; history: ValidatorStatusHistory; ... } ``` ### ValidatorStatusHistory ```typescript type ValidatorStatusHistory = { slot: SlotNumber; status: ValidatorStatusInSlot }[] ``` ### ValidatorStatusInSlot ```typescript type ValidatorStatusInSlot = "block-mined" | "block-proposed" | "block-missed" | "attestation-sent" | "attestation-missed" ``` ### ValidatorStatusType ```typescript type ValidatorStatusType = "block" | "attestation" ``` ### ValidatorsEpochPerformance ```typescript type ValidatorsEpochPerformance = Record ``` ### ValidatorsStats ```typescript type ValidatorsStats = { initialSlot?: SlotNumber; lastProcessedSlot?: SlotNumber; ... } ``` ### ViemZkPassportProofParams ```typescript type ViemZkPassportProofParams = { commitments: { committedInputs: string }; proofVerificationData: { proof: string; publicInputs: string[]; vkeyHash: string }; serviceConfig: { devMode: boolean; domain: string; ... } } ``` ### chainConfigMappings ```typescript type chainConfigMappings = ConfigMappingsType ``` ### emptyChainConfig ```typescript type emptyChainConfig = ChainConfig ``` ### mockVerificationKey ```typescript type mockVerificationKey = "0000000200000800000000740000000f00000003515f3109623eb3c25aa5b16a1a79fd558bac7a7ce62c4560a8c537c77ce80dd339128d1d37b6582ee9e6df9567efb64313471dfa18f520f9ce53161b50dbf7731bc5f900000003515f322bc4cce83a486a92c92fd59bd84e0f92595baa639fc2ed86b00ffa0dfded2a092a669a3bdb7a273a015eda494457cc7ed5236f26cee330c290d45a33b9daa94800000003515f332729426c008c085a81bd34d8ef12dd31e80130339ef99d50013a89e4558eee6d0fa4ffe2ee7b7b62eb92608b2251ac31396a718f9b34978888789042b790a30100000003515f342be6b6824a913eb7a57b03cb1ee7bfb4de02f2f65fe8a4e97baa7766ddb353a82a8a25c49dc63778cd9fe96173f12a2bc77f3682f4c4448f98f1df82c75234a100000003515f351f85760d6ab567465aadc2f180af9eae3800e6958fec96aef53fd8a7b195d7c000c6267a0dd5cfc22b3fe804f53e266069c0e36f51885baec1e7e67650c62e170000000c515f41524954484d455449430d9d0f8ece2aa12012fa21e6e5c859e97bd5704e5c122064a66051294bc5e04213f61f54a0ebdf6fee4d4a6ecf693478191de0c2899bcd8e86a636c8d3eff43400000003515f43224a99d02c86336737c8dd5b746c40d2be6aead8393889a76a18d664029096e90f7fe81adcc92a74350eada9622ac453f49ebac24a066a1f83b394df54dfa0130000000c515f46495845445f42415345060e8a013ed289c2f9fd7473b04f6594b138ddb4b4cf6b901622a14088f04b8d2c83ff74fce56e3d5573b99c7b26d85d5046ce0c6559506acb7a675e7713eb3a00000007515f4c4f4749430721a91cb8da4b917e054f72147e1760cfe0ef3d45090ac0f4961d84ec1996961a25e787b26bd8b50b1a99450f77a424a83513c2b33af268cd253b0587ff50c700000003515f4d05dbd8623b8652511e1eb38d38887a69eceb082f807514f09e127237c5213b401b9325b48c6c225968002318095f89d0ef9cf629b2b7f0172e03bc39aacf6ed800000007515f52414e474504b57a3805e41df328f5ca9aefa40fad5917391543b7b65c6476e60b8f72e9ad07c92f3b3e11c8feae96dedc4b14a6226ef3201244f37cfc1ee5b96781f48d2b000000075349474d415f3125001d1954a18571eaa007144c5a567bb0d2be4def08a8be918b8c05e3b27d312c59ed41e09e144eab5de77ca89a2fd783be702a47c951d3112e3de02ce6e47c000000075349474d415f3223994e6a23618e60fa01c449a7ab88378709197e186d48d604bfb6931ffb15ad11c5ec7a0700570f80088fd5198ab5d5c227f2ad2a455a6edeec024156bb7beb000000075349474d415f3300cda5845f23468a13275d18bddae27c6bb189cf9aa95b6a03a0cb6688c7e8d829639b45cf8607c525cc400b55ebf90205f2f378626dc3406cc59b2d1b474fba000000075349474d415f342d299e7928496ea2d37f10b43afd6a80c90a33b483090d18069ffa275eedb2fc2f82121e8de43dc036d99b478b6227ceef34248939987a19011f065d8b5cef5c0000000010000000000000000100000002000000030000000400000005000000060000000700000008000000090000000a0000000b0000000c0000000d0000000e0000000f" ``` ### nodeRpcConfigMappings ```typescript type nodeRpcConfigMappings = ConfigMappingsType ``` ### privateKernelResetDimensionNames ```typescript type privateKernelResetDimensionNames = DimensionName[] ``` ### proverConfigMappings ```typescript type proverConfigMappings = ConfigMappingsType ``` ### schemas ```typescript type schemas = { AztecAddress: ZodFor; BigInt: z.ZodPipeline, z.ZodBigInt>; ... } ``` Validation schemas for common types. Every schema must match its toJSON. Foundation schemas are repeated here to aid type inference ## Enums ### CircuitType CircuitType replaces ComposerType for now. When using Plonk, CircuitType is equivalent to the information of the proving system that will be used to construct a proof. In the future Aztec zk stack, more information must be specified (e.g., the curve over which circuits are constructed; Plonk vs Honk; zk-SNARK or just SNARK; etc). Values: `0`, `1` ### Comparator The comparator to use to compare. Values: `1`, `5`, `6`, `3`, `4`, `2` ### FunctionType Aztec.nr function types. Values: `private`, `public`, `utility` ### L2BlockSourceEvents Values: `invalidBlockDetected`, `l2BlockProven`, `l2PruneDetected` ### MerkleTreeId Defines the possible Merkle tree IDs. Values: `4`, `3`, `1`, `0`, `2` ### NoteStatus The status of notes to retrieve. Values: `1`, `2` ### OffenseType Values: `7`, `4`, `1`, `3`, `6`, `5`, `0`, `2` ### P2PClientType Values: `0`, `1` ### PeerErrorSeverity Values: `HighToleranceError`, `LowToleranceError`, `MidToleranceError` ### ProvingRequestType Values: `10`, `7`, `5`, `8`, `6`, `9`, `14`, `13`, `11`, `12`, `16`, `17`, `2`, `1`, `3`, `0`, `15`, `4` ### ReadRequestActionEnum Values: `1`, `2`, `0` ### RevertCodeEnum Values: `1`, `3`, `0`, `2` ### SignatureDomainSeparator Values: `2`, `1`, `0` ### TopicType Values: `block_attestation`, `block_proposal`, `tx` ### TxExecutionPhase Values: `1`, `0`, `2` ### TxStatus Possible status of a transaction. Values: `app_logic_reverted`, `both_reverted`, `dropped`, `pending`, `success`, `teardown_reverted` ### WorldStateRunningState Defines the possible states of the world state synchronizer. Values: `0`, `2`, `3`, `1` ## Cross-Package References This package references types from other Aztec packages: **@aztec/blob-lib** - `BatchedBlob`, `BlobAccumulator`, `BlockBlobData`, `FinalBlobAccumulator`, `FinalBlobBatchingChallenges`, `SpongeBlob`, `TxBlobData`, `TxStartMarker` **@aztec/constants** - `AVM_V2_PROOF_LENGTH_IN_FIELDS_PADDED`, `CHONK_PROOF_LENGTH`, `GeneratorIndex.IVSK_M`, `GeneratorIndex.NSK_M`, `GeneratorIndex.OVSK_M`, `GeneratorIndex.TSK_M`, `MAX_NOTE_HASH_READ_REQUESTS_PER_TX`, `MAX_NULLIFIER_READ_REQUESTS_PER_TX`, `NESTED_RECURSIVE_PROOF_LENGTH`, `NESTED_RECURSIVE_ROLLUP_HONK_PROOF_LENGTH`, `NOTE_HASH_TREE_HEIGHT`, `NULLIFIER_TREE_HEIGHT`, `RECURSIVE_PROOF_LENGTH`, `RECURSIVE_ROLLUP_HONK_PROOF_LENGTH` **@aztec/ethereum** - `L1ContractAddresses`, `L1TxRequest`, `ViemClient`, `ViemCommitteeAttestation`, `ViemCommitteeAttestations`, `ViemContentCommitment`, `ViemHeader` **@aztec/foundation** - `BlockNumber`, `Buffer32`, `BufferReader`, `Bufferable`, `CheckpointNumber`, `ConfigMappingsType`, `EpochNumber`, `EthAddress`, `FieldReader`, `Fieldable`, `FieldsOf`, `Fq`, `Fr`, `GrumpkinScalar`, `IndexedTreeLeaf`, `IndexedTreeLeafPreimage`, `K`, `Logger`, `MembershipWitness`, `MerkleTree`, `PartialBy`, `Point`, `PromiseWithResolvers`, `S`, `SchnorrSignature`, `Secp256k1Signer`, `SecretValue`, `SecretValue.schema`, `SiblingPath`, `Signature`, `SlotNumber`, `TClass`, `TKey`, `TValue`, `Timer`, `Tuple`, `TypedEventEmitter`, `ViemSignature`, `ViemTransactionSignature`, `ZodFor`, `ZodNullableOptional` **@aztec/noir-acvm_js** - `WitnessMap`