@aztec/pxe 0.0.1-commit.aada20e3 → 0.0.1-commit.b2a5d0dd1
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.
- package/dest/bin/check_oracle_version.js +4 -4
- package/dest/block_synchronizer/block_synchronizer.d.ts +9 -3
- package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
- package/dest/block_synchronizer/block_synchronizer.js +26 -2
- package/dest/config/index.d.ts +2 -2
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +8 -15
- package/dest/config/package_info.js +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +63 -29
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +206 -75
- package/dest/contract_function_simulator/ephemeral_array_service.d.ts +28 -0
- package/dest/contract_function_simulator/ephemeral_array_service.d.ts.map +1 -0
- package/dest/contract_function_simulator/ephemeral_array_service.js +78 -0
- package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts +7 -7
- package/dest/contract_function_simulator/execution_tagging_index_cache.d.ts.map +1 -1
- package/dest/contract_function_simulator/execution_tagging_index_cache.js +19 -11
- package/dest/contract_function_simulator/index.d.ts +2 -1
- package/dest/contract_function_simulator/index.d.ts.map +1 -1
- package/dest/contract_function_simulator/index.js +1 -0
- package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts +4 -6
- package/dest/contract_function_simulator/noir-structs/event_validation_request.d.ts.map +1 -1
- package/dest/contract_function_simulator/noir-structs/event_validation_request.js +8 -10
- package/dest/contract_function_simulator/noir-structs/log_retrieval_request.d.ts +1 -1
- package/dest/contract_function_simulator/noir-structs/log_retrieval_request.js +1 -1
- package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +2 -2
- package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts.map +1 -1
- package/dest/contract_function_simulator/noir-structs/log_retrieval_response.js +2 -4
- package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +4 -7
- package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts.map +1 -1
- package/dest/contract_function_simulator/noir-structs/note_validation_request.js +6 -11
- package/dest/contract_function_simulator/oracle/interfaces.d.ts +61 -45
- package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +47 -0
- package/dest/contract_function_simulator/oracle/oracle.d.ts +75 -44
- package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.js +282 -97
- package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +54 -78
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +114 -86
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +119 -64
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +315 -123
- package/dest/contract_function_simulator/pick_notes.d.ts +1 -1
- package/dest/contract_function_simulator/pick_notes.d.ts.map +1 -1
- package/dest/contract_function_simulator/pick_notes.js +20 -3
- package/dest/contract_function_simulator/proxied_contract_data_source.d.ts +1 -1
- package/dest/contract_function_simulator/proxied_contract_data_source.d.ts.map +1 -1
- package/dest/contract_function_simulator/proxied_contract_data_source.js +3 -0
- package/dest/contract_logging.d.ts +27 -0
- package/dest/contract_logging.d.ts.map +1 -0
- package/dest/contract_logging.js +38 -0
- package/dest/contract_sync/contract_sync_service.d.ts +44 -0
- package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
- package/dest/contract_sync/contract_sync_service.js +116 -0
- package/dest/contract_sync/helpers.d.ts +28 -0
- package/dest/contract_sync/helpers.d.ts.map +1 -0
- package/dest/contract_sync/{index.js → helpers.js} +14 -15
- package/dest/debug/pxe_debug_utils.d.ts +14 -10
- package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
- package/dest/debug/pxe_debug_utils.js +16 -15
- package/dest/entrypoints/client/bundle/index.d.ts +3 -1
- package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
- package/dest/entrypoints/client/bundle/index.js +2 -0
- package/dest/entrypoints/client/bundle/utils.d.ts +2 -2
- package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
- package/dest/entrypoints/client/bundle/utils.js +11 -3
- package/dest/entrypoints/client/lazy/index.d.ts +3 -1
- package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/index.js +2 -0
- package/dest/entrypoints/client/lazy/utils.d.ts +2 -2
- package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/utils.js +11 -3
- package/dest/entrypoints/pxe_creation_options.d.ts +3 -1
- package/dest/entrypoints/pxe_creation_options.d.ts.map +1 -1
- package/dest/entrypoints/pxe_creation_options.js +3 -1
- package/dest/entrypoints/server/index.d.ts +4 -3
- package/dest/entrypoints/server/index.d.ts.map +1 -1
- package/dest/entrypoints/server/index.js +3 -2
- package/dest/entrypoints/server/utils.d.ts +2 -2
- package/dest/entrypoints/server/utils.d.ts.map +1 -1
- package/dest/entrypoints/server/utils.js +11 -3
- package/dest/events/event_service.d.ts +3 -2
- package/dest/events/event_service.d.ts.map +1 -1
- package/dest/events/event_service.js +26 -5
- package/dest/events/private_event_filter_validator.d.ts +3 -2
- package/dest/events/private_event_filter_validator.d.ts.map +1 -1
- package/dest/events/private_event_filter_validator.js +15 -0
- package/dest/logs/log_service.d.ts +7 -7
- package/dest/logs/log_service.d.ts.map +1 -1
- package/dest/logs/log_service.js +33 -48
- package/dest/messages/message_context_service.d.ts +17 -0
- package/dest/messages/message_context_service.d.ts.map +1 -0
- package/dest/messages/message_context_service.js +36 -0
- package/dest/notes/note_service.d.ts +4 -4
- package/dest/notes/note_service.d.ts.map +1 -1
- package/dest/notes/note_service.js +17 -7
- package/dest/notes_filter.d.ts +24 -0
- package/dest/notes_filter.d.ts.map +1 -0
- package/dest/notes_filter.js +4 -0
- package/dest/oracle_version.d.ts +4 -3
- package/dest/oracle_version.d.ts.map +1 -1
- package/dest/oracle_version.js +20 -10
- package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts +4 -0
- package/dest/private_kernel/hints/compute_tx_expiration_timestamp.d.ts.map +1 -0
- package/dest/private_kernel/hints/{compute_tx_include_by_timestamp.js → compute_tx_expiration_timestamp.js} +12 -12
- package/dest/private_kernel/hints/index.d.ts +1 -1
- package/dest/private_kernel/hints/index.js +1 -1
- package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts +4 -3
- package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.d.ts.map +1 -1
- package/dest/private_kernel/hints/private_kernel_reset_private_inputs_builder.js +129 -68
- package/dest/private_kernel/hints/test_utils.d.ts +122 -0
- package/dest/private_kernel/hints/test_utils.d.ts.map +1 -0
- package/dest/private_kernel/hints/test_utils.js +203 -0
- package/dest/private_kernel/private_kernel_execution_prover.d.ts +1 -1
- package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
- package/dest/private_kernel/private_kernel_execution_prover.js +18 -13
- package/dest/private_kernel/private_kernel_oracle.d.ts +10 -6
- package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
- package/dest/private_kernel/private_kernel_oracle.js +19 -18
- package/dest/pxe.d.ts +74 -24
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +143 -84
- package/dest/storage/anchor_block_store/anchor_block_store.js +1 -1
- package/dest/storage/capsule_store/capsule_service.d.ts +21 -0
- package/dest/storage/capsule_store/capsule_service.d.ts.map +1 -0
- package/dest/storage/capsule_store/capsule_service.js +50 -0
- package/dest/storage/capsule_store/capsule_store.d.ts +9 -9
- package/dest/storage/capsule_store/capsule_store.d.ts.map +1 -1
- package/dest/storage/capsule_store/capsule_store.js +36 -28
- package/dest/storage/capsule_store/index.d.ts +2 -1
- package/dest/storage/capsule_store/index.d.ts.map +1 -1
- package/dest/storage/capsule_store/index.js +1 -0
- package/dest/storage/contract_store/contract_store.d.ts +42 -15
- package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
- package/dest/storage/contract_store/contract_store.js +148 -70
- package/dest/storage/metadata.d.ts +1 -1
- package/dest/storage/metadata.js +1 -1
- package/dest/storage/note_store/note_store.d.ts +3 -3
- package/dest/storage/note_store/note_store.d.ts.map +1 -1
- package/dest/storage/note_store/note_store.js +6 -4
- package/dest/storage/private_event_store/private_event_store.d.ts +1 -1
- package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
- package/dest/storage/private_event_store/private_event_store.js +3 -0
- package/dest/storage/private_event_store/stored_private_event.js +1 -1
- package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
- package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
- package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
- package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
- package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
- package/dest/tagging/get_all_logs_by_tags.js +17 -3
- package/dest/tagging/index.d.ts +3 -3
- package/dest/tagging/index.d.ts.map +1 -1
- package/dest/tagging/index.js +1 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +8 -22
- package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
- package/package.json +25 -16
- package/src/bin/check_oracle_version.ts +4 -4
- package/src/block_synchronizer/block_synchronizer.ts +28 -2
- package/src/config/index.ts +3 -9
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +366 -136
- package/src/contract_function_simulator/ephemeral_array_service.ts +110 -0
- package/src/contract_function_simulator/execution_tagging_index_cache.ts +19 -14
- package/src/contract_function_simulator/index.ts +1 -0
- package/src/contract_function_simulator/noir-structs/event_validation_request.ts +9 -9
- package/src/contract_function_simulator/noir-structs/log_retrieval_request.ts +1 -1
- package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +2 -5
- package/src/contract_function_simulator/noir-structs/note_validation_request.ts +4 -10
- package/src/contract_function_simulator/oracle/interfaces.ts +82 -54
- package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +104 -0
- package/src/contract_function_simulator/oracle/oracle.ts +364 -140
- package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +144 -178
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +530 -153
- package/src/contract_function_simulator/pick_notes.ts +22 -3
- package/src/contract_function_simulator/proxied_contract_data_source.ts +8 -1
- package/src/contract_logging.ts +52 -0
- package/src/contract_sync/contract_sync_service.ts +176 -0
- package/src/contract_sync/{index.ts → helpers.ts} +14 -35
- package/src/debug/pxe_debug_utils.ts +48 -18
- package/src/entrypoints/client/bundle/index.ts +2 -0
- package/src/entrypoints/client/bundle/utils.ts +11 -4
- package/src/entrypoints/client/lazy/index.ts +2 -0
- package/src/entrypoints/client/lazy/utils.ts +11 -4
- package/src/entrypoints/pxe_creation_options.ts +7 -0
- package/src/entrypoints/server/index.ts +3 -2
- package/src/entrypoints/server/utils.ts +9 -10
- package/src/events/event_service.ts +30 -5
- package/src/events/private_event_filter_validator.ts +21 -1
- package/src/logs/log_service.ts +63 -91
- package/src/messages/message_context_service.ts +44 -0
- package/src/notes/note_service.ts +19 -8
- package/src/notes_filter.ts +24 -0
- package/src/oracle_version.ts +20 -10
- package/src/private_kernel/hints/{compute_tx_include_by_timestamp.ts → compute_tx_expiration_timestamp.ts} +13 -13
- package/src/private_kernel/hints/index.ts +1 -1
- package/src/private_kernel/hints/private_kernel_reset_private_inputs_builder.ts +164 -117
- package/src/private_kernel/hints/test_utils.ts +325 -0
- package/src/private_kernel/private_kernel_execution_prover.ts +18 -16
- package/src/private_kernel/private_kernel_oracle.ts +21 -21
- package/src/pxe.ts +270 -134
- package/src/storage/anchor_block_store/anchor_block_store.ts +1 -1
- package/src/storage/capsule_store/capsule_service.ts +90 -0
- package/src/storage/capsule_store/capsule_store.ts +44 -26
- package/src/storage/capsule_store/index.ts +1 -0
- package/src/storage/contract_store/contract_store.ts +181 -80
- package/src/storage/metadata.ts +1 -1
- package/src/storage/note_store/note_store.ts +9 -5
- package/src/storage/private_event_store/private_event_store.ts +4 -0
- package/src/storage/private_event_store/stored_private_event.ts +1 -1
- package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
- package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
- package/src/tagging/get_all_logs_by_tags.ts +28 -4
- package/src/tagging/index.ts +2 -2
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +12 -25
- package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
- package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
- package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
- package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
- package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
- package/dest/contract_sync/index.d.ts +0 -24
- package/dest/contract_sync/index.d.ts.map +0 -1
- package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts +0 -4
- package/dest/private_kernel/hints/compute_tx_include_by_timestamp.d.ts.map +0 -1
package/src/pxe.ts
CHANGED
|
@@ -18,6 +18,7 @@ import {
|
|
|
18
18
|
} from '@aztec/stdlib/abi';
|
|
19
19
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
20
20
|
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
21
|
+
import type { L2TipsProvider } from '@aztec/stdlib/block';
|
|
21
22
|
import {
|
|
22
23
|
CompleteAddress,
|
|
23
24
|
type ContractInstanceWithAddress,
|
|
@@ -33,6 +34,7 @@ import type {
|
|
|
33
34
|
PrivateKernelTailCircuitPublicInputs,
|
|
34
35
|
} from '@aztec/stdlib/kernel';
|
|
35
36
|
import {
|
|
37
|
+
BlockHeader,
|
|
36
38
|
type ContractOverrides,
|
|
37
39
|
type InTx,
|
|
38
40
|
PrivateExecutionResult,
|
|
@@ -46,7 +48,7 @@ import {
|
|
|
46
48
|
TxProfileResult,
|
|
47
49
|
TxProvingResult,
|
|
48
50
|
TxSimulationResult,
|
|
49
|
-
|
|
51
|
+
UtilityExecutionResult,
|
|
50
52
|
} from '@aztec/stdlib/tx';
|
|
51
53
|
|
|
52
54
|
import { inspect } from 'util';
|
|
@@ -59,11 +61,14 @@ import {
|
|
|
59
61
|
generateSimulatedProvingResult,
|
|
60
62
|
} from './contract_function_simulator/contract_function_simulator.js';
|
|
61
63
|
import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
|
|
62
|
-
import {
|
|
64
|
+
import { displayDebugLogs } from './contract_logging.js';
|
|
65
|
+
import { ContractSyncService } from './contract_sync/contract_sync_service.js';
|
|
66
|
+
import { readCurrentClassId } from './contract_sync/helpers.js';
|
|
63
67
|
import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
|
|
64
68
|
import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
|
|
65
69
|
import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
|
|
66
70
|
import { JobCoordinator } from './job_coordinator/job_coordinator.js';
|
|
71
|
+
import { MessageContextService } from './messages/message_context_service.js';
|
|
67
72
|
import {
|
|
68
73
|
PrivateKernelExecutionProver,
|
|
69
74
|
type PrivateKernelExecutionProverConfig,
|
|
@@ -84,6 +89,58 @@ export type PackedPrivateEvent = InTx & {
|
|
|
84
89
|
eventSelector: EventSelector;
|
|
85
90
|
};
|
|
86
91
|
|
|
92
|
+
/** Options for PXE.profileTx. */
|
|
93
|
+
export type ProfileTxOpts = {
|
|
94
|
+
/** The profiling mode to use. */
|
|
95
|
+
profileMode: 'full' | 'execution-steps' | 'gates';
|
|
96
|
+
/** If true, proof generation is skipped during profiling. Defaults to true. */
|
|
97
|
+
skipProofGeneration?: boolean;
|
|
98
|
+
/** Addresses whose private state and keys are accessible during private execution. */
|
|
99
|
+
scopes: AztecAddress[];
|
|
100
|
+
};
|
|
101
|
+
|
|
102
|
+
/** Options for PXE.simulateTx. */
|
|
103
|
+
export type SimulateTxOpts = {
|
|
104
|
+
/** Whether to simulate the public part of the transaction. */
|
|
105
|
+
simulatePublic: boolean;
|
|
106
|
+
/** If false, this function throws if the transaction is unable to be included in a block at the current state. */
|
|
107
|
+
skipTxValidation?: boolean;
|
|
108
|
+
/** If false, fees are enforced. */
|
|
109
|
+
skipFeeEnforcement?: boolean;
|
|
110
|
+
/** If true, kernel logic is emulated in TS for simulation */
|
|
111
|
+
skipKernels?: boolean;
|
|
112
|
+
/** State overrides for the simulation, such as contract instances and artifacts. Requires skipKernels: true */
|
|
113
|
+
overrides?: SimulationOverrides;
|
|
114
|
+
/** Addresses whose private state and keys are accessible during private execution */
|
|
115
|
+
scopes: AztecAddress[];
|
|
116
|
+
};
|
|
117
|
+
|
|
118
|
+
/** Options for PXE.executeUtility. */
|
|
119
|
+
export type ExecuteUtilityOpts = {
|
|
120
|
+
/** The authentication witnesses required for the function call. */
|
|
121
|
+
authwits?: AuthWitness[];
|
|
122
|
+
/** The accounts whose notes we can access in this call */
|
|
123
|
+
scopes: AztecAddress[];
|
|
124
|
+
};
|
|
125
|
+
|
|
126
|
+
/** Args for PXE.create. */
|
|
127
|
+
export type PXECreateArgs = {
|
|
128
|
+
/** The Aztec node to connect to. */
|
|
129
|
+
node: AztecNode;
|
|
130
|
+
/** The key-value store for persisting PXE state. */
|
|
131
|
+
store: AztecAsyncKVStore;
|
|
132
|
+
/** The prover for generating private kernel proofs. */
|
|
133
|
+
proofCreator: PrivateKernelProver;
|
|
134
|
+
/** The circuit simulator for executing ACIR circuits. */
|
|
135
|
+
simulator: CircuitSimulator;
|
|
136
|
+
/** Provider for protocol contract artifacts and instances. */
|
|
137
|
+
protocolContractsProvider: ProtocolContractsProvider;
|
|
138
|
+
/** PXE configuration options. */
|
|
139
|
+
config: PXEConfig;
|
|
140
|
+
/** Optional logger instance or string suffix for the logger name. */
|
|
141
|
+
loggerOrSuffix?: string | Logger;
|
|
142
|
+
};
|
|
143
|
+
|
|
87
144
|
/**
|
|
88
145
|
* Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
|
|
89
146
|
* manage private state of users.
|
|
@@ -91,6 +148,7 @@ export type PackedPrivateEvent = InTx & {
|
|
|
91
148
|
export class PXE {
|
|
92
149
|
private constructor(
|
|
93
150
|
private node: AztecNode,
|
|
151
|
+
private db: AztecAsyncKVStore,
|
|
94
152
|
private blockStateSynchronizer: BlockSynchronizer,
|
|
95
153
|
private keyStore: KeyStore,
|
|
96
154
|
private contractStore: ContractStore,
|
|
@@ -102,6 +160,9 @@ export class PXE {
|
|
|
102
160
|
private recipientTaggingStore: RecipientTaggingStore,
|
|
103
161
|
private addressStore: AddressStore,
|
|
104
162
|
private privateEventStore: PrivateEventStore,
|
|
163
|
+
private contractSyncService: ContractSyncService,
|
|
164
|
+
private messageContextService: MessageContextService,
|
|
165
|
+
private l2TipsStore: L2TipsProvider,
|
|
105
166
|
private simulator: CircuitSimulator,
|
|
106
167
|
private proverEnabled: boolean,
|
|
107
168
|
private proofCreator: PrivateKernelProver,
|
|
@@ -119,15 +180,15 @@ export class PXE {
|
|
|
119
180
|
*
|
|
120
181
|
* @returns A promise that resolves PXE is ready to be used.
|
|
121
182
|
*/
|
|
122
|
-
public static async create(
|
|
123
|
-
node
|
|
124
|
-
store
|
|
125
|
-
proofCreator
|
|
126
|
-
simulator
|
|
127
|
-
protocolContractsProvider
|
|
128
|
-
config
|
|
129
|
-
loggerOrSuffix
|
|
130
|
-
) {
|
|
183
|
+
public static async create({
|
|
184
|
+
node,
|
|
185
|
+
store,
|
|
186
|
+
proofCreator,
|
|
187
|
+
simulator,
|
|
188
|
+
protocolContractsProvider,
|
|
189
|
+
config,
|
|
190
|
+
loggerOrSuffix,
|
|
191
|
+
}: PXECreateArgs) {
|
|
131
192
|
// Extract bindings from the logger, or use empty bindings if a string suffix is provided.
|
|
132
193
|
const bindings: LoggerBindings | undefined =
|
|
133
194
|
loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
|
|
@@ -137,7 +198,9 @@ export class PXE {
|
|
|
137
198
|
? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
|
|
138
199
|
: loggerOrSuffix;
|
|
139
200
|
|
|
140
|
-
const
|
|
201
|
+
const info = await node.getNodeInfo();
|
|
202
|
+
|
|
203
|
+
const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
|
|
141
204
|
const addressStore = new AddressStore(store);
|
|
142
205
|
const privateEventStore = new PrivateEventStore(store);
|
|
143
206
|
const contractStore = new ContractStore(store);
|
|
@@ -149,6 +212,14 @@ export class PXE {
|
|
|
149
212
|
const capsuleStore = new CapsuleStore(store);
|
|
150
213
|
const keyStore = new KeyStore(store);
|
|
151
214
|
const tipsStore = new L2TipsKVStore(store, 'pxe');
|
|
215
|
+
const contractSyncService = new ContractSyncService(
|
|
216
|
+
node,
|
|
217
|
+
contractStore,
|
|
218
|
+
noteStore,
|
|
219
|
+
createLogger('pxe:contract_sync', bindings),
|
|
220
|
+
);
|
|
221
|
+
const messageContextService = new MessageContextService(node);
|
|
222
|
+
|
|
152
223
|
const synchronizer = new BlockSynchronizer(
|
|
153
224
|
node,
|
|
154
225
|
store,
|
|
@@ -156,6 +227,7 @@ export class PXE {
|
|
|
156
227
|
noteStore,
|
|
157
228
|
privateEventStore,
|
|
158
229
|
tipsStore,
|
|
230
|
+
contractSyncService,
|
|
159
231
|
config,
|
|
160
232
|
bindings,
|
|
161
233
|
);
|
|
@@ -167,14 +239,16 @@ export class PXE {
|
|
|
167
239
|
recipientTaggingStore,
|
|
168
240
|
privateEventStore,
|
|
169
241
|
noteStore,
|
|
242
|
+
contractSyncService,
|
|
170
243
|
]);
|
|
171
244
|
|
|
172
|
-
const debugUtils = new PXEDebugUtils(
|
|
245
|
+
const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
|
|
173
246
|
|
|
174
247
|
const jobQueue = new SerialQueue();
|
|
175
248
|
|
|
176
249
|
const pxe = new PXE(
|
|
177
250
|
node,
|
|
251
|
+
store,
|
|
178
252
|
synchronizer,
|
|
179
253
|
keyStore,
|
|
180
254
|
contractStore,
|
|
@@ -186,6 +260,9 @@ export class PXE {
|
|
|
186
260
|
recipientTaggingStore,
|
|
187
261
|
addressStore,
|
|
188
262
|
privateEventStore,
|
|
263
|
+
contractSyncService,
|
|
264
|
+
messageContextService,
|
|
265
|
+
tipsStore,
|
|
189
266
|
simulator,
|
|
190
267
|
proverEnabled,
|
|
191
268
|
proofCreator,
|
|
@@ -196,12 +273,15 @@ export class PXE {
|
|
|
196
273
|
debugUtils,
|
|
197
274
|
);
|
|
198
275
|
|
|
199
|
-
debugUtils.
|
|
276
|
+
debugUtils.setPXEHelpers(
|
|
277
|
+
pxe.#putInJobQueue.bind(pxe),
|
|
278
|
+
pxe.#getSimulatorForTx.bind(pxe),
|
|
279
|
+
pxe.#executeUtility.bind(pxe),
|
|
280
|
+
);
|
|
200
281
|
|
|
201
282
|
pxe.jobQueue.start();
|
|
202
283
|
|
|
203
284
|
await pxe.#registerProtocolContracts();
|
|
204
|
-
const info = await node.getNodeInfo();
|
|
205
285
|
log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
|
|
206
286
|
return pxe;
|
|
207
287
|
}
|
|
@@ -211,19 +291,22 @@ export class PXE {
|
|
|
211
291
|
#getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
|
|
212
292
|
const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
|
|
213
293
|
|
|
214
|
-
return new ContractFunctionSimulator(
|
|
215
|
-
proxyContractStore,
|
|
216
|
-
this.noteStore,
|
|
217
|
-
this.keyStore,
|
|
218
|
-
this.addressStore,
|
|
219
|
-
BenchmarkedNodeFactory.create(this.node),
|
|
220
|
-
this.
|
|
221
|
-
this.
|
|
222
|
-
this.
|
|
223
|
-
this.
|
|
224
|
-
this.
|
|
225
|
-
this.
|
|
226
|
-
|
|
294
|
+
return new ContractFunctionSimulator({
|
|
295
|
+
contractStore: proxyContractStore,
|
|
296
|
+
noteStore: this.noteStore,
|
|
297
|
+
keyStore: this.keyStore,
|
|
298
|
+
addressStore: this.addressStore,
|
|
299
|
+
aztecNode: BenchmarkedNodeFactory.create(this.node),
|
|
300
|
+
l2TipsStore: this.l2TipsStore,
|
|
301
|
+
senderTaggingStore: this.senderTaggingStore,
|
|
302
|
+
recipientTaggingStore: this.recipientTaggingStore,
|
|
303
|
+
senderAddressBookStore: this.senderAddressBookStore,
|
|
304
|
+
capsuleStore: this.capsuleStore,
|
|
305
|
+
privateEventStore: this.privateEventStore,
|
|
306
|
+
simulator: this.simulator,
|
|
307
|
+
contractSyncService: this.contractSyncService,
|
|
308
|
+
messageContextService: this.messageContextService,
|
|
309
|
+
});
|
|
227
310
|
}
|
|
228
311
|
|
|
229
312
|
#contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -275,9 +358,8 @@ export class PXE {
|
|
|
275
358
|
async #registerProtocolContracts() {
|
|
276
359
|
const registered: Record<string, string> = {};
|
|
277
360
|
for (const name of protocolContractNames) {
|
|
278
|
-
const { address,
|
|
279
|
-
|
|
280
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
361
|
+
const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
|
|
362
|
+
await this.contractStore.addContractArtifact(artifact);
|
|
281
363
|
await this.contractStore.addContractInstance(instance);
|
|
282
364
|
registered[name] = address.toString();
|
|
283
365
|
}
|
|
@@ -289,37 +371,30 @@ export class PXE {
|
|
|
289
371
|
async #executePrivate(
|
|
290
372
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
291
373
|
txRequest: TxExecutionRequest,
|
|
292
|
-
|
|
374
|
+
anchorBlockHeader: BlockHeader,
|
|
375
|
+
scopes: AztecAddress[],
|
|
293
376
|
jobId: string,
|
|
294
377
|
): Promise<PrivateExecutionResult> {
|
|
295
378
|
const { origin: contractAddress, functionSelector } = txRequest;
|
|
296
379
|
|
|
297
380
|
try {
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
await ensureContractSynced(
|
|
381
|
+
await this.contractSyncService.ensureContractSynced(
|
|
301
382
|
contractAddress,
|
|
302
383
|
functionSelector,
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
this.contractStore,
|
|
306
|
-
this.noteStore,
|
|
384
|
+
(privateSyncCall, execScopes) =>
|
|
385
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
307
386
|
anchorBlockHeader,
|
|
308
387
|
jobId,
|
|
388
|
+
scopes,
|
|
309
389
|
);
|
|
310
390
|
|
|
311
|
-
const result = await contractFunctionSimulator.run(
|
|
312
|
-
txRequest,
|
|
391
|
+
const result = await contractFunctionSimulator.run(txRequest, {
|
|
313
392
|
contractAddress,
|
|
314
|
-
functionSelector,
|
|
315
|
-
undefined,
|
|
393
|
+
selector: functionSelector,
|
|
316
394
|
anchorBlockHeader,
|
|
317
|
-
// The sender for tags is set by contracts, typically by an account
|
|
318
|
-
// contract entrypoint
|
|
319
|
-
undefined, // senderForTags
|
|
320
395
|
scopes,
|
|
321
396
|
jobId,
|
|
322
|
-
);
|
|
397
|
+
});
|
|
323
398
|
this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
|
|
324
399
|
return result;
|
|
325
400
|
} catch (err) {
|
|
@@ -331,25 +406,32 @@ export class PXE {
|
|
|
331
406
|
}
|
|
332
407
|
|
|
333
408
|
/**
|
|
334
|
-
*
|
|
409
|
+
* Execute a utility function call on the given contract.
|
|
335
410
|
* @param contractFunctionSimulator - The simulator to use for the function call.
|
|
336
411
|
* @param call - The function call to execute.
|
|
337
412
|
* @param authWitnesses - Authentication witnesses required for the function call.
|
|
338
413
|
* @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
|
|
339
414
|
* accounts if not specified.
|
|
340
415
|
* @param jobId - The job ID for staged writes.
|
|
341
|
-
* @returns The
|
|
416
|
+
* @returns The execution result containing the outputs of the utility function.
|
|
342
417
|
*/
|
|
343
|
-
async #
|
|
418
|
+
async #executeUtility(
|
|
344
419
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
345
420
|
call: FunctionCall,
|
|
346
421
|
authWitnesses: AuthWitness[] | undefined,
|
|
347
|
-
scopes: AztecAddress[]
|
|
422
|
+
scopes: AztecAddress[],
|
|
348
423
|
jobId: string,
|
|
349
424
|
) {
|
|
350
425
|
try {
|
|
351
426
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
352
|
-
|
|
427
|
+
const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
|
|
428
|
+
call,
|
|
429
|
+
authWitnesses ?? [],
|
|
430
|
+
anchorBlockHeader,
|
|
431
|
+
scopes,
|
|
432
|
+
jobId,
|
|
433
|
+
);
|
|
434
|
+
return { result, offchainEffects };
|
|
353
435
|
} catch (err) {
|
|
354
436
|
if (err instanceof SimulationError) {
|
|
355
437
|
await enrichSimulationError(err, this.contractStore, this.log);
|
|
@@ -400,11 +482,10 @@ export class PXE {
|
|
|
400
482
|
txExecutionRequest: TxExecutionRequest,
|
|
401
483
|
proofCreator: PrivateKernelProver,
|
|
402
484
|
privateExecutionResult: PrivateExecutionResult,
|
|
485
|
+
anchorBlockHeader: BlockHeader,
|
|
403
486
|
config: PrivateKernelExecutionProverConfig,
|
|
404
487
|
): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
|
|
405
|
-
const
|
|
406
|
-
const anchorBlockHash = await anchorBlockHeader.hash();
|
|
407
|
-
const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHash);
|
|
488
|
+
const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHeader);
|
|
408
489
|
const kernelTraceProver = new PrivateKernelExecutionProver(
|
|
409
490
|
kernelOracle,
|
|
410
491
|
proofCreator,
|
|
@@ -417,6 +498,21 @@ export class PXE {
|
|
|
417
498
|
|
|
418
499
|
// Public API
|
|
419
500
|
|
|
501
|
+
/**
|
|
502
|
+
* Returns the block header up to which the PXE has synced.
|
|
503
|
+
* @returns The synced block header
|
|
504
|
+
*/
|
|
505
|
+
public getSyncedBlockHeader(): Promise<BlockHeader> {
|
|
506
|
+
return this.#putInJobQueue(() => {
|
|
507
|
+
return this.anchorBlockStore.getBlockHeader();
|
|
508
|
+
});
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
/**
|
|
512
|
+
* Returns the contract instance for a given address, if it's registered in the PXE.
|
|
513
|
+
* @param address - The contract address.
|
|
514
|
+
* @returns The contract instance if found, undefined otherwise.
|
|
515
|
+
*/
|
|
420
516
|
public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
|
|
421
517
|
return this.contractStore.getContractInstance(address);
|
|
422
518
|
}
|
|
@@ -466,6 +562,12 @@ export class PXE {
|
|
|
466
562
|
* TODO: It's strange that we return the address here and I (benesjan) think we should drop the return value.
|
|
467
563
|
*/
|
|
468
564
|
public async registerSender(sender: AztecAddress): Promise<AztecAddress> {
|
|
565
|
+
if (!(await sender.isValid())) {
|
|
566
|
+
throw new Error(
|
|
567
|
+
`Address ${sender} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register it as a sender.`,
|
|
568
|
+
);
|
|
569
|
+
}
|
|
570
|
+
|
|
469
571
|
const accounts = await this.keyStore.getAccounts();
|
|
470
572
|
if (accounts.includes(sender)) {
|
|
471
573
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
@@ -476,6 +578,9 @@ export class PXE {
|
|
|
476
578
|
|
|
477
579
|
if (wasAdded) {
|
|
478
580
|
this.log.info(`Added sender:\n ${sender.toString()}`);
|
|
581
|
+
// Wipe the entire sync cache: the new sender's tagged logs could contain notes/events for any contract, so
|
|
582
|
+
// all contracts must re-sync to discover them. Queued to avoid wiping while a job is in flight.
|
|
583
|
+
await this.#putInJobQueue(() => Promise.resolve(this.contractSyncService.wipe()));
|
|
479
584
|
} else {
|
|
480
585
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
481
586
|
}
|
|
@@ -525,8 +630,7 @@ export class PXE {
|
|
|
525
630
|
* @param artifact - The build artifact for the contract class.
|
|
526
631
|
*/
|
|
527
632
|
public async registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
528
|
-
const
|
|
529
|
-
await this.contractStore.addContractArtifact(contractClassId, artifact);
|
|
633
|
+
const contractClassId = await this.contractStore.addContractArtifact(artifact);
|
|
530
634
|
this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
|
|
531
635
|
}
|
|
532
636
|
|
|
@@ -545,17 +649,17 @@ export class PXE {
|
|
|
545
649
|
if (artifact) {
|
|
546
650
|
// If the user provides an artifact, validate it against the expected class id and register it
|
|
547
651
|
const contractClass = await getContractClassFromArtifact(artifact);
|
|
548
|
-
|
|
549
|
-
if (!contractClassId.equals(instance.currentContractClassId)) {
|
|
652
|
+
if (!contractClass.id.equals(instance.currentContractClassId)) {
|
|
550
653
|
throw new Error(
|
|
551
|
-
`Artifact does not match expected class id (computed ${
|
|
654
|
+
`Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
|
|
552
655
|
);
|
|
553
656
|
}
|
|
554
657
|
const computedAddress = await computeContractAddressFromInstance(instance);
|
|
555
658
|
if (!computedAddress.equals(instance.address)) {
|
|
556
659
|
throw new Error('Added a contract in which the address does not match the contract instance.');
|
|
557
660
|
}
|
|
558
|
-
|
|
661
|
+
|
|
662
|
+
await this.contractStore.addContractArtifact(artifact, contractClass);
|
|
559
663
|
|
|
560
664
|
const publicFunctionSignatures = artifact.functions
|
|
561
665
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
@@ -604,15 +708,16 @@ export class PXE {
|
|
|
604
708
|
throw new Error('Could not update contract to a class different from the current one.');
|
|
605
709
|
}
|
|
606
710
|
|
|
607
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
608
|
-
|
|
609
711
|
const publicFunctionSignatures = artifact.functions
|
|
610
712
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
611
713
|
.map(fn => decodeFunctionSignature(fn.name, fn.parameters));
|
|
612
714
|
await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
|
|
613
715
|
|
|
614
716
|
currentInstance.currentContractClassId = contractClass.id;
|
|
615
|
-
await
|
|
717
|
+
await Promise.all([
|
|
718
|
+
this.contractStore.addContractArtifact(artifact, contractClass),
|
|
719
|
+
this.contractStore.addContractInstance(currentInstance),
|
|
720
|
+
]);
|
|
616
721
|
this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
|
|
617
722
|
});
|
|
618
723
|
}
|
|
@@ -630,11 +735,12 @@ export class PXE {
|
|
|
630
735
|
* (where validators prove the public portion).
|
|
631
736
|
*
|
|
632
737
|
* @param txRequest - An authenticated tx request ready for proving
|
|
738
|
+
* @param scopes - Addresses whose private state and keys are accessible during private execution.
|
|
633
739
|
* @returns A result containing the proof and public inputs of the tail circuit.
|
|
634
740
|
* @throws If contract code not found, or public simulation reverts.
|
|
635
741
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
636
742
|
*/
|
|
637
|
-
public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
|
|
743
|
+
public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
|
|
638
744
|
let privateExecutionResult: PrivateExecutionResult;
|
|
639
745
|
// We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
|
|
640
746
|
// computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
|
|
@@ -643,16 +749,23 @@ export class PXE {
|
|
|
643
749
|
try {
|
|
644
750
|
const syncTimer = new Timer();
|
|
645
751
|
await this.blockStateSynchronizer.sync();
|
|
752
|
+
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
646
753
|
const syncTime = syncTimer.ms();
|
|
647
754
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
648
|
-
privateExecutionResult = await this.#executePrivate(
|
|
755
|
+
privateExecutionResult = await this.#executePrivate(
|
|
756
|
+
contractFunctionSimulator,
|
|
757
|
+
txRequest,
|
|
758
|
+
anchorBlockHeader,
|
|
759
|
+
scopes,
|
|
760
|
+
jobId,
|
|
761
|
+
);
|
|
649
762
|
|
|
650
763
|
const {
|
|
651
764
|
publicInputs,
|
|
652
765
|
chonkProof,
|
|
653
766
|
executionSteps,
|
|
654
767
|
timings: { proving } = {},
|
|
655
|
-
} = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, {
|
|
768
|
+
} = await this.#prove(txRequest, this.proofCreator, privateExecutionResult, anchorBlockHeader, {
|
|
656
769
|
simulate: false,
|
|
657
770
|
skipFeeEnforcement: false,
|
|
658
771
|
profileMode: 'none',
|
|
@@ -687,17 +800,17 @@ export class PXE {
|
|
|
687
800
|
// transaction before this one is included in a block from this PXE, and that transaction contains a log with
|
|
688
801
|
// a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
|
|
689
802
|
// storing the tags here prevents linkage of txs sent from the same PXE.
|
|
690
|
-
const
|
|
691
|
-
if (
|
|
803
|
+
const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
|
|
804
|
+
if (taggingIndexRangesUsedInTheTx.length > 0) {
|
|
692
805
|
// TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
|
|
693
806
|
const txHash = (await txProvingResult.toTx()).txHash;
|
|
694
807
|
|
|
695
|
-
await this.senderTaggingStore.storePendingIndexes(
|
|
696
|
-
this.log.debug(`Stored used
|
|
697
|
-
|
|
808
|
+
await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
|
|
809
|
+
this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
|
|
810
|
+
taggingIndexRangesUsedInTheTx,
|
|
698
811
|
});
|
|
699
812
|
} else {
|
|
700
|
-
this.log.debug(`No
|
|
813
|
+
this.log.debug(`No tagging index ranges used in the tx`);
|
|
701
814
|
}
|
|
702
815
|
|
|
703
816
|
return txProvingResult;
|
|
@@ -709,17 +822,13 @@ export class PXE {
|
|
|
709
822
|
|
|
710
823
|
/**
|
|
711
824
|
* Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
|
|
712
|
-
*
|
|
713
|
-
* @param txRequest - An authenticated tx request ready for simulation
|
|
714
|
-
* @param msgSender - (Optional) The message sender to use for the simulation.
|
|
715
|
-
* @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
|
|
825
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
716
826
|
* @returns A trace of the program execution with gate counts.
|
|
717
827
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
718
828
|
*/
|
|
719
829
|
public profileTx(
|
|
720
830
|
txRequest: TxExecutionRequest,
|
|
721
|
-
profileMode
|
|
722
|
-
skipProofGeneration: boolean = true,
|
|
831
|
+
{ profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
|
|
723
832
|
): Promise<TxProfileResult> {
|
|
724
833
|
// We disable concurrent profiles for consistency with simulateTx.
|
|
725
834
|
return this.#putInJobQueue(async jobId => {
|
|
@@ -739,13 +848,15 @@ export class PXE {
|
|
|
739
848
|
);
|
|
740
849
|
const syncTimer = new Timer();
|
|
741
850
|
await this.blockStateSynchronizer.sync();
|
|
851
|
+
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
742
852
|
const syncTime = syncTimer.ms();
|
|
743
853
|
|
|
744
854
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
745
855
|
const privateExecutionResult = await this.#executePrivate(
|
|
746
856
|
contractFunctionSimulator,
|
|
747
857
|
txRequest,
|
|
748
|
-
|
|
858
|
+
anchorBlockHeader,
|
|
859
|
+
scopes,
|
|
749
860
|
jobId,
|
|
750
861
|
);
|
|
751
862
|
|
|
@@ -753,6 +864,7 @@ export class PXE {
|
|
|
753
864
|
txRequest,
|
|
754
865
|
this.proofCreator,
|
|
755
866
|
privateExecutionResult,
|
|
867
|
+
anchorBlockHeader,
|
|
756
868
|
{
|
|
757
869
|
simulate: skipProofGeneration,
|
|
758
870
|
skipFeeEnforcement: false,
|
|
@@ -804,12 +916,7 @@ export class PXE {
|
|
|
804
916
|
* In that case, the transaction returned is only potentially ready to be sent to the network for execution.
|
|
805
917
|
*
|
|
806
918
|
*
|
|
807
|
-
* @param txRequest - An authenticated tx request ready for simulation
|
|
808
|
-
* @param simulatePublic - Whether to simulate the public part of the transaction.
|
|
809
|
-
* @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
|
|
810
|
-
* @param skipFeeEnforcement - (Optional) If false, fees are enforced.
|
|
811
|
-
* @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
|
|
812
|
-
* @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all.
|
|
919
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
813
920
|
* @returns A simulated transaction result object that includes public and private return values.
|
|
814
921
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
815
922
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
@@ -818,11 +925,14 @@ export class PXE {
|
|
|
818
925
|
*/
|
|
819
926
|
public simulateTx(
|
|
820
927
|
txRequest: TxExecutionRequest,
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
928
|
+
{
|
|
929
|
+
simulatePublic,
|
|
930
|
+
skipTxValidation = false,
|
|
931
|
+
skipFeeEnforcement = false,
|
|
932
|
+
skipKernels = true,
|
|
933
|
+
overrides,
|
|
934
|
+
scopes,
|
|
935
|
+
}: SimulateTxOpts,
|
|
826
936
|
): Promise<TxSimulationResult> {
|
|
827
937
|
// We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
|
|
828
938
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
@@ -844,16 +954,33 @@ export class PXE {
|
|
|
844
954
|
);
|
|
845
955
|
const syncTimer = new Timer();
|
|
846
956
|
await this.blockStateSynchronizer.sync();
|
|
957
|
+
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
847
958
|
const syncTime = syncTimer.ms();
|
|
848
959
|
|
|
960
|
+
const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
|
|
961
|
+
const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
|
|
962
|
+
|
|
963
|
+
if (hasOverriddenContracts && !skipKernels) {
|
|
964
|
+
throw new Error(
|
|
965
|
+
'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
|
|
966
|
+
);
|
|
967
|
+
}
|
|
849
968
|
const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
969
|
+
|
|
970
|
+
if (hasOverriddenContracts) {
|
|
971
|
+
// Overridden contracts don't have a sync function, so calling sync on them would fail.
|
|
972
|
+
// We exclude them so the sync service skips them entirely.
|
|
973
|
+
this.contractSyncService.setExcludedFromSync(jobId, overriddenContracts);
|
|
974
|
+
}
|
|
854
975
|
|
|
855
976
|
// Execution of private functions only; no proving, and no kernel logic.
|
|
856
|
-
const privateExecutionResult = await this.#executePrivate(
|
|
977
|
+
const privateExecutionResult = await this.#executePrivate(
|
|
978
|
+
contractFunctionSimulator,
|
|
979
|
+
txRequest,
|
|
980
|
+
anchorBlockHeader,
|
|
981
|
+
scopes,
|
|
982
|
+
jobId,
|
|
983
|
+
);
|
|
857
984
|
|
|
858
985
|
let publicInputs: PrivateKernelTailCircuitPublicInputs | undefined;
|
|
859
986
|
let executionSteps: PrivateExecutionStep[] = [];
|
|
@@ -861,15 +988,22 @@ export class PXE {
|
|
|
861
988
|
if (skipKernels) {
|
|
862
989
|
({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
|
|
863
990
|
privateExecutionResult,
|
|
864
|
-
this.contractStore,
|
|
991
|
+
(addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
|
|
992
|
+
this.node,
|
|
865
993
|
));
|
|
866
994
|
} else {
|
|
867
995
|
// Kernel logic, plus proving of all private functions and kernels.
|
|
868
|
-
({ publicInputs, executionSteps } = await this.#prove(
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
996
|
+
({ publicInputs, executionSteps } = await this.#prove(
|
|
997
|
+
txRequest,
|
|
998
|
+
this.proofCreator,
|
|
999
|
+
privateExecutionResult,
|
|
1000
|
+
anchorBlockHeader,
|
|
1001
|
+
{
|
|
1002
|
+
simulate: true,
|
|
1003
|
+
skipFeeEnforcement,
|
|
1004
|
+
profileMode: 'none',
|
|
1005
|
+
},
|
|
1006
|
+
));
|
|
873
1007
|
}
|
|
874
1008
|
|
|
875
1009
|
const privateSimulationResult = new PrivateSimulationResult(privateExecutionResult, publicInputs);
|
|
@@ -880,6 +1014,9 @@ export class PXE {
|
|
|
880
1014
|
const publicSimulationTimer = new Timer();
|
|
881
1015
|
publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
|
|
882
1016
|
publicSimulationTime = publicSimulationTimer.ms();
|
|
1017
|
+
if (publicOutput?.debugLogs?.length) {
|
|
1018
|
+
await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
|
|
1019
|
+
}
|
|
883
1020
|
}
|
|
884
1021
|
|
|
885
1022
|
let validationTime: number | undefined;
|
|
@@ -888,7 +1025,8 @@ export class PXE {
|
|
|
888
1025
|
const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
|
|
889
1026
|
validationTime = validationTimer.ms();
|
|
890
1027
|
if (validationResult.result === 'invalid') {
|
|
891
|
-
|
|
1028
|
+
const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
|
|
1029
|
+
throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
|
|
892
1030
|
}
|
|
893
1031
|
}
|
|
894
1032
|
|
|
@@ -939,29 +1077,23 @@ export class PXE {
|
|
|
939
1077
|
inspect(txRequest),
|
|
940
1078
|
`simulatePublic=${simulatePublic}`,
|
|
941
1079
|
`skipTxValidation=${skipTxValidation}`,
|
|
942
|
-
`scopes=${scopes
|
|
1080
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
943
1081
|
);
|
|
944
1082
|
}
|
|
945
1083
|
});
|
|
946
1084
|
}
|
|
947
1085
|
|
|
948
1086
|
/**
|
|
949
|
-
*
|
|
950
|
-
*
|
|
1087
|
+
* Executes a contract utility function.
|
|
951
1088
|
* @param call - The function call containing the function details, arguments, and target contract address.
|
|
952
|
-
* @param authwits - (Optional) The authentication witnesses required for the function call.
|
|
953
|
-
* @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
|
|
954
|
-
* default to all.
|
|
955
|
-
* @returns The result of the utility function call, structured based on the function ABI.
|
|
956
1089
|
*/
|
|
957
|
-
public
|
|
1090
|
+
public executeUtility(
|
|
958
1091
|
call: FunctionCall,
|
|
959
|
-
authwits
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
// We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
|
|
1092
|
+
{ authwits, scopes }: ExecuteUtilityOpts = { scopes: [] },
|
|
1093
|
+
): Promise<UtilityExecutionResult> {
|
|
1094
|
+
// We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
|
|
963
1095
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
964
|
-
// delete the same read value, or reading values that another
|
|
1096
|
+
// delete the same read value, or reading values that another execution is currently modifying).
|
|
965
1097
|
return this.#putInJobQueue(async jobId => {
|
|
966
1098
|
try {
|
|
967
1099
|
const totalTimer = new Timer();
|
|
@@ -972,18 +1104,17 @@ export class PXE {
|
|
|
972
1104
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
973
1105
|
|
|
974
1106
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
975
|
-
await ensureContractSynced(
|
|
1107
|
+
await this.contractSyncService.ensureContractSynced(
|
|
976
1108
|
call.to,
|
|
977
1109
|
call.selector,
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
this.contractStore,
|
|
981
|
-
this.noteStore,
|
|
1110
|
+
(privateSyncCall, execScopes) =>
|
|
1111
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
982
1112
|
anchorBlockHeader,
|
|
983
1113
|
jobId,
|
|
1114
|
+
scopes,
|
|
984
1115
|
);
|
|
985
1116
|
|
|
986
|
-
const executionResult = await this.#
|
|
1117
|
+
const { result: executionResult, offchainEffects } = await this.#executeUtility(
|
|
987
1118
|
contractFunctionSimulator,
|
|
988
1119
|
call,
|
|
989
1120
|
authwits ?? [],
|
|
@@ -1004,14 +1135,19 @@ export class PXE {
|
|
|
1004
1135
|
};
|
|
1005
1136
|
|
|
1006
1137
|
const simulationStats = contractFunctionSimulator.getStats();
|
|
1007
|
-
return {
|
|
1138
|
+
return {
|
|
1139
|
+
result: executionResult,
|
|
1140
|
+
offchainEffects,
|
|
1141
|
+
anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
|
|
1142
|
+
stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
|
|
1143
|
+
};
|
|
1008
1144
|
} catch (err: any) {
|
|
1009
1145
|
const { to, name, args } = call;
|
|
1010
1146
|
const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
|
|
1011
1147
|
throw this.#contextualizeError(
|
|
1012
1148
|
err,
|
|
1013
|
-
`
|
|
1014
|
-
`scopes=${scopes
|
|
1149
|
+
`executeUtility ${to}:${name}(${stringifiedArgs})`,
|
|
1150
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
1015
1151
|
);
|
|
1016
1152
|
}
|
|
1017
1153
|
});
|
|
@@ -1044,16 +1180,14 @@ export class PXE {
|
|
|
1044
1180
|
|
|
1045
1181
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
1046
1182
|
|
|
1047
|
-
await ensureContractSynced(
|
|
1183
|
+
await this.contractSyncService.ensureContractSynced(
|
|
1048
1184
|
filter.contractAddress,
|
|
1049
1185
|
null,
|
|
1050
|
-
async privateSyncCall =>
|
|
1051
|
-
await this.#
|
|
1052
|
-
this.node,
|
|
1053
|
-
this.contractStore,
|
|
1054
|
-
this.noteStore,
|
|
1186
|
+
async (privateSyncCall, execScopes) =>
|
|
1187
|
+
await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1055
1188
|
anchorBlockHeader,
|
|
1056
1189
|
jobId,
|
|
1190
|
+
filter.scopes,
|
|
1057
1191
|
);
|
|
1058
1192
|
});
|
|
1059
1193
|
|
|
@@ -1068,9 +1202,11 @@ export class PXE {
|
|
|
1068
1202
|
}
|
|
1069
1203
|
|
|
1070
1204
|
/**
|
|
1071
|
-
* Stops the PXE's job queue.
|
|
1205
|
+
* Stops the PXE's job queue and closes the backing store.
|
|
1072
1206
|
*/
|
|
1073
|
-
public stop(): Promise<void> {
|
|
1074
|
-
|
|
1207
|
+
public async stop(): Promise<void> {
|
|
1208
|
+
await this.jobQueue.end();
|
|
1209
|
+
await this.blockStateSynchronizer.stop();
|
|
1210
|
+
await this.db.close();
|
|
1075
1211
|
}
|
|
1076
1212
|
}
|