@aztec/simulator 0.0.1-commit.f295ac2 → 0.0.1-commit.fc805bf

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (151) hide show
  1. package/dest/private/acvm/acvm.d.ts +4 -2
  2. package/dest/private/acvm/acvm.d.ts.map +1 -1
  3. package/dest/private/acvm/acvm.js +4 -3
  4. package/dest/private/acvm_native.d.ts +5 -3
  5. package/dest/private/acvm_native.d.ts.map +1 -1
  6. package/dest/private/acvm_native.js +8 -6
  7. package/dest/private/acvm_wasm.d.ts +4 -3
  8. package/dest/private/acvm_wasm.d.ts.map +1 -1
  9. package/dest/private/acvm_wasm.js +4 -4
  10. package/dest/private/circuit_recording/circuit_recorder.d.ts +4 -3
  11. package/dest/private/circuit_recording/circuit_recorder.d.ts.map +1 -1
  12. package/dest/private/circuit_recording/circuit_recorder.js +5 -3
  13. package/dest/private/circuit_recording/file_circuit_recorder.d.ts +3 -2
  14. package/dest/private/circuit_recording/file_circuit_recorder.d.ts.map +1 -1
  15. package/dest/private/circuit_recording/file_circuit_recorder.js +2 -2
  16. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts +7 -2
  17. package/dest/private/circuit_recording/memory_circuit_recorder.d.ts.map +1 -1
  18. package/dest/private/circuit_recording/memory_circuit_recorder.js +4 -4
  19. package/dest/private/factory.d.ts +3 -3
  20. package/dest/private/factory.d.ts.map +1 -1
  21. package/dest/private/factory.js +7 -4
  22. package/dest/public/avm/avm_context.d.ts +3 -3
  23. package/dest/public/avm/avm_context.d.ts.map +1 -1
  24. package/dest/public/avm/avm_contract_call_result.d.ts +6 -6
  25. package/dest/public/avm/avm_contract_call_result.d.ts.map +1 -1
  26. package/dest/public/avm/avm_contract_call_result.js +3 -3
  27. package/dest/public/avm/avm_execution_environment.d.ts +6 -5
  28. package/dest/public/avm/avm_execution_environment.d.ts.map +1 -1
  29. package/dest/public/avm/avm_machine_state.d.ts +6 -5
  30. package/dest/public/avm/avm_machine_state.d.ts.map +1 -1
  31. package/dest/public/avm/avm_machine_state.js +3 -2
  32. package/dest/public/avm/avm_memory_types.d.ts +1 -1
  33. package/dest/public/avm/avm_memory_types.d.ts.map +1 -1
  34. package/dest/public/avm/avm_memory_types.js +3 -0
  35. package/dest/public/avm/avm_simulator.d.ts +3 -2
  36. package/dest/public/avm/avm_simulator.d.ts.map +1 -1
  37. package/dest/public/avm/avm_simulator.js +5 -4
  38. package/dest/public/avm/calldata.d.ts +51 -0
  39. package/dest/public/avm/calldata.d.ts.map +1 -0
  40. package/dest/public/avm/calldata.js +63 -0
  41. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts +1 -1
  42. package/dest/public/avm/fixtures/avm_simulation_tester.d.ts.map +1 -1
  43. package/dest/public/avm/fixtures/avm_simulation_tester.js +3 -2
  44. package/dest/public/avm/fixtures/initializers.d.ts +1 -1
  45. package/dest/public/avm/fixtures/initializers.d.ts.map +1 -1
  46. package/dest/public/avm/fixtures/initializers.js +2 -1
  47. package/dest/public/avm/opcodes/accrued_substate.d.ts +3 -4
  48. package/dest/public/avm/opcodes/accrued_substate.d.ts.map +1 -1
  49. package/dest/public/avm/opcodes/accrued_substate.js +12 -12
  50. package/dest/public/avm/opcodes/contract.d.ts +1 -1
  51. package/dest/public/avm/opcodes/contract.d.ts.map +1 -1
  52. package/dest/public/avm/opcodes/contract.js +4 -4
  53. package/dest/public/avm/opcodes/external_calls.d.ts +1 -1
  54. package/dest/public/avm/opcodes/external_calls.d.ts.map +1 -1
  55. package/dest/public/avm/opcodes/external_calls.js +7 -7
  56. package/dest/public/avm/opcodes/memory.js +1 -1
  57. package/dest/public/avm/opcodes/storage.d.ts +13 -12
  58. package/dest/public/avm/opcodes/storage.d.ts.map +1 -1
  59. package/dest/public/avm/opcodes/storage.js +30 -20
  60. package/dest/public/debug_fn_name.d.ts +4 -4
  61. package/dest/public/debug_fn_name.d.ts.map +1 -1
  62. package/dest/public/debug_fn_name.js +7 -5
  63. package/dest/public/executor_metrics.d.ts +1 -1
  64. package/dest/public/executor_metrics.d.ts.map +1 -1
  65. package/dest/public/executor_metrics.js +7 -2
  66. package/dest/public/fixtures/opcode_spammer.d.ts +3 -4
  67. package/dest/public/fixtures/opcode_spammer.d.ts.map +1 -1
  68. package/dest/public/fixtures/opcode_spammer.js +30 -58
  69. package/dest/public/fuzzing/avm_simulator_bin.js +7 -4
  70. package/dest/public/public_db_sources.d.ts +4 -3
  71. package/dest/public/public_db_sources.d.ts.map +1 -1
  72. package/dest/public/public_db_sources.js +4 -4
  73. package/dest/public/public_processor/public_processor.d.ts +5 -3
  74. package/dest/public/public_processor/public_processor.d.ts.map +1 -1
  75. package/dest/public/public_processor/public_processor.js +8 -5
  76. package/dest/public/public_processor/public_processor_metrics.d.ts +2 -2
  77. package/dest/public/public_processor/public_processor_metrics.d.ts.map +1 -1
  78. package/dest/public/public_processor/public_processor_metrics.js +20 -4
  79. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts +3 -2
  80. package/dest/public/public_tx_simulator/contract_provider_for_cpp.d.ts.map +1 -1
  81. package/dest/public/public_tx_simulator/contract_provider_for_cpp.js +2 -2
  82. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts +5 -5
  83. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.d.ts.map +1 -1
  84. package/dest/public/public_tx_simulator/cpp_public_tx_simulator.js +8 -8
  85. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts +4 -4
  86. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.d.ts.map +1 -1
  87. package/dest/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.js +5 -5
  88. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts +4 -4
  89. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.d.ts.map +1 -1
  90. package/dest/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.js +6 -6
  91. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts +3 -2
  92. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.d.ts.map +1 -1
  93. package/dest/public/public_tx_simulator/dumping_cpp_public_tx_simulator.js +2 -2
  94. package/dest/public/public_tx_simulator/factories.d.ts +3 -2
  95. package/dest/public/public_tx_simulator/factories.d.ts.map +1 -1
  96. package/dest/public/public_tx_simulator/factories.js +3 -3
  97. package/dest/public/public_tx_simulator/public_tx_context.d.ts +4 -3
  98. package/dest/public/public_tx_simulator/public_tx_context.d.ts.map +1 -1
  99. package/dest/public/public_tx_simulator/public_tx_context.js +8 -8
  100. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts +4 -3
  101. package/dest/public/public_tx_simulator/public_tx_simulator.d.ts.map +1 -1
  102. package/dest/public/public_tx_simulator/public_tx_simulator.js +9 -6
  103. package/dest/public/side_effect_trace.d.ts +4 -4
  104. package/dest/public/side_effect_trace.d.ts.map +1 -1
  105. package/dest/public/side_effect_trace.js +3 -3
  106. package/dest/public/state_manager/state_manager.d.ts +10 -4
  107. package/dest/public/state_manager/state_manager.d.ts.map +1 -1
  108. package/dest/public/state_manager/state_manager.js +12 -5
  109. package/dest/public/test_executor_metrics.d.ts +3 -2
  110. package/dest/public/test_executor_metrics.d.ts.map +1 -1
  111. package/dest/public/test_executor_metrics.js +2 -2
  112. package/package.json +16 -16
  113. package/src/private/acvm/acvm.ts +4 -3
  114. package/src/private/acvm_native.ts +11 -5
  115. package/src/private/acvm_wasm.ts +7 -3
  116. package/src/private/circuit_recording/circuit_recorder.ts +5 -3
  117. package/src/private/circuit_recording/file_circuit_recorder.ts +7 -2
  118. package/src/private/circuit_recording/memory_circuit_recorder.ts +6 -4
  119. package/src/private/factory.ts +7 -4
  120. package/src/public/avm/avm_context.ts +2 -2
  121. package/src/public/avm/avm_contract_call_result.ts +8 -6
  122. package/src/public/avm/avm_execution_environment.ts +9 -4
  123. package/src/public/avm/avm_machine_state.ts +6 -5
  124. package/src/public/avm/avm_memory_types.ts +4 -0
  125. package/src/public/avm/avm_simulator.ts +8 -5
  126. package/src/public/avm/calldata.ts +100 -0
  127. package/src/public/avm/fixtures/avm_simulation_tester.ts +8 -2
  128. package/src/public/avm/fixtures/initializers.ts +2 -1
  129. package/src/public/avm/opcodes/accrued_substate.ts +13 -15
  130. package/src/public/avm/opcodes/contract.ts +1 -4
  131. package/src/public/avm/opcodes/external_calls.ts +8 -7
  132. package/src/public/avm/opcodes/memory.ts +1 -1
  133. package/src/public/avm/opcodes/storage.ts +28 -20
  134. package/src/public/debug_fn_name.ts +10 -8
  135. package/src/public/executor_metrics.ts +4 -1
  136. package/src/public/fixtures/opcode_spammer.ts +49 -53
  137. package/src/public/fuzzing/avm_simulator_bin.ts +11 -1
  138. package/src/public/public_db_sources.ts +15 -5
  139. package/src/public/public_processor/public_processor.ts +18 -5
  140. package/src/public/public_processor/public_processor_metrics.ts +10 -4
  141. package/src/public/public_tx_simulator/contract_provider_for_cpp.ts +6 -3
  142. package/src/public/public_tx_simulator/cpp_public_tx_simulator.ts +9 -6
  143. package/src/public/public_tx_simulator/cpp_public_tx_simulator_with_hinted_dbs.ts +6 -4
  144. package/src/public/public_tx_simulator/cpp_vs_ts_public_tx_simulator.ts +7 -5
  145. package/src/public/public_tx_simulator/dumping_cpp_public_tx_simulator.ts +3 -1
  146. package/src/public/public_tx_simulator/factories.ts +4 -2
  147. package/src/public/public_tx_simulator/public_tx_context.ts +13 -6
  148. package/src/public/public_tx_simulator/public_tx_simulator.ts +14 -5
  149. package/src/public/side_effect_trace.ts +5 -2
  150. package/src/public/state_manager/state_manager.ts +27 -4
  151. package/src/public/test_executor_metrics.ts +3 -3
@@ -1,4 +1,4 @@
1
- import { createLogger } from '@aztec/foundation/log';
1
+ import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
2
2
  import {
3
3
  type ExecutionError,
4
4
  type ForeignCallInput,
@@ -37,6 +37,7 @@ export interface ACIRExecutionResult {
37
37
  * @param acir - The ACIR circuit bytecode to execute.
38
38
  * @param initialWitness - The initial witness map defining all of the inputs to `circuit`.
39
39
  * @param callback - A callback to process any foreign calls from the circuit.
40
+ * @param logger - Optional logger for ACVM execution logs.
40
41
  * @returns The solved witness calculated by executing the circuit on the provided inputs, as well as the return
41
42
  * witness indices as specified by the circuit.
42
43
  */
@@ -44,9 +45,9 @@ export async function acvm(
44
45
  acir: Buffer,
45
46
  initialWitness: ACVMWitness,
46
47
  callback: ACIRCallback,
48
+ loggerOrBindings?: Logger | LoggerBindings,
47
49
  ): Promise<ACIRExecutionResult> {
48
- const logger = createLogger('simulator:acvm');
49
-
50
+ const logger = resolveLogger('simulator:acvm', loggerOrBindings);
50
51
  const solvedAndReturnWitness = await executeCircuitWithReturnWitness(
51
52
  acir,
52
53
  initialWitness,
@@ -1,5 +1,5 @@
1
1
  import { runInDirectory } from '@aztec/foundation/fs';
2
- import { createLogger } from '@aztec/foundation/log';
2
+ import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
3
3
  import { Timer } from '@aztec/foundation/timer';
4
4
  import type { ForeignCallHandler, WitnessMap } from '@aztec/noir-acvm_js';
5
5
  import type { FunctionArtifactWithContractName } from '@aztec/stdlib/abi';
@@ -12,8 +12,6 @@ import type { ACIRCallback, ACIRExecutionResult } from './acvm/acvm.js';
12
12
  import type { ACVMWitness } from './acvm/acvm_types.js';
13
13
  import type { CircuitSimulator } from './circuit_simulator.js';
14
14
 
15
- const logger = createLogger('simulator:acvm-native');
16
-
17
15
  export enum ACVM_RESULT {
18
16
  SUCCESS,
19
17
  FAILURE,
@@ -64,7 +62,9 @@ export async function executeNativeCircuit(
64
62
  workingDirectory: string,
65
63
  pathToAcvm: string,
66
64
  outputFilename?: string,
65
+ loggerOrBindings?: Logger | LoggerBindings,
67
66
  ): Promise<ACVMResult> {
67
+ const logger = resolveLogger('simulator:acvm-native', loggerOrBindings);
68
68
  const bytecodeFilename = 'bytecode';
69
69
  const witnessFilename = 'input_witness.toml';
70
70
 
@@ -145,11 +145,16 @@ export async function executeNativeCircuit(
145
145
  }
146
146
 
147
147
  export class NativeACVMSimulator implements CircuitSimulator {
148
+ private logger: Logger;
149
+
148
150
  constructor(
149
151
  private workingDirectory: string,
150
152
  private pathToAcvm: string,
151
153
  private witnessFilename?: string,
152
- ) {}
154
+ loggerOrBindings?: Logger | LoggerBindings,
155
+ ) {
156
+ this.logger = resolveLogger('simulator:acvm-native', loggerOrBindings);
157
+ }
153
158
 
154
159
  async executeProtocolCircuit(
155
160
  input: ACVMWitness,
@@ -172,6 +177,7 @@ export class NativeACVMSimulator implements CircuitSimulator {
172
177
  directory,
173
178
  this.pathToAcvm,
174
179
  this.witnessFilename,
180
+ this.logger,
175
181
  );
176
182
 
177
183
  if (result.status == ACVM_RESULT.FAILURE) {
@@ -181,7 +187,7 @@ export class NativeACVMSimulator implements CircuitSimulator {
181
187
  return result;
182
188
  };
183
189
 
184
- return await runInDirectory(this.workingDirectory, operation, false, logger);
190
+ return await runInDirectory(this.workingDirectory, operation, false, this.logger);
185
191
  }
186
192
 
187
193
  executeUserCircuit(
@@ -1,4 +1,4 @@
1
- import { createLogger } from '@aztec/foundation/log';
1
+ import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
2
2
  import { Timer } from '@aztec/foundation/timer';
3
3
  import initACVM, { type ExecutionError, type ForeignCallHandler, executeCircuit } from '@aztec/noir-acvm_js';
4
4
  import initAbi from '@aztec/noir-noirc_abi';
@@ -11,7 +11,11 @@ import type { ACVMSuccess } from './acvm_native.js';
11
11
  import { type CircuitSimulator, enrichNoirError } from './circuit_simulator.js';
12
12
 
13
13
  export class WASMSimulator implements CircuitSimulator {
14
- constructor(protected log = createLogger('wasm-simulator')) {}
14
+ protected log: Logger;
15
+
16
+ constructor(loggerOrBindings?: Logger | LoggerBindings) {
17
+ this.log = resolveLogger('wasm-simulator', loggerOrBindings);
18
+ }
15
19
 
16
20
  async init(): Promise<void> {
17
21
  // If these are available, then we are in the
@@ -67,6 +71,6 @@ export class WASMSimulator implements CircuitSimulator {
67
71
  callback: ACIRCallback,
68
72
  ): Promise<ACIRExecutionResult> {
69
73
  await this.init();
70
- return acvm(artifact.bytecode, input, callback);
74
+ return acvm(artifact.bytecode, input, callback, this.log.createChild('acvm'));
71
75
  }
72
76
  }
@@ -1,5 +1,5 @@
1
1
  import { sha512 } from '@aztec/foundation/crypto/sha512';
2
- import { createLogger } from '@aztec/foundation/log';
2
+ import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
3
3
  import { Timer } from '@aztec/foundation/timer';
4
4
  import type { ForeignCallHandler, ForeignCallInput, ForeignCallOutput } from '@aztec/noir-acvm_js';
5
5
 
@@ -89,14 +89,16 @@ export class CircuitRecording {
89
89
  * ```
90
90
  */
91
91
  export class CircuitRecorder {
92
- protected readonly logger = createLogger('simulator:acvm:recording');
92
+ protected readonly logger: Logger;
93
93
 
94
94
  protected recording?: CircuitRecording;
95
95
 
96
96
  private stackDepth: number = 0;
97
97
  private newCircuit: boolean = true;
98
98
 
99
- protected constructor() {}
99
+ protected constructor(loggerOrBindings?: Logger | LoggerBindings) {
100
+ this.logger = resolveLogger('simulator:acvm:recording', loggerOrBindings);
101
+ }
100
102
 
101
103
  /**
102
104
  * Initializes a new circuit recording session.
@@ -1,3 +1,5 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+
1
3
  import fs from 'fs/promises';
2
4
  import path from 'path';
3
5
 
@@ -7,8 +9,11 @@ import { CircuitRecorder, type CircuitRecording } from './circuit_recorder.js';
7
9
  export class FileCircuitRecorder extends CircuitRecorder {
8
10
  declare recording?: CircuitRecording & { filePath: string; isFirstCall: boolean };
9
11
 
10
- constructor(private readonly recordDir: string) {
11
- super();
12
+ constructor(
13
+ private readonly recordDir: string,
14
+ logger?: Logger,
15
+ ) {
16
+ super(logger);
12
17
  }
13
18
 
14
19
  override async start(
@@ -1,11 +1,13 @@
1
+ import type { Logger } from '@aztec/foundation/log';
2
+
1
3
  import { CircuitRecorder } from './circuit_recorder.js';
2
4
 
3
- /*
5
+ /**
4
6
  * In memory circuit recorder uses the default implementation. This is kept
5
- * while we decide the fate of the FileCircuitRecorder
7
+ * while we decide the fate of the FileCircuitRecorder.
6
8
  */
7
9
  export class MemoryCircuitRecorder extends CircuitRecorder {
8
- constructor() {
9
- super();
10
+ constructor(logger?: Logger) {
11
+ super(logger);
10
12
  }
11
13
  }
@@ -1,4 +1,4 @@
1
- import { type Logger, createLogger } from '@aztec/foundation/log';
1
+ import { type Logger, type LoggerBindings, resolveLogger } from '@aztec/foundation/log';
2
2
 
3
3
  import { promises as fs } from 'fs';
4
4
 
@@ -21,18 +21,21 @@ export function getSimulatorConfigFromEnv() {
21
21
 
22
22
  export async function createSimulator(
23
23
  config: SimulatorConfig,
24
- logger: Logger = createLogger('simulator'),
24
+ loggerOrBindings?: Logger | LoggerBindings,
25
25
  ): Promise<CircuitSimulator> {
26
+ const logger = resolveLogger('simulator', loggerOrBindings);
26
27
  if (config.acvmBinaryPath && config.acvmWorkingDirectory) {
27
28
  try {
28
29
  await fs.access(config.acvmBinaryPath, fs.constants.R_OK);
29
30
  await fs.mkdir(config.acvmWorkingDirectory, { recursive: true });
30
31
  logger.info(`Using native ACVM at ${config.acvmBinaryPath} and working directory ${config.acvmWorkingDirectory}`);
31
- return new NativeACVMSimulator(config.acvmWorkingDirectory, config.acvmBinaryPath);
32
+ const acvmLogger = logger.createChild('acvm-native');
33
+ return new NativeACVMSimulator(config.acvmWorkingDirectory, config.acvmBinaryPath, undefined, acvmLogger);
32
34
  } catch {
33
35
  logger.warn(`Failed to access ACVM at ${config.acvmBinaryPath}, falling back to WASM`);
34
36
  }
35
37
  }
36
38
  logger.info('Using WASM ACVM simulation');
37
- return new WASMSimulator();
39
+ const wasmLogger = logger.createChild('wasm');
40
+ return new WASMSimulator(wasmLogger);
38
41
  }
@@ -1,4 +1,3 @@
1
- import type { Fr } from '@aztec/foundation/curves/bn254';
2
1
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
3
2
 
4
3
  import type { PublicPersistableStateManager } from '../state_manager/state_manager.js';
@@ -6,6 +5,7 @@ import type { AvmExecutionEnvironment } from './avm_execution_environment.js';
6
5
  import { type Gas, gasToGasLeft } from './avm_gas.js';
7
6
  import { AvmMachineState } from './avm_machine_state.js';
8
7
  import type { AvmSimulatorInterface } from './avm_simulator_interface.js';
8
+ import type { CallData } from './calldata.js';
9
9
 
10
10
  /**
11
11
  * An execution context includes the information necessary to initiate AVM
@@ -45,7 +45,7 @@ export class AvmContext {
45
45
  */
46
46
  public async createNestedContractCallContext(
47
47
  address: AztecAddress,
48
- calldata: Fr[],
48
+ calldata: CallData,
49
49
  allocatedGas: Gas,
50
50
  callType: 'CALL' | 'STATICCALL',
51
51
  ): Promise<AvmContext> {
@@ -1,4 +1,3 @@
1
- import type { Fr } from '@aztec/foundation/curves/bn254';
2
1
  import type { SimulationError } from '@aztec/stdlib/errors';
3
2
  import { Gas } from '@aztec/stdlib/gas';
4
3
 
@@ -6,6 +5,7 @@ import { inspect } from 'util';
6
5
 
7
6
  import { createSimulationError } from '../../common/errors.js';
8
7
  import type { Gas as AvmGas } from './avm_gas.js';
8
+ import type { ReturnData } from './calldata.js';
9
9
  import type { AvmRevertReason } from './errors.js';
10
10
 
11
11
  /**
@@ -14,14 +14,14 @@ import type { AvmRevertReason } from './errors.js';
14
14
  export class AvmContractCallResult {
15
15
  constructor(
16
16
  public reverted: boolean,
17
- public output: Fr[],
17
+ public output: ReturnData,
18
18
  public gasLeft: AvmGas,
19
19
  public revertReason?: AvmRevertReason,
20
20
  public totalInstructions: number = 0, // including nested calls
21
21
  ) {}
22
22
 
23
23
  toString(): string {
24
- let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(
24
+ let resultsStr = `reverted: ${this.reverted}, output: ${this.output.bestEffortReadAll(10)}${this.output.length() > 10 ? ' ...' : ''}, gasLeft: ${inspect(
25
25
  this.gasLeft,
26
26
  )}, totalInstructions: ${this.totalInstructions}`;
27
27
  if (this.revertReason) {
@@ -31,7 +31,9 @@ export class AvmContractCallResult {
31
31
  }
32
32
 
33
33
  finalize(): AvmFinalizedCallResult {
34
- const revertReason = this.revertReason ? createSimulationError(this.revertReason, this.output) : undefined;
34
+ const revertReason = this.revertReason
35
+ ? createSimulationError(this.revertReason, this.output.bestEffortReadAll())
36
+ : undefined;
35
37
  return new AvmFinalizedCallResult(
36
38
  this.reverted,
37
39
  this.output,
@@ -49,14 +51,14 @@ export class AvmContractCallResult {
49
51
  export class AvmFinalizedCallResult {
50
52
  constructor(
51
53
  public reverted: boolean,
52
- public output: Fr[],
54
+ public output: ReturnData,
53
55
  public gasLeft: Gas,
54
56
  public revertReason?: SimulationError,
55
57
  public totalInstructions: number = 0, // including nested calls
56
58
  ) {}
57
59
 
58
60
  toString(): string {
59
- let resultsStr = `reverted: ${this.reverted}, output: ${this.output}, gasLeft: ${inspect(
61
+ let resultsStr = `reverted: ${this.reverted}, output: ${this.output.bestEffortReadAll(10)}${this.output.length() > 10 ? ' ...' : ''}, gasLeft: ${inspect(
60
62
  this.gasLeft,
61
63
  )}, totalInstructions: ${this.totalInstructions}`;
62
64
  if (this.revertReason) {
@@ -3,6 +3,8 @@ import type { PublicSimulatorConfig } from '@aztec/stdlib/avm';
3
3
  import type { AztecAddress } from '@aztec/stdlib/aztec-address';
4
4
  import type { GlobalVariables } from '@aztec/stdlib/tx';
5
5
 
6
+ import type { CallData } from './calldata.js';
7
+
6
8
  /**
7
9
  * Contains variables that remain constant during AVM execution
8
10
  * These variables are provided by the public kernel circuit
@@ -15,13 +17,13 @@ export class AvmExecutionEnvironment {
15
17
  public readonly transactionFee: Fr,
16
18
  public readonly globals: GlobalVariables,
17
19
  public readonly isStaticCall: boolean,
18
- public readonly calldata: Fr[],
20
+ public readonly calldata: CallData,
19
21
  public readonly config: PublicSimulatorConfig,
20
22
  ) {}
21
23
 
22
24
  private deriveEnvironmentForNestedCallInternal(
23
25
  targetAddress: AztecAddress,
24
- calldata: Fr[],
26
+ calldata: CallData,
25
27
  isStaticCall: boolean,
26
28
  ): AvmExecutionEnvironment {
27
29
  return new AvmExecutionEnvironment(
@@ -36,11 +38,14 @@ export class AvmExecutionEnvironment {
36
38
  );
37
39
  }
38
40
 
39
- public deriveEnvironmentForNestedCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment {
41
+ public deriveEnvironmentForNestedCall(targetAddress: AztecAddress, calldata: CallData): AvmExecutionEnvironment {
40
42
  return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ false);
41
43
  }
42
44
 
43
- public deriveEnvironmentForNestedStaticCall(targetAddress: AztecAddress, calldata: Fr[]): AvmExecutionEnvironment {
45
+ public deriveEnvironmentForNestedStaticCall(
46
+ targetAddress: AztecAddress,
47
+ calldata: CallData,
48
+ ): AvmExecutionEnvironment {
44
49
  return this.deriveEnvironmentForNestedCallInternal(targetAddress, calldata, /*isStaticCall=*/ true);
45
50
  }
46
51
  }
@@ -2,6 +2,7 @@ import type { Fr } from '@aztec/foundation/curves/bn254';
2
2
 
3
3
  import type { Gas } from './avm_gas.js';
4
4
  import { TaggedMemory } from './avm_memory_types.js';
5
+ import { type ReturnData, ReturnDataArray } from './calldata.js';
5
6
  import { type AvmRevertReason, OutOfGasError } from './errors.js';
6
7
 
7
8
  /**
@@ -39,7 +40,7 @@ export class AvmMachineState {
39
40
  /** program counter of the next instruction, byte based */
40
41
  public nextPc: number = 0;
41
42
  /** return/revertdata of the last nested call. */
42
- public nestedReturndata: Fr[] = [];
43
+ public nestedReturndata: ReturnData = new ReturnDataArray([]);
43
44
  /** Tracks whether the last external call was successful */
44
45
  public nestedCallSuccess: boolean = false;
45
46
  /**
@@ -66,7 +67,7 @@ export class AvmMachineState {
66
67
  /** Signals that execution has reverted normally (this does not cover exceptional halts) */
67
68
  private reverted: boolean = false;
68
69
  /** Output data must NOT be modified once it is set */
69
- private output: Fr[] = [];
70
+ private output: ReturnData = new ReturnDataArray([]);
70
71
 
71
72
  // Metrics only - not needed for execution
72
73
  /** instruction counter, including nested calls */
@@ -129,7 +130,7 @@ export class AvmMachineState {
129
130
  * Output data must NOT be modified once it is set
130
131
  * @param output
131
132
  */
132
- public return(output: Fr[]) {
133
+ public return(output: ReturnData) {
133
134
  this.halted = true;
134
135
  this.output = output;
135
136
  }
@@ -139,7 +140,7 @@ export class AvmMachineState {
139
140
  * Output data must NOT be modified once it is set
140
141
  * @param output
141
142
  */
142
- public revert(output: Fr[]) {
143
+ public revert(output: ReturnData) {
143
144
  this.halted = true;
144
145
  this.reverted = true;
145
146
  this.output = output;
@@ -153,7 +154,7 @@ export class AvmMachineState {
153
154
  return this.reverted;
154
155
  }
155
156
 
156
- public getOutput(): Fr[] {
157
+ public getOutput(): ReturnData {
157
158
  return this.output;
158
159
  }
159
160
 
@@ -369,6 +369,10 @@ export class TaggedMemory implements TaggedMemoryInterface {
369
369
  * Check tags for all memory in the specified range.
370
370
  */
371
371
  public checkTagsRange(tag: TypeTag, startOffset: number, size: number) {
372
+ if (startOffset + size > TaggedMemory.MAX_MEMORY_SIZE) {
373
+ throw new MemorySliceOutOfRangeError(startOffset, size);
374
+ }
375
+
372
376
  for (let offset = startOffset; offset < startOffset + size; offset++) {
373
377
  this.checkTag(tag, offset);
374
378
  }
@@ -15,6 +15,7 @@ import { AvmExecutionEnvironment } from './avm_execution_environment.js';
15
15
  import type { Gas } from './avm_gas.js';
16
16
  import { AvmMachineState } from './avm_machine_state.js';
17
17
  import type { AvmSimulatorInterface } from './avm_simulator_interface.js';
18
+ import { type CallData, ReturnDataArray } from './calldata.js';
18
19
  import { AvmRevertReason, InvalidProgramCounterError } from './errors.js';
19
20
  import type { Instruction } from './opcodes/instruction.js';
20
21
  import { revertReasonFromExceptionalHalt, revertReasonFromExplicitRevert } from './revert_reason.js';
@@ -49,7 +50,7 @@ export class AvmSimulator implements AvmSimulatorInterface {
49
50
  // This will be used by the CALL opcode to create a new simulator. It is required to
50
51
  // avoid a dependency cycle.
51
52
  context.provideSimulator = AvmSimulator.build;
52
- this.log = createLogger(`simulator:avm(calldata[0]: ${context.environment.calldata[0]})`);
53
+ this.log = createLogger(`simulator:avm(calldata[0]: ${context.environment.calldata.read(0)})`);
53
54
  // Turn on tallying if explicitly enabled or if trace logging
54
55
  if (enableTallying || this.log.isLevelEnabled('trace')) {
55
56
  this.tallyPrintFunction = this.printOpcodeTallies;
@@ -74,7 +75,7 @@ export class AvmSimulator implements AvmSimulatorInterface {
74
75
  transactionFee: Fr,
75
76
  globals: GlobalVariables,
76
77
  isStaticCall: boolean,
77
- calldata: Fr[],
78
+ calldata: CallData,
78
79
  allocatedGas: Gas,
79
80
  config: PublicSimulatorConfig,
80
81
  ) {
@@ -183,7 +184,9 @@ export class AvmSimulator implements AvmSimulatorInterface {
183
184
 
184
185
  const output = machineState.getOutput();
185
186
  const reverted = machineState.getReverted();
186
- const revertReason = reverted ? await revertReasonFromExplicitRevert(output, this.context) : undefined;
187
+ const revertReason = reverted
188
+ ? await revertReasonFromExplicitRevert(output.bestEffortReadAll(), this.context)
189
+ : undefined;
187
190
  const results = new AvmContractCallResult(
188
191
  reverted,
189
192
  output,
@@ -220,7 +223,7 @@ export class AvmSimulator implements AvmSimulatorInterface {
220
223
  // Note: "exceptional halts" cannot return data, hence [].
221
224
  const results = new AvmContractCallResult(
222
225
  /*reverted=*/ true,
223
- /*output=*/ [],
226
+ /*output=*/ new ReturnDataArray([]),
224
227
  noGasLeft,
225
228
  revertReason,
226
229
  machineState.instrCounter,
@@ -250,7 +253,7 @@ export class AvmSimulator implements AvmSimulatorInterface {
250
253
  this.log.warn(message);
251
254
  return new AvmContractCallResult(
252
255
  /*reverted=*/ true,
253
- /*output=*/ [],
256
+ /*output=*/ new ReturnDataArray([]),
254
257
  /*gasLeft=*/ { l2Gas: 0, daGas: 0 }, // consumes all allocated gas
255
258
  revertReason,
256
259
  );
@@ -0,0 +1,100 @@
1
+ import type { Fr } from '@aztec/foundation/schemas';
2
+
3
+ import { TaggedMemory } from './avm_memory_types.js';
4
+
5
+ // Allow reading up to 300 kB of return data when unspecified.
6
+ const DEFAULT_BEST_EFFORT_READ_CAP = 10000;
7
+
8
+ export interface LazyReader {
9
+ bestEffortReadAll(readCap?: number): Fr[];
10
+ readAll(): Fr[];
11
+ read(idx: number): Fr | undefined;
12
+ slice(start: number, end: number): Fr[];
13
+ length(): number;
14
+ }
15
+
16
+ export class LazyReaderMemory implements LazyReader {
17
+ constructor(
18
+ private memory: TaggedMemory,
19
+ private offset: number,
20
+ private size: number,
21
+ ) {}
22
+
23
+ public bestEffortReadAll(readCap = DEFAULT_BEST_EFFORT_READ_CAP): Fr[] {
24
+ const size = Math.min(this.size, readCap, TaggedMemory.MAX_MEMORY_SIZE - this.offset);
25
+ return this.memory.getSlice(this.offset, size).map(word => word.toFr());
26
+ }
27
+
28
+ public read(idx: number): Fr | undefined {
29
+ if (idx >= this.size) {
30
+ return undefined;
31
+ }
32
+ return this.memory.get(this.offset + idx).toFr();
33
+ }
34
+
35
+ public slice(start: number, end: number): Fr[] {
36
+ const clampedEnd = Math.min(end, this.size);
37
+ const length = Math.max(0, clampedEnd - start);
38
+ return this.memory.getSlice(this.offset + start, length).map(word => word.toFr());
39
+ }
40
+
41
+ public readAll(): Fr[] {
42
+ return this.memory.getSlice(this.offset, this.size).map(word => word.toFr());
43
+ }
44
+
45
+ public length(): number {
46
+ return this.size;
47
+ }
48
+ }
49
+
50
+ export class LazyReaderArray implements LazyReader {
51
+ constructor(private array: Fr[]) {}
52
+
53
+ public bestEffortReadAll(readCap = DEFAULT_BEST_EFFORT_READ_CAP): Fr[] {
54
+ return this.array.slice(0, readCap);
55
+ }
56
+
57
+ public read(idx: number): Fr | undefined {
58
+ return this.array[idx];
59
+ }
60
+
61
+ public slice(start: number, end: number): Fr[] {
62
+ return this.array.slice(start, end);
63
+ }
64
+
65
+ public readAll(): Fr[] {
66
+ return this.array;
67
+ }
68
+
69
+ public length(): number {
70
+ return this.array.length;
71
+ }
72
+ }
73
+
74
+ // Compile time branding to avoid swapping CallData and ReturnData by accident.
75
+ declare const CallDataBrand: unique symbol;
76
+ declare const ReturnDataBrand: unique symbol;
77
+
78
+ export type CallData = LazyReader & {
79
+ readonly [CallDataBrand]: true;
80
+ };
81
+
82
+ export type ReturnData = LazyReader & {
83
+ readonly [ReturnDataBrand]: true;
84
+ };
85
+
86
+ export class CallDataArray extends LazyReaderArray implements CallData {
87
+ declare readonly [CallDataBrand]: true;
88
+ }
89
+
90
+ export class CallDataMemory extends LazyReaderMemory implements CallData {
91
+ declare readonly [CallDataBrand]: true;
92
+ }
93
+
94
+ export class ReturnDataArray extends LazyReaderArray implements ReturnData {
95
+ declare readonly [ReturnDataBrand]: true;
96
+ }
97
+
98
+ export class ReturnDataMemory extends LazyReaderMemory implements ReturnData {
99
+ declare readonly [ReturnDataBrand]: true;
100
+ }
@@ -13,6 +13,7 @@ import { SimpleContractDataSource } from '../../fixtures/simple_contract_data_so
13
13
  import { PublicContractsDB, PublicTreesDB } from '../../public_db_sources.js';
14
14
  import { PublicPersistableStateManager } from '../../state_manager/state_manager.js';
15
15
  import { AvmSimulator } from '../avm_simulator.js';
16
+ import { CallDataArray } from '../calldata.js';
16
17
  import { BaseAvmSimulationTester } from './base_avm_simulation_tester.js';
17
18
  import { initContext, initExecutionEnvironment } from './initializers.js';
18
19
  import {
@@ -89,7 +90,7 @@ export class AvmSimulationTester extends BaseAvmSimulationTester {
89
90
  collectCallMetadata: true,
90
91
  });
91
92
  const environment = initExecutionEnvironment({
92
- calldata,
93
+ calldata: new CallDataArray(calldata),
93
94
  globals,
94
95
  address,
95
96
  sender,
@@ -105,7 +106,12 @@ export class AvmSimulationTester extends BaseAvmSimulationTester {
105
106
  if (result.reverted) {
106
107
  this.logger.error(`Error in ${fnName}:`);
107
108
  this.logger.error(
108
- resolveContractAssertionMessage(fnName, result.revertReason!, result.output, contractArtifact)!,
109
+ resolveContractAssertionMessage(
110
+ fnName,
111
+ result.revertReason!,
112
+ result.output.bestEffortReadAll(),
113
+ contractArtifact,
114
+ )!,
109
115
  );
110
116
  } else {
111
117
  this.logger.info(`Simulation of function ${fnName} succeeded!`);
@@ -19,6 +19,7 @@ import { AvmContext } from '../avm_context.js';
19
19
  import { AvmExecutionEnvironment } from '../avm_execution_environment.js';
20
20
  import { AvmMachineState } from '../avm_machine_state.js';
21
21
  import { AvmSimulator } from '../avm_simulator.js';
22
+ import { CallDataArray } from '../calldata.js';
22
23
  import { DEFAULT_TIMESTAMP } from './utils.js';
23
24
 
24
25
  /**
@@ -70,7 +71,7 @@ export function initExecutionEnvironment(overrides?: Partial<AvmExecutionEnviron
70
71
  overrides?.transactionFee ?? Fr.zero(),
71
72
  overrides?.globals ?? GlobalVariables.empty(),
72
73
  overrides?.isStaticCall ?? false,
73
- overrides?.calldata ?? [],
74
+ overrides?.calldata ?? new CallDataArray([]),
74
75
  overrides?.config ?? PublicSimulatorConfig.empty(),
75
76
  );
76
77
  }
@@ -1,3 +1,5 @@
1
+ import { MAX_ETH_ADDRESS_VALUE } from '@aztec/constants';
2
+
1
3
  import { NullifierCollisionError } from '../../side_effect_errors.js';
2
4
  import type { AvmContext } from '../avm_context.js';
3
5
  import { TypeTag, Uint1 } from '../avm_memory_types.js';
@@ -86,18 +88,11 @@ export class NullifierExists extends Instruction {
86
88
  static type: string = 'NULLIFIEREXISTS';
87
89
  static readonly opcode: Opcode = Opcode.NULLIFIEREXISTS;
88
90
  // Informs (de)serialization. See Instruction.deserialize.
89
- static readonly wireFormat = [
90
- OperandType.UINT8,
91
- OperandType.UINT8,
92
- OperandType.UINT16,
93
- OperandType.UINT16,
94
- OperandType.UINT16,
95
- ];
91
+ static readonly wireFormat = [OperandType.UINT8, OperandType.UINT8, OperandType.UINT16, OperandType.UINT16];
96
92
 
97
93
  constructor(
98
94
  private addressingMode: number,
99
- private nullifierOffset: number,
100
- private addressOffset: number,
95
+ private siloedNullifierOffset: number,
101
96
  private existsOffset: number,
102
97
  ) {
103
98
  super();
@@ -111,13 +106,12 @@ export class NullifierExists extends Instruction {
111
106
  this.baseGasCost(addressing.indirectOperandsCount(), addressing.relativeOperandsCount()),
112
107
  );
113
108
 
114
- const operands = [this.nullifierOffset, this.addressOffset, this.existsOffset];
115
- const [nullifierOffset, addressOffset, existsOffset] = addressing.resolve(operands, memory);
116
- memory.checkTags(TypeTag.FIELD, nullifierOffset, addressOffset);
109
+ const operands = [this.siloedNullifierOffset, this.existsOffset];
110
+ const [siloedNullifierOffset, existsOffset] = addressing.resolve(operands, memory);
111
+ memory.checkTag(TypeTag.FIELD, siloedNullifierOffset);
117
112
 
118
- const nullifier = memory.get(nullifierOffset).toFr();
119
- const address = memory.get(addressOffset).toAztecAddress();
120
- const exists = await context.persistableState.checkNullifierExists(address, nullifier);
113
+ const siloedNullifier = memory.get(siloedNullifierOffset).toFr();
114
+ const exists = await context.persistableState.checkSiloedNullifierExists(siloedNullifier);
121
115
 
122
116
  memory.set(existsOffset, exists ? new Uint1(1) : new Uint1(0));
123
117
  }
@@ -282,6 +276,10 @@ export class SendL2ToL1Message extends Instruction {
282
276
  memory.checkTags(TypeTag.FIELD, recipientOffset, contentOffset);
283
277
 
284
278
  const recipient = memory.get(recipientOffset).toFr();
279
+
280
+ if (recipient.toBigInt() > MAX_ETH_ADDRESS_VALUE) {
281
+ throw new InstructionExecutionError(`SENDL2TOL1MSG: Recipient address is too large`);
282
+ }
285
283
  const content = memory.get(contentOffset).toFr();
286
284
  context.persistableState.writeL2ToL1Message(context.environment.address, recipient, content);
287
285
  }
@@ -67,9 +67,6 @@ export class GetContractInstance extends Instruction {
67
67
  }
68
68
  }
69
69
 
70
- const existsOffset = dstOffset;
71
- const memberValueOffset = dstOffset + 1;
72
- memory.set(existsOffset, new Uint1(exists ? 1 : 0));
73
- memory.set(memberValueOffset, memberValue);
70
+ memory.setSlice(dstOffset, [new Uint1(exists ? 1 : 0), memberValue]);
74
71
  }
75
72
  }