@aztec/pxe 0.0.1-commit.d431d1c → 0.0.1-commit.d939eb5aa
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 +5 -5
- package/dest/block_synchronizer/block_synchronizer.d.ts +9 -5
- package/dest/block_synchronizer/block_synchronizer.d.ts.map +1 -1
- package/dest/block_synchronizer/block_synchronizer.js +68 -16
- package/dest/config/index.d.ts +4 -2
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +12 -2
- package/dest/config/package_info.js +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +63 -31
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +206 -78
- 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 +5 -7
- 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 +9 -11
- 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 +5 -8
- 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 +7 -12
- package/dest/contract_function_simulator/oracle/interfaces.d.ts +65 -46
- 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 -42
- package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.js +319 -112
- package/dest/contract_function_simulator/oracle/private_execution.d.ts +2 -22
- package/dest/contract_function_simulator/oracle/private_execution.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution.js +5 -40
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +59 -77
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +120 -86
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +134 -67
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +337 -151
- 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/helpers.js +60 -0
- package/dest/debug/pxe_debug_utils.d.ts +24 -10
- package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
- package/dest/debug/pxe_debug_utils.js +28 -17
- 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 +23 -9
- 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 +3 -3
- package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/utils.js +24 -10
- package/dest/entrypoints/pxe_creation_options.d.ts +5 -2
- 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 -2
- package/dest/entrypoints/server/index.d.ts.map +1 -1
- package/dest/entrypoints/server/index.js +3 -1
- 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 +30 -11
- package/dest/events/event_service.d.ts +6 -6
- package/dest/events/event_service.d.ts.map +1 -1
- package/dest/events/event_service.js +21 -10
- 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/job_coordinator/job_coordinator.d.ts +3 -2
- package/dest/job_coordinator/job_coordinator.d.ts.map +1 -1
- package/dest/job_coordinator/job_coordinator.js +3 -2
- package/dest/logs/log_service.d.ts +10 -9
- package/dest/logs/log_service.d.ts.map +1 -1
- package/dest/logs/log_service.js +50 -64
- 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 +8 -8
- package/dest/notes/note_service.d.ts.map +1 -1
- package/dest/notes/note_service.js +29 -19
- 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 -9
- 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 +3 -2
- package/dest/private_kernel/private_kernel_execution_prover.d.ts.map +1 -1
- package/dest/private_kernel/private_kernel_execution_prover.js +20 -15
- package/dest/private_kernel/private_kernel_oracle.d.ts +8 -4
- 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 +142 -80
- package/dest/storage/address_store/address_store.d.ts +1 -1
- package/dest/storage/address_store/address_store.d.ts.map +1 -1
- package/dest/storage/address_store/address_store.js +12 -11
- package/dest/storage/anchor_block_store/anchor_block_store.d.ts +9 -1
- package/dest/storage/anchor_block_store/anchor_block_store.d.ts.map +1 -1
- package/dest/storage/anchor_block_store/anchor_block_store.js +8 -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 +39 -36
- 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 -16
- package/dest/storage/contract_store/contract_store.d.ts.map +1 -1
- package/dest/storage/contract_store/contract_store.js +157 -84
- package/dest/storage/metadata.d.ts +1 -1
- package/dest/storage/metadata.js +1 -1
- package/dest/storage/note_store/note_store.d.ts +47 -49
- package/dest/storage/note_store/note_store.d.ts.map +1 -1
- package/dest/storage/note_store/note_store.js +278 -252
- package/dest/storage/note_store/stored_note.d.ts +16 -0
- package/dest/storage/note_store/stored_note.d.ts.map +1 -0
- package/dest/storage/note_store/stored_note.js +43 -0
- package/dest/storage/private_event_store/private_event_store.d.ts +17 -4
- package/dest/storage/private_event_store/private_event_store.d.ts.map +1 -1
- package/dest/storage/private_event_store/private_event_store.js +198 -147
- package/dest/storage/private_event_store/stored_private_event.d.ts +23 -0
- package/dest/storage/private_event_store/stored_private_event.d.ts.map +1 -0
- package/dest/storage/private_event_store/stored_private_event.js +56 -0
- 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/recipient_tagging_store.js +31 -19
- package/dest/storage/tagging_store/sender_address_book_store.d.ts +1 -1
- package/dest/storage/tagging_store/sender_address_book_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_address_book_store.js +20 -14
- 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 +233 -137
- package/dest/tagging/get_all_logs_by_tags.d.ts +24 -0
- package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -0
- package/dest/tagging/get_all_logs_by_tags.js +60 -0
- package/dest/tagging/index.d.ts +4 -3
- package/dest/tagging/index.d.ts.map +1 -1
- package/dest/tagging/index.js +2 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +5 -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 +7 -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 +16 -12
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +5 -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 +23 -16
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +6 -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 +42 -27
- package/package.json +25 -16
- package/src/bin/check_oracle_version.ts +5 -4
- package/src/block_synchronizer/block_synchronizer.ts +82 -33
- package/src/config/index.ts +9 -1
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +366 -142
- 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 +10 -10
- 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 +5 -11
- package/src/contract_function_simulator/oracle/interfaces.ts +95 -58
- package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +104 -0
- package/src/contract_function_simulator/oracle/oracle.ts +404 -150
- package/src/contract_function_simulator/oracle/private_execution.ts +5 -64
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +160 -182
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +564 -182
- 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/helpers.ts +98 -0
- package/src/debug/pxe_debug_utils.ts +63 -18
- package/src/entrypoints/client/bundle/index.ts +2 -0
- package/src/entrypoints/client/bundle/utils.ts +18 -18
- package/src/entrypoints/client/lazy/index.ts +2 -0
- package/src/entrypoints/client/lazy/utils.ts +19 -18
- package/src/entrypoints/pxe_creation_options.ts +9 -1
- package/src/entrypoints/server/index.ts +3 -1
- package/src/entrypoints/server/utils.ts +24 -29
- package/src/events/event_service.ts +22 -11
- package/src/events/private_event_filter_validator.ts +21 -1
- package/src/job_coordinator/job_coordinator.ts +4 -3
- package/src/logs/log_service.ts +93 -105
- package/src/messages/message_context_service.ts +44 -0
- package/src/notes/note_service.ts +38 -26
- package/src/notes_filter.ts +24 -0
- package/src/oracle_version.ts +20 -9
- 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 +24 -19
- package/src/private_kernel/private_kernel_oracle.ts +9 -9
- package/src/pxe.ts +272 -126
- package/src/storage/address_store/address_store.ts +15 -15
- package/src/storage/anchor_block_store/anchor_block_store.ts +8 -0
- package/src/storage/capsule_store/capsule_service.ts +90 -0
- package/src/storage/capsule_store/capsule_store.ts +42 -34
- package/src/storage/capsule_store/index.ts +1 -0
- package/src/storage/contract_store/contract_store.ts +186 -96
- package/src/storage/metadata.ts +1 -1
- package/src/storage/note_store/note_store.ts +318 -318
- package/src/storage/note_store/stored_note.ts +48 -0
- package/src/storage/private_event_store/private_event_store.ts +250 -190
- package/src/storage/private_event_store/stored_private_event.ts +73 -0
- package/src/storage/tagging_store/recipient_tagging_store.ts +38 -24
- package/src/storage/tagging_store/sender_address_book_store.ts +20 -14
- package/src/storage/tagging_store/sender_tagging_store.ts +287 -156
- package/src/tagging/get_all_logs_by_tags.ts +92 -0
- package/src/tagging/index.ts +3 -2
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +19 -24
- package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
- package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +17 -16
- package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +25 -10
- package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +29 -26
- package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +39 -29
- 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/dest/tree_membership/tree_membership_service.d.ts +0 -50
- package/dest/tree_membership/tree_membership_service.d.ts.map +0 -1
- package/dest/tree_membership/tree_membership_service.js +0 -75
- package/src/tree_membership/tree_membership_service.ts +0 -97
package/src/pxe.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { PrivateEventFilter } from '@aztec/aztec.js/wallet';
|
|
2
2
|
import { BlockNumber } from '@aztec/foundation/branded-types';
|
|
3
3
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
4
|
-
import { type Logger, createLogger } from '@aztec/foundation/log';
|
|
4
|
+
import { type Logger, type LoggerBindings, createLogger } from '@aztec/foundation/log';
|
|
5
5
|
import { SerialQueue } from '@aztec/foundation/queue';
|
|
6
6
|
import { Timer } from '@aztec/foundation/timer';
|
|
7
7
|
import { KeyStore } from '@aztec/key-store';
|
|
@@ -18,7 +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 {
|
|
21
|
+
import type { L2TipsProvider } from '@aztec/stdlib/block';
|
|
22
22
|
import {
|
|
23
23
|
CompleteAddress,
|
|
24
24
|
type ContractInstanceWithAddress,
|
|
@@ -34,6 +34,7 @@ import type {
|
|
|
34
34
|
PrivateKernelTailCircuitPublicInputs,
|
|
35
35
|
} from '@aztec/stdlib/kernel';
|
|
36
36
|
import {
|
|
37
|
+
BlockHeader,
|
|
37
38
|
type ContractOverrides,
|
|
38
39
|
type InTx,
|
|
39
40
|
PrivateExecutionResult,
|
|
@@ -47,7 +48,7 @@ import {
|
|
|
47
48
|
TxProfileResult,
|
|
48
49
|
TxProvingResult,
|
|
49
50
|
TxSimulationResult,
|
|
50
|
-
|
|
51
|
+
UtilityExecutionResult,
|
|
51
52
|
} from '@aztec/stdlib/tx';
|
|
52
53
|
|
|
53
54
|
import { inspect } from 'util';
|
|
@@ -59,12 +60,15 @@ import {
|
|
|
59
60
|
ContractFunctionSimulator,
|
|
60
61
|
generateSimulatedProvingResult,
|
|
61
62
|
} from './contract_function_simulator/contract_function_simulator.js';
|
|
62
|
-
import { readCurrentClassId } from './contract_function_simulator/oracle/private_execution.js';
|
|
63
63
|
import { ProxiedContractStoreFactory } from './contract_function_simulator/proxied_contract_data_source.js';
|
|
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';
|
|
64
67
|
import { PXEDebugUtils } from './debug/pxe_debug_utils.js';
|
|
65
68
|
import { enrichPublicSimulationError, enrichSimulationError } from './error_enriching.js';
|
|
66
69
|
import { PrivateEventFilterValidator } from './events/private_event_filter_validator.js';
|
|
67
70
|
import { JobCoordinator } from './job_coordinator/job_coordinator.js';
|
|
71
|
+
import { MessageContextService } from './messages/message_context_service.js';
|
|
68
72
|
import {
|
|
69
73
|
PrivateKernelExecutionProver,
|
|
70
74
|
type PrivateKernelExecutionProverConfig,
|
|
@@ -85,6 +89,58 @@ export type PackedPrivateEvent = InTx & {
|
|
|
85
89
|
eventSelector: EventSelector;
|
|
86
90
|
};
|
|
87
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
|
+
|
|
88
144
|
/**
|
|
89
145
|
* Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
|
|
90
146
|
* manage private state of users.
|
|
@@ -92,6 +148,7 @@ export type PackedPrivateEvent = InTx & {
|
|
|
92
148
|
export class PXE {
|
|
93
149
|
private constructor(
|
|
94
150
|
private node: AztecNode,
|
|
151
|
+
private db: AztecAsyncKVStore,
|
|
95
152
|
private blockStateSynchronizer: BlockSynchronizer,
|
|
96
153
|
private keyStore: KeyStore,
|
|
97
154
|
private contractStore: ContractStore,
|
|
@@ -103,6 +160,9 @@ export class PXE {
|
|
|
103
160
|
private recipientTaggingStore: RecipientTaggingStore,
|
|
104
161
|
private addressStore: AddressStore,
|
|
105
162
|
private privateEventStore: PrivateEventStore,
|
|
163
|
+
private contractSyncService: ContractSyncService,
|
|
164
|
+
private messageContextService: MessageContextService,
|
|
165
|
+
private l2TipsStore: L2TipsProvider,
|
|
106
166
|
private simulator: CircuitSimulator,
|
|
107
167
|
private proverEnabled: boolean,
|
|
108
168
|
private proofCreator: PrivateKernelProver,
|
|
@@ -120,25 +180,31 @@ export class PXE {
|
|
|
120
180
|
*
|
|
121
181
|
* @returns A promise that resolves PXE is ready to be used.
|
|
122
182
|
*/
|
|
123
|
-
public static async create(
|
|
124
|
-
node
|
|
125
|
-
store
|
|
126
|
-
proofCreator
|
|
127
|
-
simulator
|
|
128
|
-
protocolContractsProvider
|
|
129
|
-
config
|
|
130
|
-
loggerOrSuffix
|
|
131
|
-
) {
|
|
183
|
+
public static async create({
|
|
184
|
+
node,
|
|
185
|
+
store,
|
|
186
|
+
proofCreator,
|
|
187
|
+
simulator,
|
|
188
|
+
protocolContractsProvider,
|
|
189
|
+
config,
|
|
190
|
+
loggerOrSuffix,
|
|
191
|
+
}: PXECreateArgs) {
|
|
192
|
+
// Extract bindings from the logger, or use empty bindings if a string suffix is provided.
|
|
193
|
+
const bindings: LoggerBindings | undefined =
|
|
194
|
+
loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
|
|
195
|
+
|
|
132
196
|
const log =
|
|
133
197
|
!loggerOrSuffix || typeof loggerOrSuffix === 'string'
|
|
134
198
|
? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
|
|
135
199
|
: loggerOrSuffix;
|
|
136
200
|
|
|
137
|
-
const
|
|
201
|
+
const info = await node.getNodeInfo();
|
|
202
|
+
|
|
203
|
+
const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
|
|
138
204
|
const addressStore = new AddressStore(store);
|
|
139
205
|
const privateEventStore = new PrivateEventStore(store);
|
|
140
206
|
const contractStore = new ContractStore(store);
|
|
141
|
-
const noteStore =
|
|
207
|
+
const noteStore = new NoteStore(store);
|
|
142
208
|
const anchorBlockStore = new AnchorBlockStore(store);
|
|
143
209
|
const senderTaggingStore = new SenderTaggingStore(store);
|
|
144
210
|
const senderAddressBookStore = new SenderAddressBookStore(store);
|
|
@@ -146,6 +212,14 @@ export class PXE {
|
|
|
146
212
|
const capsuleStore = new CapsuleStore(store);
|
|
147
213
|
const keyStore = new KeyStore(store);
|
|
148
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
|
+
|
|
149
223
|
const synchronizer = new BlockSynchronizer(
|
|
150
224
|
node,
|
|
151
225
|
store,
|
|
@@ -153,19 +227,28 @@ export class PXE {
|
|
|
153
227
|
noteStore,
|
|
154
228
|
privateEventStore,
|
|
155
229
|
tipsStore,
|
|
230
|
+
contractSyncService,
|
|
156
231
|
config,
|
|
157
|
-
|
|
232
|
+
bindings,
|
|
158
233
|
);
|
|
159
234
|
|
|
160
|
-
const jobCoordinator = new JobCoordinator(store);
|
|
161
|
-
jobCoordinator.registerStores([
|
|
235
|
+
const jobCoordinator = new JobCoordinator(store, bindings);
|
|
236
|
+
jobCoordinator.registerStores([
|
|
237
|
+
capsuleStore,
|
|
238
|
+
senderTaggingStore,
|
|
239
|
+
recipientTaggingStore,
|
|
240
|
+
privateEventStore,
|
|
241
|
+
noteStore,
|
|
242
|
+
contractSyncService,
|
|
243
|
+
]);
|
|
162
244
|
|
|
163
|
-
const debugUtils = new PXEDebugUtils(
|
|
245
|
+
const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
|
|
164
246
|
|
|
165
247
|
const jobQueue = new SerialQueue();
|
|
166
248
|
|
|
167
249
|
const pxe = new PXE(
|
|
168
250
|
node,
|
|
251
|
+
store,
|
|
169
252
|
synchronizer,
|
|
170
253
|
keyStore,
|
|
171
254
|
contractStore,
|
|
@@ -177,6 +260,9 @@ export class PXE {
|
|
|
177
260
|
recipientTaggingStore,
|
|
178
261
|
addressStore,
|
|
179
262
|
privateEventStore,
|
|
263
|
+
contractSyncService,
|
|
264
|
+
messageContextService,
|
|
265
|
+
tipsStore,
|
|
180
266
|
simulator,
|
|
181
267
|
proverEnabled,
|
|
182
268
|
proofCreator,
|
|
@@ -187,12 +273,15 @@ export class PXE {
|
|
|
187
273
|
debugUtils,
|
|
188
274
|
);
|
|
189
275
|
|
|
190
|
-
debugUtils.
|
|
276
|
+
debugUtils.setPXEHelpers(
|
|
277
|
+
pxe.#putInJobQueue.bind(pxe),
|
|
278
|
+
pxe.#getSimulatorForTx.bind(pxe),
|
|
279
|
+
pxe.#executeUtility.bind(pxe),
|
|
280
|
+
);
|
|
191
281
|
|
|
192
282
|
pxe.jobQueue.start();
|
|
193
283
|
|
|
194
284
|
await pxe.#registerProtocolContracts();
|
|
195
|
-
const info = await node.getNodeInfo();
|
|
196
285
|
log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
|
|
197
286
|
return pxe;
|
|
198
287
|
}
|
|
@@ -202,20 +291,22 @@ export class PXE {
|
|
|
202
291
|
#getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
|
|
203
292
|
const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
|
|
204
293
|
|
|
205
|
-
return new ContractFunctionSimulator(
|
|
206
|
-
proxyContractStore,
|
|
207
|
-
this.noteStore,
|
|
208
|
-
this.keyStore,
|
|
209
|
-
this.addressStore,
|
|
210
|
-
BenchmarkedNodeFactory.create(this.node),
|
|
211
|
-
this.
|
|
212
|
-
this.senderTaggingStore,
|
|
213
|
-
this.recipientTaggingStore,
|
|
214
|
-
this.senderAddressBookStore,
|
|
215
|
-
this.capsuleStore,
|
|
216
|
-
this.privateEventStore,
|
|
217
|
-
this.simulator,
|
|
218
|
-
|
|
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
|
+
});
|
|
219
310
|
}
|
|
220
311
|
|
|
221
312
|
#contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -267,9 +358,8 @@ export class PXE {
|
|
|
267
358
|
async #registerProtocolContracts() {
|
|
268
359
|
const registered: Record<string, string> = {};
|
|
269
360
|
for (const name of protocolContractNames) {
|
|
270
|
-
const { address,
|
|
271
|
-
|
|
272
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
361
|
+
const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
|
|
362
|
+
await this.contractStore.addContractArtifact(artifact);
|
|
273
363
|
await this.contractStore.addContractInstance(instance);
|
|
274
364
|
registered[name] = address.toString();
|
|
275
365
|
}
|
|
@@ -281,7 +371,7 @@ export class PXE {
|
|
|
281
371
|
async #executePrivate(
|
|
282
372
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
283
373
|
txRequest: TxExecutionRequest,
|
|
284
|
-
scopes: AztecAddress[]
|
|
374
|
+
scopes: AztecAddress[],
|
|
285
375
|
jobId: string,
|
|
286
376
|
): Promise<PrivateExecutionResult> {
|
|
287
377
|
const { origin: contractAddress, functionSelector } = txRequest;
|
|
@@ -289,18 +379,23 @@ export class PXE {
|
|
|
289
379
|
try {
|
|
290
380
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
291
381
|
|
|
292
|
-
|
|
293
|
-
txRequest,
|
|
382
|
+
await this.contractSyncService.ensureContractSynced(
|
|
294
383
|
contractAddress,
|
|
295
384
|
functionSelector,
|
|
296
|
-
|
|
385
|
+
(privateSyncCall, execScopes) =>
|
|
386
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
297
387
|
anchorBlockHeader,
|
|
298
|
-
// The sender for tags is set by contracts, typically by an account
|
|
299
|
-
// contract entrypoint
|
|
300
|
-
undefined, // senderForTags
|
|
301
|
-
scopes,
|
|
302
388
|
jobId,
|
|
389
|
+
scopes,
|
|
303
390
|
);
|
|
391
|
+
|
|
392
|
+
const result = await contractFunctionSimulator.run(txRequest, {
|
|
393
|
+
contractAddress,
|
|
394
|
+
selector: functionSelector,
|
|
395
|
+
anchorBlockHeader,
|
|
396
|
+
scopes,
|
|
397
|
+
jobId,
|
|
398
|
+
});
|
|
304
399
|
this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
|
|
305
400
|
return result;
|
|
306
401
|
} catch (err) {
|
|
@@ -312,25 +407,32 @@ export class PXE {
|
|
|
312
407
|
}
|
|
313
408
|
|
|
314
409
|
/**
|
|
315
|
-
*
|
|
410
|
+
* Execute a utility function call on the given contract.
|
|
316
411
|
* @param contractFunctionSimulator - The simulator to use for the function call.
|
|
317
412
|
* @param call - The function call to execute.
|
|
318
413
|
* @param authWitnesses - Authentication witnesses required for the function call.
|
|
319
414
|
* @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
|
|
320
415
|
* accounts if not specified.
|
|
321
416
|
* @param jobId - The job ID for staged writes.
|
|
322
|
-
* @returns The
|
|
417
|
+
* @returns The execution result containing the outputs of the utility function.
|
|
323
418
|
*/
|
|
324
|
-
async #
|
|
419
|
+
async #executeUtility(
|
|
325
420
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
326
421
|
call: FunctionCall,
|
|
327
422
|
authWitnesses: AuthWitness[] | undefined,
|
|
328
|
-
scopes: AztecAddress[]
|
|
423
|
+
scopes: AztecAddress[],
|
|
329
424
|
jobId: string,
|
|
330
425
|
) {
|
|
331
426
|
try {
|
|
332
427
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
333
|
-
|
|
428
|
+
const { result, offchainEffects } = await contractFunctionSimulator.runUtility(
|
|
429
|
+
call,
|
|
430
|
+
authWitnesses ?? [],
|
|
431
|
+
anchorBlockHeader,
|
|
432
|
+
scopes,
|
|
433
|
+
jobId,
|
|
434
|
+
);
|
|
435
|
+
return { result, offchainEffects };
|
|
334
436
|
} catch (err) {
|
|
335
437
|
if (err instanceof SimulationError) {
|
|
336
438
|
await enrichSimulationError(err, this.contractStore, this.log);
|
|
@@ -384,15 +486,35 @@ export class PXE {
|
|
|
384
486
|
config: PrivateKernelExecutionProverConfig,
|
|
385
487
|
): Promise<PrivateKernelExecutionProofOutput<PrivateKernelTailCircuitPublicInputs>> {
|
|
386
488
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
387
|
-
const anchorBlockHash =
|
|
489
|
+
const anchorBlockHash = await anchorBlockHeader.hash();
|
|
388
490
|
const kernelOracle = new PrivateKernelOracle(this.contractStore, this.keyStore, this.node, anchorBlockHash);
|
|
389
|
-
const kernelTraceProver = new PrivateKernelExecutionProver(
|
|
491
|
+
const kernelTraceProver = new PrivateKernelExecutionProver(
|
|
492
|
+
kernelOracle,
|
|
493
|
+
proofCreator,
|
|
494
|
+
!this.proverEnabled,
|
|
495
|
+
this.log.getBindings(),
|
|
496
|
+
);
|
|
390
497
|
this.log.debug(`Executing kernel trace prover (${JSON.stringify(config)})...`);
|
|
391
498
|
return await kernelTraceProver.proveWithKernels(txExecutionRequest.toTxRequest(), privateExecutionResult, config);
|
|
392
499
|
}
|
|
393
500
|
|
|
394
501
|
// Public API
|
|
395
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
|
+
*/
|
|
396
518
|
public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
|
|
397
519
|
return this.contractStore.getContractInstance(address);
|
|
398
520
|
}
|
|
@@ -428,7 +550,6 @@ export class PXE {
|
|
|
428
550
|
}
|
|
429
551
|
|
|
430
552
|
await this.addressStore.addCompleteAddress(accountCompleteAddress);
|
|
431
|
-
await this.noteStore.addScope(accountCompleteAddress.address);
|
|
432
553
|
return accountCompleteAddress;
|
|
433
554
|
}
|
|
434
555
|
|
|
@@ -443,6 +564,12 @@ export class PXE {
|
|
|
443
564
|
* TODO: It's strange that we return the address here and I (benesjan) think we should drop the return value.
|
|
444
565
|
*/
|
|
445
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
|
+
|
|
446
573
|
const accounts = await this.keyStore.getAccounts();
|
|
447
574
|
if (accounts.includes(sender)) {
|
|
448
575
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
@@ -453,6 +580,9 @@ export class PXE {
|
|
|
453
580
|
|
|
454
581
|
if (wasAdded) {
|
|
455
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();
|
|
456
586
|
} else {
|
|
457
587
|
this.log.info(`Sender:\n "${sender.toString()}"\n already registered.`);
|
|
458
588
|
}
|
|
@@ -502,8 +632,7 @@ export class PXE {
|
|
|
502
632
|
* @param artifact - The build artifact for the contract class.
|
|
503
633
|
*/
|
|
504
634
|
public async registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
505
|
-
const
|
|
506
|
-
await this.contractStore.addContractArtifact(contractClassId, artifact);
|
|
635
|
+
const contractClassId = await this.contractStore.addContractArtifact(artifact);
|
|
507
636
|
this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
|
|
508
637
|
}
|
|
509
638
|
|
|
@@ -522,17 +651,17 @@ export class PXE {
|
|
|
522
651
|
if (artifact) {
|
|
523
652
|
// If the user provides an artifact, validate it against the expected class id and register it
|
|
524
653
|
const contractClass = await getContractClassFromArtifact(artifact);
|
|
525
|
-
|
|
526
|
-
if (!contractClassId.equals(instance.currentContractClassId)) {
|
|
654
|
+
if (!contractClass.id.equals(instance.currentContractClassId)) {
|
|
527
655
|
throw new Error(
|
|
528
|
-
`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})`,
|
|
529
657
|
);
|
|
530
658
|
}
|
|
531
659
|
const computedAddress = await computeContractAddressFromInstance(instance);
|
|
532
660
|
if (!computedAddress.equals(instance.address)) {
|
|
533
661
|
throw new Error('Added a contract in which the address does not match the contract instance.');
|
|
534
662
|
}
|
|
535
|
-
|
|
663
|
+
|
|
664
|
+
await this.contractStore.addContractArtifact(artifact, contractClass);
|
|
536
665
|
|
|
537
666
|
const publicFunctionSignatures = artifact.functions
|
|
538
667
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
@@ -581,15 +710,16 @@ export class PXE {
|
|
|
581
710
|
throw new Error('Could not update contract to a class different from the current one.');
|
|
582
711
|
}
|
|
583
712
|
|
|
584
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
585
|
-
|
|
586
713
|
const publicFunctionSignatures = artifact.functions
|
|
587
714
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
588
715
|
.map(fn => decodeFunctionSignature(fn.name, fn.parameters));
|
|
589
716
|
await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
|
|
590
717
|
|
|
591
718
|
currentInstance.currentContractClassId = contractClass.id;
|
|
592
|
-
await
|
|
719
|
+
await Promise.all([
|
|
720
|
+
this.contractStore.addContractArtifact(artifact, contractClass),
|
|
721
|
+
this.contractStore.addContractInstance(currentInstance),
|
|
722
|
+
]);
|
|
593
723
|
this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
|
|
594
724
|
});
|
|
595
725
|
}
|
|
@@ -607,11 +737,12 @@ export class PXE {
|
|
|
607
737
|
* (where validators prove the public portion).
|
|
608
738
|
*
|
|
609
739
|
* @param txRequest - An authenticated tx request ready for proving
|
|
740
|
+
* @param scopes - Addresses whose private state and keys are accessible during private execution.
|
|
610
741
|
* @returns A result containing the proof and public inputs of the tail circuit.
|
|
611
742
|
* @throws If contract code not found, or public simulation reverts.
|
|
612
743
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
613
744
|
*/
|
|
614
|
-
public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
|
|
745
|
+
public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
|
|
615
746
|
let privateExecutionResult: PrivateExecutionResult;
|
|
616
747
|
// We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
|
|
617
748
|
// computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
|
|
@@ -622,7 +753,7 @@ export class PXE {
|
|
|
622
753
|
await this.blockStateSynchronizer.sync();
|
|
623
754
|
const syncTime = syncTimer.ms();
|
|
624
755
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
625
|
-
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest,
|
|
756
|
+
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
626
757
|
|
|
627
758
|
const {
|
|
628
759
|
publicInputs,
|
|
@@ -664,17 +795,17 @@ export class PXE {
|
|
|
664
795
|
// transaction before this one is included in a block from this PXE, and that transaction contains a log with
|
|
665
796
|
// a tag derived from the same secret, we would reuse the tag and the transactions would be linked. Hence
|
|
666
797
|
// storing the tags here prevents linkage of txs sent from the same PXE.
|
|
667
|
-
const
|
|
668
|
-
if (
|
|
798
|
+
const taggingIndexRangesUsedInTheTx = privateExecutionResult.entrypoint.taggingIndexRanges;
|
|
799
|
+
if (taggingIndexRangesUsedInTheTx.length > 0) {
|
|
669
800
|
// TODO(benesjan): The following is an expensive operation. Figure out a way to avoid it.
|
|
670
801
|
const txHash = (await txProvingResult.toTx()).txHash;
|
|
671
802
|
|
|
672
|
-
await this.senderTaggingStore.storePendingIndexes(
|
|
673
|
-
this.log.debug(`Stored used
|
|
674
|
-
|
|
803
|
+
await this.senderTaggingStore.storePendingIndexes(taggingIndexRangesUsedInTheTx, txHash, jobId);
|
|
804
|
+
this.log.debug(`Stored used tagging index ranges as sender for the tx`, {
|
|
805
|
+
taggingIndexRangesUsedInTheTx,
|
|
675
806
|
});
|
|
676
807
|
} else {
|
|
677
|
-
this.log.debug(`No
|
|
808
|
+
this.log.debug(`No tagging index ranges used in the tx`);
|
|
678
809
|
}
|
|
679
810
|
|
|
680
811
|
return txProvingResult;
|
|
@@ -686,17 +817,13 @@ export class PXE {
|
|
|
686
817
|
|
|
687
818
|
/**
|
|
688
819
|
* Profiles a transaction, reporting gate counts (unless disabled) and returns an execution trace.
|
|
689
|
-
*
|
|
690
|
-
* @param txRequest - An authenticated tx request ready for simulation
|
|
691
|
-
* @param msgSender - (Optional) The message sender to use for the simulation.
|
|
692
|
-
* @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.
|
|
693
821
|
* @returns A trace of the program execution with gate counts.
|
|
694
822
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
695
823
|
*/
|
|
696
824
|
public profileTx(
|
|
697
825
|
txRequest: TxExecutionRequest,
|
|
698
|
-
profileMode
|
|
699
|
-
skipProofGeneration: boolean = true,
|
|
826
|
+
{ profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
|
|
700
827
|
): Promise<TxProfileResult> {
|
|
701
828
|
// We disable concurrent profiles for consistency with simulateTx.
|
|
702
829
|
return this.#putInJobQueue(async jobId => {
|
|
@@ -719,12 +846,7 @@ export class PXE {
|
|
|
719
846
|
const syncTime = syncTimer.ms();
|
|
720
847
|
|
|
721
848
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
722
|
-
const privateExecutionResult = await this.#executePrivate(
|
|
723
|
-
contractFunctionSimulator,
|
|
724
|
-
txRequest,
|
|
725
|
-
undefined,
|
|
726
|
-
jobId,
|
|
727
|
-
);
|
|
849
|
+
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
728
850
|
|
|
729
851
|
const { executionSteps, timings: { proving } = {} } = await this.#prove(
|
|
730
852
|
txRequest,
|
|
@@ -781,12 +903,7 @@ export class PXE {
|
|
|
781
903
|
* In that case, the transaction returned is only potentially ready to be sent to the network for execution.
|
|
782
904
|
*
|
|
783
905
|
*
|
|
784
|
-
* @param txRequest - An authenticated tx request ready for simulation
|
|
785
|
-
* @param simulatePublic - Whether to simulate the public part of the transaction.
|
|
786
|
-
* @param skipTxValidation - (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state.
|
|
787
|
-
* @param skipFeeEnforcement - (Optional) If false, fees are enforced.
|
|
788
|
-
* @param overrides - (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts.
|
|
789
|
-
* @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.
|
|
790
907
|
* @returns A simulated transaction result object that includes public and private return values.
|
|
791
908
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
792
909
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
@@ -795,11 +912,14 @@ export class PXE {
|
|
|
795
912
|
*/
|
|
796
913
|
public simulateTx(
|
|
797
914
|
txRequest: TxExecutionRequest,
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
915
|
+
{
|
|
916
|
+
simulatePublic,
|
|
917
|
+
skipTxValidation = false,
|
|
918
|
+
skipFeeEnforcement = false,
|
|
919
|
+
skipKernels = true,
|
|
920
|
+
overrides,
|
|
921
|
+
scopes,
|
|
922
|
+
}: SimulateTxOpts,
|
|
803
923
|
): Promise<TxSimulationResult> {
|
|
804
924
|
// We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
|
|
805
925
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
@@ -823,11 +943,21 @@ export class PXE {
|
|
|
823
943
|
await this.blockStateSynchronizer.sync();
|
|
824
944
|
const syncTime = syncTimer.ms();
|
|
825
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
|
+
}
|
|
826
954
|
const contractFunctionSimulator = this.#getSimulatorForTx(overrides);
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
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
|
+
}
|
|
831
961
|
|
|
832
962
|
// Execution of private functions only; no proving, and no kernel logic.
|
|
833
963
|
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
@@ -838,7 +968,8 @@ export class PXE {
|
|
|
838
968
|
if (skipKernels) {
|
|
839
969
|
({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
|
|
840
970
|
privateExecutionResult,
|
|
841
|
-
this.contractStore,
|
|
971
|
+
(addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
|
|
972
|
+
this.node,
|
|
842
973
|
));
|
|
843
974
|
} else {
|
|
844
975
|
// Kernel logic, plus proving of all private functions and kernels.
|
|
@@ -857,6 +988,9 @@ export class PXE {
|
|
|
857
988
|
const publicSimulationTimer = new Timer();
|
|
858
989
|
publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
|
|
859
990
|
publicSimulationTime = publicSimulationTimer.ms();
|
|
991
|
+
if (publicOutput?.debugLogs?.length) {
|
|
992
|
+
await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
|
|
993
|
+
}
|
|
860
994
|
}
|
|
861
995
|
|
|
862
996
|
let validationTime: number | undefined;
|
|
@@ -865,7 +999,8 @@ export class PXE {
|
|
|
865
999
|
const validationResult = await this.node.isValidTx(simulatedTx, { isSimulation: true, skipFeeEnforcement });
|
|
866
1000
|
validationTime = validationTimer.ms();
|
|
867
1001
|
if (validationResult.result === 'invalid') {
|
|
868
|
-
|
|
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}`);
|
|
869
1004
|
}
|
|
870
1005
|
}
|
|
871
1006
|
|
|
@@ -916,29 +1051,23 @@ export class PXE {
|
|
|
916
1051
|
inspect(txRequest),
|
|
917
1052
|
`simulatePublic=${simulatePublic}`,
|
|
918
1053
|
`skipTxValidation=${skipTxValidation}`,
|
|
919
|
-
`scopes=${scopes
|
|
1054
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
920
1055
|
);
|
|
921
1056
|
}
|
|
922
1057
|
});
|
|
923
1058
|
}
|
|
924
1059
|
|
|
925
1060
|
/**
|
|
926
|
-
*
|
|
927
|
-
*
|
|
1061
|
+
* Executes a contract utility function.
|
|
928
1062
|
* @param call - The function call containing the function details, arguments, and target contract address.
|
|
929
|
-
* @param authwits - (Optional) The authentication witnesses required for the function call.
|
|
930
|
-
* @param scopes - (Optional) The accounts whose notes we can access in this call. Currently optional and will
|
|
931
|
-
* default to all.
|
|
932
|
-
* @returns The result of the utility function call, structured based on the function ABI.
|
|
933
1063
|
*/
|
|
934
|
-
public
|
|
1064
|
+
public executeUtility(
|
|
935
1065
|
call: FunctionCall,
|
|
936
|
-
authwits
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
// 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.
|
|
940
1069
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
941
|
-
// 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).
|
|
942
1071
|
return this.#putInJobQueue(async jobId => {
|
|
943
1072
|
try {
|
|
944
1073
|
const totalTimer = new Timer();
|
|
@@ -948,11 +1077,18 @@ export class PXE {
|
|
|
948
1077
|
const functionTimer = new Timer();
|
|
949
1078
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
950
1079
|
|
|
951
|
-
await this.
|
|
952
|
-
|
|
1080
|
+
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
1081
|
+
await this.contractSyncService.ensureContractSynced(
|
|
1082
|
+
call.to,
|
|
1083
|
+
call.selector,
|
|
1084
|
+
(privateSyncCall, execScopes) =>
|
|
1085
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1086
|
+
anchorBlockHeader,
|
|
1087
|
+
jobId,
|
|
1088
|
+
scopes,
|
|
953
1089
|
);
|
|
954
1090
|
|
|
955
|
-
const executionResult = await this.#
|
|
1091
|
+
const { result: executionResult, offchainEffects } = await this.#executeUtility(
|
|
956
1092
|
contractFunctionSimulator,
|
|
957
1093
|
call,
|
|
958
1094
|
authwits ?? [],
|
|
@@ -973,14 +1109,19 @@ export class PXE {
|
|
|
973
1109
|
};
|
|
974
1110
|
|
|
975
1111
|
const simulationStats = contractFunctionSimulator.getStats();
|
|
976
|
-
return {
|
|
1112
|
+
return {
|
|
1113
|
+
result: executionResult,
|
|
1114
|
+
offchainEffects,
|
|
1115
|
+
anchorBlockTimestamp: anchorBlockHeader.globalVariables.timestamp,
|
|
1116
|
+
stats: { timings, nodeRPCCalls: simulationStats.nodeRPCCalls },
|
|
1117
|
+
};
|
|
977
1118
|
} catch (err: any) {
|
|
978
1119
|
const { to, name, args } = call;
|
|
979
1120
|
const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
|
|
980
1121
|
throw this.#contextualizeError(
|
|
981
1122
|
err,
|
|
982
|
-
`
|
|
983
|
-
`scopes=${scopes
|
|
1123
|
+
`executeUtility ${to}:${name}(${stringifiedArgs})`,
|
|
1124
|
+
`scopes=${scopes.map(s => s.toString()).join(', ')}`,
|
|
984
1125
|
);
|
|
985
1126
|
}
|
|
986
1127
|
});
|
|
@@ -1008,15 +1149,19 @@ export class PXE {
|
|
|
1008
1149
|
await this.#putInJobQueue(async jobId => {
|
|
1009
1150
|
await this.blockStateSynchronizer.sync();
|
|
1010
1151
|
|
|
1011
|
-
|
|
1152
|
+
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
1153
|
+
anchorBlockNumber = anchorBlockHeader.getBlockNumber();
|
|
1012
1154
|
|
|
1013
1155
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
1014
1156
|
|
|
1015
|
-
await this.
|
|
1157
|
+
await this.contractSyncService.ensureContractSynced(
|
|
1016
1158
|
filter.contractAddress,
|
|
1017
1159
|
null,
|
|
1018
|
-
async privateSyncCall =>
|
|
1019
|
-
await this.#
|
|
1160
|
+
async (privateSyncCall, execScopes) =>
|
|
1161
|
+
await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1162
|
+
anchorBlockHeader,
|
|
1163
|
+
jobId,
|
|
1164
|
+
filter.scopes,
|
|
1020
1165
|
);
|
|
1021
1166
|
});
|
|
1022
1167
|
|
|
@@ -1031,9 +1176,10 @@ export class PXE {
|
|
|
1031
1176
|
}
|
|
1032
1177
|
|
|
1033
1178
|
/**
|
|
1034
|
-
* Stops the PXE's job queue.
|
|
1179
|
+
* Stops the PXE's job queue and closes the backing store.
|
|
1035
1180
|
*/
|
|
1036
|
-
public stop(): Promise<void> {
|
|
1037
|
-
|
|
1181
|
+
public async stop(): Promise<void> {
|
|
1182
|
+
await this.jobQueue.end();
|
|
1183
|
+
await this.db.close();
|
|
1038
1184
|
}
|
|
1039
1185
|
}
|