@aztec/pxe 0.0.1-commit.8afd444 → 0.0.1-commit.934299a21
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/access_scopes.d.ts +9 -0
- package/dest/access_scopes.d.ts.map +1 -0
- package/dest/access_scopes.js +6 -0
- 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 +7 -1
- package/dest/config/package_info.js +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +54 -28
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +174 -68
- package/dest/contract_function_simulator/noir-structs/event_validation_request.js +1 -1
- package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -2
- 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 +1 -1
- package/dest/contract_function_simulator/oracle/interfaces.d.ts +2 -2
- package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.d.ts +2 -2
- package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.js +3 -3
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +36 -35
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +64 -19
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +32 -11
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +57 -31
- package/dest/contract_logging.d.ts +22 -0
- package/dest/contract_logging.d.ts.map +1 -0
- package/dest/contract_logging.js +23 -0
- package/dest/contract_sync/contract_sync_service.d.ts +43 -0
- package/dest/contract_sync/contract_sync_service.d.ts.map +1 -0
- package/dest/contract_sync/contract_sync_service.js +97 -0
- package/dest/contract_sync/helpers.d.ts +29 -0
- package/dest/contract_sync/helpers.d.ts.map +1 -0
- package/dest/contract_sync/{index.js → helpers.js} +8 -14
- 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 +4 -1
- package/dest/entrypoints/client/bundle/index.d.ts.map +1 -1
- package/dest/entrypoints/client/bundle/index.js +3 -0
- package/dest/entrypoints/client/bundle/utils.d.ts +1 -1
- package/dest/entrypoints/client/bundle/utils.d.ts.map +1 -1
- package/dest/entrypoints/client/bundle/utils.js +9 -1
- package/dest/entrypoints/client/lazy/index.d.ts +4 -1
- package/dest/entrypoints/client/lazy/index.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/index.js +3 -0
- package/dest/entrypoints/client/lazy/utils.d.ts +1 -1
- package/dest/entrypoints/client/lazy/utils.d.ts.map +1 -1
- package/dest/entrypoints/client/lazy/utils.js +9 -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.js +9 -1
- package/dest/logs/log_service.d.ts +3 -2
- package/dest/logs/log_service.d.ts.map +1 -1
- package/dest/logs/log_service.js +5 -10
- package/dest/notes/note_service.d.ts +4 -3
- package/dest/notes/note_service.d.ts.map +1 -1
- package/dest/notes/note_service.js +3 -2
- package/dest/notes_filter.d.ts +25 -0
- package/dest/notes_filter.d.ts.map +1 -0
- package/dest/notes_filter.js +4 -0
- package/dest/oracle_version.d.ts +2 -2
- package/dest/oracle_version.js +2 -2
- 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 +69 -23
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +92 -60
- 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/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/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/recipient_sync/load_private_logs_for_sender_recipient_pair.js +4 -4
- package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
- package/package.json +25 -16
- package/src/access_scopes.ts +9 -0
- package/src/block_synchronizer/block_synchronizer.ts +6 -0
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +323 -128
- package/src/contract_function_simulator/noir-structs/event_validation_request.ts +1 -1
- package/src/contract_function_simulator/noir-structs/note_validation_request.ts +1 -1
- package/src/contract_function_simulator/oracle/interfaces.ts +1 -1
- package/src/contract_function_simulator/oracle/oracle.ts +3 -3
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +85 -96
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +102 -29
- package/src/contract_logging.ts +39 -0
- package/src/contract_sync/contract_sync_service.ts +152 -0
- package/src/contract_sync/{index.ts → helpers.ts} +13 -34
- package/src/debug/pxe_debug_utils.ts +48 -18
- package/src/entrypoints/client/bundle/index.ts +3 -0
- package/src/entrypoints/client/bundle/utils.ts +9 -1
- package/src/entrypoints/client/lazy/index.ts +3 -0
- package/src/entrypoints/client/lazy/utils.ts +9 -1
- package/src/entrypoints/server/index.ts +3 -1
- package/src/entrypoints/server/utils.ts +7 -7
- package/src/logs/log_service.ts +7 -19
- package/src/notes/note_service.ts +4 -3
- package/src/notes_filter.ts +26 -0
- package/src/oracle_version.ts +2 -2
- 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 +173 -112
- package/src/storage/contract_store/contract_store.ts +174 -75
- package/src/storage/note_store/note_store.ts +12 -5
- package/src/tagging/get_all_logs_by_tags.ts +28 -4
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +4 -4
- package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
- 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
|
@@ -33,6 +33,7 @@ import type {
|
|
|
33
33
|
PrivateKernelTailCircuitPublicInputs,
|
|
34
34
|
} from '@aztec/stdlib/kernel';
|
|
35
35
|
import {
|
|
36
|
+
BlockHeader,
|
|
36
37
|
type ContractOverrides,
|
|
37
38
|
type InTx,
|
|
38
39
|
PrivateExecutionResult,
|
|
@@ -46,11 +47,12 @@ import {
|
|
|
46
47
|
TxProfileResult,
|
|
47
48
|
TxProvingResult,
|
|
48
49
|
TxSimulationResult,
|
|
49
|
-
|
|
50
|
+
UtilityExecutionResult,
|
|
50
51
|
} from '@aztec/stdlib/tx';
|
|
51
52
|
|
|
52
53
|
import { inspect } from 'util';
|
|
53
54
|
|
|
55
|
+
import type { AccessScopes } from './access_scopes.js';
|
|
54
56
|
import { BlockSynchronizer } from './block_synchronizer/index.js';
|
|
55
57
|
import type { PXEConfig } from './config/index.js';
|
|
56
58
|
import { BenchmarkedNodeFactory } from './contract_function_simulator/benchmarked_node.js';
|
|
@@ -59,7 +61,9 @@ 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';
|
|
@@ -84,6 +88,56 @@ export type PackedPrivateEvent = InTx & {
|
|
|
84
88
|
eventSelector: EventSelector;
|
|
85
89
|
};
|
|
86
90
|
|
|
91
|
+
/** Options for PXE.profileTx. */
|
|
92
|
+
export type ProfileTxOpts = {
|
|
93
|
+
/** The profiling mode to use. */
|
|
94
|
+
profileMode: 'full' | 'execution-steps' | 'gates';
|
|
95
|
+
/** If true, proof generation is skipped during profiling. Defaults to true. */
|
|
96
|
+
skipProofGeneration?: boolean;
|
|
97
|
+
/** Addresses whose private state and keys are accessible during private execution. */
|
|
98
|
+
scopes: AccessScopes;
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
/** Options for PXE.simulateTx. */
|
|
102
|
+
export type SimulateTxOpts = {
|
|
103
|
+
/** Whether to simulate the public part of the transaction. */
|
|
104
|
+
simulatePublic: boolean;
|
|
105
|
+
/** If false, this function throws if the transaction is unable to be included in a block at the current state. */
|
|
106
|
+
skipTxValidation?: boolean;
|
|
107
|
+
/** If false, fees are enforced. */
|
|
108
|
+
skipFeeEnforcement?: boolean;
|
|
109
|
+
/** State overrides for the simulation, such as contract instances and artifacts. */
|
|
110
|
+
overrides?: SimulationOverrides;
|
|
111
|
+
/** Addresses whose private state and keys are accessible during private execution */
|
|
112
|
+
scopes: AccessScopes;
|
|
113
|
+
};
|
|
114
|
+
|
|
115
|
+
/** Options for PXE.executeUtility. */
|
|
116
|
+
export type ExecuteUtilityOpts = {
|
|
117
|
+
/** The authentication witnesses required for the function call. */
|
|
118
|
+
authwits?: AuthWitness[];
|
|
119
|
+
/** The accounts whose notes we can access in this call */
|
|
120
|
+
scopes: AccessScopes;
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
/** Args for PXE.create. */
|
|
124
|
+
export type PXECreateArgs = {
|
|
125
|
+
/** The Aztec node to connect to. */
|
|
126
|
+
node: AztecNode;
|
|
127
|
+
/** The key-value store for persisting PXE state. */
|
|
128
|
+
store: AztecAsyncKVStore;
|
|
129
|
+
/** The prover for generating private kernel proofs. */
|
|
130
|
+
proofCreator: PrivateKernelProver;
|
|
131
|
+
/** The circuit simulator for executing ACIR circuits. */
|
|
132
|
+
simulator: CircuitSimulator;
|
|
133
|
+
/** Provider for protocol contract artifacts and instances. */
|
|
134
|
+
protocolContractsProvider: ProtocolContractsProvider;
|
|
135
|
+
/** PXE configuration options. */
|
|
136
|
+
config: PXEConfig;
|
|
137
|
+
/** Optional logger instance or string suffix for the logger name. */
|
|
138
|
+
loggerOrSuffix?: string | Logger;
|
|
139
|
+
};
|
|
140
|
+
|
|
87
141
|
/**
|
|
88
142
|
* Private eXecution Environment (PXE) is a library used by wallets to simulate private phase of transactions and to
|
|
89
143
|
* manage private state of users.
|
|
@@ -102,6 +156,7 @@ export class PXE {
|
|
|
102
156
|
private recipientTaggingStore: RecipientTaggingStore,
|
|
103
157
|
private addressStore: AddressStore,
|
|
104
158
|
private privateEventStore: PrivateEventStore,
|
|
159
|
+
private contractSyncService: ContractSyncService,
|
|
105
160
|
private simulator: CircuitSimulator,
|
|
106
161
|
private proverEnabled: boolean,
|
|
107
162
|
private proofCreator: PrivateKernelProver,
|
|
@@ -119,15 +174,15 @@ export class PXE {
|
|
|
119
174
|
*
|
|
120
175
|
* @returns A promise that resolves PXE is ready to be used.
|
|
121
176
|
*/
|
|
122
|
-
public static async create(
|
|
123
|
-
node
|
|
124
|
-
store
|
|
125
|
-
proofCreator
|
|
126
|
-
simulator
|
|
127
|
-
protocolContractsProvider
|
|
128
|
-
config
|
|
129
|
-
loggerOrSuffix
|
|
130
|
-
) {
|
|
177
|
+
public static async create({
|
|
178
|
+
node,
|
|
179
|
+
store,
|
|
180
|
+
proofCreator,
|
|
181
|
+
simulator,
|
|
182
|
+
protocolContractsProvider,
|
|
183
|
+
config,
|
|
184
|
+
loggerOrSuffix,
|
|
185
|
+
}: PXECreateArgs) {
|
|
131
186
|
// Extract bindings from the logger, or use empty bindings if a string suffix is provided.
|
|
132
187
|
const bindings: LoggerBindings | undefined =
|
|
133
188
|
loggerOrSuffix && typeof loggerOrSuffix !== 'string' ? loggerOrSuffix.getBindings() : undefined;
|
|
@@ -137,7 +192,9 @@ export class PXE {
|
|
|
137
192
|
? createLogger(loggerOrSuffix ? `pxe:service:${loggerOrSuffix}` : `pxe:service`)
|
|
138
193
|
: loggerOrSuffix;
|
|
139
194
|
|
|
140
|
-
const
|
|
195
|
+
const info = await node.getNodeInfo();
|
|
196
|
+
|
|
197
|
+
const proverEnabled = config.proverEnabled !== undefined ? config.proverEnabled : info.realProofs;
|
|
141
198
|
const addressStore = new AddressStore(store);
|
|
142
199
|
const privateEventStore = new PrivateEventStore(store);
|
|
143
200
|
const contractStore = new ContractStore(store);
|
|
@@ -149,6 +206,12 @@ export class PXE {
|
|
|
149
206
|
const capsuleStore = new CapsuleStore(store);
|
|
150
207
|
const keyStore = new KeyStore(store);
|
|
151
208
|
const tipsStore = new L2TipsKVStore(store, 'pxe');
|
|
209
|
+
const contractSyncService = new ContractSyncService(
|
|
210
|
+
node,
|
|
211
|
+
contractStore,
|
|
212
|
+
noteStore,
|
|
213
|
+
createLogger('pxe:contract_sync', bindings),
|
|
214
|
+
);
|
|
152
215
|
const synchronizer = new BlockSynchronizer(
|
|
153
216
|
node,
|
|
154
217
|
store,
|
|
@@ -156,6 +219,7 @@ export class PXE {
|
|
|
156
219
|
noteStore,
|
|
157
220
|
privateEventStore,
|
|
158
221
|
tipsStore,
|
|
222
|
+
contractSyncService,
|
|
159
223
|
config,
|
|
160
224
|
bindings,
|
|
161
225
|
);
|
|
@@ -167,9 +231,10 @@ export class PXE {
|
|
|
167
231
|
recipientTaggingStore,
|
|
168
232
|
privateEventStore,
|
|
169
233
|
noteStore,
|
|
234
|
+
contractSyncService,
|
|
170
235
|
]);
|
|
171
236
|
|
|
172
|
-
const debugUtils = new PXEDebugUtils(
|
|
237
|
+
const debugUtils = new PXEDebugUtils(contractSyncService, noteStore, synchronizer, anchorBlockStore);
|
|
173
238
|
|
|
174
239
|
const jobQueue = new SerialQueue();
|
|
175
240
|
|
|
@@ -186,6 +251,7 @@ export class PXE {
|
|
|
186
251
|
recipientTaggingStore,
|
|
187
252
|
addressStore,
|
|
188
253
|
privateEventStore,
|
|
254
|
+
contractSyncService,
|
|
189
255
|
simulator,
|
|
190
256
|
proverEnabled,
|
|
191
257
|
proofCreator,
|
|
@@ -196,12 +262,15 @@ export class PXE {
|
|
|
196
262
|
debugUtils,
|
|
197
263
|
);
|
|
198
264
|
|
|
199
|
-
debugUtils.
|
|
265
|
+
debugUtils.setPXEHelpers(
|
|
266
|
+
pxe.#putInJobQueue.bind(pxe),
|
|
267
|
+
pxe.#getSimulatorForTx.bind(pxe),
|
|
268
|
+
pxe.#executeUtility.bind(pxe),
|
|
269
|
+
);
|
|
200
270
|
|
|
201
271
|
pxe.jobQueue.start();
|
|
202
272
|
|
|
203
273
|
await pxe.#registerProtocolContracts();
|
|
204
|
-
const info = await node.getNodeInfo();
|
|
205
274
|
log.info(`Started PXE connected to chain ${info.l1ChainId} version ${info.rollupVersion}`);
|
|
206
275
|
return pxe;
|
|
207
276
|
}
|
|
@@ -211,19 +280,20 @@ export class PXE {
|
|
|
211
280
|
#getSimulatorForTx(overrides?: { contracts?: ContractOverrides }) {
|
|
212
281
|
const proxyContractStore = ProxiedContractStoreFactory.create(this.contractStore, overrides?.contracts);
|
|
213
282
|
|
|
214
|
-
return new ContractFunctionSimulator(
|
|
215
|
-
proxyContractStore,
|
|
216
|
-
this.noteStore,
|
|
217
|
-
this.keyStore,
|
|
218
|
-
this.addressStore,
|
|
219
|
-
BenchmarkedNodeFactory.create(this.node),
|
|
220
|
-
this.senderTaggingStore,
|
|
221
|
-
this.recipientTaggingStore,
|
|
222
|
-
this.senderAddressBookStore,
|
|
223
|
-
this.capsuleStore,
|
|
224
|
-
this.privateEventStore,
|
|
225
|
-
this.simulator,
|
|
226
|
-
|
|
283
|
+
return new ContractFunctionSimulator({
|
|
284
|
+
contractStore: proxyContractStore,
|
|
285
|
+
noteStore: this.noteStore,
|
|
286
|
+
keyStore: this.keyStore,
|
|
287
|
+
addressStore: this.addressStore,
|
|
288
|
+
aztecNode: BenchmarkedNodeFactory.create(this.node),
|
|
289
|
+
senderTaggingStore: this.senderTaggingStore,
|
|
290
|
+
recipientTaggingStore: this.recipientTaggingStore,
|
|
291
|
+
senderAddressBookStore: this.senderAddressBookStore,
|
|
292
|
+
capsuleStore: this.capsuleStore,
|
|
293
|
+
privateEventStore: this.privateEventStore,
|
|
294
|
+
simulator: this.simulator,
|
|
295
|
+
contractSyncService: this.contractSyncService,
|
|
296
|
+
});
|
|
227
297
|
}
|
|
228
298
|
|
|
229
299
|
#contextualizeError(err: Error, ...context: string[]): Error {
|
|
@@ -275,9 +345,8 @@ export class PXE {
|
|
|
275
345
|
async #registerProtocolContracts() {
|
|
276
346
|
const registered: Record<string, string> = {};
|
|
277
347
|
for (const name of protocolContractNames) {
|
|
278
|
-
const { address,
|
|
279
|
-
|
|
280
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
348
|
+
const { address, instance, artifact } = await this.protocolContractsProvider.getProtocolContractArtifact(name);
|
|
349
|
+
await this.contractStore.addContractArtifact(artifact);
|
|
281
350
|
await this.contractStore.addContractInstance(instance);
|
|
282
351
|
registered[name] = address.toString();
|
|
283
352
|
}
|
|
@@ -289,7 +358,7 @@ export class PXE {
|
|
|
289
358
|
async #executePrivate(
|
|
290
359
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
291
360
|
txRequest: TxExecutionRequest,
|
|
292
|
-
scopes:
|
|
361
|
+
scopes: AccessScopes,
|
|
293
362
|
jobId: string,
|
|
294
363
|
): Promise<PrivateExecutionResult> {
|
|
295
364
|
const { origin: contractAddress, functionSelector } = txRequest;
|
|
@@ -297,29 +366,23 @@ export class PXE {
|
|
|
297
366
|
try {
|
|
298
367
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
299
368
|
|
|
300
|
-
await ensureContractSynced(
|
|
369
|
+
await this.contractSyncService.ensureContractSynced(
|
|
301
370
|
contractAddress,
|
|
302
371
|
functionSelector,
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
this.contractStore,
|
|
306
|
-
this.noteStore,
|
|
372
|
+
(privateSyncCall, execScopes) =>
|
|
373
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
307
374
|
anchorBlockHeader,
|
|
308
375
|
jobId,
|
|
376
|
+
scopes,
|
|
309
377
|
);
|
|
310
378
|
|
|
311
|
-
const result = await contractFunctionSimulator.run(
|
|
312
|
-
txRequest,
|
|
379
|
+
const result = await contractFunctionSimulator.run(txRequest, {
|
|
313
380
|
contractAddress,
|
|
314
|
-
functionSelector,
|
|
315
|
-
undefined,
|
|
381
|
+
selector: functionSelector,
|
|
316
382
|
anchorBlockHeader,
|
|
317
|
-
// The sender for tags is set by contracts, typically by an account
|
|
318
|
-
// contract entrypoint
|
|
319
|
-
undefined, // senderForTags
|
|
320
383
|
scopes,
|
|
321
384
|
jobId,
|
|
322
|
-
);
|
|
385
|
+
});
|
|
323
386
|
this.log.debug(`Private simulation completed for ${contractAddress.toString()}:${functionSelector}`);
|
|
324
387
|
return result;
|
|
325
388
|
} catch (err) {
|
|
@@ -331,20 +394,20 @@ export class PXE {
|
|
|
331
394
|
}
|
|
332
395
|
|
|
333
396
|
/**
|
|
334
|
-
*
|
|
397
|
+
* Execute a utility function call on the given contract.
|
|
335
398
|
* @param contractFunctionSimulator - The simulator to use for the function call.
|
|
336
399
|
* @param call - The function call to execute.
|
|
337
400
|
* @param authWitnesses - Authentication witnesses required for the function call.
|
|
338
401
|
* @param scopes - Optional array of account addresses whose notes can be accessed in this call. Defaults to all
|
|
339
402
|
* accounts if not specified.
|
|
340
403
|
* @param jobId - The job ID for staged writes.
|
|
341
|
-
* @returns The
|
|
404
|
+
* @returns The execution result containing the outputs of the utility function.
|
|
342
405
|
*/
|
|
343
|
-
async #
|
|
406
|
+
async #executeUtility(
|
|
344
407
|
contractFunctionSimulator: ContractFunctionSimulator,
|
|
345
408
|
call: FunctionCall,
|
|
346
409
|
authWitnesses: AuthWitness[] | undefined,
|
|
347
|
-
scopes:
|
|
410
|
+
scopes: AccessScopes,
|
|
348
411
|
jobId: string,
|
|
349
412
|
) {
|
|
350
413
|
try {
|
|
@@ -417,6 +480,19 @@ export class PXE {
|
|
|
417
480
|
|
|
418
481
|
// Public API
|
|
419
482
|
|
|
483
|
+
/**
|
|
484
|
+
* Returns the block header up to which the PXE has synced.
|
|
485
|
+
* @returns The synced block header
|
|
486
|
+
*/
|
|
487
|
+
public getSyncedBlockHeader(): Promise<BlockHeader> {
|
|
488
|
+
return this.anchorBlockStore.getBlockHeader();
|
|
489
|
+
}
|
|
490
|
+
|
|
491
|
+
/**
|
|
492
|
+
* Returns the contract instance for a given address, if it's registered in the PXE.
|
|
493
|
+
* @param address - The contract address.
|
|
494
|
+
* @returns The contract instance if found, undefined otherwise.
|
|
495
|
+
*/
|
|
420
496
|
public getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
|
|
421
497
|
return this.contractStore.getContractInstance(address);
|
|
422
498
|
}
|
|
@@ -525,8 +601,7 @@ export class PXE {
|
|
|
525
601
|
* @param artifact - The build artifact for the contract class.
|
|
526
602
|
*/
|
|
527
603
|
public async registerContractClass(artifact: ContractArtifact): Promise<void> {
|
|
528
|
-
const
|
|
529
|
-
await this.contractStore.addContractArtifact(contractClassId, artifact);
|
|
604
|
+
const contractClassId = await this.contractStore.addContractArtifact(artifact);
|
|
530
605
|
this.log.info(`Added contract class ${artifact.name} with id ${contractClassId}`);
|
|
531
606
|
}
|
|
532
607
|
|
|
@@ -545,17 +620,17 @@ export class PXE {
|
|
|
545
620
|
if (artifact) {
|
|
546
621
|
// If the user provides an artifact, validate it against the expected class id and register it
|
|
547
622
|
const contractClass = await getContractClassFromArtifact(artifact);
|
|
548
|
-
|
|
549
|
-
if (!contractClassId.equals(instance.currentContractClassId)) {
|
|
623
|
+
if (!contractClass.id.equals(instance.currentContractClassId)) {
|
|
550
624
|
throw new Error(
|
|
551
|
-
`Artifact does not match expected class id (computed ${
|
|
625
|
+
`Artifact does not match expected class id (computed ${contractClass.id} but instance refers to ${instance.currentContractClassId})`,
|
|
552
626
|
);
|
|
553
627
|
}
|
|
554
628
|
const computedAddress = await computeContractAddressFromInstance(instance);
|
|
555
629
|
if (!computedAddress.equals(instance.address)) {
|
|
556
630
|
throw new Error('Added a contract in which the address does not match the contract instance.');
|
|
557
631
|
}
|
|
558
|
-
|
|
632
|
+
|
|
633
|
+
await this.contractStore.addContractArtifact(artifact, contractClass);
|
|
559
634
|
|
|
560
635
|
const publicFunctionSignatures = artifact.functions
|
|
561
636
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
@@ -604,15 +679,16 @@ export class PXE {
|
|
|
604
679
|
throw new Error('Could not update contract to a class different from the current one.');
|
|
605
680
|
}
|
|
606
681
|
|
|
607
|
-
await this.contractStore.addContractArtifact(contractClass.id, artifact);
|
|
608
|
-
|
|
609
682
|
const publicFunctionSignatures = artifact.functions
|
|
610
683
|
.filter(fn => fn.functionType === FunctionType.PUBLIC)
|
|
611
684
|
.map(fn => decodeFunctionSignature(fn.name, fn.parameters));
|
|
612
685
|
await this.node.registerContractFunctionSignatures(publicFunctionSignatures);
|
|
613
686
|
|
|
614
687
|
currentInstance.currentContractClassId = contractClass.id;
|
|
615
|
-
await
|
|
688
|
+
await Promise.all([
|
|
689
|
+
this.contractStore.addContractArtifact(artifact, contractClass),
|
|
690
|
+
this.contractStore.addContractInstance(currentInstance),
|
|
691
|
+
]);
|
|
616
692
|
this.log.info(`Updated contract ${artifact.name} at ${contractAddress.toString()} to class ${contractClass.id}`);
|
|
617
693
|
});
|
|
618
694
|
}
|
|
@@ -630,11 +706,12 @@ export class PXE {
|
|
|
630
706
|
* (where validators prove the public portion).
|
|
631
707
|
*
|
|
632
708
|
* @param txRequest - An authenticated tx request ready for proving
|
|
709
|
+
* @param scopes - Addresses whose private state and keys are accessible during private execution.
|
|
633
710
|
* @returns A result containing the proof and public inputs of the tail circuit.
|
|
634
711
|
* @throws If contract code not found, or public simulation reverts.
|
|
635
712
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
636
713
|
*/
|
|
637
|
-
public proveTx(txRequest: TxExecutionRequest): Promise<TxProvingResult> {
|
|
714
|
+
public proveTx(txRequest: TxExecutionRequest, scopes: AztecAddress[]): Promise<TxProvingResult> {
|
|
638
715
|
let privateExecutionResult: PrivateExecutionResult;
|
|
639
716
|
// We disable proving concurrently mostly out of caution, since it accesses some of our stores. Proving is so
|
|
640
717
|
// computationally demanding that it'd be rare for someone to try to do it concurrently regardless.
|
|
@@ -645,7 +722,7 @@ export class PXE {
|
|
|
645
722
|
await this.blockStateSynchronizer.sync();
|
|
646
723
|
const syncTime = syncTimer.ms();
|
|
647
724
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
648
|
-
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest,
|
|
725
|
+
privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
649
726
|
|
|
650
727
|
const {
|
|
651
728
|
publicInputs,
|
|
@@ -709,17 +786,13 @@ export class PXE {
|
|
|
709
786
|
|
|
710
787
|
/**
|
|
711
788
|
* 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.
|
|
789
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
716
790
|
* @returns A trace of the program execution with gate counts.
|
|
717
791
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
718
792
|
*/
|
|
719
793
|
public profileTx(
|
|
720
794
|
txRequest: TxExecutionRequest,
|
|
721
|
-
profileMode
|
|
722
|
-
skipProofGeneration: boolean = true,
|
|
795
|
+
{ profileMode, skipProofGeneration = true, scopes }: ProfileTxOpts,
|
|
723
796
|
): Promise<TxProfileResult> {
|
|
724
797
|
// We disable concurrent profiles for consistency with simulateTx.
|
|
725
798
|
return this.#putInJobQueue(async jobId => {
|
|
@@ -742,12 +815,7 @@ export class PXE {
|
|
|
742
815
|
const syncTime = syncTimer.ms();
|
|
743
816
|
|
|
744
817
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
745
|
-
const privateExecutionResult = await this.#executePrivate(
|
|
746
|
-
contractFunctionSimulator,
|
|
747
|
-
txRequest,
|
|
748
|
-
undefined,
|
|
749
|
-
jobId,
|
|
750
|
-
);
|
|
818
|
+
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
751
819
|
|
|
752
820
|
const { executionSteps, timings: { proving } = {} } = await this.#prove(
|
|
753
821
|
txRequest,
|
|
@@ -804,12 +872,7 @@ export class PXE {
|
|
|
804
872
|
* In that case, the transaction returned is only potentially ready to be sent to the network for execution.
|
|
805
873
|
*
|
|
806
874
|
*
|
|
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.
|
|
875
|
+
* @param txRequest - An authenticated tx request ready for simulation.
|
|
813
876
|
* @returns A simulated transaction result object that includes public and private return values.
|
|
814
877
|
* @throws If the code for the functions executed in this transaction have not been made available via `addContracts`.
|
|
815
878
|
* Also throws if simulatePublic is true and public simulation reverts.
|
|
@@ -818,11 +881,7 @@ export class PXE {
|
|
|
818
881
|
*/
|
|
819
882
|
public simulateTx(
|
|
820
883
|
txRequest: TxExecutionRequest,
|
|
821
|
-
simulatePublic:
|
|
822
|
-
skipTxValidation: boolean = false,
|
|
823
|
-
skipFeeEnforcement: boolean = false,
|
|
824
|
-
overrides?: SimulationOverrides,
|
|
825
|
-
scopes?: AztecAddress[],
|
|
884
|
+
{ simulatePublic, skipTxValidation = false, skipFeeEnforcement = false, overrides, scopes }: SimulateTxOpts,
|
|
826
885
|
): Promise<TxSimulationResult> {
|
|
827
886
|
// We disable concurrent simulations since those might execute oracles which read and write to the PXE stores (e.g.
|
|
828
887
|
// to the capsules), and we need to prevent concurrent runs from interfering with one another (e.g. attempting to
|
|
@@ -850,7 +909,14 @@ export class PXE {
|
|
|
850
909
|
// Temporary: in case there are overrides, we have to skip the kernels or validations
|
|
851
910
|
// will fail. Consider handing control to the user/wallet on whether they want to run them
|
|
852
911
|
// or not.
|
|
853
|
-
const
|
|
912
|
+
const overriddenContracts = overrides?.contracts ? new Set(Object.keys(overrides.contracts)) : undefined;
|
|
913
|
+
const hasOverriddenContracts = overriddenContracts !== undefined && overriddenContracts.size > 0;
|
|
914
|
+
const skipKernels = hasOverriddenContracts;
|
|
915
|
+
|
|
916
|
+
// Set overridden contracts on the sync service so it knows to skip syncing them
|
|
917
|
+
if (hasOverriddenContracts) {
|
|
918
|
+
this.contractSyncService.setOverriddenContracts(jobId, overriddenContracts);
|
|
919
|
+
}
|
|
854
920
|
|
|
855
921
|
// Execution of private functions only; no proving, and no kernel logic.
|
|
856
922
|
const privateExecutionResult = await this.#executePrivate(contractFunctionSimulator, txRequest, scopes, jobId);
|
|
@@ -861,7 +927,8 @@ export class PXE {
|
|
|
861
927
|
if (skipKernels) {
|
|
862
928
|
({ publicInputs, executionSteps } = await generateSimulatedProvingResult(
|
|
863
929
|
privateExecutionResult,
|
|
864
|
-
this.contractStore,
|
|
930
|
+
(addr, sel) => this.contractStore.getDebugFunctionName(addr, sel),
|
|
931
|
+
this.node,
|
|
865
932
|
));
|
|
866
933
|
} else {
|
|
867
934
|
// Kernel logic, plus proving of all private functions and kernels.
|
|
@@ -880,6 +947,9 @@ export class PXE {
|
|
|
880
947
|
const publicSimulationTimer = new Timer();
|
|
881
948
|
publicOutput = await this.#simulatePublicCalls(simulatedTx, skipFeeEnforcement);
|
|
882
949
|
publicSimulationTime = publicSimulationTimer.ms();
|
|
950
|
+
if (publicOutput?.debugLogs?.length) {
|
|
951
|
+
await displayDebugLogs(publicOutput.debugLogs, addr => this.contractStore.getDebugContractName(addr));
|
|
952
|
+
}
|
|
883
953
|
}
|
|
884
954
|
|
|
885
955
|
let validationTime: number | undefined;
|
|
@@ -939,29 +1009,23 @@ export class PXE {
|
|
|
939
1009
|
inspect(txRequest),
|
|
940
1010
|
`simulatePublic=${simulatePublic}`,
|
|
941
1011
|
`skipTxValidation=${skipTxValidation}`,
|
|
942
|
-
`scopes=${scopes
|
|
1012
|
+
`scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
|
|
943
1013
|
);
|
|
944
1014
|
}
|
|
945
1015
|
});
|
|
946
1016
|
}
|
|
947
1017
|
|
|
948
1018
|
/**
|
|
949
|
-
*
|
|
950
|
-
*
|
|
1019
|
+
* Executes a contract utility function.
|
|
951
1020
|
* @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
1021
|
*/
|
|
957
|
-
public
|
|
1022
|
+
public executeUtility(
|
|
958
1023
|
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.
|
|
1024
|
+
{ authwits, scopes }: ExecuteUtilityOpts = { scopes: 'ALL_SCOPES' },
|
|
1025
|
+
): Promise<UtilityExecutionResult> {
|
|
1026
|
+
// We disable concurrent executions since those might execute oracles which read and write to the PXE stores (e.g.
|
|
963
1027
|
// 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
|
|
1028
|
+
// delete the same read value, or reading values that another execution is currently modifying).
|
|
965
1029
|
return this.#putInJobQueue(async jobId => {
|
|
966
1030
|
try {
|
|
967
1031
|
const totalTimer = new Timer();
|
|
@@ -972,18 +1036,17 @@ export class PXE {
|
|
|
972
1036
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
973
1037
|
|
|
974
1038
|
const anchorBlockHeader = await this.anchorBlockStore.getBlockHeader();
|
|
975
|
-
await ensureContractSynced(
|
|
1039
|
+
await this.contractSyncService.ensureContractSynced(
|
|
976
1040
|
call.to,
|
|
977
1041
|
call.selector,
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
this.contractStore,
|
|
981
|
-
this.noteStore,
|
|
1042
|
+
(privateSyncCall, execScopes) =>
|
|
1043
|
+
this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
982
1044
|
anchorBlockHeader,
|
|
983
1045
|
jobId,
|
|
1046
|
+
scopes,
|
|
984
1047
|
);
|
|
985
1048
|
|
|
986
|
-
const executionResult = await this.#
|
|
1049
|
+
const executionResult = await this.#executeUtility(
|
|
987
1050
|
contractFunctionSimulator,
|
|
988
1051
|
call,
|
|
989
1052
|
authwits ?? [],
|
|
@@ -1010,8 +1073,8 @@ export class PXE {
|
|
|
1010
1073
|
const stringifiedArgs = args.map(arg => arg.toString()).join(', ');
|
|
1011
1074
|
throw this.#contextualizeError(
|
|
1012
1075
|
err,
|
|
1013
|
-
`
|
|
1014
|
-
`scopes=${scopes
|
|
1076
|
+
`executeUtility ${to}:${name}(${stringifiedArgs})`,
|
|
1077
|
+
`scopes=${scopes === 'ALL_SCOPES' ? scopes : scopes.map(s => s.toString()).join(', ')}`,
|
|
1015
1078
|
);
|
|
1016
1079
|
}
|
|
1017
1080
|
});
|
|
@@ -1044,16 +1107,14 @@ export class PXE {
|
|
|
1044
1107
|
|
|
1045
1108
|
const contractFunctionSimulator = this.#getSimulatorForTx();
|
|
1046
1109
|
|
|
1047
|
-
await ensureContractSynced(
|
|
1110
|
+
await this.contractSyncService.ensureContractSynced(
|
|
1048
1111
|
filter.contractAddress,
|
|
1049
1112
|
null,
|
|
1050
|
-
async privateSyncCall =>
|
|
1051
|
-
await this.#
|
|
1052
|
-
this.node,
|
|
1053
|
-
this.contractStore,
|
|
1054
|
-
this.noteStore,
|
|
1113
|
+
async (privateSyncCall, execScopes) =>
|
|
1114
|
+
await this.#executeUtility(contractFunctionSimulator, privateSyncCall, [], execScopes, jobId),
|
|
1055
1115
|
anchorBlockHeader,
|
|
1056
1116
|
jobId,
|
|
1117
|
+
filter.scopes,
|
|
1057
1118
|
);
|
|
1058
1119
|
});
|
|
1059
1120
|
|