@aztec/pxe 0.0.1-commit.ee80a48 → 0.0.1-commit.f103f88
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 +4 -2
- package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
- package/dest/block_synchronizer/block_synchronizer.js +13 -1
- 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 +205 -72
- 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 +300 -103
- package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +53 -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 +109 -86
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +118 -63
- 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 +9 -2
- 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 +16 -4
- 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 +19 -11
- package/dest/private_kernel/private_kernel_oracle.d.ts +6 -2
- package/dest/private_kernel/private_kernel_oracle.d.ts.map +1 -1
- package/dest/private_kernel/private_kernel_oracle.js +7 -3
- package/dest/pxe.d.ts +74 -24
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +132 -74
- 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 +33 -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 +145 -69
- 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/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 +7 -21
- 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 +12 -0
- package/src/config/index.ts +3 -9
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +365 -133
- 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 +373 -142
- package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +134 -180
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +530 -153
- package/src/contract_function_simulator/pick_notes.ts +9 -2
- 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 +17 -4
- 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 +19 -12
- package/src/private_kernel/private_kernel_oracle.ts +7 -7
- package/src/pxe.ts +236 -127
- package/src/storage/capsule_store/capsule_service.ts +90 -0
- package/src/storage/capsule_store/capsule_store.ts +34 -26
- package/src/storage/capsule_store/index.ts +1 -0
- package/src/storage/contract_store/contract_store.ts +174 -75
- package/src/storage/metadata.ts +1 -1
- package/src/storage/note_store/note_store.ts +9 -5
- 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 +9 -24
- 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,7 +371,7 @@ export class PXE {
|
|
|
289
371
|
async #executePrivate(
|
|
290
372
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
291
373
|
txRequest: TxExecutionRequest,
|
|
292
|
-
scopes: AztecAddress[]
|
|
374
|
+
scopes: AztecAddress[],
|
|
293
375
|
jobId: string,
|
|
294
376
|
): Promise<PrivateExecutionResult> {
|
|
295
377
|
const { origin: contractAddress, functionSelector } = txRequest;
|
|
@@ -297,29 +379,23 @@ export class PXE {
|
|
|
297
379
|
try {
|
|
298
380
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
299
381
|
|
|
300
|
-
await ensureContractSynced(
|
|
382
|
+
await this.contractSyncService.ensureContractSynced(
|
|
301
383
|
contractAddress,
|
|
302
384
|
functionSelector,
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
this.contractStore,
|
|
306
|
-
this.noteStore,
|
|
385
|
+
(privateSyncCall, execScopes) =>
|
|
386
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
307
387
|
anchorBlockHeader,
|
|
308
388
|
jobId,
|
|
389
|
+
scopes,
|
|
309
390
|
);
|
|
310
391
|
|
|
311
|
-
const result = await contractFunctionSimulator.run(
|
|
312
|
-
txRequest,
|
|
392
|
+
const result = await contractFunctionSimulator.run(txRequest, {
|
|
313
393
|
contractAddress,
|
|
314
|
-
functionSelector,
|
|
315
|
-
undefined,
|
|
394
|
+
selector: functionSelector,
|
|
316
395
|
anchorBlockHeader,
|
|
317
|
-
// The sender for tags is set by contracts, typically by an account
|
|
318
|
-
// contract entrypoint
|
|
319
|
-
undefined, // senderForTags
|
|
320
396
|
scopes,
|
|
321
397
|
jobId,
|
|
322
|
-
);
|
|
398
|
+
});
|
|
323
399
|
this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
|
|
324
400
|
return result;
|
|
325
401
|
} catch (err) {
|
|
@@ -331,25 +407,32 @@ export class PXE {
|
|
|
331
407
|
}
|
|
332
408
|
|
|
333
409
|
/**
|
|
334
|
-
*
|
|
410
|
+
* Execute a utility function call on the given contract.
|
|
335
411
|
* @param contractFunctionSimulator - The simulator to use for the function call.
|
|
336
412
|
* @param call - The function call to execute.
|
|
337
413
|
* @param authWitnesses - Authentication witnesses required for the function call.
|
|
338
414
|
* @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
|
|
339
415
|
* accounts if not specified.
|
|
340
416
|
* @param jobId - The job ID for staged writes.
|
|
341
|
-
* @returns The
|
|
417
|
+
* @returns The execution result containing the outputs of the utility function.
|
|
342
418
|
*/
|
|
343
|
-
async #
|
|
419
|
+
async #executeUtility(
|
|
344
420
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
345
421
|
call: FunctionCall,
|
|
346
422
|
authWitnesses: AuthWitness[] | undefined,
|
|
347
|
-
scopes: AztecAddress[]
|
|
423
|
+
scopes: AztecAddress[],
|
|
348
424
|
jobId: string,
|
|
349
425
|
) {
|
|
350
426
|
try {
|
|
351
427
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
352
|
-
|
|
428
|
+
const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
|
|
429
|
+
call,
|
|
430
|
+
authWitnesses ?? [],
|
|
431
|
+
anchorBlockHeader,
|
|
432
|
+
scopes,
|
|
433
|
+
jobId,
|
|
434
|
+
);
|
|
435
|
+
return { result, offchainEffects };
|
|
353
436
|
} catch (err) {
|
|
354
437
|
if (err instanceof SimulationError) {
|
|
355
438
|
await enrichSimulationError(err, this.contractStore, this.log);
|
|
@@ -417,6 +500,21 @@ export class PXE {
|
|
|
417
500
|
|
|
418
501
|
// Public API
|
|
419
502
|
|
|
503
|
+
/**
|
|
504
|
+
* Returns the block header up to which the PXE has synced.
|
|
505
|
+
* @returns The synced block header
|
|
506
|
+
*/
|
|
507
|
+
public getSyncedBlockHeader(): Promise<BlockHeader> {
|
|
508
|
+
return this.#putInJobQueue(() => {
|
|
509
|
+
return this.anchorBlockStore.getBlockHeader();
|
|
510
|
+
});
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
/**
|
|
514
|
+
* Returns the contract instance for a given address, if it's registered in the PXE.
|
|
515
|
+
* @param address - The contract address.
|
|
516
|
+
* @returns The contract instance if found, undefined otherwise.
|
|
517
|
+
*/
|
|
420
518
|
public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
|
|
421
519
|
return this.contractStore.getContractInstance(address);
|
|
422
520
|
}
|
|
@@ -466,6 +564,12 @@ export class PXE {
|
|
|
466
564
|
* TODO: It's strange that we return the address here and I (benesjan) think we should drop the return value.
|
|
467
565
|
*/
|
|
468
566
|
public async registerSender(sender: AztecAddress): Promise<AztecAddress> {
|
|
567
|
+
if (!(await sender.isValid())) {
|
|
568
|
+
throw new Error(
|
|
569
|
+
`Address ${sender} is not valid: it does not correspond to a point on the Grumpkin curve. Cannot register it as a sender.`,
|
|
570
|
+
);
|
|
571
|
+
}
|
|
572
|
+
|
|
469
573
|
const accounts = await this.keyStore.getAccounts();
|
|
470
574
|
if (accounts.includes(sender)) {
|
|
471
575
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
@@ -476,6 +580,9 @@ export class PXE {
|
|
|
476
580
|
|
|
477
581
|
if (wasAdded) {
|
|
478
582
|
this.log.info(`Added sender:\n ${sender.toString()}`);
|
|
583
|
+
// Wipe the entire sync cache: the new sender's tagged logs could contain notes/events for any contract, so
|
|
584
|
+
// all contracts must re-sync to discover them.
|
|
585
|
+
this.contractSyncService.wipe();
|
|
479
586
|
} else {
|
|
480
587
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
481
588
|
}
|
|
@@ -525,8 +632,7 @@ export class PXE {
|
|
|
525
632
|
* @param artifact - The build artifact for the contract class.
|
|
526
633
|
*/
|
|
527
634
|
public async registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
528
|
-
const
|
|
529
|
-
await this.contractStore.addContractArtifact(contractClassId, artifact);
|
|
635
|
+
const contractClassId = await this.contractStore.addContractArtifact(artifact);
|
|
530
636
|
this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
|
|
531
637
|
}
|
|
532
638
|
|
|
@@ -545,17 +651,17 @@ export class PXE {
|
|
|
545
651
|
if (artifact) {
|
|
546
652
|
// If the user provides an artifact, validate it against the expected class id and register it
|
|
547
653
|
const contractClass = await getContractClassFromArtifact(artifact);
|
|
548
|
-
|
|
549
|
-
if (!contractClassId.equals(instance.currentContractClassId)) {
|
|
654
|
+
if (!contractClass.id.equals(instance.currentContractClassId)) {
|
|
550
655
|
throw new Error(
|
|
551
|
-
`Artifact does not match expected class id (computed ${
|
|
656
|
+
`Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
|
|
552
657
|
);
|
|
553
658
|
}
|
|
554
659
|
const computedAddress = await computeContractAddressFromInstance(instance);
|
|
555
660
|
if (!computedAddress.equals(instance.address)) {
|
|
556
661
|
throw new Error('Added a contract in which the address does not match the contract instance.');
|
|
557
662
|
}
|
|
558
|
-
|
|
663
|
+
|
|
664
|
+
await this.contractStore.addContractArtifact(artifact, contractClass);
|
|
559
665
|
|
|
560
666
|
const publicFunctionSignatures = artifact.functions
|
|
561
667
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
@@ -604,15 +710,16 @@ export class PXE {
|
|
|
604
710
|
throw new Error('Could not update contract to a class different from the current one.');
|
|
605
711
|
}
|
|
606
712
|
|
|
607
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
608
|
-
|
|
609
713
|
const publicFunctionSignatures = artifact.functions
|
|
610
714
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
611
715
|
.map(fn => decodeFunctionSignature(fn.name, fn.parameters));
|
|
612
716
|
await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
|
|
613
717
|
|
|
614
718
|
currentInstance.currentContractClassId = contractClass.id;
|
|
615
|
-
await
|
|
719
|
+
await Promise.all([
|
|
720
|
+
this.contractStore.addContractArtifact(artifact, contractClass),
|
|
721
|
+
this.contractStore.addContractInstance(currentInstance),
|
|
722
|
+
]);
|
|
616
723
|
this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
|
|
617
724
|
});
|
|
618
725
|
}
|
|
@@ -630,11 +737,12 @@ export class PXE {
|
|
|
630
737
|
* (where validators prove the public portion).
|
|
631
738
|
*
|
|
632
739
|
* @param txRequest - An authenticated tx request ready for proving
|
|
740
|
+
* @param scopes - Addresses whose private state and keys are accessible during private execution.
|
|
633
741
|
* @returns A result containing the proof and public inputs of the tail circuit.
|
|
634
742
|
* @throws If contract code not found, or public simulation reverts.
|
|
635
743
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
636
744
|
*/
|
|
637
|
-
public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
|
|
745
|
+
public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
|
|
638
746
|
let privateExecutionResult: PrivateExecutionResult;
|
|
639
747
|
// We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
|
|
640
748
|
// computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
|
|
@@ -645,7 +753,7 @@ export class PXE {
|
|
|
645
753
|
await this.blockStateSynchronizer.sync();
|
|
646
754
|
const syncTime = syncTimer.ms();
|
|
647
755
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
648
|
-
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest,
|
|
756
|
+
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
649
757
|
|
|
650
758
|
const {
|
|
651
759
|
publicInputs,
|
|
@@ -687,17 +795,17 @@ export class PXE {
|
|
|
687
795
|
// transaction before this one is included in a block from this PXE, and that transaction contains a log with
|
|
688
796
|
// a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
|
|
689
797
|
// storing the tags here prevents linkage of txs sent from the same PXE.
|
|
690
|
-
const
|
|
691
|
-
if (
|
|
798
|
+
const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
|
|
799
|
+
if (taggingIndexRangesUsedInTheTx.length > 0) {
|
|
692
800
|
// TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
|
|
693
801
|
const txHash = (await txProvingResult.toTx()).txHash;
|
|
694
802
|
|
|
695
|
-
await this.senderTaggingStore.storePendingIndexes(
|
|
696
|
-
this.log.debug(`Stored used
|
|
697
|
-
|
|
803
|
+
await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
|
|
804
|
+
this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
|
|
805
|
+
taggingIndexRangesUsedInTheTx,
|
|
698
806
|
});
|
|
699
807
|
} else {
|
|
700
|
-
this.log.debug(`No
|
|
808
|
+
this.log.debug(`No tagging index ranges used in the tx`);
|
|
701
809
|
}
|
|
702
810
|
|
|
703
811
|
return txProvingResult;
|
|
@@ -709,17 +817,13 @@ export class PXE {
|
|
|
709
817
|
|
|
710
818
|
/**
|
|
711
819
|
* 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.
|
|
820
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
716
821
|
* @returns A trace of the program execution with gate counts.
|
|
717
822
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
718
823
|
*/
|
|
719
824
|
public profileTx(
|
|
720
825
|
txRequest: TxExecutionRequest,
|
|
721
|
-
profileMode
|
|
722
|
-
skipProofGeneration: boolean = true,
|
|
826
|
+
{ profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
|
|
723
827
|
): Promise<TxProfileResult> {
|
|
724
828
|
// We disable concurrent profiles for consistency with simulateTx.
|
|
725
829
|
return this.#putInJobQueue(async jobId => {
|
|
@@ -742,12 +846,7 @@ export class PXE {
|
|
|
742
846
|
const syncTime = syncTimer.ms();
|
|
743
847
|
|
|
744
848
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
745
|
-
const privateExecutionResult = await this.#executePrivate(
|
|
746
|
-
contractFunctionSimulator,
|
|
747
|
-
txRequest,
|
|
748
|
-
undefined,
|
|
749
|
-
jobId,
|
|
750
|
-
);
|
|
849
|
+
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
751
850
|
|
|
752
851
|
const { executionSteps, timings: { proving } = {} } = await this.#prove(
|
|
753
852
|
txRequest,
|
|
@@ -804,12 +903,7 @@ export class PXE {
|
|
|
804
903
|
* In that case, the transaction returned is only potentially ready to be sent to the network for execution.
|
|
805
904
|
*
|
|
806
905
|
*
|
|
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.
|
|
906
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
813
907
|
* @returns A simulated transaction result object that includes public and private return values.
|
|
814
908
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
815
909
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
@@ -818,11 +912,14 @@ export class PXE {
|
|
|
818
912
|
*/
|
|
819
913
|
public simulateTx(
|
|
820
914
|
txRequest: TxExecutionRequest,
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
915
|
+
{
|
|
916
|
+
simulatePublic,
|
|
917
|
+
skipTxValidation = false,
|
|
918
|
+
skipFeeEnforcement = false,
|
|
919
|
+
skipKernels = true,
|
|
920
|
+
overrides,
|
|
921
|
+
scopes,
|
|
922
|
+
}: SimulateTxOpts,
|
|
826
923
|
): Promise<TxSimulationResult> {
|
|
827
924
|
// We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
|
|
828
925
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
@@ -846,11 +943,21 @@ export class PXE {
|
|
|
846
943
|
await this.blockStateSynchronizer.sync();
|
|
847
944
|
const syncTime = syncTimer.ms();
|
|
848
945
|
|
|
946
|
+
const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
|
|
947
|
+
const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
|
|
948
|
+
|
|
949
|
+
if (hasOverriddenContracts && !skipKernels) {
|
|
950
|
+
throw new Error(
|
|
951
|
+
'Simulating with overridden contracts is not compatible with kernel execution. Please set skipKernels to true when simulating with overridden contracts.',
|
|
952
|
+
);
|
|
953
|
+
}
|
|
849
954
|
const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
955
|
+
|
|
956
|
+
if (hasOverriddenContracts) {
|
|
957
|
+
// Overridden contracts don't have a sync function, so calling sync on them would fail.
|
|
958
|
+
// We exclude them so the sync service skips them entirely.
|
|
959
|
+
this.contractSyncService.setExcludedFromSync(jobId, overriddenContracts);
|
|
960
|
+
}
|
|
854
961
|
|
|
855
962
|
// Execution of private functions only; no proving, and no kernel logic.
|
|
856
963
|
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
@@ -861,7 +968,8 @@ export class PXE {
|
|
|
861
968
|
if (skipKernels) {
|
|
862
969
|
({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
|
|
863
970
|
privateExecutionResult,
|
|
864
|
-
this.contractStore,
|
|
971
|
+
(addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
|
|
972
|
+
this.node,
|
|
865
973
|
));
|
|
866
974
|
} else {
|
|
867
975
|
// Kernel logic, plus proving of all private functions and kernels.
|
|
@@ -880,6 +988,9 @@ export class PXE {
|
|
|
880
988
|
const publicSimulationTimer = new Timer();
|
|
881
989
|
publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
|
|
882
990
|
publicSimulationTime = publicSimulationTimer.ms();
|
|
991
|
+
if (publicOutput?.debugLogs?.length) {
|
|
992
|
+
await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
|
|
993
|
+
}
|
|
883
994
|
}
|
|
884
995
|
|
|
885
996
|
let validationTime: number | undefined;
|
|
@@ -888,7 +999,8 @@ export class PXE {
|
|
|
888
999
|
const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
|
|
889
1000
|
validationTime = validationTimer.ms();
|
|
890
1001
|
if (validationResult.result === 'invalid') {
|
|
891
|
-
|
|
1002
|
+
const reason = validationResult.reason.length > 0 ? ` Reason: ${validationResult.reason.join(', ')}` : '';
|
|
1003
|
+
throw new Error(`The simulated transaction is unable to be added to state and is invalid.${reason}`);
|
|
892
1004
|
}
|
|
893
1005
|
}
|
|
894
1006
|
|
|
@@ -939,29 +1051,23 @@ export class PXE {
|
|
|
939
1051
|
inspect(txRequest),
|
|
940
1052
|
`simulatePublic=${simulatePublic}`,
|
|
941
1053
|
`skipTxValidation=${skipTxValidation}`,
|
|
942
|
-
`scopes=${scopes
|
|
1054
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
943
1055
|
);
|
|
944
1056
|
}
|
|
945
1057
|
});
|
|
946
1058
|
}
|
|
947
1059
|
|
|
948
1060
|
/**
|
|
949
|
-
*
|
|
950
|
-
*
|
|
1061
|
+
* Executes a contract utility function.
|
|
951
1062
|
* @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
1063
|
*/
|
|
957
|
-
public
|
|
1064
|
+
public executeUtility(
|
|
958
1065
|
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.
|
|
1066
|
+
{ authwits, scopes }: ExecuteUtilityOpts = { scopes: [] },
|
|
1067
|
+
): Promise<UtilityExecutionResult> {
|
|
1068
|
+
// We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
|
|
963
1069
|
// 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
|
|
1070
|
+
// delete the same read value, or reading values that another execution is currently modifying).
|
|
965
1071
|
return this.#putInJobQueue(async jobId => {
|
|
966
1072
|
try {
|
|
967
1073
|
const totalTimer = new Timer();
|
|
@@ -972,18 +1078,17 @@ export class PXE {
|
|
|
972
1078
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
973
1079
|
|
|
974
1080
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
975
|
-
await ensureContractSynced(
|
|
1081
|
+
await this.contractSyncService.ensureContractSynced(
|
|
976
1082
|
call.to,
|
|
977
1083
|
call.selector,
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
this.contractStore,
|
|
981
|
-
this.noteStore,
|
|
1084
|
+
(privateSyncCall, execScopes) =>
|
|
1085
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
982
1086
|
anchorBlockHeader,
|
|
983
1087
|
jobId,
|
|
1088
|
+
scopes,
|
|
984
1089
|
);
|
|
985
1090
|
|
|
986
|
-
const executionResult = await this.#
|
|
1091
|
+
const { result: executionResult, offchainEffects } = await this.#executeUtility(
|
|
987
1092
|
contractFunctionSimulator,
|
|
988
1093
|
call,
|
|
989
1094
|
authwits ?? [],
|
|
@@ -1004,14 +1109,19 @@ export class PXE {
|
|
|
1004
1109
|
};
|
|
1005
1110
|
|
|
1006
1111
|
const simulationStats = contractFunctionSimulator.getStats();
|
|
1007
|
-
return {
|
|
1112
|
+
return {
|
|
1113
|
+
result: executionResult,
|
|
1114
|
+
offchainEffects,
|
|
1115
|
+
anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
|
|
1116
|
+
stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
|
|
1117
|
+
};
|
|
1008
1118
|
} catch (err: any) {
|
|
1009
1119
|
const { to, name, args } = call;
|
|
1010
1120
|
const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
|
|
1011
1121
|
throw this.#contextualizeError(
|
|
1012
1122
|
err,
|
|
1013
|
-
`
|
|
1014
|
-
`scopes=${scopes
|
|
1123
|
+
`executeUtility ${to}:${name}(${stringifiedArgs})`,
|
|
1124
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
1015
1125
|
);
|
|
1016
1126
|
}
|
|
1017
1127
|
});
|
|
@@ -1044,16 +1154,14 @@ export class PXE {
|
|
|
1044
1154
|
|
|
1045
1155
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
1046
1156
|
|
|
1047
|
-
await ensureContractSynced(
|
|
1157
|
+
await this.contractSyncService.ensureContractSynced(
|
|
1048
1158
|
filter.contractAddress,
|
|
1049
1159
|
null,
|
|
1050
|
-
async privateSyncCall =>
|
|
1051
|
-
await this.#
|
|
1052
|
-
this.node,
|
|
1053
|
-
this.contractStore,
|
|
1054
|
-
this.noteStore,
|
|
1160
|
+
async (privateSyncCall, execScopes) =>
|
|
1161
|
+
await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1055
1162
|
anchorBlockHeader,
|
|
1056
1163
|
jobId,
|
|
1164
|
+
filter.scopes,
|
|
1057
1165
|
);
|
|
1058
1166
|
});
|
|
1059
1167
|
|
|
@@ -1068,9 +1176,10 @@ export class PXE {
|
|
|
1068
1176
|
}
|
|
1069
1177
|
|
|
1070
1178
|
/**
|
|
1071
|
-
* Stops the PXE's job queue.
|
|
1179
|
+
* Stops the PXE's job queue and closes the backing store.
|
|
1072
1180
|
*/
|
|
1073
|
-
public stop(): Promise<void> {
|
|
1074
|
-
|
|
1181
|
+
public async stop(): Promise<void> {
|
|
1182
|
+
await this.jobQueue.end();
|
|
1183
|
+
await this.db.close();
|
|
1075
1184
|
}
|
|
1076
1185
|
}
|