@aztec/pxe 0.0.1-commit.3d8f95d → 0.0.1-commit.3fd054f6
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/config/index.d.ts +2 -2
- package/dest/config/index.d.ts.map +1 -1
- package/dest/config/index.js +1 -1
- package/dest/config/package_info.js +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.d.ts +15 -7
- package/dest/contract_function_simulator/contract_function_simulator.d.ts.map +1 -1
- package/dest/contract_function_simulator/contract_function_simulator.js +137 -45
- 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 +2 -3
- 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 +5 -4
- package/dest/contract_function_simulator/noir-structs/log_retrieval_response.d.ts +1 -1
- 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 +1 -3
- package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts +16 -0
- package/dest/contract_function_simulator/noir-structs/message_tx_context.d.ts.map +1 -0
- package/dest/contract_function_simulator/noir-structs/message_tx_context.js +57 -0
- package/dest/contract_function_simulator/noir-structs/note_validation_request.d.ts +2 -4
- 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 +3 -5
- package/dest/contract_function_simulator/oracle/interfaces.d.ts +50 -45
- package/dest/contract_function_simulator/oracle/interfaces.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts +9 -0
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.d.ts.map +1 -0
- package/dest/contract_function_simulator/oracle/legacy_oracle_mappings.js +42 -0
- package/dest/contract_function_simulator/oracle/oracle.d.ts +45 -44
- package/dest/contract_function_simulator/oracle/oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/oracle.js +163 -94
- package/dest/contract_function_simulator/oracle/private_execution.js +5 -3
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts +24 -48
- package/dest/contract_function_simulator/oracle/private_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/private_execution_oracle.js +39 -71
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts +56 -37
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.d.ts.map +1 -1
- package/dest/contract_function_simulator/oracle/utility_execution_oracle.js +115 -55
- 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 +8 -4
- package/dest/contract_sync/contract_sync_service.d.ts.map +1 -1
- package/dest/contract_sync/contract_sync_service.js +61 -29
- package/dest/contract_sync/helpers.d.ts +3 -2
- package/dest/contract_sync/helpers.d.ts.map +1 -1
- package/dest/contract_sync/helpers.js +3 -3
- package/dest/debug/pxe_debug_utils.d.ts +5 -4
- package/dest/debug/pxe_debug_utils.d.ts.map +1 -1
- package/dest/debug/pxe_debug_utils.js +4 -4
- 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/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/server/index.d.ts +3 -1
- package/dest/entrypoints/server/index.d.ts.map +1 -1
- package/dest/entrypoints/server/index.js +2 -0
- 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 +9 -14
- package/dest/messages/message_context_service.d.ts +17 -0
- package/dest/messages/message_context_service.d.ts.map +1 -0
- package/dest/messages/message_context_service.js +36 -0
- package/dest/notes/note_service.d.ts +4 -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 +3 -3
- 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 +23 -15
- package/dest/pxe.d.ts.map +1 -1
- package/dest/pxe.js +78 -53
- 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 +140 -64
- package/dest/storage/metadata.d.ts +1 -1
- package/dest/storage/metadata.js +1 -1
- package/dest/storage/note_store/note_store.d.ts +3 -3
- package/dest/storage/note_store/note_store.d.ts.map +1 -1
- package/dest/storage/note_store/note_store.js +3 -4
- package/dest/storage/tagging_store/recipient_tagging_store.d.ts +6 -6
- package/dest/storage/tagging_store/recipient_tagging_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_tagging_store.d.ts +29 -28
- package/dest/storage/tagging_store/sender_tagging_store.d.ts.map +1 -1
- package/dest/storage/tagging_store/sender_tagging_store.js +141 -115
- package/dest/tagging/get_all_logs_by_tags.d.ts +1 -1
- package/dest/tagging/get_all_logs_by_tags.d.ts.map +1 -1
- package/dest/tagging/get_all_logs_by_tags.js +17 -3
- package/dest/tagging/index.d.ts +3 -3
- package/dest/tagging/index.d.ts.map +1 -1
- package/dest/tagging/index.js +1 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts +4 -5
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.js +7 -7
- package/dest/tagging/recipient_sync/utils/find_highest_indexes.js +2 -2
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts +6 -7
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.d.ts.map +1 -1
- package/dest/tagging/recipient_sync/utils/load_logs_for_range.js +12 -11
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts +4 -8
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/sync_sender_tagging_indexes.js +13 -7
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts +4 -3
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/get_status_change_of_pending.js +20 -10
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts +5 -7
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.d.ts.map +1 -1
- package/dest/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.js +36 -24
- package/package.json +16 -16
- package/src/access_scopes.ts +9 -0
- package/src/config/index.ts +1 -1
- package/src/config/package_info.ts +1 -1
- package/src/contract_function_simulator/contract_function_simulator.ts +254 -65
- 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 +8 -5
- package/src/contract_function_simulator/noir-structs/log_retrieval_response.ts +1 -4
- package/src/contract_function_simulator/noir-structs/message_tx_context.ts +55 -0
- package/src/contract_function_simulator/noir-structs/note_validation_request.ts +3 -6
- package/src/contract_function_simulator/oracle/interfaces.ts +54 -54
- package/src/contract_function_simulator/oracle/legacy_oracle_mappings.ts +135 -0
- package/src/contract_function_simulator/oracle/oracle.ts +176 -138
- package/src/contract_function_simulator/oracle/private_execution.ts +4 -4
- package/src/contract_function_simulator/oracle/private_execution_oracle.ts +47 -90
- package/src/contract_function_simulator/oracle/utility_execution_oracle.ts +157 -67
- package/src/contract_logging.ts +39 -0
- package/src/contract_sync/contract_sync_service.ts +87 -35
- package/src/contract_sync/helpers.ts +7 -2
- package/src/debug/pxe_debug_utils.ts +11 -9
- package/src/entrypoints/client/bundle/index.ts +3 -0
- package/src/entrypoints/client/lazy/index.ts +3 -0
- package/src/entrypoints/server/index.ts +2 -0
- package/src/logs/log_service.ts +17 -24
- package/src/messages/message_context_service.ts +45 -0
- package/src/notes/note_service.ts +4 -3
- package/src/notes_filter.ts +26 -0
- package/src/oracle_version.ts +3 -3
- 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 +117 -71
- package/src/storage/contract_store/contract_store.ts +170 -71
- package/src/storage/metadata.ts +1 -1
- package/src/storage/note_store/note_store.ts +8 -5
- package/src/storage/tagging_store/recipient_tagging_store.ts +9 -5
- package/src/storage/tagging_store/sender_tagging_store.ts +185 -138
- package/src/tagging/get_all_logs_by_tags.ts +28 -4
- package/src/tagging/index.ts +2 -2
- package/src/tagging/recipient_sync/load_private_logs_for_sender_recipient_pair.ts +7 -10
- package/src/tagging/recipient_sync/utils/find_highest_indexes.ts +2 -2
- package/src/tagging/recipient_sync/utils/load_logs_for_range.ts +10 -15
- package/src/tagging/sender_sync/sync_sender_tagging_indexes.ts +23 -10
- package/src/tagging/sender_sync/utils/get_status_change_of_pending.ts +26 -11
- package/src/tagging/sender_sync/utils/load_and_store_new_tagging_indexes.ts +27 -26
- package/dest/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
|
@@ -3,25 +3,30 @@ import type { BlockNumber } from '@aztec/foundation/branded-types';
|
|
|
3
3
|
import { Aes128 } from '@aztec/foundation/crypto/aes128';
|
|
4
4
|
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
5
5
|
import { Point } from '@aztec/foundation/curves/grumpkin';
|
|
6
|
-
import { LogLevels, type Logger,
|
|
6
|
+
import { LogLevels, type Logger, createLogger } from '@aztec/foundation/log';
|
|
7
7
|
import type { MembershipWitness } from '@aztec/foundation/trees';
|
|
8
8
|
import type { KeyStore } from '@aztec/key-store';
|
|
9
|
+
import { isProtocolContract } from '@aztec/protocol-contracts';
|
|
9
10
|
import type { AuthWitness } from '@aztec/stdlib/auth-witness';
|
|
10
11
|
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
11
12
|
import { BlockHash } from '@aztec/stdlib/block';
|
|
12
|
-
import type { CompleteAddress, ContractInstance } from '@aztec/stdlib/contract';
|
|
13
|
+
import type { CompleteAddress, ContractInstance, PartialAddress } from '@aztec/stdlib/contract';
|
|
13
14
|
import { siloNullifier } from '@aztec/stdlib/hash';
|
|
14
15
|
import type { AztecNode } from '@aztec/stdlib/interfaces/server';
|
|
15
16
|
import type { KeyValidationRequest } from '@aztec/stdlib/kernel';
|
|
16
|
-
import { computeAddressSecret } from '@aztec/stdlib/keys';
|
|
17
|
+
import { type PublicKeys, computeAddressSecret } from '@aztec/stdlib/keys';
|
|
17
18
|
import { deriveEcdhSharedSecret } from '@aztec/stdlib/logs';
|
|
18
19
|
import { getNonNullifiedL1ToL2MessageWitness } from '@aztec/stdlib/messaging';
|
|
19
20
|
import type { NoteStatus } from '@aztec/stdlib/note';
|
|
20
21
|
import { MerkleTreeId, type NullifierMembershipWitness, PublicDataWitness } from '@aztec/stdlib/trees';
|
|
21
|
-
import type { BlockHeader, Capsule } from '@aztec/stdlib/tx';
|
|
22
|
+
import type { BlockHeader, Capsule, OffchainEffect } from '@aztec/stdlib/tx';
|
|
22
23
|
|
|
24
|
+
import type { AccessScopes } from '../../access_scopes.js';
|
|
25
|
+
import { createContractLogger, logContractMessage } from '../../contract_logging.js';
|
|
26
|
+
import type { ContractSyncService } from '../../contract_sync/contract_sync_service.js';
|
|
23
27
|
import { EventService } from '../../events/event_service.js';
|
|
24
28
|
import { LogService } from '../../logs/log_service.js';
|
|
29
|
+
import { MessageContextService } from '../../messages/message_context_service.js';
|
|
25
30
|
import { NoteService } from '../../notes/note_service.js';
|
|
26
31
|
import { ORACLE_VERSION } from '../../oracle_version.js';
|
|
27
32
|
import type { AddressStore } from '../../storage/address_store/address_store.js';
|
|
@@ -34,6 +39,7 @@ import type { SenderAddressBookStore } from '../../storage/tagging_store/sender_
|
|
|
34
39
|
import { EventValidationRequest } from '../noir-structs/event_validation_request.js';
|
|
35
40
|
import { LogRetrievalRequest } from '../noir-structs/log_retrieval_request.js';
|
|
36
41
|
import { LogRetrievalResponse } from '../noir-structs/log_retrieval_response.js';
|
|
42
|
+
import { MessageTxContext } from '../noir-structs/message_tx_context.js';
|
|
37
43
|
import { NoteValidationRequest } from '../noir-structs/note_validation_request.js';
|
|
38
44
|
import { UtilityContext } from '../noir-structs/utility_context.js';
|
|
39
45
|
import { pickNotes } from '../pick_notes.js';
|
|
@@ -56,9 +62,11 @@ export type UtilityExecutionOracleArgs = {
|
|
|
56
62
|
senderAddressBookStore: SenderAddressBookStore;
|
|
57
63
|
capsuleStore: CapsuleStore;
|
|
58
64
|
privateEventStore: PrivateEventStore;
|
|
65
|
+
messageContextService: MessageContextService;
|
|
66
|
+
contractSyncService: ContractSyncService;
|
|
59
67
|
jobId: string;
|
|
60
68
|
log?: ReturnType<typeof createLogger>;
|
|
61
|
-
scopes
|
|
69
|
+
scopes: AccessScopes;
|
|
62
70
|
};
|
|
63
71
|
|
|
64
72
|
/**
|
|
@@ -69,6 +77,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
69
77
|
isUtility = true as const;
|
|
70
78
|
|
|
71
79
|
private contractLogger: Logger | undefined;
|
|
80
|
+
private offchainEffects: OffchainEffect[] = [];
|
|
72
81
|
|
|
73
82
|
protected readonly contractAddress: AztecAddress;
|
|
74
83
|
protected readonly authWitnesses: AuthWitness[];
|
|
@@ -83,9 +92,11 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
83
92
|
protected readonly senderAddressBookStore: SenderAddressBookStore;
|
|
84
93
|
protected readonly capsuleStore: CapsuleStore;
|
|
85
94
|
protected readonly privateEventStore: PrivateEventStore;
|
|
95
|
+
protected readonly messageContextService: MessageContextService;
|
|
96
|
+
protected readonly contractSyncService: ContractSyncService;
|
|
86
97
|
protected readonly jobId: string;
|
|
87
|
-
protected
|
|
88
|
-
protected readonly scopes
|
|
98
|
+
protected logger: ReturnType<typeof createLogger>;
|
|
99
|
+
protected readonly scopes: AccessScopes;
|
|
89
100
|
|
|
90
101
|
constructor(args: UtilityExecutionOracleArgs) {
|
|
91
102
|
this.contractAddress = args.contractAddress;
|
|
@@ -101,22 +112,39 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
101
112
|
this.senderAddressBookStore = args.senderAddressBookStore;
|
|
102
113
|
this.capsuleStore = args.capsuleStore;
|
|
103
114
|
this.privateEventStore = args.privateEventStore;
|
|
115
|
+
this.messageContextService = args.messageContextService;
|
|
116
|
+
this.contractSyncService = args.contractSyncService;
|
|
104
117
|
this.jobId = args.jobId;
|
|
105
|
-
this.
|
|
118
|
+
this.logger = args.log ?? createLogger('simulator:client_view_context');
|
|
106
119
|
this.scopes = args.scopes;
|
|
107
120
|
}
|
|
108
121
|
|
|
109
|
-
public
|
|
122
|
+
public assertCompatibleOracleVersion(version: number): void {
|
|
123
|
+
// TODO(F-416): Remove this hack on v5 when protocol contracts are redeployed.
|
|
124
|
+
// Protocol contracts/canonical contracts shipped with committed bytecode that cannot be changed. Assert they use
|
|
125
|
+
// the expected pinned version or the current one. We want to allow for both the pinned and the current versions
|
|
126
|
+
// because we want this code to work with both the pinned and unpinned version since some branches do not have the
|
|
127
|
+
// pinned contracts (like e.g. next)
|
|
128
|
+
const LEGACY_ORACLE_VERSION = 12;
|
|
129
|
+
if (isProtocolContract(this.contractAddress)) {
|
|
130
|
+
if (version !== LEGACY_ORACLE_VERSION && version !== ORACLE_VERSION) {
|
|
131
|
+
throw new Error(
|
|
132
|
+
`Expected legacy oracle version ${LEGACY_ORACLE_VERSION} or current oracle version ${ORACLE_VERSION} for alpha payload contract at ${this.contractAddress}, got ${version}.`,
|
|
133
|
+
);
|
|
134
|
+
}
|
|
135
|
+
return;
|
|
136
|
+
}
|
|
137
|
+
|
|
110
138
|
if (version !== ORACLE_VERSION) {
|
|
111
139
|
throw new Error(`Incompatible oracle version. Expected version ${ORACLE_VERSION}, got ${version}.`);
|
|
112
140
|
}
|
|
113
141
|
}
|
|
114
142
|
|
|
115
|
-
public
|
|
143
|
+
public getRandomField(): Fr {
|
|
116
144
|
return Fr.random();
|
|
117
145
|
}
|
|
118
146
|
|
|
119
|
-
public
|
|
147
|
+
public getUtilityContext(): UtilityContext {
|
|
120
148
|
return new UtilityContext(this.anchorBlockHeader, this.contractAddress);
|
|
121
149
|
}
|
|
122
150
|
|
|
@@ -127,12 +155,17 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
127
155
|
* @throws If the keys are not registered in the key store.
|
|
128
156
|
* @throws If scopes are defined and the account is not in the scopes.
|
|
129
157
|
*/
|
|
130
|
-
public async
|
|
131
|
-
// If scopes are defined, check that the key belongs to an account in the scopes
|
|
132
|
-
if (this.scopes && this.scopes.length > 0) {
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
158
|
+
public async getKeyValidationRequest(pkMHash: Fr): Promise<KeyValidationRequest> {
|
|
159
|
+
// If scopes are defined, check that the key belongs to an account in the scopes.
|
|
160
|
+
if (this.scopes !== 'ALL_SCOPES' && this.scopes.length > 0) {
|
|
161
|
+
let hasAccess = false;
|
|
162
|
+
for (let i = 0; i < this.scopes.length && !hasAccess; i++) {
|
|
163
|
+
if (await this.keyStore.accountHasKey(this.scopes[i], pkMHash)) {
|
|
164
|
+
hasAccess = true;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
if (!hasAccess) {
|
|
168
|
+
throw new Error(`Key validation request denied: no scoped account has a key with hash ${pkMHash.toString()}.`);
|
|
136
169
|
}
|
|
137
170
|
}
|
|
138
171
|
return this.keyStore.getKeyValidationRequest(pkMHash, this.contractAddress);
|
|
@@ -145,7 +178,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
145
178
|
* @param noteHash - The note hash to find in the note hash tree.
|
|
146
179
|
* @returns The membership witness containing the leaf index and sibling path
|
|
147
180
|
*/
|
|
148
|
-
public
|
|
181
|
+
public getNoteHashMembershipWitness(
|
|
149
182
|
anchorBlockHash: BlockHash,
|
|
150
183
|
noteHash: Fr,
|
|
151
184
|
): Promise<MembershipWitness<typeof NOTE_HASH_TREE_HEIGHT> | undefined> {
|
|
@@ -163,7 +196,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
163
196
|
* @param blockHash - The block hash to find in the archive tree.
|
|
164
197
|
* @returns The membership witness containing the leaf index and sibling path
|
|
165
198
|
*/
|
|
166
|
-
public
|
|
199
|
+
public getBlockHashMembershipWitness(
|
|
167
200
|
anchorBlockHash: BlockHash,
|
|
168
201
|
blockHash: BlockHash,
|
|
169
202
|
): Promise<MembershipWitness<typeof ARCHIVE_HEIGHT> | undefined> {
|
|
@@ -176,7 +209,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
176
209
|
* @param nullifier - Nullifier we try to find witness for.
|
|
177
210
|
* @returns The nullifier membership witness (if found).
|
|
178
211
|
*/
|
|
179
|
-
public
|
|
212
|
+
public getNullifierMembershipWitness(
|
|
180
213
|
blockHash: BlockHash,
|
|
181
214
|
nullifier: Fr,
|
|
182
215
|
): Promise<NullifierMembershipWitness | undefined> {
|
|
@@ -192,7 +225,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
192
225
|
* list structure" of leaves and proving that a lower nullifier is pointing to a bigger next value than the nullifier
|
|
193
226
|
* we are trying to prove non-inclusion for.
|
|
194
227
|
*/
|
|
195
|
-
public
|
|
228
|
+
public getLowNullifierMembershipWitness(
|
|
196
229
|
blockHash: BlockHash,
|
|
197
230
|
nullifier: Fr,
|
|
198
231
|
): Promise<NullifierMembershipWitness | undefined> {
|
|
@@ -205,7 +238,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
205
238
|
* @param leafSlot - The slot of the public data tree to get the witness for.
|
|
206
239
|
* @returns - The witness
|
|
207
240
|
*/
|
|
208
|
-
public
|
|
241
|
+
public getPublicDataWitness(blockHash: BlockHash, leafSlot: Fr): Promise<PublicDataWitness | undefined> {
|
|
209
242
|
return this.aztecNode.getPublicDataWitness(blockHash, leafSlot);
|
|
210
243
|
}
|
|
211
244
|
|
|
@@ -214,7 +247,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
214
247
|
* @param blockNumber - The number of a block of which to get the block header.
|
|
215
248
|
* @returns Block extracted from a block with block number `blockNumber`.
|
|
216
249
|
*/
|
|
217
|
-
public async
|
|
250
|
+
public async getBlockHeader(blockNumber: BlockNumber): Promise<BlockHeader | undefined> {
|
|
218
251
|
const anchorBlockNumber = this.anchorBlockHeader.getBlockNumber();
|
|
219
252
|
if (blockNumber > anchorBlockNumber) {
|
|
220
253
|
throw new Error(`Block number ${blockNumber} is higher than current block ${anchorBlockNumber}`);
|
|
@@ -225,12 +258,18 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
225
258
|
}
|
|
226
259
|
|
|
227
260
|
/**
|
|
228
|
-
* Retrieve the
|
|
261
|
+
* Retrieve the public keys and partial address associated to a given address.
|
|
229
262
|
* @param account - The account address.
|
|
230
|
-
* @returns
|
|
263
|
+
* @returns The public keys and partial address, or `undefined` if the account is not registered.
|
|
231
264
|
*/
|
|
232
|
-
public
|
|
233
|
-
|
|
265
|
+
public async tryGetPublicKeysAndPartialAddress(
|
|
266
|
+
account: AztecAddress,
|
|
267
|
+
): Promise<{ publicKeys: PublicKeys; partialAddress: PartialAddress } | undefined> {
|
|
268
|
+
const completeAddress = await this.addressStore.getCompleteAddress(account);
|
|
269
|
+
if (!completeAddress) {
|
|
270
|
+
return undefined;
|
|
271
|
+
}
|
|
272
|
+
return { publicKeys: completeAddress.publicKeys, partialAddress: completeAddress.partialAddress };
|
|
234
273
|
}
|
|
235
274
|
|
|
236
275
|
protected async getCompleteAddressOrFail(account: AztecAddress): Promise<CompleteAddress> {
|
|
@@ -249,11 +288,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
249
288
|
* @param address - Address.
|
|
250
289
|
* @returns A contract instance.
|
|
251
290
|
*/
|
|
252
|
-
public
|
|
253
|
-
return this.getContractInstance(address);
|
|
254
|
-
}
|
|
255
|
-
|
|
256
|
-
protected async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
|
|
291
|
+
public async getContractInstance(address: AztecAddress): Promise<ContractInstance> {
|
|
257
292
|
const instance = await this.contractStore.getContractInstance(address);
|
|
258
293
|
if (!instance) {
|
|
259
294
|
throw new Error(`No contract instance found for address ${address.toString()}`);
|
|
@@ -267,7 +302,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
267
302
|
* @param messageHash - Hash of the message to authenticate.
|
|
268
303
|
* @returns Authentication witness for the requested message hash.
|
|
269
304
|
*/
|
|
270
|
-
public
|
|
305
|
+
public getAuthWitness(messageHash: Fr): Promise<Fr[] | undefined> {
|
|
271
306
|
return Promise.resolve(this.authWitnesses.find(w => w.requestHash.equals(messageHash))?.witness);
|
|
272
307
|
}
|
|
273
308
|
|
|
@@ -293,7 +328,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
293
328
|
* @param status - The status of notes to fetch.
|
|
294
329
|
* @returns Array of note data.
|
|
295
330
|
*/
|
|
296
|
-
public async
|
|
331
|
+
public async getNotes(
|
|
297
332
|
owner: AztecAddress | undefined,
|
|
298
333
|
storageSlot: Fr,
|
|
299
334
|
numSelects: number,
|
|
@@ -333,7 +368,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
333
368
|
* @param innerNullifier - The inner nullifier.
|
|
334
369
|
* @returns A boolean indicating whether the nullifier exists in the tree or not.
|
|
335
370
|
*/
|
|
336
|
-
public async
|
|
371
|
+
public async checkNullifierExists(innerNullifier: Fr) {
|
|
337
372
|
const [nullifier, anchorBlockHash] = await Promise.all([
|
|
338
373
|
siloNullifier(this.contractAddress, innerNullifier!),
|
|
339
374
|
this.anchorBlockHeader.hash(),
|
|
@@ -352,7 +387,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
352
387
|
* @dev Contract address and secret are only used to compute the nullifier to get non-nullified messages
|
|
353
388
|
* @returns The l1 to l2 membership witness (index of message in the tree and sibling path).
|
|
354
389
|
*/
|
|
355
|
-
public async
|
|
390
|
+
public async getL1ToL2MembershipWitness(contractAddress: AztecAddress, messageHash: Fr, secret: Fr) {
|
|
356
391
|
const [messageIndex, siblingPath] = await getNonNullifiedL1ToL2MessageWitness(
|
|
357
392
|
this.aztecNode,
|
|
358
393
|
contractAddress,
|
|
@@ -370,7 +405,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
370
405
|
* @param startStorageSlot - The starting storage slot.
|
|
371
406
|
* @param numberOfElements - Number of elements to read from the starting storage slot.
|
|
372
407
|
*/
|
|
373
|
-
public async
|
|
408
|
+
public async storageRead(
|
|
374
409
|
blockHash: BlockHash,
|
|
375
410
|
contractAddress: AztecAddress,
|
|
376
411
|
startStorageSlot: Fr,
|
|
@@ -384,7 +419,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
384
419
|
slots.map(storageSlot => this.aztecNode.getPublicStorageAt(blockHash, contractAddress, storageSlot)),
|
|
385
420
|
);
|
|
386
421
|
|
|
387
|
-
this.
|
|
422
|
+
this.logger.debug(
|
|
388
423
|
`Oracle storage read: slots=[${slots.map(slot => slot.toString()).join(', ')}] address=${contractAddress.toString()} values=[${values.join(', ')}]`,
|
|
389
424
|
);
|
|
390
425
|
|
|
@@ -396,26 +431,26 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
396
431
|
*/
|
|
397
432
|
async #getContractLogger(): Promise<Logger> {
|
|
398
433
|
if (!this.contractLogger) {
|
|
399
|
-
const addrAbbrev = this.contractAddress.toString().slice(0, 10);
|
|
400
|
-
const name = await this.contractStore.getDebugContractName(this.contractAddress);
|
|
401
|
-
const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::${addrAbbrev}`;
|
|
402
434
|
// Purpose of instanceId is to distinguish logs from different instances of the same component. It makes sense
|
|
403
435
|
// to re-use jobId as instanceId here as executions of different PXE jobs are isolated.
|
|
404
|
-
this.contractLogger =
|
|
436
|
+
this.contractLogger = await createContractLogger(
|
|
437
|
+
this.contractAddress,
|
|
438
|
+
addr => this.contractStore.getDebugContractName(addr),
|
|
439
|
+
{ instanceId: this.jobId },
|
|
440
|
+
);
|
|
405
441
|
}
|
|
406
442
|
return this.contractLogger;
|
|
407
443
|
}
|
|
408
444
|
|
|
409
|
-
public async
|
|
445
|
+
public async log(level: number, message: string, fields: Fr[]): Promise<void> {
|
|
410
446
|
if (!LogLevels[level]) {
|
|
411
447
|
throw new Error(`Invalid log level: ${level}`);
|
|
412
448
|
}
|
|
413
|
-
const levelName = LogLevels[level];
|
|
414
449
|
const logger = await this.#getContractLogger();
|
|
415
|
-
logger[
|
|
450
|
+
logContractMessage(logger, LogLevels[level], message, fields);
|
|
416
451
|
}
|
|
417
452
|
|
|
418
|
-
public async
|
|
453
|
+
public async fetchTaggedLogs(pendingTaggedLogArrayBaseSlot: Fr) {
|
|
419
454
|
const logService = new LogService(
|
|
420
455
|
this.aztecNode,
|
|
421
456
|
this.anchorBlockHeader,
|
|
@@ -425,7 +460,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
425
460
|
this.senderAddressBookStore,
|
|
426
461
|
this.addressStore,
|
|
427
462
|
this.jobId,
|
|
428
|
-
this.
|
|
463
|
+
this.logger.getBindings(),
|
|
429
464
|
);
|
|
430
465
|
|
|
431
466
|
await logService.fetchTaggedLogs(this.contractAddress, pendingTaggedLogArrayBaseSlot, this.scopes);
|
|
@@ -441,10 +476,12 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
441
476
|
* @param noteValidationRequestsArrayBaseSlot - The base slot of capsule array containing note validation requests.
|
|
442
477
|
* @param eventValidationRequestsArrayBaseSlot - The base slot of capsule array containing event validation requests.
|
|
443
478
|
*/
|
|
444
|
-
public async
|
|
479
|
+
public async validateAndStoreEnqueuedNotesAndEvents(
|
|
445
480
|
contractAddress: AztecAddress,
|
|
446
481
|
noteValidationRequestsArrayBaseSlot: Fr,
|
|
447
482
|
eventValidationRequestsArrayBaseSlot: Fr,
|
|
483
|
+
maxNotePackedLen: number,
|
|
484
|
+
maxEventSerializedLen: number,
|
|
448
485
|
) {
|
|
449
486
|
// TODO(#10727): allow other contracts to store notes
|
|
450
487
|
if (!this.contractAddress.equals(contractAddress)) {
|
|
@@ -455,11 +492,11 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
455
492
|
// faster as we don't need to wait for the network round-trip.
|
|
456
493
|
const noteValidationRequests = (
|
|
457
494
|
await this.capsuleStore.readCapsuleArray(contractAddress, noteValidationRequestsArrayBaseSlot, this.jobId)
|
|
458
|
-
).map(NoteValidationRequest.fromFields);
|
|
495
|
+
).map(fields => NoteValidationRequest.fromFields(fields, maxNotePackedLen));
|
|
459
496
|
|
|
460
497
|
const eventValidationRequests = (
|
|
461
498
|
await this.capsuleStore.readCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, this.jobId)
|
|
462
|
-
).map(EventValidationRequest.fromFields);
|
|
499
|
+
).map(fields => EventValidationRequest.fromFields(fields, maxEventSerializedLen));
|
|
463
500
|
|
|
464
501
|
const noteService = new NoteService(this.noteStore, this.aztecNode, this.anchorBlockHeader, this.jobId);
|
|
465
502
|
const noteStorePromises = noteValidationRequests.map(request =>
|
|
@@ -497,7 +534,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
497
534
|
await this.capsuleStore.setCapsuleArray(contractAddress, eventValidationRequestsArrayBaseSlot, [], this.jobId);
|
|
498
535
|
}
|
|
499
536
|
|
|
500
|
-
public async
|
|
537
|
+
public async bulkRetrieveLogs(
|
|
501
538
|
contractAddress: AztecAddress,
|
|
502
539
|
logRetrievalRequestsArrayBaseSlot: Fr,
|
|
503
540
|
logRetrievalResponsesArrayBaseSlot: Fr,
|
|
@@ -522,7 +559,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
522
559
|
this.senderAddressBookStore,
|
|
523
560
|
this.addressStore,
|
|
524
561
|
this.jobId,
|
|
525
|
-
this.
|
|
562
|
+
this.logger.getBindings(),
|
|
526
563
|
);
|
|
527
564
|
|
|
528
565
|
const maybeLogRetrievalResponses = await logService.bulkRetrieveLogs(logRetrievalRequests);
|
|
@@ -539,7 +576,48 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
539
576
|
);
|
|
540
577
|
}
|
|
541
578
|
|
|
542
|
-
public
|
|
579
|
+
public async utilityResolveMessageContexts(
|
|
580
|
+
contractAddress: AztecAddress,
|
|
581
|
+
messageContextRequestsArrayBaseSlot: Fr,
|
|
582
|
+
messageContextResponsesArrayBaseSlot: Fr,
|
|
583
|
+
) {
|
|
584
|
+
try {
|
|
585
|
+
if (!this.contractAddress.equals(contractAddress)) {
|
|
586
|
+
throw new Error(`Got a message context request from ${contractAddress}, expected ${this.contractAddress}`);
|
|
587
|
+
}
|
|
588
|
+
const requestCapsules = await this.capsuleStore.readCapsuleArray(
|
|
589
|
+
contractAddress,
|
|
590
|
+
messageContextRequestsArrayBaseSlot,
|
|
591
|
+
this.jobId,
|
|
592
|
+
);
|
|
593
|
+
|
|
594
|
+
const txHashes = requestCapsules.map((fields, i) => {
|
|
595
|
+
if (fields.length !== 1) {
|
|
596
|
+
throw new Error(
|
|
597
|
+
`Malformed message context request at index ${i}: expected 1 field (tx hash), got ${fields.length}`,
|
|
598
|
+
);
|
|
599
|
+
}
|
|
600
|
+
return fields[0];
|
|
601
|
+
});
|
|
602
|
+
|
|
603
|
+
const maybeMessageContexts = await this.messageContextService.resolveMessageContexts(
|
|
604
|
+
txHashes,
|
|
605
|
+
this.anchorBlockHeader.getBlockNumber(),
|
|
606
|
+
);
|
|
607
|
+
|
|
608
|
+
// Leave response in response capsule array.
|
|
609
|
+
await this.capsuleStore.setCapsuleArray(
|
|
610
|
+
contractAddress,
|
|
611
|
+
messageContextResponsesArrayBaseSlot,
|
|
612
|
+
maybeMessageContexts.map(MessageTxContext.toSerializedOption),
|
|
613
|
+
this.jobId,
|
|
614
|
+
);
|
|
615
|
+
} finally {
|
|
616
|
+
await this.capsuleStore.setCapsuleArray(contractAddress, messageContextRequestsArrayBaseSlot, [], this.jobId);
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
public storeCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[]): Promise<void> {
|
|
543
621
|
if (!contractAddress.equals(this.contractAddress)) {
|
|
544
622
|
// TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
|
|
545
623
|
throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
|
|
@@ -548,7 +626,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
548
626
|
return Promise.resolve();
|
|
549
627
|
}
|
|
550
628
|
|
|
551
|
-
public async
|
|
629
|
+
public async loadCapsule(contractAddress: AztecAddress, slot: Fr): Promise<Fr[] | null> {
|
|
552
630
|
if (!contractAddress.equals(this.contractAddress)) {
|
|
553
631
|
// TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
|
|
554
632
|
throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
|
|
@@ -560,7 +638,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
560
638
|
);
|
|
561
639
|
}
|
|
562
640
|
|
|
563
|
-
public
|
|
641
|
+
public deleteCapsule(contractAddress: AztecAddress, slot: Fr): Promise<void> {
|
|
564
642
|
if (!contractAddress.equals(this.contractAddress)) {
|
|
565
643
|
// TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
|
|
566
644
|
throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
|
|
@@ -569,12 +647,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
569
647
|
return Promise.resolve();
|
|
570
648
|
}
|
|
571
649
|
|
|
572
|
-
public
|
|
573
|
-
contractAddress: AztecAddress,
|
|
574
|
-
srcSlot: Fr,
|
|
575
|
-
dstSlot: Fr,
|
|
576
|
-
numEntries: number,
|
|
577
|
-
): Promise<void> {
|
|
650
|
+
public copyCapsule(contractAddress: AztecAddress, srcSlot: Fr, dstSlot: Fr, numEntries: number): Promise<void> {
|
|
578
651
|
if (!contractAddress.equals(this.contractAddress)) {
|
|
579
652
|
// TODO(#10727): instead of this check that this.contractAddress is allowed to access the external DB
|
|
580
653
|
throw new Error(`Contract ${contractAddress} is not allowed to access ${this.contractAddress}'s PXE DB`);
|
|
@@ -582,8 +655,19 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
582
655
|
return this.capsuleStore.copyCapsule(this.contractAddress, srcSlot, dstSlot, numEntries, this.jobId);
|
|
583
656
|
}
|
|
584
657
|
|
|
658
|
+
/**
|
|
659
|
+
* Clears cached sync state for a contract for a set of scopes, forcing re-sync on the next query so that newly
|
|
660
|
+
* stored notes or events are discovered.
|
|
661
|
+
*/
|
|
662
|
+
public invalidateContractSyncCache(contractAddress: AztecAddress, scopes: AztecAddress[]): void {
|
|
663
|
+
if (!contractAddress.equals(this.contractAddress)) {
|
|
664
|
+
throw new Error(`Contract ${this.contractAddress} cannot invalidate sync cache of ${contractAddress}`);
|
|
665
|
+
}
|
|
666
|
+
this.contractSyncService.invalidateContractForScopes(contractAddress, scopes);
|
|
667
|
+
}
|
|
668
|
+
|
|
585
669
|
// TODO(#11849): consider replacing this oracle with a pure Noir implementation of aes decryption.
|
|
586
|
-
public
|
|
670
|
+
public aes128Decrypt(ciphertext: Buffer, iv: Buffer, symKey: Buffer): Promise<Buffer> {
|
|
587
671
|
const aes128 = new Aes128();
|
|
588
672
|
return aes128.decryptBufferCBC(ciphertext, iv, symKey);
|
|
589
673
|
}
|
|
@@ -594,11 +678,7 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
594
678
|
* @param ephPk - The ephemeral public key to get the secret for.
|
|
595
679
|
* @returns The secret for the given address.
|
|
596
680
|
*/
|
|
597
|
-
public
|
|
598
|
-
return this.getSharedSecret(address, ephPk);
|
|
599
|
-
}
|
|
600
|
-
|
|
601
|
-
protected async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
|
|
681
|
+
public async getSharedSecret(address: AztecAddress, ephPk: Point): Promise<Point> {
|
|
602
682
|
// TODO(#12656): return an app-siloed secret
|
|
603
683
|
const recipientCompleteAddress = await this.getCompleteAddressOrFail(address);
|
|
604
684
|
const ivskM = await this.keyStore.getMasterSecretKey(
|
|
@@ -607,4 +687,14 @@ export class UtilityExecutionOracle implements IMiscOracle, IUtilityExecutionOra
|
|
|
607
687
|
const addressSecret = await computeAddressSecret(await recipientCompleteAddress.getPreaddress(), ivskM);
|
|
608
688
|
return deriveEcdhSharedSecret(addressSecret, ephPk);
|
|
609
689
|
}
|
|
690
|
+
|
|
691
|
+
public emitOffchainEffect(data: Fr[]): Promise<void> {
|
|
692
|
+
this.offchainEffects.push({ data, contractAddress: this.contractAddress });
|
|
693
|
+
return Promise.resolve();
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
/** Returns offchain effects collected during execution. */
|
|
697
|
+
public getOffchainEffects(): OffchainEffect[] {
|
|
698
|
+
return this.offchainEffects;
|
|
699
|
+
}
|
|
610
700
|
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { Fr } from '@aztec/foundation/curves/bn254';
|
|
2
|
+
import { type LogLevel, type Logger, applyStringFormatting, createLogger } from '@aztec/foundation/log';
|
|
3
|
+
import type { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
4
|
+
import type { DebugLog } from '@aztec/stdlib/logs';
|
|
5
|
+
|
|
6
|
+
/** Resolves a contract address to a human-readable name, if available. */
|
|
7
|
+
export type ContractNameResolver = (address: AztecAddress) => Promise<string | undefined>;
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* Creates a logger whose output is prefixed with `contract_log::<name>(<addrAbbrev>)`.
|
|
11
|
+
*/
|
|
12
|
+
export async function createContractLogger(
|
|
13
|
+
contractAddress: AztecAddress,
|
|
14
|
+
getContractName: ContractNameResolver,
|
|
15
|
+
options?: { instanceId?: string },
|
|
16
|
+
): Promise<Logger> {
|
|
17
|
+
const addrAbbrev = contractAddress.toString().slice(0, 10);
|
|
18
|
+
const name = await getContractName(contractAddress);
|
|
19
|
+
const module = name ? `contract_log::${name}(${addrAbbrev})` : `contract_log::Unknown(${addrAbbrev})`;
|
|
20
|
+
return createLogger(module, options);
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/**
|
|
24
|
+
* Formats and emits a single contract log message through the given logger.
|
|
25
|
+
*/
|
|
26
|
+
export function logContractMessage(logger: Logger, level: LogLevel, message: string, fields: Fr[]): void {
|
|
27
|
+
logger[level](applyStringFormatting(message, fields));
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Displays debug logs collected during public function simulation,
|
|
32
|
+
* using the `contract_log::` prefixed logger format.
|
|
33
|
+
*/
|
|
34
|
+
export async function displayDebugLogs(debugLogs: DebugLog[], getContractName: ContractNameResolver): Promise<void> {
|
|
35
|
+
for (const log of debugLogs) {
|
|
36
|
+
const logger = await createContractLogger(log.contractAddress, getContractName);
|
|
37
|
+
logContractMessage(logger, log.level, log.message, log.fields);
|
|
38
|
+
}
|
|
39
|
+
}
|